user-access-brand
type: StructureDefinition
node role: treeRoot
id:
  v: user-access-brand
text:
  status:
    v: extensions
  div: Name Flags Card. Type Description & Constraints<img src="[binary]" alt="doco" style="background-color: inherit"/> 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 <a href="StructureDefinition-user-access-brand-definitions.html#Organization.identifier" title="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" }` ">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. <a href="StructureDefinition-user-access-brand-definitions.html#Organization.address" title="Locations (e.g., zip codes and/or street addresses) associated with the Brand. The following combin…
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/structuredefinition-wg
  value:
    v: fhir
url:
  v: http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brand
version:
  v: 2.2.0
name:
  v: UserAccessBrand
title:
  v: User Access Brand (Organization) Profile
status:
  v: active
date:
  v: 2023-03-05
publisher:
  v: HL7 International / FHIR Infrastructure
contact:
  name:
    v: HL7 International / FHIR Infrastructure
  telecom:
    system:
      v: url
    value:
      v: http://www.hl7.org/Special/committees/fiwg
  telecom:
    system:
      v: email
description:
  v: 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"}`
jurisdiction:
  coding:
    system:
      v: http://unstats.un.org/unsd/methods/m49/m49.htm
    code:
      v: 001
    display:
      v: World
fhir version:
  v: 4.0.1
mapping:
  identity:
    v: v2
  uri:
    v: http://hl7.org/v2
  name:
    v: HL7 v2 Mapping
mapping:
  identity:
    v: rim
  uri:
    v: http://hl7.org/v3
  name:
    v: RIM Mapping
mapping:
  identity:
    v: servd
  uri:
    v: http://www.omg.org/spec/ServD/1.0/
  name:
    v: ServD
mapping:
  identity:
    v: w5
  uri:
    v: http://hl7.org/fhir/fivews
  name:
    v: FiveWs Pattern Mapping
kind:
  v: resource
abstract:
  v: false
type:
  v: Organization
base definition:
  v: http://hl7.org/fhir/StructureDefinition/Organization
  link: http://hl7.org/fhir/StructureDefinition/Organization
derivation:
  v: constraint
snapshot:
  element:
    id:
      v: Organization
    path:
      v: Organization
    short:
      v: User Access Brand
    definition:
      v: A brand of a healthcare provider, such as a hospital, clinic, or practice
    min:
      v: 0
    max:
      v: *
    base:
      path:
        v: Organization
      min:
        v: 0
      max:
        v: *
    constraint:
      key:
        v: dom-2
      severity:
        v: error
      human:
        v: If the resource is contained in another resource, it SHALL NOT contain nested Resources
      expression:
        v: contained.contained.empty()
      xpath:
        v: not(parent::f:contained and f:contained)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-3
      severity:
        v: error
      human:
        v: 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
      expression:
        v: 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()
      xpath:
        v: not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-4
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
      expression:
        v: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-5
      severity:
        v: error
      human:
        v: If a resource is contained in another resource, it SHALL NOT have a security label
      expression:
        v: contained.meta.security.empty()
      xpath:
        v: not(exists(f:contained/*/f:meta/f:security))
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: dom-6
      severity:
        v: warning
      human:
        v: A resource should have narrative for robust management
      expression:
        v: text.`div`.exists()
      xpath:
        v: exists(f:text/h:div)
      source:
        v: http://hl7.org/fhir/StructureDefinition/DomainResource
        link: http://hl7.org/fhir/StructureDefinition/DomainResource
    constraint:
      key:
        v: org-1
      severity:
        v: error
      human:
        v: The organization SHALL at least have a name or an identifier, and possibly more than one
      expression:
        v: (identifier.count() + name.count()) > 0
      xpath:
        v: count(f:identifier | f:name) > 0
      source:
        v: http://hl7.org/fhir/StructureDefinition/Organization
        link: http://hl7.org/fhir/StructureDefinition/Organization
    constraint:
      key:
        v: uab-1
      severity:
        v: error
      human:
        v: Portal endpoints must also appear at Organization.endpoint
      expression:
        v: Organization.extension('http://hl7.org/fhir/StructureDefinition/organization-portal').extension('portalEndpoint').value.ofType(Reference).reference.subsetOf(%resource.endpoint.reference)

v: true

v: When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

v: false

v: false

identity:
  v: rim
map:
  v: Entity. Role, or Act

identity:
  v: v2
map:
  v: (also see master files messages)

identity:
  v: rim
map:
  v: Organization(classCode=ORG, determinerCode=INST)

identity:
  v: servd
map:
  v: Organization

id:
  v: Organization.id
path:
  v: Organization.id
short:
  v: Logical id of this artifact
definition:
  v: The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
comment:
  v: The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: id
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: true

id:
  v: Organization.meta
path:
  v: Organization.meta
short:
  v: Metadata about the resource
definition:
  v: The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.meta
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Meta
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true

id:
  v: Organization.implicitRules
path:
  v: Organization.implicitRules
short:
  v: A set of rules under which this content was created
definition:
  v: A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
comment:
  v: Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.implicitRules
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
is summary:
  v: true

id:
  v: Organization.language
path:
  v: Organization.language
short:
  v: Language of the resource content
definition:
  v: The base language in which the resource is written.
comment:
  v: Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Resource.language
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: code
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet
    value:
      v: http://hl7.org/fhir/ValueSet/all-languages
      link: http://hl7.org/fhir/ValueSet/all-languages
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: Language
  strength:
    v: preferred
  description:
    v: A human language.
  value set:
    v: http://hl7.org/fhir/ValueSet/languages
    link: http://hl7.org/fhir/ValueSet/languages

id:
  v: Organization.text
path:
  v: Organization.text
short:
  v: Text summary of the resource, for human interpretation
definition:
  v: A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
comment:
  v: Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
alias:
  v: narrative
alias:
  v: html
alias:
  v: xhtml
alias:
  v: display
min:
  v: 0
max:
  v: 1
base:
  path:
    v: DomainResource.text
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Narrative
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: Act.text?

id:
  v: Organization.contained
path:
  v: Organization.contained
short:
  v: Contained, inline Resources
definition:
  v: These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
comment:
  v: This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
alias:
  v: inline resources
alias:
  v: anonymous resources
alias:
  v: contained resources
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.contained
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Resource
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Organization.extension
path:
  v: Organization.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  ordered:
    v: false
  rules:
    v: open
short:
  v: Extension
definition:
  v: An Extension
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false

id:
  v: Organization.extension:brand
path:
  v: Organization.extension
slice name:
  v: brand
short:
  v: Brand Details
definition:
  v: Organization-level Brand information.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/organization-brand
    link: http://hl7.org/fhir/StructureDefinition/organization-brand
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: true
is modifier:
  v: false

id:
  v: Organization.extension:portal
path:
  v: Organization.extension
slice name:
  v: portal
short:
  v: Portal Details
definition:
  v: Organization-level portal information.
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
  profile:
    v: http://hl7.org/fhir/StructureDefinition/organization-portal
    link: http://hl7.org/fhir/StructureDefinition/organization-portal
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
must support:
  v: true
is modifier:
  v: false

id:
  v: Organization.modifierExtension
path:
  v: Organization.modifierExtension
short:
  v: Extensions that cannot be ignored
definition:
  v: May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: DomainResource.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Organization.identifier
path:
  v: Organization.identifier
short:
  v: Unique identifier for the brand
definition:
  v: 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" }`
requirements:
  v: Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Organization.identifier
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Identifier
condition:
  v: org-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.identifier
mapping:
  identity:
    v: v2
  map:
    v: XON.10 / XON.3
mapping:
  identity:
    v: rim
  map:
    v: .scopes[Role](classCode=IDENT)
mapping:
  identity:
    v: servd
  map:
    v: ./Identifiers

id:
  v: Organization.active
path:
  v: Organization.active
short:
  v: Whether the organization's record is still in active use
definition:
  v: Whether the organization's record is still in active use.
comment:
  v: This active flag is not intended to be used to mark an organization as temporarily closed or under construction. Instead the Location(s) within the Organization should have the suspended status. If further details of the reason for the suspension are required, then an extension on this element should be used. This element is labeled as a modifier because it may be used to mark that the resource was created in error.
requirements:
  v: Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Organization.active
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: boolean
meaning when missing:
  v: This resource is generally assumed to be active if no value is provided for the active element
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: true
is modifier reason:
  v: This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid
is summary:
  v: true
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.status
mapping:
  identity:
    v: v2
  map:
    v: No equivalent in HL7 v2
mapping:
  identity:
    v: rim
  map:
    v: .status
mapping:
  identity:
    v: servd
  map:
    v: ./Status (however this concept in ServD more covers why the organization is active or not, could be delisted, deregistered, not operational yet) this could alternatively be derived from ./StartDate and ./EndDate and given a context date.

id:
  v: Organization.type
path:
  v: Organization.type
slicing:
  discriminator:
    type:
      v: value
    path:
      v: $this
  rules:
    v: open
short:
  v: Kind of organization
definition:
  v: The kind(s) of organization that this is.
comment:
  v: Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality.
requirements:
  v: Need to be able to track the kind of organization that this is - different organization types have different uses.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Organization.type
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: OrganizationType
  strength:
    v: example
  description:
    v: Used to categorize the organization.
  value set:
    v: http://hl7.org/fhir/ValueSet/organization-type
    link: http://hl7.org/fhir/ValueSet/organization-type
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: v2
  map:
    v: No equivalent in v2
mapping:
  identity:
    v: rim
  map:
    v: .code
mapping:
  identity:
    v: servd
  map:
    v: n/a

id:
  v: Organization.type:pab
path:
  v: Organization.type
slice name:
  v: pab
short:
  v: Categories of user access offered
definition:
  v: The kind(s) of organization that this is.
comment:
  v: Organizations can be corporations, wards, sections, clinical teams, government departments, etc. Note that code is generally a classifier of the type of organization; in many applications, codes are used to identity a particular organization (say, ward) as opposed to another of the same type - these are identifiers, not codes When considering if multiple types are appropriate, you should evaluate if child organizations would be a more appropriate use of the concept, as different types likely are in different sub-areas of the organization. This is most likely to be used where type values have orthogonal values, such as a religious, academic and medical center. We expect that some jurisdictions will profile this optionality to be a single cardinality.
requirements:
  v: Need to be able to track the kind of organization that this is - different organization types have different uses.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Organization.type
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
binding:
  strength:
    v: required
  value set:
    v: http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category
    link: http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category
mapping:
  identity:
    v: w5
  map:
    v: FiveWs.class
mapping:
  identity:
    v: v2
  map:
    v: No equivalent in v2
mapping:
  identity:
    v: rim
  map:
    v: .code
mapping:
  identity:
    v: servd
  map:
    v: n/a

id:
  v: Organization.name
path:
  v: Organization.name
short:
  v: Primary brand name to display on a card
definition:
  v: The primary brand name to display on a card.
comment:
  v: If the name of an organization changes, consider putting the old name in the alias column so that it can still be located through searches.
requirements:
  v: Need to use the name as the label of the organization.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Organization.name
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
condition:
  v: org-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: XON.1
mapping:
  identity:
    v: rim
  map:
    v: .name
mapping:
  identity:
    v: servd
  map:
    v: .PreferredName/Name

id:
  v: Organization.alias
path:
  v: Organization.alias
short:
  v: Aliases (e.g., former names like "Partners Healthcare") for filtering/search
definition:
  v: Aliases (e.g., former names like "Partners Healthcare") for filtering/search
comment:
  v: There are no dates associated with the alias/historic names, as this is not intended to track when names were used, but to assist in searching so that older names can still result in identifying the organization.
requirements:
  v: Over time locations and organizations go through many changes and can be known by different names. For searching knowing previous names that the organization was known by can be very useful.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Organization.alias
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: .name

id:
  v: Organization.telecom
path:
  v: Organization.telecom
short:
  v: The primary public website for the Brand.
definition:
  v: `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.
comment:
  v: The use code 'home' is not to be used. Note that these contacts are not the contact details of people who are employed by or represent the organization, but official contacts for the organization itself.
requirements:
  v: Human contact for the organization.
min:
  v: 1
max:
  v: 1
base:
  path:
    v: Organization.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
condition:
  v: org-3
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: org-3
  severity:
    v: error
  human:
    v: The telecom of an organization can never be of use 'home'
  expression:
    v: where(use = 'home').empty()
  xpath:
    v: count(f:use[@value='home']) = 0
  source:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: ORC-22?
mapping:
  identity:
    v: rim
  map:
    v: .telecom
mapping:
  identity:
    v: servd
  map:
    v: ./ContactPoints

id:
  v: Organization.address
path:
  v: Organization.address
short:
  v: Locations (e.g., zip codes and/or street addresses) associated with the Brand.
definition:
  v: 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
comment:
  v: Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.
requirements:
  v: May need to keep track of the organization's addresses for contacting, billing or reporting requirements.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Organization.address
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Address
condition:
  v: org-2
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: org-2
  severity:
    v: error
  human:
    v: An address of an organization can never be of use 'home'
  expression:
    v: where(use = 'home').empty()
  xpath:
    v: count(f:use[@value='home']) = 0
  source:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: ORC-23?
mapping:
  identity:
    v: rim
  map:
    v: .address
mapping:
  identity:
    v: servd
  map:
    v: ./PrimaryAddress and ./OtherAddresses

id:
  v: Organization.partOf
path:
  v: Organization.partOf
short:
  v: Affiliated "parent brand", if this Brand is part of a larger health system
definition:
  v: 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).
requirements:
  v: Need to be able to track the hierarchy of organizations within an organization.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Organization.partOf
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-hierarchy
    value:
      v: true
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/StructureDefinition/Organization
    link: http://hl7.org/fhir/StructureDefinition/Organization
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: v2
  map:
    v: No equivalent in HL7 v2
mapping:
  identity:
    v: rim
  map:
    v: .playedBy[classCode=Part].scoper
mapping:
  identity:
    v: servd
  map:
    v: n/a

id:
  v: Organization.contact
path:
  v: Organization.contact
short:
  v: Contact for the organization for a certain purpose
definition:
  v: Contact for the organization for a certain purpose.
comment:
  v: Where multiple contacts for the same purpose are provided there is a standard extension that can be used to determine which one is the preferred contact to use.
requirements:
  v: Need to keep track of assigned contact points within bigger organization.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Organization.contact
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: BackboneElement
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: .contactParty

id:
  v: Organization.contact.id
path:
  v: Organization.contact.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Organization.contact.extension
path:
  v: Organization.contact.extension
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Organization.contact.modifierExtension
path:
  v: Organization.contact.modifierExtension
short:
  v: Extensions that cannot be ignored even if unrecognized
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
requirements:
  v: Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
alias:
  v: extensions
alias:
  v: user content
alias:
  v: modifiers
min:
  v: 0
max:
  v: *
base:
  path:
    v: BackboneElement.modifierExtension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: true
is modifier reason:
  v: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Organization.contact.purpose
path:
  v: Organization.contact.purpose
short:
  v: The type of contact
definition:
  v: Indicates a purpose for which the contact can be reached.
requirements:
  v: Need to distinguish between multiple contact persons.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Organization.contact.purpose
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: CodeableConcept
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: ContactPartyType
  strength:
    v: extensible
  description:
    v: The purpose for which you would contact a contact party.
  value set:
    v: http://hl7.org/fhir/ValueSet/contactentity-type
    link: http://hl7.org/fhir/ValueSet/contactentity-type
mapping:
  identity:
    v: rim
  map:
    v: ./type

id:
  v: Organization.contact.name
path:
  v: Organization.contact.name
short:
  v: A name associated with the contact
definition:
  v: A name associated with the contact.
requirements:
  v: Need to be able to track the person by name.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Organization.contact.name
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: HumanName
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: PID-5, PID-9
mapping:
  identity:
    v: rim
  map:
    v: ./name

id:
  v: Organization.contact.telecom
path:
  v: Organization.contact.telecom
short:
  v: Contact details (telephone, email, etc.) for a contact
definition:
  v: A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.
requirements:
  v: People have (primary) ways to contact them in some way such as phone, email.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Organization.contact.telecom
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: ContactPoint
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: PID-13, PID-14
mapping:
  identity:
    v: rim
  map:
    v: ./telecom

id:
  v: Organization.contact.address
path:
  v: Organization.contact.address
short:
  v: Visiting or postal addresses for the contact
definition:
  v: Visiting or postal addresses for the contact.
requirements:
  v: May need to keep track of a contact party's address for contacting, billing or reporting requirements.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Organization.contact.address
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Address
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: v2
  map:
    v: PID-11
mapping:
  identity:
    v: rim
  map:
    v: ./addr

id:
  v: Organization.endpoint
path:
  v: Organization.endpoint
short:
  v: Endpoint associated with this brand
definition:
  v: 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.
requirements:
  v: Organizations have multiple systems that provide various services and need to be able to define the technical connection details for how to connect to them, and for what purpose.
min:
  v: 0
max:
  v: *
base:
  path:
    v: Organization.endpoint
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Reference
  target profile:
    v: http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-endpoint
    link: http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-endpoint
  aggregation:
    v: bundled
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Organization.endpoint.id
path:
  v: Organization.endpoint.id
representation:
  v: xmlAttr
short:
  v: Unique id for inter-element referencing
definition:
  v: Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Element.id
  min:
    v: 0
  max:
    v: 1
type:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type
    value:
      v: string
  code:
    v: http://hl7.org/fhirpath/System.String
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Organization.endpoint.extension
path:
  v: Organization.endpoint.extension
slicing:
  discriminator:
    type:
      v: value
    path:
      v: url
  description:
    v: Extensions are always sliced by (at least) url
  rules:
    v: open
short:
  v: Additional content defined by implementations
definition:
  v: May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
comment:
  v: There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
alias:
  v: extensions
alias:
  v: user content
min:
  v: 0
max:
  v: *
base:
  path:
    v: Element.extension
  min:
    v: 0
  max:
    v: *
type:
  code:
    v: Extension
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
constraint:
  key:
    v: ext-1
  severity:
    v: error
  human:
    v: Must have either extensions or value[x], not both
  expression:
    v: extension.exists() != value.exists()
  xpath:
    v: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
  source:
    v: http://hl7.org/fhir/StructureDefinition/Extension
    link: http://hl7.org/fhir/StructureDefinition/Extension
is modifier:
  v: false
is summary:
  v: false
mapping:
  identity:
    v: rim
  map:
    v: n/a

id:
  v: Organization.endpoint.reference
path:
  v: Organization.endpoint.reference
short:
  v: Relative URL to an Endpoint within the User Access Brands Bundle
definition:
  v: Relative URL to an Endpoint within the User Access Brands Bundle
comment:
  v: Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.reference
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
condition:
  v: ref-1
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
must support:
  v: true
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Organization.endpoint.type
path:
  v: Organization.endpoint.type
short:
  v: Type the reference refers to (e.g. "Patient")
definition:
  v: The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).
comment:
  v: This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.type
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: uri
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
binding:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName
    value:
      v: FHIRResourceTypeExt
  strength:
    v: extensible
  description:
    v: Aa resource (or, for logical models, the URI of the logical model).
  value set:
    v: http://hl7.org/fhir/ValueSet/resource-types
    link: http://hl7.org/fhir/ValueSet/resource-types
mapping:
  identity:
    v: rim
  map:
    v: N/A

id:
  v: Organization.endpoint.identifier
path:
  v: Organization.endpoint.identifier
short:
  v: Logical reference, when literal reference is not known
definition:
  v: An identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.
comment:
  v: When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.identifier
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: Identifier
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: .identifier

id:
  v: Organization.endpoint.display
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable
  value:
    v: true
path:
  v: Organization.endpoint.display
short:
  v: Text alternative for the resource
definition:
  v: Plain text narrative that identifies the resource in addition to the resource reference.
comment:
  v: This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.
min:
  v: 0
max:
  v: 1
base:
  path:
    v: Reference.display
  min:
    v: 0
  max:
    v: 1
type:
  code:
    v: string
constraint:
  key:
    v: ele-1
  severity:
    v: error
  human:
    v: All FHIR elements must have a @value or children
  expression:
    v: hasValue() or (children().count() > id.count())
  xpath:
    v: @value|f:*|h:div
  source:
    v: http://hl7.org/fhir/StructureDefinition/Element
    link: http://hl7.org/fhir/StructureDefinition/Element
is modifier:
  v: false
is summary:
  v: true
mapping:
  identity:
    v: rim
  map:
    v: N/A

element:
  id:
    v: Organization
  path:
    v: Organization
  short:
    v: User Access Brand
  definition:
    v: A brand of a healthcare provider, such as a hospital, clinic, or practice
  constraint:
    key:
      v: uab-1
    severity:
      v: error
    human:
      v: Portal endpoints must also appear at Organization.endpoint
    expression:
      v: Organization.extension('http://hl7.org/fhir/StructureDefinition/organization-portal').extension('portalEndpoint').value.ofType(Reference).reference.subsetOf(%resource.endpoint.reference)
    source:
      v: http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brand
      link: http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-brand
element:
  id:
    v: Organization.extension
  path:
    v: Organization.extension
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: url
    ordered:
      v: false
    rules:
      v: open
element:
  id:
    v: Organization.extension:brand
  path:
    v: Organization.extension
  slice name:
    v: brand
  short:
    v: Brand Details
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/organization-brand
      link: http://hl7.org/fhir/StructureDefinition/organization-brand
  must support:
    v: true
element:
  id:
    v: Organization.extension:portal
  path:
    v: Organization.extension
  slice name:
    v: portal
  short:
    v: Portal Details
  min:
    v: 0
  max:
    v: *
  type:
    code:
      v: Extension
    profile:
      v: http://hl7.org/fhir/StructureDefinition/organization-portal
      link: http://hl7.org/fhir/StructureDefinition/organization-portal
  must support:
    v: true
element:
  id:
    v: Organization.identifier
  path:
    v: Organization.identifier
  short:
    v: Unique identifier for the brand
  definition:
    v: 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" }`
  must support:
    v: true
element:
  id:
    v: Organization.type
  path:
    v: Organization.type
  slicing:
    discriminator:
      type:
        v: value
      path:
        v: $this
    rules:
      v: open
  must support:
    v: true
element:
  id:
    v: Organization.type:pab
  path:
    v: Organization.type
  slice name:
    v: pab
  short:
    v: Categories of user access offered
  min:
    v: 0
  must support:
    v: true
  binding:
    strength:
      v: required
    value set:
      v: http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category
      link: http://hl7.org/fhir/smart-app-launch/ValueSet/user-access-category
element:
  id:
    v: Organization.name
  path:
    v: Organization.name
  short:
    v: Primary brand name to display on a card
  definition:
    v: The primary brand name to display on a card.
  min:
    v: 1
  must support:
    v: true
element:
  id:
    v: Organization.alias
  path:
    v: Organization.alias
  short:
    v: Aliases (e.g., former names like "Partners Healthcare") for filtering/search
  definition:
    v: Aliases (e.g., former names like "Partners Healthcare") for filtering/search
  must support:
    v: true
element:
  id:
    v: Organization.telecom
  path:
    v: Organization.telecom
  short:
    v: The primary public website for the Brand.
  definition:
    v: `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.
  min:
    v: 1
  max:
    v: 1
  must support:
    v: true
element:
  id:
    v: Organization.address
  path:
    v: Organization.address
  short:
    v: Locations (e.g., zip codes and/or street addresses) associated with the Brand.
  definition:
    v: 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
  must support:
    v: true
element:
  id:
    v: Organization.partOf
  path:
    v: Organization.partOf
  short:
    v: Affiliated "parent brand", if this Brand is part of a larger health system
  definition:
    v: 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).
  must support:
    v: true
element:
  id:
    v: Organization.endpoint
  path:
    v: Organization.endpoint
  short:
    v: Endpoint associated with this brand
  definition:
    v: 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.
  type:
    code:
      v: Reference
    target profile:
      v: http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-endpoint
      link: http://hl7.org/fhir/smart-app-launch/StructureDefinition/user-access-endpoint
    aggregation:
      v: bundled

v: true

id:
  v: Organization.endpoint.reference
path:
  v: Organization.endpoint.reference
short:
  v: Relative URL to an Endpoint within the User Access Brands Bundle
definition:
  v: Relative URL to an Endpoint within the User Access Brands Bundle
must support:
  v: true