SMART App Launch
2.2.0 - STU 2.2
SMART App Launch
2.2.0 - STU 2.2
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 in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brand | Version: 2.2.0 | |||
| 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:
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).
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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.type:pab | required | UserAccessCategoryValueSethttp://hl7.org/fhir/smart-app-launch/ValueSet/user-access-categoryfrom this IG |
| 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 |
|---|---|---|---|---|
| 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typefrom the FHIR Standard | |
| Organization.type:pab | required | UserAccessCategoryValueSethttp://hl7.org/fhir/smart-app-launch/ValueSet/user-access-categoryfrom this IG |
| 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() | |
| 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 | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typefrom the FHIR Standard | ||||
| Organization.type:pab | required | UserAccessCategoryValueSethttp://hl7.org/fhir/smart-app-launch/ValueSet/user-access-categoryfrom this IG | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard | ||||
| Organization.endpoint.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| 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() | |
| 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) |
This structure is derived from Organization
Summary
Mandatory: 2 elements
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.type:pab | required | UserAccessCategoryValueSethttp://hl7.org/fhir/smart-app-launch/ValueSet/user-access-categoryfrom this IG |
| 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) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typefrom the FHIR Standard | |
| Organization.type:pab | required | UserAccessCategoryValueSethttp://hl7.org/fhir/smart-app-launch/ValueSet/user-access-categoryfrom this IG |
| 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() | |
| 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) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| 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.
| |||||
| 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 | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Organization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Organization.type | example | OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-typefrom the FHIR Standard | ||||
| Organization.type:pab | required | UserAccessCategoryValueSethttp://hl7.org/fhir/smart-app-launch/ValueSet/user-access-categoryfrom this IG | ||||
| Organization.contact.purpose | extensible | ContactEntityTypehttp://hl7.org/fhir/ValueSet/contactentity-typefrom the FHIR Standard | ||||
| Organization.endpoint.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard |
| 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() | |
| 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) |
This structure is derived from Organization
Summary
Mandatory: 2 elements
Must-Support: 12 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / FHIR Infrastructure and Boston Children's Hospital. Package hl7.fhir.uv.smart-app-launch#2.2.0 based on FHIR 4.0.1. Generated 2024-04-30
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change