PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.uv.smart@app-launch-2.2.0-ballot
    http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand
description: 'Profile on Organization to convey a Patient Access Brand.\n\nFor background and context, see **[Patient Access Brands Overview](brands.html#brand-profile-organization)**.\n\nIn addition to the core data elements on Organization, two key extensions are used in this profile:\n\n*  conveys the organization''s logo(s) and other top-level branding details. See definitions for details.\n*  conveys the details of a patient portal and its associated FHIR endpoints. See definitions for details.\n\n Notes:\n* `0..1 MS` `partOf` Conveys that an affiliate Brand response for providing this Brand''s patient access. The hierarchy of \"access provided by\" links SHALL NOT exceed a depth of two (i.e., a Brand either includes portal details or links directly to a Brand that provides them).\n\n* `0..* MS` `identifier` Conveys identifiers that apps can use to link this Brand across publishers or with external data sets. EHRs SHALL support customer-supplied identifiers (`system` and `value`).\n\n    * It is RECOMMENDED that each Brand include an identifier where `system` is `urn:ietf:rfc: 3986` (meaning the identifier is a URL) and `value` is the HTTPS URL for the Brand''s primary web presence, omitting any \"www.\" prefix from the domain and omitting any path component. For example, since the main web presence of Boston Children''s Hospital is https://www.childrenshospital.org/, a recommended identifier would be:     `{\"system\": \"urn:ietf:rfc:3986\",\"value\": \"https://childrenshospital.org\"}`'
package_name: hl7.fhir.uv.smart
derivation: constraint
name: PatientAccessBrand
type: Organization
elements:
  address: {short: 'Locations (e.g., zip codes and/or street addresses) associated with the Brand.', mustSupport: true, index: 9}
  name: {short: Primary brand name to display on a card, mustSupport: true, index: 6}
  type:
    mustSupport: true
    index: 4
    slicing:
      rules: open
      discriminator:
      - {path: $this, type: value}
      min: null
      slices:
        pab:
          match: {}
          schema:
            short: Categories of patient access offered
            binding: {strength: required, valueSet: 'http://hl7.org/fhir/smart-app-launch/ValueSet/patient-access-category'}
            mustSupport: true
            index: 5
          min: 0
  extension:
    index: 0
    slicing:
      rules: open
      ordered: false
      discriminator:
      - {path: url, type: value}
      min: null
      slices:
        brand:
          match: {url: null}
          schema: {type: Extension, short: Brand Details, mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/organization-brand', index: 1}
          min: 0
        portal:
          match: {url: null}
          schema: {type: Extension, short: Portal Details, mustSupport: true, url: 'http://hl7.org/fhir/StructureDefinition/organization-portal', index: 2}
          min: 0
  alias: {short: 'Aliases (e.g., former names like "Partners Healthcare") for filtering/search', mustSupport: true, index: 7}
  identifier: {short: Unique identifier for the brand, mustSupport: true, index: 3}
  telecom: {short: The primary public website for the Brand., mustSupport: true, index: 8}
  partOf: {short: 'Affiliated "parent brand", if this Brand is part of a larger health system', mustSupport: true, index: 10}
  endpoint:
    type: Reference
    short: Endpoint associated with this brand
    mustSupport: true
    refers: ['http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-endpoint']
    index: 11
    elements:
      reference: {short: Relative URL to an Endpoint within the Patient Access Brands Bundle, mustSupport: true, index: 12}
package_version: app-launch-2.2.0-ballot
extensions:
  brand: {url: 'http://hl7.org/fhir/StructureDefinition/organization-brand', min: 0, type: Extension, short: Brand Details, mustSupport: true, index: 1}
  portal: {url: 'http://hl7.org/fhir/StructureDefinition/organization-portal', min: 0, type: Extension, short: Portal Details, mustSupport: true, index: 2}
class: profile
kind: resource
url: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand
base: http://hl7.org/fhir/StructureDefinition/Organization
version: 2.2.0-ballot
required: [name, telecom]