UserAccessBrand

User Access Brand (Organization) Profile

activeSMART App Launch2.2.0resource12 key elements

Profile on Organization to convey a User Access Brand.

For background and context, see [User Access Brands Overview](brands.html#brand-profile-organization).

In addition to the core data elements on Organization, two key extensions are used in this profile:

  • <http://hl7.org/fhir/StructureDefinition/organization-brand> conveys the organization's logo(s) and other top-level branding details. See definitions for details.
  • <http://hl7.org/fhir/StructureDefinition/organization-portal> conveys the details of a user portal and its associated FHIR endpoints. See definitions for details.

Notes:

  • `0..1 MS` `partOf` Conveys that an affiliate Brand response for providing this Brand's user 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).
  • `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`).

* 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"}`

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brand
ID
user-access-brand
Type
Base Definition
Derivation
constraint
Mandatory and Must-Support Elements

Elements with cardinality > 0 or marked as Must Support (S)

PathCard.TypeFlagsDescription
:brand0..*
Extension
S
Brand Details
:portal0..*
Extension
S
Portal Details
identifier
S
Unique identifier for the brand
type
S
:pab
S
Categories of user access offered
name
S1+
Primary brand name to display on a card
alias
S
Aliases (e.g., former names like "Partners Healthcare") for filtering/search
telecom1..1
S1+
The primary public website for the Brand.
address
S
Locations (e.g., zip codes and/or street addresses) associated with the Brand.
partOf
S
Affiliated "parent brand", if this Brand is part of a larger health system
endpoint
Reference
S
Endpoint associated with this brand
endpoint.reference
S
Relative URL to an Endpoint within the User Access Brands Bundle