SMART App Launch
2.2.0 - STU 2.2 International flag

SMART App Launch, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 2.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/smart-app-launch/ and changes regularly. See the Directory of published versions

Resource Profile: UserAccessBrand - Detailed Descriptions

Active as of 2023-03-05

Definitions for the user-access-brand resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Organization
Definition

A brand of a healthcare provider, such as a hospital, clinic, or practice

ShortUser Access Brand
Invariantsuab-1: Portal endpoints must also appear at Organization.endpoint (Organization.extension('http://hl7.org/fhir/StructureDefinition/organization-portal').extension('portalEndpoint').value.ofType(Reference).reference.subsetOf(%resource.endpoint.reference))
2. Organization.extension
SlicingThis element introduces a set of slices on Organization.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 4. Organization.extension:brand
    Slice Namebrand
    ShortBrand Details
    Control0..*
    TypeExtension(Organization Brand) (Complex Extension)
    Must Supporttrue
    6. Organization.extension:portal
    Slice Nameportal
    ShortPortal Details
    Control0..*
    TypeExtension(Organization Portal) (Complex Extension)
    Must Supporttrue
    8. Organization.identifier
    Definition

    The unique identifier for the brand that apps can use to link this Brand across publishers or with external data sets. EHRs SHALL support customer-supplied identifiers (system and value).

    • 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" }

    ShortUnique identifier for the brand
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Must Supporttrue
    10. Organization.type
    Must Supporttrue
    SlicingThis element introduces a set of slices on Organization.type. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ $this
    • 12. Organization.type:pab
      Slice Namepab
      ShortCategories of user access offered
      Control0..?
      BindingThe codes SHALL be taken from User Access Category Value Set
      (required to http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category)
      Must Supporttrue
      14. Organization.name
      Definition

      The primary brand name to display on a card.

      ShortPrimary brand name to display on a card
      Control1..?
      Must Supporttrue
      16. Organization.alias
      Definition

      Aliases (e.g., former names like "Partners Healthcare") for filtering/search

      ShortAliases (e.g., former names like "Partners Healthcare") for filtering/search
      Must Supporttrue
      18. Organization.telecom
      Definition

      telecom with system of url and value conveying the primary public website for the Brand. Note this is distinct from the user access portal website.

      ShortThe primary public website for the Brand.
      Control1..1
      Must Supporttrue
      20. Organization.address
      Definition

      Locations (e.g., zip codes and/or street addresses) associated with the Brand. The following combinations are allowed, and as a best practice to ensure consistent worldwide adoption, the Address.country data element SHOULD be populated inside any of these with an ISO 3166-1 alpha-2 country code:

      • State
      • City, state
      • City, state, zip code
      • Street address, city, state, zip code
      • zip code alone
      ShortLocations (e.g., zip codes and/or street addresses) associated with the Brand.
      Must Supporttrue
      22. Organization.partOf
      Definition

      Affiliated "parent brand", if this Brand is part of a larger health system. "User access provided by", to convey that an affiliated Brand hosts this Brand's API technology and user portal. 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).

      ShortAffiliated "parent brand", if this Brand is part of a larger health system
      Must Supporttrue
      24. Organization.endpoint
      Definition

      References one or more UserAccessEndpoints. Endpoints here will also be listed within the organization-portal extension, to indicate the specific portal they're associated with.

      ShortEndpoint associated with this brand
      TypeReference(User Access Endpoint Profile)bundled
      Must Supporttrue
      26. Organization.endpoint.reference
      Definition

      Relative URL to an Endpoint within the User Access Brands Bundle

      ShortRelative URL to an Endpoint within the User Access Brands Bundle
      Must Supporttrue