Extensions for Using Data Elements from FHIR R4B in FHIR STU3
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR STU3 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4B_Organization_R3 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-Organization resource profile.

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

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, etc.

ShortA grouping of people or organizations with a common purpose
Control0..*
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
org-1: The organization SHALL at least have a name or an id, and possibly more than one ((identifier.count() + name.count()) > 0)
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
org-1: The organization SHALL at least have a name or an id, and possibly more than one ((identifier.count() + name.count()) > 0)
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.

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.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

Control0..1
Typeuri
Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
4. 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. Usually modifier elements provide negation or qualification. In order 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.

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 No Modifier Reason provideed in previous versions of FHIR
Alternate Namesextensions, user content
6. Organization.active
Definition

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

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

Default is true.

This active flag is not intended to be used to mark an organizations 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 No Modifier Reason provideed in previous versions of FHIR
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
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.

Default Valuetrue

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

0. Organization
2. Organization.meta
4. Organization.meta.extension
Control0..*
SlicingThis element introduces a set of slices on Organization.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 6. Organization.meta.extension:meta
    Slice Namemeta
    Definition

    R4B: Organization.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

    ShortR4B: meta additional types
    Comments

    Element Organization.meta is mapped to FHIR STU3 element Organization.meta as SourceIsBroaderThanTarget. The mappings for Organization.meta do not cover the following types: Meta. The mappings for Organization.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

    Control0..1
    TypeExtension(R4B: meta additional types) (Extension Type: Meta)
    8. Organization.text
    10. Organization.text.extension
    Control0..*
    SlicingThis element introduces a set of slices on Organization.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 12. Organization.text.extension:text
      Slice Nametext
      Definition

      R4B: Organization.text additional types (Narrative) additional types from child elements (div, status)

      ShortR4B: text additional types
      Comments

      Element Organization.text is mapped to FHIR STU3 element Organization.text as SourceIsBroaderThanTarget. The mappings for Organization.text do not cover the following types: Narrative. The mappings for Organization.text do not cover the following types based on type expansion: div, status. 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
      TypeExtension(R4B: text additional types) (Complex Extension)
      14. Organization.identifier
      NoteThis is a business identifier, not a resource identifier (see discussion)
      16. Organization.identifier.extension
      Control0..*
      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
      • 18. Organization.identifier.extension:identifier
        Slice Nameidentifier
        Definition

        R4B: Organization.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

        ShortR4B: identifier additional types
        Comments

        Element Organization.identifier is mapped to FHIR STU3 element Organization.identifier as SourceIsBroaderThanTarget. The mappings for Organization.identifier do not cover the following types: Identifier. The mappings for Organization.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

        Control0..*
        TypeExtension(R4B: identifier additional types) (Extension Type: Identifier)
        20. Organization.telecom
        22. Organization.telecom.extension
        Control0..*
        SlicingThis element introduces a set of slices on Organization.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 24. Organization.telecom.extension:telecom
          Slice Nametelecom
          Definition

          R4B: Organization.telecom additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)

          ShortR4B: telecom additional types
          Comments

          Element Organization.telecom is mapped to FHIR STU3 element Organization.telecom as SourceIsBroaderThanTarget. The mappings for Organization.telecom do not cover the following types: ContactPoint. The mappings for Organization.telecom do not cover the following types based on type expansion: period, rank, system, use, value. 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..*
          TypeExtension(R4B: telecom additional types) (Extension Type: ContactPoint)
          26. Organization.address
          28. Organization.address.extension
          Control0..*
          SlicingThis element introduces a set of slices on Organization.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 30. Organization.address.extension:address
            Slice Nameaddress
            Definition

            R4B: Organization.address additional types (Address) additional types from child elements (city, country, district, line, period, postalCode, state, text, type, use)

            ShortR4B: address additional types
            Comments

            Element Organization.address is mapped to FHIR STU3 element Organization.address as SourceIsBroaderThanTarget. The mappings for Organization.address do not cover the following types: Address. The mappings for Organization.address do not cover the following types based on type expansion: city, country, district, line, period, postalCode, state, text, type, use. Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

            Control0..*
            TypeExtension(R4B: address additional types) (Extension Type: Address)
            32. Organization.partOf
            34. Organization.partOf.extension
            Control0..*
            SlicingThis element introduces a set of slices on Organization.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 36. Organization.partOf.extension:partOf
              Slice NamepartOf
              Definition

              R4B: Organization.partOf additional types from child elements (display, identifier, reference, type)

              ShortR4B: partOf additional types
              Comments

              Element Organization.partOf is mapped to FHIR STU3 element Organization.partOf as SourceIsBroaderThanTarget. The mappings for Organization.partOf do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4B element Organization.partOf with unmapped reference targets: Organization.

              Control0..1
              TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
              38. Organization.contact
              40. Organization.contact.name
              42. Organization.contact.name.extension
              Control0..*
              SlicingThis element introduces a set of slices on Organization.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 44. Organization.contact.name.extension:name
                Slice Namename
                Definition

                R4B: Organization.contact.name additional types (HumanName) additional types from child elements (family, given, period, prefix, suffix, text, use)

                ShortR4B: name additional types
                Comments

                Element Organization.contact.name is mapped to FHIR STU3 element Organization.contact.name as SourceIsBroaderThanTarget. The mappings for Organization.contact.name do not cover the following types: HumanName. The mappings for Organization.contact.name do not cover the following types based on type expansion: family, given, period, prefix, suffix, text, use.

                Control0..1
                TypeExtension(R4B: name additional types) (Extension Type: HumanName)
                46. Organization.contact.telecom
                48. Organization.contact.telecom.extension
                Control0..*
                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
                • 50. Organization.contact.telecom.extension:telecom
                  Slice Nametelecom
                  Definition

                  R4B: Organization.contact.telecom additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)

                  ShortR4B: telecom additional types
                  Comments

                  Element Organization.contact.telecom is mapped to FHIR STU3 element Organization.contact.telecom as SourceIsBroaderThanTarget. The mappings for Organization.contact.telecom do not cover the following types: ContactPoint. The mappings for Organization.contact.telecom do not cover the following types based on type expansion: period, rank, system, use, value.

                  Control0..*
                  TypeExtension(R4B: telecom additional types) (Extension Type: ContactPoint)
                  52. Organization.contact.address
                  54. Organization.contact.address.extension
                  Control0..*
                  SlicingThis element introduces a set of slices on Organization.contact.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 56. Organization.contact.address.extension:address
                    Slice Nameaddress
                    Definition

                    R4B: Organization.contact.address additional types (Address) additional types from child elements (city, country, district, line, period, postalCode, state, text, type, use)

                    ShortR4B: address additional types
                    Comments

                    Element Organization.contact.address is mapped to FHIR STU3 element Organization.contact.address as SourceIsBroaderThanTarget. The mappings for Organization.contact.address do not cover the following types: Address. The mappings for Organization.contact.address do not cover the following types based on type expansion: city, country, district, line, period, postalCode, state, text, type, use.

                    Control0..1
                    TypeExtension(R4B: address additional types) (Extension Type: Address)
                    58. Organization.endpoint
                    60. Organization.endpoint.extension
                    Control0..*
                    SlicingThis element introduces a set of slices on Organization.endpoint.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                    • value @ url
                    • 62. Organization.endpoint.extension:endpoint
                      Slice Nameendpoint
                      Definition

                      R4B: Organization.endpoint additional types from child elements (display, identifier, reference, type)

                      ShortR4B: endpoint additional types
                      Comments

                      Element Organization.endpoint is mapped to FHIR STU3 element Organization.endpoint as SourceIsBroaderThanTarget. The mappings for Organization.endpoint do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4B element Organization.endpoint with unmapped reference targets: Endpoint.

                      Control0..*
                      TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)

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

                      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, etc.

                      ShortA grouping of people or organizations with a common purpose
                      Control0..*
                      Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
                      dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.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-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty())
                      org-1: The organization SHALL at least have a name or an id, and possibly more than one ((identifier.count() + name.count()) > 0)
                      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
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      4. Organization.meta
                      Definition

                      The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

                      ShortMetadata about the resource
                      Control0..1
                      TypeMeta
                      Summarytrue
                      6. Organization.meta.id
                      Definition

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

                      Shortxml:id (or equivalent in JSON)
                      Control0..1
                      Typestring
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      XML FormatIn the XML format, this property is represented as an attribute.
                      8. Organization.meta.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control0..*
                      TypeExtension
                      SlicingThis element introduces a set of slices on Organization.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                      • value @ url
                      • 10. Organization.meta.extension:meta
                        Slice Namemeta
                        Definition

                        R4B: Organization.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)

                        ShortR4B: meta additional types
                        Comments

                        Element Organization.meta is mapped to FHIR STU3 element Organization.meta as SourceIsBroaderThanTarget. The mappings for Organization.meta do not cover the following types: Meta. The mappings for Organization.meta do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.

                        Control0..1
                        TypeExtension(R4B: meta additional types) (Extension Type: Meta)
                        12. Organization.meta.versionId
                        Definition

                        The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

                        ShortVersion specific identifier
                        Comments

                        The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

                        Control0..1
                        Typeid
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        14. Organization.meta.lastUpdated
                        Definition

                        When the resource last changed - e.g. when the version changed.

                        ShortWhen the resource version last changed
                        Comments

                        This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

                        Control0..1
                        Typeinstant
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        16. Organization.meta.profile
                        Definition

                        A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

                        ShortProfiles this resource claims to conform to
                        Comments

                        It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

                        Control0..*
                        Typeuri
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        18. Organization.meta.security
                        Definition

                        Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

                        ShortSecurity Labels applied to this resource
                        Comments

                        The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

                        Control0..*
                        BindingUnless not suitable, these codes SHALL be taken from All Security Labels
                        (extensible to http://hl7.org/fhir/ValueSet/security-labels|3.0.2)

                        Security Labels from the Healthcare Privacy and Security Classification System.

                        TypeCoding
                        Summarytrue
                        20. Organization.meta.tag
                        Definition

                        Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

                        ShortTags applied to this resource
                        Comments

                        The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

                        Control0..*
                        BindingFor example codes, see Common Tags
                        (example to http://hl7.org/fhir/ValueSet/common-tags|3.0.2)

                        Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

                        TypeCoding
                        Summarytrue
                        22. 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.

                        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.

                        This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

                        Control0..1
                        Typeuri
                        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        24. 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
                        BindingUnless not suitable, these codes SHALL be taken from Common Languages
                        (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)

                        A human language.

                        Additional BindingsPurpose
                        All LanguagesMax Binding
                        Typecode
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        26. Organization.text
                        Definition

                        A human-readable narrative that contains a summary of the resource, and may 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 in formation is added later.

                        Control0..1
                        This element is affected by the following invariants: dom-1
                        TypeNarrative
                        Alternate Namesnarrative, html, xhtml, display
                        28. Organization.text.id
                        Definition

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

                        Shortxml:id (or equivalent in JSON)
                        Control0..1
                        Typestring
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        XML FormatIn the XML format, this property is represented as an attribute.
                        30. Organization.text.extension
                        Definition

                        An Extension

                        ShortExtension
                        Control0..*
                        TypeExtension
                        SlicingThis element introduces a set of slices on Organization.text.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                        • value @ url
                        • 32. Organization.text.extension:text
                          Slice Nametext
                          Definition

                          R4B: Organization.text additional types (Narrative) additional types from child elements (div, status)

                          ShortR4B: text additional types
                          Comments

                          Element Organization.text is mapped to FHIR STU3 element Organization.text as SourceIsBroaderThanTarget. The mappings for Organization.text do not cover the following types: Narrative. The mappings for Organization.text do not cover the following types based on type expansion: div, status. 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
                          TypeExtension(R4B: text additional types) (Complex Extension)
                          34. Organization.text.status
                          Definition

                          The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.

                          Shortgenerated | extensions | additional | empty
                          Control1..1
                          BindingThe codes SHALL be taken from NarrativeStatus
                          (required to http://hl7.org/fhir/ValueSet/narrative-status|3.0.2)

                          The status of a resource narrative

                          Typecode
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          36. Organization.text.div
                          Definition

                          The actual narrative content, a stripped down version of XHTML.

                          ShortLimited xhtml content
                          Comments

                          The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                          Control1..1
                          Typexhtml
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Invariantstxt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes (htmlchecks())
                          txt-2: The narrative SHALL have some non-whitespace content (htmlchecks())
                          38. 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.

                          Control0..*
                          TypeResource
                          Alternate Namesinline resources, anonymous resources, contained resources
                          40. Organization.extension
                          Definition

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

                          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
                          Alternate Namesextensions, user content
                          42. 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. Usually modifier elements provide negation or qualification. In order 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.

                          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 No Modifier Reason provideed in previous versions of FHIR
                          Alternate Namesextensions, user content
                          44. 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)
                          Control0..*
                          This element is affected by the following invariants: org-1
                          TypeIdentifier
                          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.

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

                          Shortxml:id (or equivalent in JSON)
                          Control0..1
                          Typestring
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          XML FormatIn the XML format, this property is represented as an attribute.
                          48. Organization.identifier.extension
                          Definition

                          An Extension

                          ShortExtension
                          Control0..*
                          TypeExtension
                          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
                          • 50. Organization.identifier.extension:identifier
                            Slice Nameidentifier
                            Definition

                            R4B: Organization.identifier additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)

                            ShortR4B: identifier additional types
                            Comments

                            Element Organization.identifier is mapped to FHIR STU3 element Organization.identifier as SourceIsBroaderThanTarget. The mappings for Organization.identifier do not cover the following types: Identifier. The mappings for Organization.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value.

                            Control0..*
                            TypeExtension(R4B: identifier additional types) (Extension Type: Identifier)
                            52. Organization.identifier.use
                            Definition

                            The purpose of this identifier.

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

                            This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. 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|3.0.2)

                            Identifies the purpose for this identifier, if known .

                            Typecode
                            Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                            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.

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

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

                            TypeCodeableConcept
                            Summarytrue
                            Requirements

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

                            56. 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
                            Control0..1
                            Typeuri
                            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.

                            ExampleGeneral: http://www.acme.com/identifiers/patient
                            58. 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.

                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Summarytrue
                            ExampleGeneral: 123456
                            60. 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
                            Summarytrue
                            62. 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)
                            Summarytrue
                            64. Organization.active
                            Definition

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

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

                            Default is true.

                            This active flag is not intended to be used to mark an organizations 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 No Modifier Reason provideed in previous versions of FHIR
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            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.

                            Default Valuetrue
                            66. 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.

                            Control0..*
                            BindingFor example codes, see OrganizationType
                            (example to http://hl7.org/fhir/ValueSet/organization-type|3.0.2)

                            Used to categorize the organization

                            TypeCodeableConcept
                            Summarytrue
                            Requirements

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

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

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

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

                            70. 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
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            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.

                            72. 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
                            Requirements

                            Human contact for the organization.

                            Invariantsorg-3: The telecom of an organization can never be of use 'home' (where(use = 'home').empty())
                            74. Organization.telecom.id
                            Definition

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

                            Shortxml:id (or equivalent in JSON)
                            Control0..1
                            Typestring
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            XML FormatIn the XML format, this property is represented as an attribute.
                            76. Organization.telecom.extension
                            Definition

                            An Extension

                            ShortExtension
                            Control0..*
                            TypeExtension
                            SlicingThis element introduces a set of slices on Organization.telecom.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 78. Organization.telecom.extension:telecom
                              Slice Nametelecom
                              Definition

                              R4B: Organization.telecom additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)

                              ShortR4B: telecom additional types
                              Comments

                              Element Organization.telecom is mapped to FHIR STU3 element Organization.telecom as SourceIsBroaderThanTarget. The mappings for Organization.telecom do not cover the following types: ContactPoint. The mappings for Organization.telecom do not cover the following types based on type expansion: period, rank, system, use, value. 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..*
                              TypeExtension(R4B: telecom additional types) (Extension Type: ContactPoint)
                              80. Organization.telecom.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
                              Control0..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|3.0.2)

                              Telecommunications form for contact point

                              Typecode
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              82. Organization.telecom.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.

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

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

                              84. Organization.telecom.use
                              Definition

                              Identifies the purpose for the contact point.

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

                              This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. 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|3.0.2)

                              Use of contact point

                              Typecode
                              Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                              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.

                              86. Organization.telecom.rank
                              Definition

                              Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher 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
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Summarytrue
                              88. Organization.telecom.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
                              Summarytrue
                              90. Organization.address
                              Definition

                              An address for the organization.

                              ShortAn address for the organization
                              Comments

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

                              Control0..*
                              This element is affected by the following invariants: org-2
                              TypeAddress
                              Requirements

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

                              Invariantsorg-2: An address of an organization can never be of use 'home' (where(use = 'home').empty())
                              92. Organization.address.id
                              Definition

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

                              Shortxml:id (or equivalent in JSON)
                              Control0..1
                              Typestring
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              XML FormatIn the XML format, this property is represented as an attribute.
                              94. Organization.address.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control0..*
                              TypeExtension
                              SlicingThis element introduces a set of slices on Organization.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 96. Organization.address.extension:address
                                Slice Nameaddress
                                Definition

                                R4B: Organization.address additional types (Address) additional types from child elements (city, country, district, line, period, postalCode, state, text, type, use)

                                ShortR4B: address additional types
                                Comments

                                Element Organization.address is mapped to FHIR STU3 element Organization.address as SourceIsBroaderThanTarget. The mappings for Organization.address do not cover the following types: Address. The mappings for Organization.address do not cover the following types based on type expansion: city, country, district, line, period, postalCode, state, text, type, use. Organization may have multiple addresses with different uses or applicable periods. The use code 'home' is not to be used.

                                Control0..*
                                TypeExtension(R4B: address additional types) (Extension Type: Address)
                                98. Organization.address.use
                                Definition

                                The purpose of this address.

                                Shorthome | work | temp | old - purpose of this address
                                Comments

                                This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                Control0..1
                                BindingThe codes SHALL be taken from AddressUse
                                (required to http://hl7.org/fhir/ValueSet/address-use|3.0.2)

                                The use of an address

                                Typecode
                                Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                Allows an appropriate address to be chosen from a list of many.

                                ExampleGeneral: home
                                100. Organization.address.type
                                Definition

                                Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                Shortpostal | physical | both
                                Control0..1
                                BindingThe codes SHALL be taken from AddressType
                                (required to http://hl7.org/fhir/ValueSet/address-type|3.0.2)

                                The type of an address (physical / postal)

                                Typecode
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                ExampleGeneral: both
                                102. Organization.address.text
                                Definition

                                A full text representation of the address.

                                ShortText representation of the address
                                Comments

                                Can provide both a text representation and parts.

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

                                A renderable, unencoded form.

                                ExampleGeneral: 137 Nowhere Street, Erewhon 9132
                                104. Organization.address.line
                                Definition

                                This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                ShortStreet name, number, direction & P.O. Box etc.
                                Control0..*
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Requirements

                                home | work | temp | old - purpose of this address.

                                ExampleGeneral: 137 Nowhere Street
                                106. Organization.address.city
                                Definition

                                The name of the city, town, village or other community or delivery center.

                                ShortName of city, town etc.
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesMunicpality
                                ExampleGeneral: Erewhon
                                108. Organization.address.district
                                Definition

                                The name of the administrative area (county).

                                ShortDistrict name (aka county)
                                Comments

                                District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesCounty
                                ExampleGeneral: Madison
                                110. Organization.address.state
                                Definition

                                Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).

                                ShortSub-unit of country (abbreviations ok)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesProvince, Territory
                                112. Organization.address.postalCode
                                Definition

                                A postal code designating a region defined by the postal service.

                                ShortPostal code for area
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                Alternate NamesZip
                                ExampleGeneral: 9132
                                114. Organization.address.country
                                Definition

                                Country - a nation as commonly understood or generally accepted.

                                ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                Comments

                                ISO 3166 3 letter codes can be used in place of a full country name.

                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Summarytrue
                                116. Organization.address.period
                                Definition

                                Time period when address was/is in use.

                                ShortTime period when address was/is in use
                                Control0..1
                                TypePeriod
                                Summarytrue
                                Requirements

                                Allows addresses to be placed in historical context.

                                ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
                                118. 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)
                                Summarytrue
                                Requirements

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

                                120. Organization.partOf.id
                                Definition

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

                                Shortxml:id (or equivalent in JSON)
                                Control0..1
                                Typestring
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                XML FormatIn the XML format, this property is represented as an attribute.
                                122. Organization.partOf.extension
                                Definition

                                An Extension

                                ShortExtension
                                Control0..*
                                TypeExtension
                                SlicingThis element introduces a set of slices on Organization.partOf.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                • value @ url
                                • 124. Organization.partOf.extension:partOf
                                  Slice NamepartOf
                                  Definition

                                  R4B: Organization.partOf additional types from child elements (display, identifier, reference, type)

                                  ShortR4B: partOf additional types
                                  Comments

                                  Element Organization.partOf is mapped to FHIR STU3 element Organization.partOf as SourceIsBroaderThanTarget. The mappings for Organization.partOf do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4B element Organization.partOf with unmapped reference targets: Organization.

                                  Control0..1
                                  TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                  126. Organization.partOf.reference
                                  Definition

                                  A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                  ShortLiteral reference, Relative, internal or absolute URL
                                  Comments

                                  Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                  Control0..1
                                  This element is affected by the following invariants: ref-1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  128. Organization.partOf.identifier
                                  Definition

                                  An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                  ShortLogical reference, when literal reference is not known
                                  Comments

                                  When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                  When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                  Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                  NoteThis is a business identifier, not a resource identifier (see discussion)
                                  Control0..1
                                  TypeIdentifier
                                  Summarytrue
                                  130. Organization.partOf.display
                                  Definition

                                  Plain text narrative that identifies the resource in addition to the resource reference.

                                  ShortText alternative for the resource
                                  Comments

                                  This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  Summarytrue
                                  132. 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.

                                  Control0..*
                                  TypeBackboneElement
                                  Requirements

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

                                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))
                                  134. 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.

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  136. Organization.contact.extension
                                  Definition

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

                                  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
                                  Alternate Namesextensions, user content
                                  138. 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 that contains it. Usually modifier elements provide negation or qualification. In order 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.

                                  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 No Modifier Reason provideed in previous versions of FHIR
                                  Summarytrue
                                  Alternate Namesextensions, user content, modifiers
                                  140. 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|3.0.2)

                                  The purpose for which you would contact a contact party

                                  TypeCodeableConcept
                                  Requirements

                                  Need to distinguish between multiple contact persons.

                                  142. Organization.contact.name
                                  Definition

                                  A name associated with the contact.

                                  ShortA name associated with the contact
                                  Control0..1
                                  TypeHumanName
                                  Requirements

                                  Need to be able to track the person by name.

                                  144. Organization.contact.name.id
                                  Definition

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

                                  Shortxml:id (or equivalent in JSON)
                                  Control0..1
                                  Typestring
                                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                  XML FormatIn the XML format, this property is represented as an attribute.
                                  146. Organization.contact.name.extension
                                  Definition

                                  An Extension

                                  ShortExtension
                                  Control0..*
                                  TypeExtension
                                  SlicingThis element introduces a set of slices on Organization.contact.name.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                  • value @ url
                                  • 148. Organization.contact.name.extension:name
                                    Slice Namename
                                    Definition

                                    R4B: Organization.contact.name additional types (HumanName) additional types from child elements (family, given, period, prefix, suffix, text, use)

                                    ShortR4B: name additional types
                                    Comments

                                    Element Organization.contact.name is mapped to FHIR STU3 element Organization.contact.name as SourceIsBroaderThanTarget. The mappings for Organization.contact.name do not cover the following types: HumanName. The mappings for Organization.contact.name do not cover the following types based on type expansion: family, given, period, prefix, suffix, text, use.

                                    Control0..1
                                    TypeExtension(R4B: name additional types) (Extension Type: HumanName)
                                    150. Organization.contact.name.use
                                    Definition

                                    Identifies the purpose for this name.

                                    Shortusual | official | temp | nickname | anonymous | old | maiden
                                    Comments

                                    This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.

                                    Control0..1
                                    BindingThe codes SHALL be taken from NameUse
                                    (required to http://hl7.org/fhir/ValueSet/name-use|3.0.2)

                                    The use of a human name

                                    Typecode
                                    Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Requirements

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

                                    152. Organization.contact.name.text
                                    Definition

                                    A full text representation of the name.

                                    ShortText representation of the full name
                                    Comments

                                    Can provide both a text representation and structured parts.

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

                                    A renderable, unencoded form.

                                    154. Organization.contact.name.family
                                    Definition

                                    The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.

                                    ShortFamily name (often called 'Surname')
                                    Comments

                                    Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).

                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Alternate Namessurname
                                    156. Organization.contact.name.given
                                    Definition

                                    Given name.

                                    ShortGiven names (not always 'first'). Includes middle names
                                    Comments

                                    If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.

                                    Control0..*
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    Alternate Namesfirst name, middle name
                                    158. Organization.contact.name.prefix
                                    Definition

                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.

                                    ShortParts that come before the name
                                    Control0..*
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    160. Organization.contact.name.suffix
                                    Definition

                                    Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.

                                    ShortParts that come after the name
                                    Control0..*
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    Summarytrue
                                    162. Organization.contact.name.period
                                    Definition

                                    Indicates the period of time when this name was valid for the named person.

                                    ShortTime period when name was/is in use
                                    Control0..1
                                    TypePeriod
                                    Summarytrue
                                    Requirements

                                    Allows names to be placed in historical context.

                                    164. 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
                                    Control0..*
                                    TypeContactPoint
                                    Requirements

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

                                    166. Organization.contact.telecom.id
                                    Definition

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

                                    Shortxml:id (or equivalent in JSON)
                                    Control0..1
                                    Typestring
                                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                    XML FormatIn the XML format, this property is represented as an attribute.
                                    168. Organization.contact.telecom.extension
                                    Definition

                                    An Extension

                                    ShortExtension
                                    Control0..*
                                    TypeExtension
                                    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
                                    • 170. Organization.contact.telecom.extension:telecom
                                      Slice Nametelecom
                                      Definition

                                      R4B: Organization.contact.telecom additional types (ContactPoint) additional types from child elements (period, rank, system, use, value)

                                      ShortR4B: telecom additional types
                                      Comments

                                      Element Organization.contact.telecom is mapped to FHIR STU3 element Organization.contact.telecom as SourceIsBroaderThanTarget. The mappings for Organization.contact.telecom do not cover the following types: ContactPoint. The mappings for Organization.contact.telecom do not cover the following types based on type expansion: period, rank, system, use, value.

                                      Control0..*
                                      TypeExtension(R4B: telecom additional types) (Extension Type: ContactPoint)
                                      172. Organization.contact.telecom.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
                                      Control0..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|3.0.2)

                                      Telecommunications form for contact point

                                      Typecode
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      174. Organization.contact.telecom.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.

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

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

                                      176. Organization.contact.telecom.use
                                      Definition

                                      Identifies the purpose for the contact point.

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

                                      This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. 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|3.0.2)

                                      Use of contact point

                                      Typecode
                                      Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                      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.

                                      178. Organization.contact.telecom.rank
                                      Definition

                                      Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher 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
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      Summarytrue
                                      180. Organization.contact.telecom.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
                                      Summarytrue
                                      182. Organization.contact.address
                                      Definition

                                      Visiting or postal addresses for the contact.

                                      ShortVisiting or postal addresses for the contact
                                      Control0..1
                                      TypeAddress
                                      Requirements

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

                                      184. Organization.contact.address.id
                                      Definition

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

                                      Shortxml:id (or equivalent in JSON)
                                      Control0..1
                                      Typestring
                                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                      XML FormatIn the XML format, this property is represented as an attribute.
                                      186. Organization.contact.address.extension
                                      Definition

                                      An Extension

                                      ShortExtension
                                      Control0..*
                                      TypeExtension
                                      SlicingThis element introduces a set of slices on Organization.contact.address.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                      • value @ url
                                      • 188. Organization.contact.address.extension:address
                                        Slice Nameaddress
                                        Definition

                                        R4B: Organization.contact.address additional types (Address) additional types from child elements (city, country, district, line, period, postalCode, state, text, type, use)

                                        ShortR4B: address additional types
                                        Comments

                                        Element Organization.contact.address is mapped to FHIR STU3 element Organization.contact.address as SourceIsBroaderThanTarget. The mappings for Organization.contact.address do not cover the following types: Address. The mappings for Organization.contact.address do not cover the following types based on type expansion: city, country, district, line, period, postalCode, state, text, type, use.

                                        Control0..1
                                        TypeExtension(R4B: address additional types) (Extension Type: Address)
                                        190. Organization.contact.address.use
                                        Definition

                                        The purpose of this address.

                                        Shorthome | work | temp | old - purpose of this address
                                        Comments

                                        This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.

                                        Control0..1
                                        BindingThe codes SHALL be taken from AddressUse
                                        (required to http://hl7.org/fhir/ValueSet/address-use|3.0.2)

                                        The use of an address

                                        Typecode
                                        Is Modifiertrue because No Modifier Reason provideed in previous versions of FHIR
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        Allows an appropriate address to be chosen from a list of many.

                                        ExampleGeneral: home
                                        192. Organization.contact.address.type
                                        Definition

                                        Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.

                                        Shortpostal | physical | both
                                        Control0..1
                                        BindingThe codes SHALL be taken from AddressType
                                        (required to http://hl7.org/fhir/ValueSet/address-type|3.0.2)

                                        The type of an address (physical / postal)

                                        Typecode
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        ExampleGeneral: both
                                        194. Organization.contact.address.text
                                        Definition

                                        A full text representation of the address.

                                        ShortText representation of the address
                                        Comments

                                        Can provide both a text representation and parts.

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

                                        A renderable, unencoded form.

                                        ExampleGeneral: 137 Nowhere Street, Erewhon 9132
                                        196. Organization.contact.address.line
                                        Definition

                                        This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.

                                        ShortStreet name, number, direction & P.O. Box etc.
                                        Control0..*
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Requirements

                                        home | work | temp | old - purpose of this address.

                                        ExampleGeneral: 137 Nowhere Street
                                        198. Organization.contact.address.city
                                        Definition

                                        The name of the city, town, village or other community or delivery center.

                                        ShortName of city, town etc.
                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Alternate NamesMunicpality
                                        ExampleGeneral: Erewhon
                                        200. Organization.contact.address.district
                                        Definition

                                        The name of the administrative area (county).

                                        ShortDistrict name (aka county)
                                        Comments

                                        District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.

                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Alternate NamesCounty
                                        ExampleGeneral: Madison
                                        202. Organization.contact.address.state
                                        Definition

                                        Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).

                                        ShortSub-unit of country (abbreviations ok)
                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Alternate NamesProvince, Territory
                                        204. Organization.contact.address.postalCode
                                        Definition

                                        A postal code designating a region defined by the postal service.

                                        ShortPostal code for area
                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        Alternate NamesZip
                                        ExampleGeneral: 9132
                                        206. Organization.contact.address.country
                                        Definition

                                        Country - a nation as commonly understood or generally accepted.

                                        ShortCountry (e.g. can be ISO 3166 2 or 3 letter code)
                                        Comments

                                        ISO 3166 3 letter codes can be used in place of a full country name.

                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        Summarytrue
                                        208. Organization.contact.address.period
                                        Definition

                                        Time period when address was/is in use.

                                        ShortTime period when address was/is in use
                                        Control0..1
                                        TypePeriod
                                        Summarytrue
                                        Requirements

                                        Allows addresses to be placed in historical context.

                                        ExampleGeneral: { "start" : "2010-03-23", "end" : "2010-07-01" }
                                        210. 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)
                                        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.

                                        212. Organization.endpoint.id
                                        Definition

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

                                        Shortxml:id (or equivalent in JSON)
                                        Control0..1
                                        Typestring
                                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                        XML FormatIn the XML format, this property is represented as an attribute.
                                        214. Organization.endpoint.extension
                                        Definition

                                        An Extension

                                        ShortExtension
                                        Control0..*
                                        TypeExtension
                                        SlicingThis element introduces a set of slices on Organization.endpoint.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                                        • value @ url
                                        • 216. Organization.endpoint.extension:endpoint
                                          Slice Nameendpoint
                                          Definition

                                          R4B: Organization.endpoint additional types from child elements (display, identifier, reference, type)

                                          ShortR4B: endpoint additional types
                                          Comments

                                          Element Organization.endpoint is mapped to FHIR STU3 element Organization.endpoint as SourceIsBroaderThanTarget. The mappings for Organization.endpoint do not cover the following types based on type expansion: display, identifier, reference, type. The standard extension alternate-reference has been mapped as the representation of FHIR R4B element Organization.endpoint with unmapped reference targets: Endpoint.

                                          Control0..*
                                          TypeExtension(http://hl7.org/fhir/StructureDefinition/alternate-reference)
                                          218. Organization.endpoint.reference
                                          Definition

                                          A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.

                                          ShortLiteral reference, Relative, internal or absolute URL
                                          Comments

                                          Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.

                                          Control0..1
                                          This element is affected by the following invariants: ref-1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue
                                          220. Organization.endpoint.identifier
                                          Definition

                                          An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.

                                          ShortLogical reference, when literal reference is not known
                                          Comments

                                          When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy.

                                          When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference

                                          Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.

                                          NoteThis is a business identifier, not a resource identifier (see discussion)
                                          Control0..1
                                          TypeIdentifier
                                          Summarytrue
                                          222. Organization.endpoint.display
                                          Definition

                                          Plain text narrative that identifies the resource in addition to the resource reference.

                                          ShortText alternative for the resource
                                          Comments

                                          This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.

                                          Control0..1
                                          Typestring
                                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                          Summarytrue