SMART App Launch
2.2.0-preview - CI-Build
SMART App Launch
2.2.0-preview - CI-Build
SMART App Launch - Local Development build (v2.2.0-preview). See the Directory of published versions
| Official URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-brand | Version: 2.2.0-preview | |||
| Active as of 2023-03-05 | Computable Name: PatientAccessBrand | |||
Profile on Organization to communicate the branding associated with a Patient Access API endpoint.
0..* MS Logo
url is http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logovalueUrl SHOULD be optimized for display as a 1” square and formatted as SVG or 1024x1024 pixel PNG with transparent background. Logo should be be legible at small sizes (e.g., as small as 50x50 pixels). Tips to achieve this: if the logo contains both a brandmark and a wordmark, separate them and use just the brandmark. If the logo is predominantly horizontal, consider creating a vertically-oriented logo that is still recognizable when scaled to smaller sizes. Multiple logos may be supplied. The URL can be an absolute URL with the https:// schema, or a Data URL with the data: schema that directly embeds content.0..1 MS Logo use agreement
url is http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo-use-agreement-agreement.valueUrl MAY include a link to terms for logo use by patient access apps.0..* Brand flags
url is http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-flags.valueCode of hidden allows systems to designate Organizations as part of a hierarchy without necessarily being shown in a UX card or tile. Marking Brands hidden can also be used to associate many affiliated organizations with a parent Brand (e.g., each with its street address) without apps displaying redundant information to users.Organization.partOf).
0..1 MS Patient access name (“portal name”) Note: A Brand MUST include a this extension or inherit the value from the Brand referenced by Organization.partOf.
url is http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name.valueString indicates the name by which patients know the portal (e.g.,”MyChildren” or “Patient Gateway”)0..1 MS Patient access URL (“portal URL”) Note: A Brand MUST include a this extension or inherit the value from the Brand referenced by Organization.partOf.
url is http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url.valueUrl indicates the location of the patient portal associated with this Brand – i.e., a URL where patients can go to see their data and manage access.0..1 MS Patient access description (“portal description”)
url is http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-description.valueMarkdown explains, if necessary (in patient-friendly language), the subset of patients eligible to connect and the data available. This capability supports (for example) a cancer center that uses one EHR for pediatric patients and another for adult patients. In this scenario, each EHR would publish a different PatientAccessBrand; apps would display the description to disambiguate the user’s selection. For instance, one Brand might indicate “Access records for childhood cancer care” and another might indicate “Access records for adult cancer care”.0..* MS Patient access logo (“portal logo”). Used if the portal has its own logo in addition to the Brand’s logo
url is http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logovalueUrl See documentation for “brand logo”0..1 MS Patient access logo use agreement
url is http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo-use-agreement.valueUrl See documentation for “brand logo use agreement”.0..* MS Logo
url is http://hl7.org/fhir/smart-app-launch/StructureDefinition/brands-bundlevalueUrl for a customer-managed Patient Access Brands Bundle that defines this Brand and related Brands. It allows customers to self-publish additional information about the Brand.0..* MS identifier(s) 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"
}
0..* type Categories for this organization (system: http://hl7.org/fhir/smart-app-launch/CodeSystem/patient-access-category, code from: clinical, lab, pharmacy, insurer, network, aggregator)1..1 MS name Primary brand name to display on a card0..* MS alias Aliases (e.g., former names like “Partners Healthcare”) for filtering/search1..1 MS telecom with system of url and value conveying the primary public website for the Brand. Note this is distinct from the patient access portal website (described below)0..* MS address Locations (e.g., zip codes and/or street addresses) associated with the Brand. The following combinations are allowed:
0..1 MS partOf “Patient access provided by”, to convey that an
affiliated Brand hosts this Brand’s API technology and patient 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).0..* MS endpoint references one or more PatientAccessEndpoints. Typically, this
property associates a single “primary brand” with the endpoint. Additional
affiliated Brands or parent brands can be associated via “Patient access
provided by” links (Organization.partOf). EHR vendors SHALL support
integrated publication of Organizations in the same JSON Bundle, as well as
external customer-managed publications:
0..1 MS reference containing a relative URL to an Endpoint within a Brand BundleUsage:
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 | Patient Access Brand pab-1: A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. pab-2: A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. |
  logo | S | 0..* | url | Patient Access Brand Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo |
| logoUse | S | 0..1 | url | Patient Access Brand Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo-use-agreement |
| flags | S | 0..* | code | Patient Access Brand Flags URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-flags Binding: Brand Flags Value Set (extensible): Patient Access Brand Flags Codes. |
| portalName | SC | 0..1 | string | Patient Access Brand Portal Name URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name |
| portalURL | S | 0..1 | url | Patient Access Brand Portal URL URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url |
| portalDescription | SC | 0..1 | markdown | Patient Access Brand Portal Description URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-description |
| portalLogo | S | 0..* | url | Patient Access Brand Portal Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo |
| portalLogoUse | S | 0..1 | url | Patient Access Brand Portal Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo-use-agreement |
| brands-bundle | S | 0..* | url | URL for a customer-managed Patient Access Brands Bundle URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brands-bundle |
 identifier | S | 0..* | Identifier | Unique identifier for the brand |
| type | 0..* | CodeableConcept | Categories for this organization (health-system, hospital, outpatient, insurer, lab, pharmacy) Binding: Patient Access Category Value Set (extensible) | |
| 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 | SC | 0..1 | Reference(Organization) | Affiliated "parent brand", if this Brand is part of a larger health system |
  endpoint | S | 0..* | Reference(Patient Access Endpoint Profile) {b} | The "primary brand" endpoint. |
  reference | S | 0..1 | string | Relative URL to an Endpoint within the Patient Access Brands Bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.type | extensible | PatientAccessCategoryValueSet (a valid code from Patient Access Category Code System) |
| Id | Grade | Path(s) | Details | Requirements |
| pab-1 | error | Organization | A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() | |
| pab-2 | error | Organization | A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | Organization | Patient Access Brand pab-1: A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. pab-2: A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| logo | S | 0..* | url | Patient Access Brand Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo |
| logoUse | S | 0..1 | url | Patient Access Brand Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo-use-agreement |
| flags | S | 0..* | code | Patient Access Brand Flags URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-flags Binding: Brand Flags Value Set (extensible): Patient Access Brand Flags Codes. |
| portalName | SC | 0..1 | string | Patient Access Brand Portal Name URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name |
| portalURL | S | 0..1 | url | Patient Access Brand Portal URL URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url |
| portalDescription | SC | 0..1 | markdown | Patient Access Brand Portal Description URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-description |
| portalLogo | S | 0..* | url | Patient Access Brand Portal Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo |
| portalLogoUse | S | 0..1 | url | Patient Access Brand Portal Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo-use-agreement |
| brands-bundle | S | 0..* | url | URL for a customer-managed Patient Access Brands Bundle URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brands-bundle |
 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 |
| type | Σ | 0..* | CodeableConcept | Categories for this organization (health-system, hospital, outpatient, insurer, lab, pharmacy) Binding: Patient Access Category Value Set (extensible) |
| 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. |
| address | SC | 0..* | Address | Locations (e.g., zip codes and/or street addresses) associated with the Brand. |
| partOf | SΣC | 0..1 | Reference(Organization) | Affiliated "parent brand", if this Brand is part of a larger health system |
| endpoint | S | 0..* | Reference(Patient Access Endpoint Profile) {b} | The "primary brand" endpoint. |
| reference | SΣC | 0..1 | string | Relative URL to an Endpoint within the Patient Access Brands Bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.type | extensible | PatientAccessCategoryValueSet (a valid code from Patient Access Category Code System) |
| 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() | |
| pab-1 | error | Organization | A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() | |
| pab-2 | error | Organization | A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | Organization | Patient Access Brand pab-1: A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. pab-2: A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. | ||||
| 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 | |||||
| logo | S | 0..* | url | Patient Access Brand Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo | ||||
| logoUse | S | 0..1 | url | Patient Access Brand Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo-use-agreement | ||||
| flags | S | 0..* | code | Patient Access Brand Flags URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-flags Binding: Brand Flags Value Set (extensible): Patient Access Brand Flags Codes. | ||||
| portalName | SC | 0..1 | string | Patient Access Brand Portal Name URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name | ||||
| portalURL | S | 0..1 | url | Patient Access Brand Portal URL URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url | ||||
| portalDescription | SC | 0..1 | markdown | Patient Access Brand Portal Description URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-description | ||||
| portalLogo | S | 0..* | url | Patient Access Brand Portal Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo | ||||
| portalLogoUse | S | 0..1 | url | Patient Access Brand Portal Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo-use-agreement | ||||
| brands-bundle | S | 0..* | url | URL for a customer-managed Patient Access Brands Bundle URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brands-bundle | ||||
| 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 | ||||
| type | Σ | 0..* | CodeableConcept | Categories for this organization (health-system, hospital, outpatient, insurer, lab, pharmacy) Binding: Patient Access Category Value Set (extensible) | ||||
| 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. | ||||
| address | SC | 0..* | Address | Locations (e.g., zip codes and/or street addresses) associated with the Brand. | ||||
| partOf | SΣC | 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(Patient Access Endpoint Profile) {b} | The "primary brand" endpoint. | ||||
| 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 Patient 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 | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.type | extensible | PatientAccessCategoryValueSet (a valid code from Patient Access Category Code System) | ||||
| Organization.contact.purpose | extensible | ContactEntityType | ||||
| Organization.endpoint.type | extensible | ResourceType |
| 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() | |
| pab-1 | error | Organization | A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() | |
| pab-2 | error | Organization | A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() |
This structure is derived from Organization
Summary
Mandatory: 2 elements
Must-Support: 17 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Differential View
This structure is derived from Organization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | Organization | Patient Access Brand pab-1: A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. pab-2: A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. |
| logo | S | 0..* | url | Patient Access Brand Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo |
| logoUse | S | 0..1 | url | Patient Access Brand Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo-use-agreement |
| flags | S | 0..* | code | Patient Access Brand Flags URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-flags Binding: Brand Flags Value Set (extensible): Patient Access Brand Flags Codes. |
| portalName | SC | 0..1 | string | Patient Access Brand Portal Name URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name |
| portalURL | S | 0..1 | url | Patient Access Brand Portal URL URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url |
| portalDescription | SC | 0..1 | markdown | Patient Access Brand Portal Description URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-description |
| portalLogo | S | 0..* | url | Patient Access Brand Portal Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo |
| portalLogoUse | S | 0..1 | url | Patient Access Brand Portal Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo-use-agreement |
| brands-bundle | S | 0..* | url | URL for a customer-managed Patient Access Brands Bundle URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brands-bundle |
| identifier | S | 0..* | Identifier | Unique identifier for the brand |
| type | 0..* | CodeableConcept | Categories for this organization (health-system, hospital, outpatient, insurer, lab, pharmacy) Binding: Patient Access Category Value Set (extensible) | |
| 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 | SC | 0..1 | Reference(Organization) | Affiliated "parent brand", if this Brand is part of a larger health system |
| endpoint | S | 0..* | Reference(Patient Access Endpoint Profile) {b} | The "primary brand" endpoint. |
| reference | S | 0..1 | string | Relative URL to an Endpoint within the Patient Access Brands Bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.type | extensible | PatientAccessCategoryValueSet (a valid code from Patient Access Category Code System) |
| Id | Grade | Path(s) | Details | Requirements |
| pab-1 | error | Organization | A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() | |
| pab-2 | error | Organization | A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | C | 0..* | Organization | Patient Access Brand pab-1: A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. pab-2: A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| logo | S | 0..* | url | Patient Access Brand Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo |
| logoUse | S | 0..1 | url | Patient Access Brand Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo-use-agreement |
| flags | S | 0..* | code | Patient Access Brand Flags URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-flags Binding: Brand Flags Value Set (extensible): Patient Access Brand Flags Codes. |
| portalName | SC | 0..1 | string | Patient Access Brand Portal Name URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name |
| portalURL | S | 0..1 | url | Patient Access Brand Portal URL URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url |
| portalDescription | SC | 0..1 | markdown | Patient Access Brand Portal Description URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-description |
| portalLogo | S | 0..* | url | Patient Access Brand Portal Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo |
| portalLogoUse | S | 0..1 | url | Patient Access Brand Portal Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo-use-agreement |
| brands-bundle | S | 0..* | url | URL for a customer-managed Patient Access Brands Bundle URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brands-bundle |
| 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 |
| type | Σ | 0..* | CodeableConcept | Categories for this organization (health-system, hospital, outpatient, insurer, lab, pharmacy) Binding: Patient Access Category Value Set (extensible) |
| 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. |
| address | SC | 0..* | Address | Locations (e.g., zip codes and/or street addresses) associated with the Brand. |
| partOf | SΣC | 0..1 | Reference(Organization) | Affiliated "parent brand", if this Brand is part of a larger health system |
| endpoint | S | 0..* | Reference(Patient Access Endpoint Profile) {b} | The "primary brand" endpoint. |
| reference | SΣC | 0..1 | string | Relative URL to an Endpoint within the Patient Access Brands Bundle |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Organization.type | extensible | PatientAccessCategoryValueSet (a valid code from Patient Access Category Code System) |
| 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() | |
| pab-1 | error | Organization | A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() | |
| pab-2 | error | Organization | A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Organization | C | 0..* | Organization | Patient Access Brand pab-1: A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. pab-2: A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. | ||||
| 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 | |||||
| logo | S | 0..* | url | Patient Access Brand Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo | ||||
| logoUse | S | 0..1 | url | Patient Access Brand Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-logo-use-agreement | ||||
| flags | S | 0..* | code | Patient Access Brand Flags URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brand-flags Binding: Brand Flags Value Set (extensible): Patient Access Brand Flags Codes. | ||||
| portalName | SC | 0..1 | string | Patient Access Brand Portal Name URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name | ||||
| portalURL | S | 0..1 | url | Patient Access Brand Portal URL URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-url | ||||
| portalDescription | SC | 0..1 | markdown | Patient Access Brand Portal Description URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-description | ||||
| portalLogo | S | 0..* | url | Patient Access Brand Portal Logo URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo | ||||
| portalLogoUse | S | 0..1 | url | Patient Access Brand Portal Logo Use Agreement URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-logo-use-agreement | ||||
| brands-bundle | S | 0..* | url | URL for a customer-managed Patient Access Brands Bundle URL: http://hl7.org/fhir/smart-app-launch/StructureDefinition/brands-bundle | ||||
| 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 | ||||
| type | Σ | 0..* | CodeableConcept | Categories for this organization (health-system, hospital, outpatient, insurer, lab, pharmacy) Binding: Patient Access Category Value Set (extensible) | ||||
| 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. | ||||
| address | SC | 0..* | Address | Locations (e.g., zip codes and/or street addresses) associated with the Brand. | ||||
| partOf | SΣC | 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(Patient Access Endpoint Profile) {b} | The "primary brand" endpoint. | ||||
| 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 Patient 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 | ||||
| Organization.language | preferred | CommonLanguages
| ||||
| Organization.type | extensible | PatientAccessCategoryValueSet (a valid code from Patient Access Category Code System) | ||||
| Organization.contact.purpose | extensible | ContactEntityType | ||||
| Organization.endpoint.type | extensible | ResourceType |
| 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() | |
| pab-1 | error | Organization | A Patient Access Brand SHALL have a *portalName* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() | |
| pab-2 | error | Organization | A Patient Access Brand SHALL have a *portalURL* extension or a reference to an affiliated "parent brand" (`Organization.partOf`) or both. : extension.where(url='http://hl7.org/fhir/smart-app-launch/StructureDefinition/patient-access-name').exists() or partOf.exists() |
This structure is derived from Organization
Summary
Mandatory: 2 elements
Must-Support: 17 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International - FHIR Infrastructure WG and Boston Children's Hospital Package hl7.fhir.uv.smart-app-launch#2.2.0-preview based on FHIR 4.0.1. Generated 2023-09-14
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change