User Access Brand (Organization) Profile

SMART App Launch
2.2.0 - STU 2.2 International flag

This page is part of the Smart App Launch Implementation Guide (v2.2.0: STU 2.2) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: User Access Brand (Organization) Profile

Official URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brand

Active as of 2023年03月05日 Computable Name: UserAccessBrand

Profile on Organization to convey a User Access Brand.

For background and context, see User Access Brands Overview .

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

Usage:

Use this Resource Profile: User Access Brands Bundle Profile

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Differential Table
Key Elements Table
Snapshot Table
Statistics/References
All

This structure is derived from Organization

Name	Flags	Card.	Type	Description & Constraints doco
.. Organization	C	0..*	Organization	User Access Brand uab-1: Portal endpoints must also appear at Organization.endpoint
... Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
... brand	S	0..*	(Complex)	Brand Details URL: http://hl7.org/fhir/StructureDefinition/organization-brand
... portal	S	0..*	(Complex)	Portal Details URL: http://hl7.org/fhir/StructureDefinition/organization-portal
... identifier	S	0..*	Identifier	Unique identifier for the brand
... Slices for type	S	0..*	CodeableConcept	Kind of organization Slice: Unordered, Open by value:$this
.... type:pab	S	0..*	CodeableConcept	Categories of user access offered Binding: User Access Category Value Set (required)
... name	S	1..1	string	Primary brand name to display on a card
... alias	S	0..*	string	Aliases (e.g., former names like "Partners Healthcare") for filtering/search
... telecom	S	1..1	ContactPoint	The primary public website for the Brand.
... address	S	0..*	Address	Locations (e.g., zip codes and/or street addresses) associated with the Brand.
... partOf	S	0..1	Reference(Organization)	Affiliated "parent brand", if this Brand is part of a larger health system
... endpoint	S	0..*	Reference(User Access Endpoint Profile) { b }	Endpoint associated with this brand
.... reference	S	0..1	string	Relative URL to an Endpoint within the User Access Brands Bundle
doco Documentation for this format

Terminology Bindings (Differential)

Path Conformance ValueSet URI

Organization.type:pab required UserAccessCategoryValueSet

http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category

from this IG

Constraints

Id Grade Path(s) Details Requirements

uab-1 error Organization 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)

Name	Flags	Card.	Type	Description & Constraints doco
.. Organization	C	0..*	Organization	User Access Brand org-1: The organization SHALL at least have a name or an identifier, and possibly more than one uab-1: Portal endpoints must also appear at Organization.endpoint
... implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
... Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
... brand	S	0..*	(Complex)	Brand Details URL: http://hl7.org/fhir/StructureDefinition/organization-brand
... portal	S	0..*	(Complex)	Portal Details URL: http://hl7.org/fhir/StructureDefinition/organization-portal
... modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
... identifier	SΣC	0..*	Identifier	Unique identifier for the brand
... active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
... Slices for type	SΣ	0..*	CodeableConcept	Kind of organization Slice: Unordered, Open by value:$this Binding: OrganizationType (example ): Used to categorize the organization.
.... type:pab	SΣ	0..*	CodeableConcept	Categories of user access offered Binding: User Access Category Value Set (required)
... name	SΣC	1..1	string	Primary brand name to display on a card
... alias	S	0..*	string	Aliases (e.g., former names like "Partners Healthcare") for filtering/search
... telecom	SC	1..1	ContactPoint	The primary public website for the Brand. org-3: The telecom of an organization can never be of use 'home'
... address	SC	0..*	Address	Locations (e.g., zip codes and/or street addresses) associated with the Brand. org-2: An address of an organization can never be of use 'home'
... partOf	SΣ	0..1	Reference(Organization)	Affiliated "parent brand", if this Brand is part of a larger health system
... endpoint	S	0..*	Reference(User Access Endpoint Profile) { b }	Endpoint associated with this brand
.... reference	SΣC	0..1	string	Relative URL to an Endpoint within the User Access Brands Bundle
doco Documentation for this format

Terminology Bindings

Path Conformance ValueSet URI

Organization.type example OrganizationType

http://hl7.org/fhir/ValueSet/organization-type

from the FHIR Standard

Organization.type:pab required UserAccessCategoryValueSet

http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category

from this IG

Constraints

Id Grade Path(s) Details Requirements

dom-2 error Organization If the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()

dom-3 error Organization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()

dom-4 error Organization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()

dom-5 error Organization If a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()

dom-6 best practice Organization A resource should have narrative for robust management
: text.`div`.exists()

ele-1 error **ALL** elements All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

ext-1 error **ALL** extensions Must have either extensions or value[x], not both
: extension.exists() != value.exists()

org-1 error Organization The organization SHALL at least have a name or an identifier, and possibly more than one
: (identifier.count() + name.count()) > 0

org-2 error Organization.address An address of an organization can never be of use 'home'
: where(use = 'home').empty()

org-3 error Organization.telecom The telecom of an organization can never be of use 'home'
: where(use = 'home').empty()

Name	Flags	Card.	Type	Description & Constraints doco
.. Organization	C	0..*	Organization	User Access Brand org-1: The organization SHALL at least have a name or an identifier, and possibly more than one uab-1: Portal endpoints must also appear at Organization.endpoint
... id	Σ	0..1	id	Logical id of this artifact
... meta	Σ	0..1	Meta	Metadata about the resource
... implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
... language	0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
... text	0..1	Narrative	Text summary of the resource, for human interpretation
... contained	0..*	Resource	Contained, inline Resources
... Slices for extension	0..*	Extension	Extension Slice: Unordered, Open by value:url
... brand	S	0..*	(Complex)	Brand Details URL: http://hl7.org/fhir/StructureDefinition/organization-brand
... portal	S	0..*	(Complex)	Portal Details URL: http://hl7.org/fhir/StructureDefinition/organization-portal
... modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
... identifier	SΣC	0..*	Identifier	Unique identifier for the brand
... active	?!Σ	0..1	boolean	Whether the organization's record is still in active use
... Slices for type	SΣ	0..*	CodeableConcept	Kind of organization Slice: Unordered, Open by value:$this Binding: OrganizationType (example ): Used to categorize the organization.
.... type:pab	SΣ	0..*	CodeableConcept	Categories of user access offered Binding: User Access Category Value Set (required)
... name	SΣC	1..1	string	Primary brand name to display on a card
... alias	S	0..*	string	Aliases (e.g., former names like "Partners Healthcare") for filtering/search
... telecom	SC	1..1	ContactPoint	The primary public website for the Brand. org-3: The telecom of an organization can never be of use 'home'
... address	SC	0..*	Address	Locations (e.g., zip codes and/or street addresses) associated with the Brand. org-2: An address of an organization can never be of use 'home'
... partOf	SΣ	0..1	Reference(Organization)	Affiliated "parent brand", if this Brand is part of a larger health system
... contact	0..*	BackboneElement	Contact for the organization for a certain purpose
.... id	0..1	string	Unique id for inter-element referencing
.... extension	0..*	Extension	Additional content defined by implementations
.... modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
.... purpose	0..1	CodeableConcept	The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party.
.... name	0..1	HumanName	A name associated with the contact
.... telecom	0..*	ContactPoint	Contact details (telephone, email, etc.) for a contact
.... address	0..1	Address	Visiting or postal addresses for the contact
... endpoint	S	0..*	Reference(User Access Endpoint Profile) { b }	Endpoint associated with this brand
.... id	0..1	string	Unique id for inter-element referencing
.... extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
.... reference	SΣC	0..1	string	Relative URL to an Endpoint within the User Access Brands Bundle
.... type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
.... display	Σ	0..1	string	Text alternative for the resource
doco Documentation for this format

Terminology Bindings

Path Conformance ValueSet URI

Organization.language preferred CommonLanguages

Additional Bindings Purpose

AllLanguages Max Binding

http://hl7.org/fhir/ValueSet/languages

from the FHIR Standard

Organization.typeexample OrganizationType

http://hl7.org/fhir/ValueSet/organization-type

from the FHIR Standard

Organization.type:pabrequired UserAccessCategoryValueSet

http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category

from this IG

Organization.contact.purposeextensible ContactEntityType

http://hl7.org/fhir/ValueSet/contactentity-type

from the FHIR Standard

Organization.endpoint.typeextensible ResourceType

http://hl7.org/fhir/ValueSet/resource-types