Extensions for Using Data Elements from FHIR DSTU2 in FHIR R4
0.1.0 - STU International flag

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

Resource Profile: Profile_R2_ConceptMap_R4 - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 0

Definitions for the profile-ConceptMap resource profile.

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

0. ConceptMap
Definition

A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

ShortA map from one set of concepts to one or more other concepts
Control0..*
Is Modifierfalse
Summaryfalse
Invariantscmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
cmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ConceptMap.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ConceptMap.extension
Definition

An Extension


May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

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

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

    DSTU2: ConceptMap.source[x] additional types (Reference(http://hl7.org/fhir/StructureDefinition/ValueSet), Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition))

    ShortDSTU2: Identifies the source of the concepts which are being mapped additional types
    Comments

    Element ConceptMap.source[x] is mapped to FHIR R4 element ConceptMap.source[x] as SourceIsBroaderThanTarget. The mappings for ConceptMap.source[x] do not cover the following types: Reference. The target context ConceptMap.source[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element ConceptMap. Should be a version specific reference. URIs SHOULD be absolute.

    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: Identifies the source of the concepts which are being mapped additional types) (Extension Type: Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4, StructureDefinition))
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    8. ConceptMap.extension:target
    Slice Nametarget
    Definition

    DSTU2: ConceptMap.target[x] additional types (Reference(http://hl7.org/fhir/StructureDefinition/ValueSet), Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition))

    ShortDSTU2: Provides context to the mappings additional types
    Comments

    Element ConceptMap.target[x] is mapped to FHIR R4 element ConceptMap.target[x] as SourceIsBroaderThanTarget. The mappings for ConceptMap.target[x] do not cover the following types: Reference. The target context ConceptMap.target[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element ConceptMap. Should be a version specific reference. URIs SHOULD be absolute.

    Control1..1
    This element is affected by the following invariants: ele-1
    TypeExtension(DSTU2: Provides context to the mappings additional types) (Extension Type: Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4, StructureDefinition))
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    10. ConceptMap.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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

    The status of this concept map. Enables tracking the life-cycle of the content.

    Shortdraft | active | retired | unknown
    Comments

    Allows filtering of concept maps that are appropriate for use versus not.

    Control1..1
    BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|4.0.1
    (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

    The lifecycle status of an artifact.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

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

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

      DSTU2: ConceptMap.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

      ShortDSTU2: meta additional types
      Comments

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

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

        DSTU2: ConceptMap.text additional types (Narrative) additional types from child elements (div, status)

        ShortDSTU2: text additional types
        Comments

        Element ConceptMap.text is mapped to FHIR R4 element ConceptMap.text as SourceIsBroaderThanTarget. The mappings for ConceptMap.text do not cover the following types: Narrative. The mappings for ConceptMap.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.

        Control0..1
        TypeExtension(DSTU2: text additional types) (Complex Extension)
        14. ConceptMap.extension
        Control2..*
        SlicingThis element introduces a set of slices on ConceptMap.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 16. ConceptMap.extension:source
          Slice Namesource
          Definition

          DSTU2: ConceptMap.source[x] additional types (Reference(http://hl7.org/fhir/StructureDefinition/ValueSet), Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition))

          ShortDSTU2: Identifies the source of the concepts which are being mapped additional types
          Comments

          Element ConceptMap.source[x] is mapped to FHIR R4 element ConceptMap.source[x] as SourceIsBroaderThanTarget. The mappings for ConceptMap.source[x] do not cover the following types: Reference. The target context ConceptMap.source[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element ConceptMap. Should be a version specific reference. URIs SHOULD be absolute.

          Control1..1
          TypeExtension(DSTU2: Identifies the source of the concepts which are being mapped additional types) (Extension Type: Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4, StructureDefinition))
          18. ConceptMap.extension:target
          Slice Nametarget
          Definition

          DSTU2: ConceptMap.target[x] additional types (Reference(http://hl7.org/fhir/StructureDefinition/ValueSet), Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition))

          ShortDSTU2: Provides context to the mappings additional types
          Comments

          Element ConceptMap.target[x] is mapped to FHIR R4 element ConceptMap.target[x] as SourceIsBroaderThanTarget. The mappings for ConceptMap.target[x] do not cover the following types: Reference. The target context ConceptMap.target[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element ConceptMap. Should be a version specific reference. URIs SHOULD be absolute.

          Control1..1
          TypeExtension(DSTU2: Provides context to the mappings additional types) (Extension Type: Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4, StructureDefinition))
          20. ConceptMap.identifier
          NoteThis is a business identifier, not a resource identifier (see discussion)
          22. ConceptMap.identifier.extension
          Control0..*
          SlicingThis element introduces a set of slices on ConceptMap.identifier.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 24. ConceptMap.identifier.extension:identifier
            Slice Nameidentifier
            Definition

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

            ShortDSTU2: identifier additional types
            Comments

            Element ConceptMap.identifier is mapped to FHIR R4 element ConceptMap.identifier as SourceIsBroaderThanTarget. The mappings for ConceptMap.identifier do not cover the following types: Identifier. The mappings for ConceptMap.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. Typically, this is used for values that can go in a v3 II data type.

            Control0..1
            TypeExtension(DSTU2: identifier additional types) (Extension Type: Identifier)
            26. ConceptMap.contact
            28. ConceptMap.contact.extension
            Control0..*
            SlicingThis element introduces a set of slices on ConceptMap.contact.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 30. ConceptMap.contact.extension:name
              Slice Namename
              Definition

              DSTU2: ConceptMap.contact.name (new:string)

              ShortDSTU2: Name of a individual to contact (new)
              Comments

              Element ConceptMap.contact.name has a context of ConceptMap.contact based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.contact.name has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If there is no named individual, the telecom is for the organization as a whole.

              Control0..1
              TypeExtension(DSTU2: Name of a individual to contact (new)) (Extension Type: string)
              32. ConceptMap.contact.extension:telecom
              Slice Nametelecom
              Definition

              DSTU2: ConceptMap.contact.telecom (new:ContactPoint)

              ShortDSTU2: Contact details for individual or publisher (new)
              Comments

              Element ConceptMap.contact.telecom has a context of ConceptMap.contact based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.contact.telecom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

              Control0..*
              TypeExtension(DSTU2: Contact details for individual or publisher (new)) (Extension Type: ContactPoint)

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

              0. ConceptMap
              Definition

              A statement of relationships from one set of concepts to one or more other concepts - either concepts in code systems, or data element/data element concepts, or classes in class models.

              ShortA map from one set of concepts to one or more other concepts
              Control0..*
              Is Modifierfalse
              Summaryfalse
              Invariantscmd-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.matches('[A-Z]([A-Za-z0-9_]){0,254}'))
              dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
              dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty())
              dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
              dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
              dom-6: A resource should have narrative for robust management (text.`div`.exists())
              2. ConceptMap.id
              Definition

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

              ShortLogical id of this artifact
              Comments

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

              Control0..1
              Typeid
              Is Modifierfalse
              Summarytrue
              4. ConceptMap.meta
              Definition

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

              ShortMetadata about the resource
              Control0..1
              TypeMeta
              Is Modifierfalse
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              6. ConceptMap.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.

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

              An Extension

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

                DSTU2: ConceptMap.meta additional types (Meta) additional types from child elements (lastUpdated, profile, security, tag, versionId)

                ShortDSTU2: meta additional types
                Comments

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

                Control0..1
                TypeExtension(DSTU2: meta additional types) (Extension Type: Meta)
                Is Modifierfalse
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                12. ConceptMap.meta.versionId
                Definition

                The version specific identifier, as it appears in the version portion of the URL. This value 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
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                14. ConceptMap.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. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

                Control0..1
                Typeinstant
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                16. ConceptMap.meta.source
                Definition

                A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

                ShortIdentifies where the resource comes from
                Comments

                In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

                This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

                Control0..1
                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                18. ConceptMap.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..*
                Typecanonical(StructureDefinition)
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                20. ConceptMap.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|4.0.1)

                Security Labels from the Healthcare Privacy and Security Classification System.

                TypeCoding
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                22. ConceptMap.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 CommonTags
                (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

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

                TypeCoding
                Is Modifierfalse
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                24. ConceptMap.implicitRules
                Definition

                A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

                ShortA set of rules under which this content was created
                Comments

                Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

                Control0..1
                Typeuri
                Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                26. ConceptMap.language
                Definition

                The base language in which the resource is written.

                ShortLanguage of the resource content
                Comments

                Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

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

                A human language.

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

                A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

                ShortText summary of the resource, for human interpretation
                Comments

                Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

                Control0..1
                TypeNarrative
                Is Modifierfalse
                Summaryfalse
                Alternate Namesnarrative, html, xhtml, display
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                30. ConceptMap.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.

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

                An Extension

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

                  DSTU2: ConceptMap.text additional types (Narrative) additional types from child elements (div, status)

                  ShortDSTU2: text additional types
                  Comments

                  Element ConceptMap.text is mapped to FHIR R4 element ConceptMap.text as SourceIsBroaderThanTarget. The mappings for ConceptMap.text do not cover the following types: Narrative. The mappings for ConceptMap.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.

                  Control0..1
                  TypeExtension(DSTU2: text additional types) (Complex Extension)
                  Is Modifierfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  36. ConceptMap.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|4.0.1)

                  The status of a resource narrative.

                  Typecode
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  38. ConceptMap.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 SHALL NOT contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.

                  Control1..1
                  Typexhtml
                  Is Modifierfalse
                  Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  txt-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())
                  40. ConceptMap.contained
                  Definition

                  These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

                  ShortContained, inline Resources
                  Comments

                  This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

                  Control0..*
                  TypeResource
                  Is Modifierfalse
                  Summaryfalse
                  Alternate Namesinline resources, anonymous resources, contained resources
                  42. ConceptMap.extension
                  Definition

                  An Extension

                  ShortExtension
                  Control2..*
                  TypeExtension
                  Is Modifierfalse
                  Summaryfalse
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                  SlicingThis element introduces a set of slices on ConceptMap.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                  • value @ url
                  • 44. ConceptMap.extension:source
                    Slice Namesource
                    Definition

                    DSTU2: ConceptMap.source[x] additional types (Reference(http://hl7.org/fhir/StructureDefinition/ValueSet), Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition))

                    ShortDSTU2: Identifies the source of the concepts which are being mapped additional types
                    Comments

                    Element ConceptMap.source[x] is mapped to FHIR R4 element ConceptMap.source[x] as SourceIsBroaderThanTarget. The mappings for ConceptMap.source[x] do not cover the following types: Reference. The target context ConceptMap.source[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element ConceptMap. Should be a version specific reference. URIs SHOULD be absolute.

                    Control1..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(DSTU2: Identifies the source of the concepts which are being mapped additional types) (Extension Type: Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4, StructureDefinition))
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    46. ConceptMap.extension:target
                    Slice Nametarget
                    Definition

                    DSTU2: ConceptMap.target[x] additional types (Reference(http://hl7.org/fhir/StructureDefinition/ValueSet), Reference(http://hl7.org/fhir/StructureDefinition/StructureDefinition))

                    ShortDSTU2: Provides context to the mappings additional types
                    Comments

                    Element ConceptMap.target[x] is mapped to FHIR R4 element ConceptMap.target[x] as SourceIsBroaderThanTarget. The mappings for ConceptMap.target[x] do not cover the following types: Reference. The target context ConceptMap.target[x] is a choice-type element and cannot directly hold extensions. The context is moved up to parent element ConceptMap. Should be a version specific reference. URIs SHOULD be absolute.

                    Control1..1
                    This element is affected by the following invariants: ele-1
                    TypeExtension(DSTU2: Provides context to the mappings additional types) (Extension Type: Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R4, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R4, StructureDefinition))
                    Is Modifierfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                    48. ConceptMap.modifierExtension
                    Definition

                    May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                    ShortExtensions that cannot be ignored
                    Comments

                    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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

                    An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different servers.

                    ShortCanonical identifier for this concept map, represented as a URI (globally unique)
                    Comments

                    Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

                    The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

                    In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

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

                    Allows the concept map to be referenced by a single globally unique identifier.

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

                    A formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.

                    ShortAdditional identifier for the concept map
                    Comments

                    Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this concept map outside of FHIR, where it is not possible to use the logical URI.

                    NoteThis is a business identifier, not a resource identifier (see discussion)
                    Control0..1
                    TypeIdentifier
                    Is Modifierfalse
                    Summarytrue
                    Requirements

                    Allows externally provided and/or usable business identifiers to be easily associated with the module.

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

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

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

                    An Extension

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

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

                      ShortDSTU2: identifier additional types
                      Comments

                      Element ConceptMap.identifier is mapped to FHIR R4 element ConceptMap.identifier as SourceIsBroaderThanTarget. The mappings for ConceptMap.identifier do not cover the following types: Identifier. The mappings for ConceptMap.identifier do not cover the following types based on type expansion: assigner, period, system, type, use, value. Typically, this is used for values that can go in a v3 II data type.

                      Control0..1
                      TypeExtension(DSTU2: identifier additional types) (Extension Type: Identifier)
                      Is Modifierfalse
                      Summaryfalse
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                      60. ConceptMap.identifier.use
                      Definition

                      The purpose of this identifier.

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

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

                      Control0..1
                      BindingThe codes SHALL be taken from IdentifierUse
                      (required to http://hl7.org/fhir/ValueSet/identifier-use|4.0.1)

                      Identifies the purpose for this identifier, if known .

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Requirements

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

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

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

                      TypeCodeableConcept
                      Is Modifierfalse
                      Summarytrue
                      Requirements

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

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

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

                      ShortThe namespace for the identifier value
                      Comments

                      Identifier.system is always case sensitive.

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

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

                      ExampleGeneral: http://www.acme.com/identifiers/patient
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      66. ConceptMap.identifier.value
                      Definition

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

                      ShortThe value that is unique
                      Comments

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

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      ExampleGeneral: 123456
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      68. ConceptMap.identifier.period
                      Definition

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

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

                      Organization that issued/manages the identifier.

                      ShortOrganization that issued id (may be just text)
                      Comments

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

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

                      The identifier that is used to identify this version of the concept map when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence.

                      ShortBusiness version of the concept map
                      Comments

                      There may be different concept map instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the concept map with the format [url]|[version].

                      NoteThis is a business version Id, not a resource version Id (see discussion)
                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      74. ConceptMap.name
                      Definition

                      A natural language name identifying the concept map. This name should be usable as an identifier for the module by machine processing applications such as code generation.

                      ShortName for this concept map (computer friendly)
                      Comments

                      The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

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

                      Support human navigation and code generation.

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

                      A short, descriptive, user-friendly title for the concept map.

                      ShortName for this concept map (human friendly)
                      Comments

                      This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

                      Control0..1
                      Typestring
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      78. ConceptMap.status
                      Definition

                      The status of this concept map. Enables tracking the life-cycle of the content.

                      Shortdraft | active | retired | unknown
                      Comments

                      Allows filtering of concept maps that are appropriate for use versus not.

                      Control1..1
                      BindingThe codes SHALL be taken from PublicationStatus
                      (required to http://hl7.org/fhir/ValueSet/publication-status|4.0.1)

                      The lifecycle status of an artifact.

                      Typecode
                      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      80. ConceptMap.experimental
                      Definition

                      A Boolean value to indicate that this concept map is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

                      ShortFor testing purposes, not real usage
                      Comments

                      Allows filtering of concept maps that are appropriate for use versus not.

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

                      Enables experimental content to be developed following the same lifecycle that would be used for a production-level concept map.

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

                      The date (and optionally time) when the concept map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.

                      ShortDate last changed
                      Comments

                      Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

                      Control0..1
                      TypedateTime
                      Is Modifierfalse
                      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                      Summarytrue
                      Alternate NamesRevision Date
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      84. ConceptMap.publisher
                      Definition

                      The name of the organization or individual that published the concept map.

                      ShortName of the publisher (organization or individual)
                      Comments

                      Usually an organization but may be an individual. The publisher (or steward) of the concept map is the organization or individual primarily responsible for the maintenance and upkeep of the concept map. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the concept map. This item SHOULD be populated unless the information is available from context.

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

                      Helps establish the "authority/credibility" of the concept map. May also allow for contact.

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

                      Contact details to assist a user in finding and communicating with the publisher.

                      ShortContact details for the publisher
                      Comments

                      May be a web site, an email address, a telephone number, etc.

                      Control0..*
                      TypeContactDetail
                      Is Modifierfalse
                      Summarytrue
                      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                      88. ConceptMap.contact.id
                      Definition

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

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

                      An Extension

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

                        DSTU2: ConceptMap.contact.name (new:string)

                        ShortDSTU2: Name of a individual to contact (new)
                        Comments

                        Element ConceptMap.contact.name has a context of ConceptMap.contact based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.contact.name has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element). If there is no named individual, the telecom is for the organization as a whole.

                        Control0..1
                        TypeExtension(DSTU2: Name of a individual to contact (new)) (Extension Type: string)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        94. ConceptMap.contact.extension:telecom
                        Slice Nametelecom
                        Definition

                        DSTU2: ConceptMap.contact.telecom (new:ContactPoint)

                        ShortDSTU2: Contact details for individual or publisher (new)
                        Comments

                        Element ConceptMap.contact.telecom has a context of ConceptMap.contact based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.contact.telecom has no mapping targets in FHIR R4. Typically, this is because the element has been added (is a new element).

                        Control0..*
                        TypeExtension(DSTU2: Contact details for individual or publisher (new)) (Extension Type: ContactPoint)
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        96. ConceptMap.contact.name
                        Definition

                        The name of an individual to contact.

                        ShortName of an individual to contact
                        Comments

                        If there is no named individual, the telecom information is for the organization as a whole.

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

                        The contact details for the individual (if a name was provided) or the organization.

                        ShortContact details for individual or organization
                        Control0..*
                        TypeContactPoint
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        100. ConceptMap.description
                        Definition

                        A free text natural language description of the concept map from a consumer's perspective.

                        ShortNatural language description of the concept map
                        Comments

                        The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.

                        Control0..1
                        Typemarkdown
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        102. ConceptMap.useContext
                        Definition

                        The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate concept map instances.

                        ShortThe context that the content is intended to support
                        Comments

                        When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

                        Control0..*
                        TypeUsageContext
                        Is Modifierfalse
                        Summarytrue
                        Requirements

                        Assist in searching for appropriate content.

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

                        A legal or geographic region in which the concept map is intended to be used.

                        ShortIntended jurisdiction for concept map (if applicable)
                        Comments

                        It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended.

                        Control0..*
                        BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
                        (extensible to http://hl7.org/fhir/ValueSet/jurisdiction|4.0.1)

                        Countries and regions within which this artifact is targeted for use.

                        TypeCodeableConcept
                        Is Modifierfalse
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        106. ConceptMap.purpose
                        Definition

                        Explanation of why this concept map is needed and why it has been designed as it has.

                        ShortWhy this concept map is defined
                        Comments

                        This element does not describe the usage of the concept map. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this concept map.

                        Control0..1
                        Typemarkdown
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        108. ConceptMap.copyright
                        Definition

                        A copyright statement relating to the concept map and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the concept map.

                        ShortUse and/or publishing restrictions
                        Comments

                        Frequently the copyright differs between the concept map and codes that are included. The copyright statement should clearly differentiate between these when required.

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

                        Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content.

                        Alternate NamesLicense, Restrictions
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        110. ConceptMap.source[x]
                        Definition

                        Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings.

                        ShortThe source value set that contains the concepts that are being mapped
                        Comments

                        Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, there is no specified context for the map (not recommended). The source value set may select codes from either an explicit (standard or local) or implicit code system.

                        Control0..1
                        TypeChoice of: uri, canonical(ValueSet)
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        112. ConceptMap.target[x]
                        Definition

                        The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are made.

                        ShortThe target value set which provides context for the mappings
                        Comments

                        Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map.

                        Control0..1
                        TypeChoice of: uri, canonical(ValueSet)
                        [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summarytrue
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        114. ConceptMap.group
                        Definition

                        A group of mappings that all have the same source and target system.

                        ShortSame source and target systems
                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        116. ConceptMap.group.id
                        Definition

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

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

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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

                        An absolute URI that identifies the source system where the concepts to be mapped are defined.

                        ShortSource system where concepts to be mapped are defined
                        Comments

                        This is not needed if the source value set is specified and it contains concepts from only a single system.

                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        124. ConceptMap.group.sourceVersion
                        Definition

                        The specific version of the code system, as determined by the code system authority.

                        ShortSpecific version of the code system
                        Comments

                        The specification of a particular code system version may be required for code systems which lack concept permanence.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        126. ConceptMap.group.target
                        Definition

                        An absolute URI that identifies the target system that the concepts will be mapped to.

                        ShortTarget system that the concepts are to be mapped to
                        Comments

                        This is not needed if the target value set is specified and it contains concepts from only a single system. The group target may also be omitted if all of the target element equivalence values are 'unmatched'.

                        Control0..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        128. ConceptMap.group.targetVersion
                        Definition

                        The specific version of the code system, as determined by the code system authority.

                        ShortSpecific version of the code system
                        Comments

                        The specification of a particular code system version may be required for code systems which lack concept permanence.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        130. ConceptMap.group.element
                        Definition

                        Mappings for an individual concept in the source to one or more concepts in the target.

                        ShortMappings for a concept from the source set
                        Comments

                        Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies.

                        Control1..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Alternate Namescode, concept, item
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        132. ConceptMap.group.element.id
                        Definition

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

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

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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

                        Identity (code or path) or the element/item being mapped.

                        ShortIdentifies element being mapped
                        Control0..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        140. ConceptMap.group.element.display
                        Definition

                        The display for the code. The display is only provided to help editors when editing the concept map.

                        ShortDisplay for the code
                        Comments

                        The display is ignored when processing the map.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        142. ConceptMap.group.element.target
                        Definition

                        A concept from the target value set that this concept maps to.

                        ShortConcept in target system for element
                        Comments

                        Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched.

                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Invariantscmd-1: If the map is narrower or inexact, there SHALL be some comments (comment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact')))
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        144. ConceptMap.group.element.target.id
                        Definition

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

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

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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

                        Identity (code or path) or the element/item that the map refers to.

                        ShortCode that identifies the target element
                        Control0..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        152. ConceptMap.group.element.target.display
                        Definition

                        The display for the code. The display is only provided to help editors when editing the concept map.

                        ShortDisplay for the code
                        Comments

                        The display is ignored when processing the map.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        154. ConceptMap.group.element.target.equivalence
                        Definition

                        The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source).

                        Shortrelatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
                        Comments

                        This element is labeled as a modifier because it may indicate that a target does not apply.

                        Control1..1
                        BindingThe codes SHALL be taken from ConceptMapEquivalence
                        (required to http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.1)

                        The degree of equivalence between concepts.

                        Typecode
                        Is Modifiertrue because Some of the values mean that there is no mapping from the source to the target, particularly 'disjoint', and the mapping cannot be interpreted without knowing this value as it could mean the elements are equivalent, totally mismatched or anything in between
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        156. ConceptMap.group.element.target.comment
                        Definition

                        A description of status/issues in mapping that conveys additional information not represented in the structured data.

                        ShortDescription of status/issues in mapping
                        Control0..1
                        This element is affected by the following invariants: cmd-1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        158. ConceptMap.group.element.target.dependsOn
                        Definition

                        A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified value.

                        ShortOther elements required for this mapping (from context)
                        Control0..*
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        160. ConceptMap.group.element.target.dependsOn.id
                        Definition

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

                        ShortUnique id for inter-element referencing
                        Control0..1
                        Typestring
                        Is Modifierfalse
                        XML FormatIn the XML format, this property is represented as an attribute.
                        Summaryfalse
                        162. ConceptMap.group.element.target.dependsOn.extension
                        Definition

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                        Alternate Namesextensions, user content, modifiers
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
                        166. ConceptMap.group.element.target.dependsOn.property
                        Definition

                        A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system property.

                        ShortReference to property mapping depends on
                        Control1..1
                        Typeuri
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        168. ConceptMap.group.element.target.dependsOn.system
                        Definition

                        An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems).

                        ShortCode System (if necessary)
                        Control0..1
                        Typecanonical(CodeSystem)
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Meaning if MissingThe code is in the source (dependsOn) or target (product) system
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        170. ConceptMap.group.element.target.dependsOn.value
                        Definition

                        Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers to.

                        ShortValue of the referenced element
                        Control1..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        172. ConceptMap.group.element.target.dependsOn.display
                        Definition

                        The display for the code. The display is only provided to help editors when editing the concept map.

                        ShortDisplay for the code (if value is a code)
                        Comments

                        The display is ignored when processing the map.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        174. ConceptMap.group.element.target.product
                        Definition

                        A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied on.

                        ShortOther concepts that this mapping also produces
                        Control0..*
                        TypeSeettp://hl7.org/fhir/StructureDefinition/ConceptMap#ConceptMap.group.element.target.dependsOn
                        Is Modifierfalse
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        176. ConceptMap.group.unmapped
                        Definition

                        What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatched.

                        ShortWhat to do when there is no mapping for the source concept
                        Comments

                        This only applies if the source code has a system value that matches the system defined for the group.

                        Control0..1
                        TypeBackboneElement
                        Is Modifierfalse
                        Summaryfalse
                        Invariantscmd-2: If the mode is 'fixed', a code must be provided ((mode = 'fixed') implies code.exists())
                        cmd-3: If the mode is 'other-map', a url must be provided ((mode = 'other-map') implies url.exists())
                        ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        178. ConceptMap.group.unmapped.id
                        Definition

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

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

                        May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

                        ShortAdditional content defined by implementations
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

                        Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

                        ShortExtensions that cannot be ignored even if unrecognized
                        Comments

                        There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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

                        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

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

                        Defines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL).

                        Shortprovided | fixed | other-map
                        Control1..1
                        BindingThe codes SHALL be taken from ConceptMapGroupUnmappedMode
                        (required to http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.1)

                        Defines which action to take if there is no match in the group.

                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        186. ConceptMap.group.unmapped.code
                        Definition

                        The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code.

                        ShortFixed code when mode = fixed
                        Control0..1
                        Typecode
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        188. ConceptMap.group.unmapped.display
                        Definition

                        The display for the code. The display is only provided to help editors when editing the concept map.

                        ShortDisplay for the code
                        Comments

                        The display is ignored when processing the map.

                        Control0..1
                        Typestring
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                        190. ConceptMap.group.unmapped.url
                        Definition

                        The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concept.

                        Shortcanonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
                        Control0..1
                        Typecanonical(ConceptMap)
                        Is Modifierfalse
                        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                        Summaryfalse
                        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))