SPL Mapping FHIR Implementation Guide
0.1.0 - Build CI United States of America flag

SPL Mapping FHIR Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions

Resource Profile: EstablishmentOrganization - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the EstablishmentOrganization resource profile.

Guidance on how to interpret the contents of this table can be found here

0. Organization
Invariantsspl-6.1.4.1: If country is not USA, then US agent is mandatory. (address.where(country = 'USA').count() = 0 implies contained.ofType(Organization).where(type.coding.where(code = 'USAgent').count() = 0).count() = 1)
spl-6.1.4.3: If country is USA, then US agent is not allowed. (address.where(country = 'USA').count() > 0 implies contained.ofType(Organization).where(type.coding.where(code = 'USAgent').count() = 0).count() = 0)
spl-6.1.5.3: If country is USA, then import business is not allowed. (address.where(country = 'USA').count() > 0 implies contained.ofType(Organization).where(type.coding.where(code = 'Importer').count() = 0).count() = 0)
spl-5.1.5.6: Each business operation code is mentioned only once. (contained.ofType(HealthcareService).type().isDistinct())
2. Organization.contained
Control1..?
SlicingThis element introduces a set of slices on Organization.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
  • profile @ $this
  • 4. Organization.contained:BusinessOperation
    Slice NameBusinessOperation
    Control1..*
    TypeHealthcareService(EstablishmentBusinessOperation)
    Must Supporttrue
    6. Organization.contained:USAgentAffiliation
    Slice NameUSAgentAffiliation
    Control0..1
    TypeOrganizationAffiliation(USAgentAffiliation)
    Must Supporttrue
    8. Organization.contained:USAgent
    Slice NameUSAgent
    Control0..1
    TypeOrganization(USAgentOrganization)
    Must Supporttrue
    10. Organization.contained:ImporterAffiliation
    Slice NameImporterAffiliation
    Control0..*
    TypeOrganizationAffiliation(ImporterAffiliation)
    Must Supporttrue
    12. Organization.contained:Importer
    Slice NameImporter
    Control0..*
    TypeOrganization(ImporterOrganization)
    Must Supporttrue
    14. Organization.identifier
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control1..?
    Must Supporttrue
    SlicingThis element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ system
    • 16. Organization.identifier.system
      Control1..?
      Must Supporttrue
      18. Organization.identifier.value
      Control1..?
      Must Supporttrue
      20. Organization.identifier:DUNSNumber
      Slice NameDUNSNumber
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control1..1
      Must Supporttrue
      Invariantsspl-2.1.5.2: DUNS number is 9 digits (system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9)
      22. Organization.identifier:DUNSNumber.system
      Pattern Valueurn:oid:1.3.6.1.4.1.519.1
      24. Organization.identifier:FEINumber
      Slice NameFEINumber
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..1
      Must Supporttrue
      Invariantsspl-6.1.3.7: FEI number is 7 or 10 digits (system = 'urn:oid:2.16.840.1.113883.4.82' implies (value.length() = 7 or value.length() = 10))
      26. Organization.identifier:FEINumber.system
      Pattern Valueurn:oid:2.16.840.1.113883.4.82
      28. Organization.type
      Control1..1
      Must Supporttrue
      Pattern Value{
        "coding" : [{
          "system" : "http://hl7.org/fhir/us/spl/CodeSystem/codesystem-organizationTypes",
          "code" : "Establishment"
        }]
      }
      30. Organization.name
      Control1..?
      Must Supporttrue
      32. Organization.address
      Control1..1
      TypeAddress(SPLAddress)
      Must Supporttrue
      34. Organization.contact
      Control1..1
      Must Supporttrue
      36. Organization.contact.name
      Control1..?
      Must Supporttrue
      38. Organization.contact.telecom
      Control2..?
      Must Supporttrue
      SlicingThis element introduces a set of slices on Organization.contact.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ system
      • 40. Organization.contact.telecom:Phone
        Slice NamePhone
        Control1..1
        TypeContactPoint(SPLContactPoint)
        Must Supporttrue
        42. Organization.contact.telecom:Phone.system
        Pattern Valuephone
        44. Organization.contact.telecom:Email
        Slice NameEmail
        Control1..1
        TypeContactPoint(SPLContactPoint)
        Must Supporttrue
        46. Organization.contact.telecom:Email.system
        Pattern Valueemail
        48. Organization.contact.address
        Control1..?
        TypeAddress(SPLAddress)
        Must Supporttrue

        Guidance on how to interpret the contents of this table can be found here

        0. Organization
        Definition

        A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

        ShortA grouping of people or organizations with a common purpose
        Control0..*
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
        dom-3: 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty())
        dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
        dom-6: A resource should have narrative for robust management (text.`div`.exists())
        org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
        spl-6.1.4.1: If country is not USA, then US agent is mandatory. (address.where(country = 'USA').count() = 0 implies contained.ofType(Organization).where(type.coding.where(code = 'USAgent').count() = 0).count() = 1)
        spl-6.1.4.3: If country is USA, then US agent is not allowed. (address.where(country = 'USA').count() > 0 implies contained.ofType(Organization).where(type.coding.where(code = 'USAgent').count() = 0).count() = 0)
        spl-6.1.5.3: If country is USA, then import business is not allowed. (address.where(country = 'USA').count() > 0 implies contained.ofType(Organization).where(type.coding.where(code = 'Importer').count() = 0).count() = 0)
        spl-5.1.5.6: Each business operation code is mentioned only once. (contained.ofType(HealthcareService).type().isDistinct())
        2. Organization.implicitRules
        Definition

        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.

        ShortA set of rules under which this content was created
        Comments

        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.

        Control0..1
        Typeuri
        Is Modifiertrue because 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
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supportfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        4. Organization.contained
        Definition

        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.

        ShortContained, inline Resources
        Comments

        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.

        Control10..*
        TypeResource
        Is Modifierfalse
        Must Supportfalse
        Summaryfalse
        Alternate Namesinline resources, anonymous resources, contained resources
        Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
        dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
        SlicingThis element introduces a set of slices on Organization.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
        • profile @ $this
        • 6. Organization.contained:BusinessOperation
          Slice NameBusinessOperation
          Definition

          The details of a healthcare service available at a location.


          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.

          ShortThe details of a healthcare service available at a locationContained, inline Resources
          Comments

          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.

          Control10..*
          TypeHealthcareServiceResource(EstablishmentBusinessOperation)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          8. Organization.contained:USAgentAffiliation
          Slice NameUSAgentAffiliation
          Definition

          Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.


          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.

          ShortDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationshipContained, inline Resources
          Comments

          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.

          Control0..1*
          TypeOrganizationAffiliationResource(USAgentAffiliation)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          10. Organization.contained:USAgent
          Slice NameUSAgent
          Definition

          A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.


          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.

          ShortA grouping of people or organizations with a common purposeContained, inline Resources
          Comments

          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.

          Control0..1*
          TypeOrganizationResource(USAgentOrganization)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          12. Organization.contained:ImporterAffiliation
          Slice NameImporterAffiliation
          Definition

          Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.


          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.

          ShortDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationshipContained, inline Resources
          Comments

          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.

          Control0..*
          TypeOrganizationAffiliationResource(ImporterAffiliation)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          14. Organization.contained:Importer
          Slice NameImporter
          Definition

          A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.


          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.

          ShortA grouping of people or organizations with a common purposeContained, inline Resources
          Comments

          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.

          Control0..*
          TypeOrganizationResource(ImporterOrganization)
          Is Modifierfalse
          Must Supporttrue
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
          16. Organization.modifierExtension
          Definition

          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).

          ShortExtensions that cannot be ignored
          Comments

          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.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
          Must Supportfalse
          Summaryfalse
          Requirements

          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.

          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
          18. Organization.identifier
          Definition

          Identifier for the organization that is used to identify the organization across multiple disparate systems.

          ShortIdentifies this organization across multiple systems
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control10..*
          This element is affected by the following invariants: org-1
          TypeIdentifier
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Requirements

          Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ system
          • 20. Organization.identifier.use
            Definition

            The purpose of this identifier.

            Shortusual | official | temp | secondary | old (If known)
            Comments

            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

            Control0..1
            BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.3.0
            (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            22. Organization.identifier.system
            Definition

            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

            ShortThe namespace for the identifier value
            Comments

            Identifier.system is always case sensitive.

            Control10..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

            Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            24. Organization.identifier.value
            Definition

            The portion of the identifier typically relevant to the user and which is unique within the context of the system.

            ShortThe value that is unique
            Comments

            If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

            Control10..1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Example<br/><b>General</b>:123456
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            26. Organization.identifier:DUNSNumber
            Slice NameDUNSNumber
            Definition

            Identifier for the organization that is used to identify the organization across multiple disparate systems.

            ShortIdentifies this organization across multiple systems
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control10..1*
            This element is affected by the following invariants: org-1
            TypeIdentifier
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            spl-2.1.5.2: DUNS number is 9 digits (system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9)
            28. Organization.identifier:DUNSNumber.use
            Definition

            The purpose of this identifier.

            Shortusual | official | temp | secondary | old (If known)
            Comments

            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

            Control0..1
            BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.3.0
            (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            30. Organization.identifier:DUNSNumber.system
            Definition

            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

            ShortThe namespace for the identifier value
            Comments

            Identifier.system is always case sensitive.

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

            Pattern Valueurn:oid:1.3.6.1.4.1.519.1
            Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            32. Organization.identifier:FEINumber
            Slice NameFEINumber
            Definition

            Identifier for the organization that is used to identify the organization across multiple disparate systems.

            ShortIdentifies this organization across multiple systems
            NoteThis is a business identifier, not a resource identifier (see discussion)
            Control0..1*
            This element is affected by the following invariants: org-1
            TypeIdentifier
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            spl-6.1.3.7: FEI number is 7 or 10 digits (system = 'urn:oid:2.16.840.1.113883.4.82' implies (value.length() = 7 or value.length() = 10))
            34. Organization.identifier:FEINumber.use
            Definition

            The purpose of this identifier.

            Shortusual | official | temp | secondary | old (If known)
            Comments

            Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

            Control0..1
            BindingThe codes SHALL be taken from IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.3.0
            (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
            Typecode
            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            36. Organization.identifier:FEINumber.system
            Definition

            Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

            ShortThe namespace for the identifier value
            Comments

            Identifier.system is always case sensitive.

            Control0..1
            Typeuri
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Summarytrue
            Requirements

            There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

            Pattern Valueurn:oid:2.16.840.1.113883.4.82
            Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            38. Organization.active
            Definition

            Whether the organization's record is still in active use.

            ShortWhether the organization's record is still in active use
            Comments

            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.

            Control0..1
            Typeboolean
            Is Modifiertrue because 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
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supportfalse
            Summarytrue
            Requirements

            Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

            Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            40. Organization.type
            Definition

            The kind(s) of organization that this is.

            ShortKind of organization
            Comments

            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.

            Control10..1*
            BindingFor example codes, see OrganizationTypehttp://hl7.org/fhir/ValueSet/organization-type
            (example to http://hl7.org/fhir/ValueSet/organization-type)

            Used to categorize the organization.

            TypeCodeableConcept
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            Need to be able to track the kind of organization that this is - different organization types have different uses.

            Pattern Value{
              "coding" : [{
                "system" : "http://hl7.org/fhir/us/spl/CodeSystem/codesystem-organizationTypes",
                "code" : "Establishment"
              }]
            }
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            42. Organization.name
            Definition

            A name associated with the organization.

            ShortName used for the organization
            Comments

            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.

            Control10..1
            This element is affected by the following invariants: org-1
            Typestring
            Is Modifierfalse
            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
            Must Supporttrue
            Summarytrue
            Requirements

            Need to use the name as the label of the organization.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            44. Organization.address
            Definition

            An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.


            An address for the organization.

            ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)An address for the organization
            Comments

            Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).


            Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

            Control10..1*
            This element is affected by the following invariants: ele-1, org-2
            TypeAddress(SPLAddress)
            Is Modifierfalse
            Must Supporttrue
            Requirements

            May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
            spl-2.1.6.4: If the country is USA, then the state and postal code exist (country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists()))
            spl-2.1.6.5: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers (country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$'))
            org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            46. Organization.contact
            Definition

            Contact for the organization for a certain purpose.

            ShortContact for the organization for a certain purpose
            Comments

            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.

            Control10..1*
            TypeBackboneElement
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

            Need to keep track of assigned contact points within bigger organization.

            Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
            48. Organization.contact.modifierExtension
            Definition

            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).

            ShortExtensions that cannot be ignored even if unrecognized
            Comments

            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.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
            Summarytrue
            Requirements

            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.

            Alternate Namesextensions, user content, modifiers
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
            50. Organization.contact.name
            Definition

            A name associated with the contact.

            ShortA name associated with the contact
            Control10..1
            TypeHumanName
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

            Need to be able to track the person by name.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            52. Organization.contact.telecom
            Definition

            A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

            ShortContact details (telephone, email, etc.) for a contact
            Control20..*
            TypeContactPoint
            Is Modifierfalse
            Must Supporttrue
            Summaryfalse
            Requirements

            People have (primary) ways to contact them in some way such as phone, email.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on Organization.contact.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ system
            • 54. Organization.contact.telecom:Phone
              Slice NamePhone
              Definition

              Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


              A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

              ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)Contact details (telephone, email, etc.) for a contact
              Control10..1*
              This element is affected by the following invariants: ele-1
              TypeContactPoint(SPLContactPoint)
              Is Modifierfalse
              Must Supporttrue
              Requirements

              People have (primary) ways to contact them in some way such as phone, email.

              Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
              ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
              spl-2.1.7.x: Telephone and fax numbers are formatted properly ((system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$'))
              spl-2.1.7.11: Emails are formatted properly (system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$'))
              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              56. Organization.contact.telecom:Phone.system
              Definition

              Telecommunications form for contact point - what communications system is required to make use of the contact.

              Shortphone | fax | email | pager | url | sms | other
              Control10..1
              This element is affected by the following invariants: cpt-2
              BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
              (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Pattern Valuephone
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              58. Organization.contact.telecom:Phone.value
              Definition

              The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

              ShortThe actual contact point details
              Comments

              Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

              Control10..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Requirements

              Need to support legacy numbers that are not in a tightly controlled format.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              60. Organization.contact.telecom:Phone.use
              Definition

              Identifies the purpose for the contact point.

              Shorthome | work | temp | old | mobile - purpose of this contact point
              Comments

              Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

              Control0..1
              BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
              (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              62. Organization.contact.telecom:Email
              Slice NameEmail
              Definition

              Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.


              A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

              ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)Contact details (telephone, email, etc.) for a contact
              Control10..1*
              This element is affected by the following invariants: ele-1
              TypeContactPoint(SPLContactPoint)
              Is Modifierfalse
              Must Supporttrue
              Requirements

              People have (primary) ways to contact them in some way such as phone, email.

              Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
              ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
              spl-2.1.7.x: Telephone and fax numbers are formatted properly ((system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$'))
              spl-2.1.7.11: Emails are formatted properly (system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$'))
              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              64. Organization.contact.telecom:Email.system
              Definition

              Telecommunications form for contact point - what communications system is required to make use of the contact.

              Shortphone | fax | email | pager | url | sms | other
              Control10..1
              This element is affected by the following invariants: cpt-2
              BindingThe codes SHALL be taken from ContactPointSystemhttp://hl7.org/fhir/ValueSet/contact-point-system|4.3.0
              (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Pattern Valueemail
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              66. Organization.contact.telecom:Email.value
              Definition

              The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

              ShortThe actual contact point details
              Comments

              Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

              Control10..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Requirements

              Need to support legacy numbers that are not in a tightly controlled format.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              68. Organization.contact.telecom:Email.use
              Definition

              Identifies the purpose for the contact point.

              Shorthome | work | temp | old | mobile - purpose of this contact point
              Comments

              Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

              Control0..1
              BindingThe codes SHALL be taken from ContactPointUsehttp://hl7.org/fhir/ValueSet/contact-point-use|4.3.0
              (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              70. Organization.contact.address
              Definition

              An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.


              Visiting or postal addresses for the contact.

              ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)Visiting or postal addresses for the contact
              Comments

              Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

              Control10..1
              This element is affected by the following invariants: ele-1
              TypeAddress(SPLAddress)
              Is Modifierfalse
              Must Supporttrue
              Requirements

              May need to keep track of a contact party's address for contacting, billing or reporting requirements.

              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
              spl-2.1.6.4: If the country is USA, then the state and postal code exist (country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists()))
              spl-2.1.6.5: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers (country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$'))
              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

              Guidance on how to interpret the contents of this table can be found here

              0. Organization
              Definition

              A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

              ShortA grouping of people or organizations with a common purpose
              Control0..*
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              dom-3: 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty())
              dom-4: 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: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
              dom-6: A resource should have narrative for robust management (text.`div`.exists())
              org-1: The organization SHALL at least have a name or an identifier, and possibly more than one ((identifier.count() + name.count()) > 0)
              spl-6.1.4.1: If country is not USA, then US agent is mandatory. (address.where(country = 'USA').count() = 0 implies contained.ofType(Organization).where(type.coding.where(code = 'USAgent').count() = 0).count() = 1)
              spl-6.1.4.3: If country is USA, then US agent is not allowed. (address.where(country = 'USA').count() > 0 implies contained.ofType(Organization).where(type.coding.where(code = 'USAgent').count() = 0).count() = 0)
              spl-6.1.5.3: If country is USA, then import business is not allowed. (address.where(country = 'USA').count() > 0 implies contained.ofType(Organization).where(type.coding.where(code = 'Importer').count() = 0).count() = 0)
              spl-5.1.5.6: Each business operation code is mentioned only once. (contained.ofType(HealthcareService).type().isDistinct())
              2. Organization.id
              Definition

              The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

              ShortLogical id of this artifact
              Comments

              The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

              Control0..1
              Typeid
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              4. Organization.meta
              Definition

              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.

              ShortMetadata about the resource
              Control0..1
              TypeMeta
              Is Modifierfalse
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. Organization.implicitRules
              Definition

              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.

              ShortA set of rules under which this content was created
              Comments

              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.

              Control0..1
              Typeuri
              Is Modifiertrue because 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
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              8. Organization.language
              Definition

              The base language in which the resource is written.

              ShortLanguage of the resource content
              Comments

              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).

              Control0..1
              BindingThe codes SHOULD be taken from CommonLanguages
              (preferred to http://hl7.org/fhir/ValueSet/languages)

              IETF language tag

              Additional BindingsPurpose
              AllLanguagesMax Binding
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supportfalse
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              10. Organization.text
              Definition

              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.

              ShortText summary of the resource, for human interpretation
              Comments

              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.

              Control0..1
              TypeNarrative
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Alternate Namesnarrative, html, xhtml, display
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              12. Organization.contained
              Definition

              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.

              ShortContained, inline Resources
              Comments

              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.

              Control1..*
              TypeResource
              Is Modifierfalse
              Must Supportfalse
              Summaryfalse
              Alternate Namesinline resources, anonymous resources, contained resources
              Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
              SlicingThis element introduces a set of slices on Organization.contained. The slices areUnordered and Closed, and can be differentiated using the following discriminators:
              • profile @ $this
              • 14. Organization.contained:BusinessOperation
                Slice NameBusinessOperation
                Definition

                The details of a healthcare service available at a location.

                ShortThe details of a healthcare service available at a location
                Comments

                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.

                Control1..*
                TypeHealthcareService(EstablishmentBusinessOperation)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                16. Organization.contained:USAgentAffiliation
                Slice NameUSAgentAffiliation
                Definition

                Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

                ShortDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
                Comments

                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.

                Control0..1
                TypeOrganizationAffiliation(USAgentAffiliation)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                18. Organization.contained:USAgent
                Slice NameUSAgent
                Definition

                A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

                ShortA grouping of people or organizations with a common purpose
                Comments

                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.

                Control0..1
                TypeOrganization(USAgentOrganization)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                20. Organization.contained:ImporterAffiliation
                Slice NameImporterAffiliation
                Definition

                Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship.

                ShortDefines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship
                Comments

                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.

                Control0..*
                TypeOrganizationAffiliation(ImporterAffiliation)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                22. Organization.contained:Importer
                Slice NameImporter
                Definition

                A formally or informally recognized grouping of people or organizations formed for the purpose of achieving some form of collective action. Includes companies, institutions, corporations, departments, community groups, healthcare practice groups, payer/insurer, etc.

                ShortA grouping of people or organizations with a common purpose
                Comments

                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.

                Control0..*
                TypeOrganization(ImporterOrganization)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsdom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems (($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic))
                24. Organization.extension
                Definition

                May be used to represent additional information that is not part of the basic definition of the resource. 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.

                ShortAdditional content defined by implementations
                Comments

                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.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Must Supportfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                26. Organization.modifierExtension
                Definition

                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).

                ShortExtensions that cannot be ignored
                Comments

                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.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                Must Supportfalse
                Summaryfalse
                Requirements

                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.

                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                28. Organization.identifier
                Definition

                Identifier for the organization that is used to identify the organization across multiple disparate systems.

                ShortIdentifies this organization across multiple systems
                NoteThis is a business identifier, not a resource identifier (see discussion)
                Control1..*
                This element is affected by the following invariants: org-1
                TypeIdentifier
                Is Modifierfalse
                Must Supporttrue
                Summarytrue
                Requirements

                Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on Organization.identifier. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ system
                • 30. Organization.identifier.id
                  Definition

                  Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                  ShortUnique id for inter-element referencing
                  Control0..1
                  Typeid
                  Is Modifierfalse
                  XML FormatIn the XML format, this property is represented as an attribute.
                  Summaryfalse
                  32. Organization.identifier.extension
                  Definition

                  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.

                  ShortAdditional content defined by implementations
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesextensions, user content
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 34. Organization.identifier.use
                    Definition

                    The purpose of this identifier.

                    Shortusual | official | temp | secondary | old (If known)
                    Comments

                    Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                    Control0..1
                    BindingThe codes SHALL be taken from IdentifierUse
                    (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
                    Typecode
                    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Summarytrue
                    Requirements

                    Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    36. Organization.identifier.type
                    Definition

                    A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                    ShortDescription of identifier
                    Comments

                    This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                    Control0..1
                    BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                    (extensible to http://hl7.org/fhir/ValueSet/identifier-type)
                    TypeCodeableConcept
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows users to make use of identifiers when the identifier system is not known.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    38. Organization.identifier.system
                    Definition

                    Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                    ShortThe namespace for the identifier value
                    Comments

                    Identifier.system is always case sensitive.

                    Control1..1
                    Typeuri
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                    Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    40. Organization.identifier.value
                    Definition

                    The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                    ShortThe value that is unique
                    Comments

                    If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                    Control1..1
                    Typestring
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supporttrue
                    Summarytrue
                    Example<br/><b>General</b>:123456
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    42. Organization.identifier.period
                    Definition

                    Time period during which identifier is/was valid for use.

                    ShortTime period when id is/was valid for use
                    Control0..1
                    TypePeriod
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    44. Organization.identifier.assigner
                    Definition

                    Organization that issued/manages the identifier.

                    ShortOrganization that issued id (may be just text)
                    Comments

                    The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                    Control0..1
                    TypeReference(Organization)
                    Is Modifierfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    46. Organization.identifier:DUNSNumber
                    Slice NameDUNSNumber
                    Definition

                    Identifier for the organization that is used to identify the organization across multiple disparate systems.

                    ShortIdentifies this organization across multiple systems
                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control1..1
                    This element is affected by the following invariants: org-1
                    TypeIdentifier
                    Is Modifierfalse
                    Must Supporttrue
                    Summarytrue
                    Requirements

                    Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    spl-2.1.5.2: DUNS number is 9 digits (system = 'urn:oid:1.3.6.1.4.1.519.1' implies value.length() = 9)
                    48. Organization.identifier:DUNSNumber.id
                    Definition

                    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                    ShortUnique id for inter-element referencing
                    Control0..1
                    Typeid
                    Is Modifierfalse
                    XML FormatIn the XML format, this property is represented as an attribute.
                    Summaryfalse
                    50. Organization.identifier:DUNSNumber.extension
                    Definition

                    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.

                    ShortAdditional content defined by implementations
                    Comments

                    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.

                    Control0..*
                    TypeExtension
                    Is Modifierfalse
                    Summaryfalse
                    Alternate Namesextensions, user content
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 52. Organization.identifier:DUNSNumber.use
                      Definition

                      The purpose of this identifier.

                      Shortusual | official | temp | secondary | old (If known)
                      Comments

                      Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                      Control0..1
                      BindingThe codes SHALL be taken from IdentifierUse
                      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      54. Organization.identifier:DUNSNumber.type
                      Definition

                      A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                      ShortDescription of identifier
                      Comments

                      This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                      Control0..1
                      BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                      (extensible to http://hl7.org/fhir/ValueSet/identifier-type)
                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Requirements

                      Allows users to make use of identifiers when the identifier system is not known.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      56. Organization.identifier:DUNSNumber.system
                      Definition

                      Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                      ShortThe namespace for the identifier value
                      Comments

                      Identifier.system is always case sensitive.

                      Control0..1
                      Typeuri
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

                      There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                      Pattern Valueurn:oid:1.3.6.1.4.1.519.1
                      Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      58. Organization.identifier:DUNSNumber.value
                      Definition

                      The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                      ShortThe value that is unique
                      Comments

                      If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Example<br/><b>General</b>:123456
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      60. Organization.identifier:DUNSNumber.period
                      Definition

                      Time period during which identifier is/was valid for use.

                      ShortTime period when id is/was valid for use
                      Control0..1
                      TypePeriod
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      62. Organization.identifier:DUNSNumber.assigner
                      Definition

                      Organization that issued/manages the identifier.

                      ShortOrganization that issued id (may be just text)
                      Comments

                      The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                      Control0..1
                      TypeReference(Organization)
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      64. Organization.identifier:FEINumber
                      Slice NameFEINumber
                      Definition

                      Identifier for the organization that is used to identify the organization across multiple disparate systems.

                      ShortIdentifies this organization across multiple systems
                      NoteThis is a business identifier, not a resource identifier (see discussion)
                      Control0..1
                      This element is affected by the following invariants: org-1
                      TypeIdentifier
                      Is Modifierfalse
                      Must Supporttrue
                      Summarytrue
                      Requirements

                      Organizations are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the organization.

                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      spl-6.1.3.7: FEI number is 7 or 10 digits (system = 'urn:oid:2.16.840.1.113883.4.82' implies (value.length() = 7 or value.length() = 10))
                      66. Organization.identifier:FEINumber.id
                      Definition

                      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                      ShortUnique id for inter-element referencing
                      Control0..1
                      Typeid
                      Is Modifierfalse
                      XML FormatIn the XML format, this property is represented as an attribute.
                      Summaryfalse
                      68. Organization.identifier:FEINumber.extension
                      Definition

                      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.

                      ShortAdditional content defined by implementations
                      Comments

                      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.

                      Control0..*
                      TypeExtension
                      Is Modifierfalse
                      Summaryfalse
                      Alternate Namesextensions, user content
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      SlicingThis element introduces a set of slices on Organization.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 70. Organization.identifier:FEINumber.use
                        Definition

                        The purpose of this identifier.

                        Shortusual | official | temp | secondary | old (If known)
                        Comments

                        Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

                        Control0..1
                        BindingThe codes SHALL be taken from IdentifierUse
                        (required to http://hl7.org/fhir/ValueSet/identifier-use|4.3.0)
                        Typecode
                        Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        72. Organization.identifier:FEINumber.type
                        Definition

                        A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

                        ShortDescription of identifier
                        Comments

                        This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

                        Control0..1
                        BindingUnless not suitable, these codes SHALL be taken from Identifier Type Codes
                        (extensible to http://hl7.org/fhir/ValueSet/identifier-type)
                        TypeCodeableConcept
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        Allows users to make use of identifiers when the identifier system is not known.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        74. Organization.identifier:FEINumber.system
                        Definition

                        Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

                        ShortThe namespace for the identifier value
                        Comments

                        Identifier.system is always case sensitive.

                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Requirements

                        There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

                        Pattern Valueurn:oid:2.16.840.1.113883.4.82
                        Example<br/><b>General</b>:http://www.acme.com/identifiers/patient
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        76. Organization.identifier:FEINumber.value
                        Definition

                        The portion of the identifier typically relevant to the user and which is unique within the context of the system.

                        ShortThe value that is unique
                        Comments

                        If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Example<br/><b>General</b>:123456
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        78. Organization.identifier:FEINumber.period
                        Definition

                        Time period during which identifier is/was valid for use.

                        ShortTime period when id is/was valid for use
                        Control0..1
                        TypePeriod
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        80. Organization.identifier:FEINumber.assigner
                        Definition

                        Organization that issued/manages the identifier.

                        ShortOrganization that issued id (may be just text)
                        Comments

                        The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

                        Control0..1
                        TypeReference(Organization)
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        82. Organization.active
                        Definition

                        Whether the organization's record is still in active use.

                        ShortWhether the organization's record is still in active use
                        Comments

                        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.

                        Control0..1
                        Typeboolean
                        Is Modifiertrue because 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
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summarytrue
                        Requirements

                        Need a flag to indicate a record is no longer to be used and should generally be hidden for the user in the UI.

                        Meaning if MissingThis resource is generally assumed to be active if no value is provided for the active element
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        84. Organization.type
                        Definition

                        The kind(s) of organization that this is.

                        ShortKind of organization
                        Comments

                        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.

                        Control1..1
                        BindingFor example codes, see OrganizationType
                        (example to http://hl7.org/fhir/ValueSet/organization-type)

                        Used to categorize the organization.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to be able to track the kind of organization that this is - different organization types have different uses.

                        Pattern Value{
                          "coding" : [{
                            "system" : "http://hl7.org/fhir/us/spl/CodeSystem/codesystem-organizationTypes",
                            "code" : "Establishment"
                          }]
                        }
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        86. Organization.name
                        Definition

                        A name associated with the organization.

                        ShortName used for the organization
                        Comments

                        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.

                        Control1..1
                        This element is affected by the following invariants: org-1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supporttrue
                        Summarytrue
                        Requirements

                        Need to use the name as the label of the organization.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        88. Organization.alias
                        Definition

                        A list of alternate names that the organization is known as, or was known as in the past.

                        ShortA list of alternate names that the organization is known as, or was known as in the past
                        Comments

                        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.

                        Control0..*
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Must Supportfalse
                        Summaryfalse
                        Requirements

                        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.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        90. Organization.telecom
                        Definition

                        A contact detail for the organization.

                        ShortA contact detail for the organization
                        Comments

                        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.

                        Control0..*
                        This element is affected by the following invariants: org-3
                        TypeContactPoint
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Requirements

                        Human contact for the organization.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        org-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                        92. Organization.address
                        Definition

                        An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

                        ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                        Comments

                        Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                        Control1..1
                        This element is affected by the following invariants: ele-1
                        TypeAddress(SPLAddress)
                        Is Modifierfalse
                        Must Supporttrue
                        Requirements

                        May need to keep track of the organization's addresses for contacting, billing or reporting requirements.

                        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                        spl-2.1.6.4: If the country is USA, then the state and postal code exist (country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists()))
                        spl-2.1.6.5: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers (country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$'))
                        org-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
                        94. Organization.partOf
                        Definition

                        The organization of which this organization forms a part.

                        ShortThe organization of which this organization forms a part
                        Control0..1
                        TypeReference(Organization)
                        Is Modifierfalse
                        Must Supportfalse
                        Summarytrue
                        Requirements

                        Need to be able to track the hierarchy of organizations within an organization.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        96. Organization.contact
                        Definition

                        Contact for the organization for a certain purpose.

                        ShortContact for the organization for a certain purpose
                        Comments

                        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.

                        Control1..1
                        TypeBackboneElement
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        Need to keep track of assigned contact points within bigger organization.

                        Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                        98. Organization.contact.id
                        Definition

                        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        100. Organization.contact.extension
                        Definition

                        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.

                        ShortAdditional content defined by implementations
                        Comments

                        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.

                        Control0..*
                        TypeExtension
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namesextensions, user content
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        102. Organization.contact.modifierExtension
                        Definition

                        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).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        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.

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                        Summarytrue
                        Requirements

                        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.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        104. Organization.contact.purpose
                        Definition

                        Indicates a purpose for which the contact can be reached.

                        ShortThe type of contact
                        Control0..1
                        BindingUnless not suitable, these codes SHALL be taken from ContactEntityType
                        (extensible to http://hl7.org/fhir/ValueSet/contactentity-type)

                        The purpose for which you would contact a contact party.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Must Supportfalse
                        Summaryfalse
                        Requirements

                        Need to distinguish between multiple contact persons.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        106. Organization.contact.name
                        Definition

                        A name associated with the contact.

                        ShortA name associated with the contact
                        Control1..1
                        TypeHumanName
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        Need to be able to track the person by name.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        108. Organization.contact.telecom
                        Definition

                        A contact detail (e.g. a telephone number or an email address) by which the party may be contacted.

                        ShortContact details (telephone, email, etc.) for a contact
                        Control2..*
                        TypeContactPoint
                        Is Modifierfalse
                        Must Supporttrue
                        Summaryfalse
                        Requirements

                        People have (primary) ways to contact them in some way such as phone, email.

                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        SlicingThis element introduces a set of slices on Organization.contact.telecom. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ system
                        • 110. Organization.contact.telecom:Phone
                          Slice NamePhone
                          Definition

                          Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                          ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)
                          Control1..1
                          This element is affected by the following invariants: ele-1
                          TypeContactPoint(SPLContactPoint)
                          Is Modifierfalse
                          Must Supporttrue
                          Requirements

                          People have (primary) ways to contact them in some way such as phone, email.

                          Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                          ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                          spl-2.1.7.x: Telephone and fax numbers are formatted properly ((system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$'))
                          spl-2.1.7.11: Emails are formatted properly (system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$'))
                          112. Organization.contact.telecom:Phone.id
                          Definition

                          Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                          ShortUnique id for inter-element referencing
                          Control0..1
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          114. Organization.contact.telecom:Phone.extension
                          Definition

                          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.

                          ShortAdditional content defined by implementations
                          Comments

                          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.

                          Control0..*
                          TypeExtension
                          Is Modifierfalse
                          Summaryfalse
                          Alternate Namesextensions, user content
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                          SlicingThis element introduces a set of slices on Organization.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                          • value @ url
                          • 116. Organization.contact.telecom:Phone.system
                            Definition

                            Telecommunications form for contact point - what communications system is required to make use of the contact.

                            Shortphone | fax | email | pager | url | sms | other
                            Control1..1
                            This element is affected by the following invariants: cpt-2
                            BindingThe codes SHALL be taken from ContactPointSystem
                            (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Pattern Valuephone
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            118. Organization.contact.telecom:Phone.value
                            Definition

                            The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                            ShortThe actual contact point details
                            Comments

                            Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                            Control1..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supporttrue
                            Summarytrue
                            Requirements

                            Need to support legacy numbers that are not in a tightly controlled format.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            120. Organization.contact.telecom:Phone.use
                            Definition

                            Identifies the purpose for the contact point.

                            Shorthome | work | temp | old | mobile - purpose of this contact point
                            Comments

                            Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                            Control0..1
                            BindingThe codes SHALL be taken from ContactPointUse
                            (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                            Typecode
                            Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Requirements

                            Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            122. Organization.contact.telecom:Phone.rank
                            Definition

                            Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                            ShortSpecify preferred order of use (1 = highest)
                            Comments

                            Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                            Control0..1
                            TypepositiveInt
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            124. Organization.contact.telecom:Phone.period
                            Definition

                            Time period when the contact point was/is in use.

                            ShortTime period when the contact point was/is in use
                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            126. Organization.contact.telecom:Email
                            Slice NameEmail
                            Definition

                            Details for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc.

                            ShortDetails of a Technology mediated contact point (phone, fax, email, etc.)
                            Control1..1
                            This element is affected by the following invariants: ele-1
                            TypeContactPoint(SPLContactPoint)
                            Is Modifierfalse
                            Must Supporttrue
                            Requirements

                            People have (primary) ways to contact them in some way such as phone, email.

                            Invariantscpt-2: A system is required if a value is provided. (value.empty() or system.exists())
                            ele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                            spl-2.1.7.x: Telephone and fax numbers are formatted properly ((system = 'phone' or system = 'fax') implies value.matches('^\\+[0-9]{1,3}-[0-9]{1,3}-[0-9]{3,4}-[0-9]{4}(;ext=[0-9]+)?$'))
                            spl-2.1.7.11: Emails are formatted properly (system = 'email' implies value.matches('^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(\\.[a-zA-Z0-9-]+)*$'))
                            128. Organization.contact.telecom:Email.id
                            Definition

                            Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                            ShortUnique id for inter-element referencing
                            Control0..1
                            Typeid
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            130. Organization.contact.telecom:Email.extension
                            Definition

                            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.

                            ShortAdditional content defined by implementations
                            Comments

                            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.

                            Control0..*
                            TypeExtension
                            Is Modifierfalse
                            Summaryfalse
                            Alternate Namesextensions, user content
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                            SlicingThis element introduces a set of slices on Organization.contact.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 132. Organization.contact.telecom:Email.system
                              Definition

                              Telecommunications form for contact point - what communications system is required to make use of the contact.

                              Shortphone | fax | email | pager | url | sms | other
                              Control1..1
                              This element is affected by the following invariants: cpt-2
                              BindingThe codes SHALL be taken from ContactPointSystem
                              (required to http://hl7.org/fhir/ValueSet/contact-point-system|4.3.0)
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summarytrue
                              Pattern Valueemail
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              134. Organization.contact.telecom:Email.value
                              Definition

                              The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).

                              ShortThe actual contact point details
                              Comments

                              Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.

                              Control1..1
                              Typestring
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supporttrue
                              Summarytrue
                              Requirements

                              Need to support legacy numbers that are not in a tightly controlled format.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              136. Organization.contact.telecom:Email.use
                              Definition

                              Identifies the purpose for the contact point.

                              Shorthome | work | temp | old | mobile - purpose of this contact point
                              Comments

                              Applications can assume that a contact is current unless it explicitly says that it is temporary or old.

                              Control0..1
                              BindingThe codes SHALL be taken from ContactPointUse
                              (required to http://hl7.org/fhir/ValueSet/contact-point-use|4.3.0)
                              Typecode
                              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Requirements

                              Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.

                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              138. Organization.contact.telecom:Email.rank
                              Definition

                              Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.

                              ShortSpecify preferred order of use (1 = highest)
                              Comments

                              Note that rank does not necessarily follow the order in which the contacts are represented in the instance.

                              Control0..1
                              TypepositiveInt
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              140. Organization.contact.telecom:Email.period
                              Definition

                              Time period when the contact point was/is in use.

                              ShortTime period when the contact point was/is in use
                              Control0..1
                              TypePeriod
                              Is Modifierfalse
                              Summarytrue
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              142. Organization.contact.address
                              Definition

                              An address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world.

                              ShortAn address expressed using postal conventions (as opposed to GPS or other location definition formats)
                              Comments

                              Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource).

                              Control1..1
                              This element is affected by the following invariants: ele-1
                              TypeAddress(SPLAddress)
                              Is Modifierfalse
                              Must Supporttrue
                              Requirements

                              May need to keep track of a contact party's address for contacting, billing or reporting requirements.

                              Invariantsele-1: All FHIR elements must have a @value or children unless an empty Parameters resource (hasValue() or (children().count() > id.count()) or $this is Parameters)
                              spl-2.1.6.4: If the country is USA, then the state and postal code exist (country = 'USA' implies (state.exists() and state.length() = 2 and postalCode.exists()))
                              spl-2.1.6.5: If the country is USA, then the postal code is 5 digits with an optional dash and 4 numbers (country = 'USA' implies postalCode.matches('^[0-9]{5}(-[0-9]{4})?$'))
                              144. Organization.endpoint
                              Definition

                              Technical endpoints providing access to services operated for the organization.

                              ShortTechnical endpoints providing access to services operated for the organization
                              Control0..*
                              TypeReference(Endpoint)
                              Is Modifierfalse
                              Must Supportfalse
                              Summaryfalse
                              Requirements

                              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.

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