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

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

Resource Profile: Profile_R2_ConceptMap_R5 - 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
Must Supportfalse
Summaryfalse
Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
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 its 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 its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ConceptMap.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

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..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
6. 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 managable, 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
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
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
  • 8. ConceptMap.extension:source
    Slice Namesource
    Definition

    DSTU2: ConceptMap.source[x] (new:Reference(ValueSet,StructureDefinition), uri)

    ShortDSTU2: Identifies the source of the concepts which are being mapped (new)
    Comments

    Element ConceptMap.source[x] has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.source[x] has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Should be a version specific reference. URIs SHOULD be absolute.

    Control1..1
    TypeExtension(DSTU2: Identifies the source of the concepts which are being mapped (new)) (Extension Type: Choice of: uri, Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R5, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5, StructureDefinition))
    Is Modifierfalse
    Must Supportfalse
    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.extension:target
    Slice Nametarget
    Definition

    DSTU2: ConceptMap.target[x] (new:Reference(ValueSet,StructureDefinition), uri)

    ShortDSTU2: Provides context to the mappings (new)
    Comments

    Element ConceptMap.target[x] has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.target[x] has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Should be a version specific reference. URIs SHOULD be absolute.

    Control1..1
    TypeExtension(DSTU2: Provides context to the mappings (new)) (Extension Type: Choice of: uri, Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R5, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5, StructureDefinition))
    Is Modifierfalse
    Must Supportfalse
    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())
    12. 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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

    ShortExtensions that cannot be ignored
    Comments

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

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    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
    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())
    14. 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.

    See guidance around (not) making local changes to elements here.


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

    See guidance around (not) making local changes to elements here.

    Control1..1
    This element is affected by the following invariants: cmd-1
    BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status|5.0.0
    (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)

    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
    Must Supportfalse
    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 R5 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 R5 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] (new:Reference(ValueSet,StructureDefinition), uri)

          ShortDSTU2: Identifies the source of the concepts which are being mapped (new)
          Comments

          Element ConceptMap.source[x] has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.source[x] has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Should be a version specific reference. URIs SHOULD be absolute.

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

          DSTU2: ConceptMap.target[x] (new:Reference(ValueSet,StructureDefinition), uri)

          ShortDSTU2: Provides context to the mappings (new)
          Comments

          Element ConceptMap.target[x] has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.target[x] has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Should be a version specific reference. URIs SHOULD be absolute.

          Control1..1
          TypeExtension(DSTU2: Provides context to the mappings (new)) (Extension Type: Choice of: uri, Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R5, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5, 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 R5 element ConceptMap.identifier as RelatedTo. 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 R5. 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 R5. 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)
              34. ConceptMap.group
              36. ConceptMap.group.element
              38. ConceptMap.group.element.target
              40. ConceptMap.group.element.target.relationship
              42. ConceptMap.group.element.target.relationship.extension
              Control0..*
              SlicingThis element introduces a set of slices on ConceptMap.group.element.target.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 44. ConceptMap.group.element.target.relationship.extension:equivalence
                Slice Nameequivalence
                Definition

                DSTU2: ConceptMap.element.target.equivalence additional codes

                ShortDSTU2: equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint additional codes
                Comments

                Element ConceptMap.element.target.equivalence is mapped to FHIR R5 element ConceptMap.group.element.target.relationship as RelatedTo. The mappings for ConceptMap.element.target.equivalence do not allow expression of the necessary codes, per the bindings on the source and target. The target context ConceptMap.group.element.target.relationship is a modifier element, so this extension does not need to be defined as a modifier.

                Control0..1
                TypeExtension(DSTU2: equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint additional codes) (Extension Type: code)
                46. ConceptMap.group.element.target.dependsOn
                48. ConceptMap.group.element.target.dependsOn.extension
                Control1..*
                SlicingThis element introduces a set of slices on ConceptMap.group.element.target.dependsOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 50. ConceptMap.group.element.target.dependsOn.extension:codeSystem
                  Slice NamecodeSystem
                  Definition

                  DSTU2: ConceptMap.element.target.dependsOn.codeSystem (new:uri)

                  ShortDSTU2: Code System (if necessary) (new)
                  Comments

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

                  Control1..1
                  TypeExtension(DSTU2: Code System (if necessary) (new)) (Extension Type: uri)

                  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
                  Must Supportfalse
                  Summaryfalse
                  Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
                  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

                  Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

                  Control0..1
                  Typeid
                  Is Modifierfalse
                  Must Supportfalse
                  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
                  Must Supportfalse
                  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
                  This element is affected by the following invariants: ele-1
                  Typeid
                  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 R5 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 element is generally omitted in instances submitted in a PUT or POST. Instead, it is populated in the response instance and when retrieving information using a GET. 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

                    The exact use of the source (and the possible implied Provenance.entity.role and agent.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. The source may correspond to Provenance.entity.what[x] or Provenance.agent.who[x], though it may be a more general or abstract reference.

                    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 AllSecurityLabels .
                    (extensible to http://hl7.org/fhir/ValueSet/security-labels|5.0.0)

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

                    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 its 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 its meaning or interpretation
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    Summarytrue
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    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 SHALL be taken from AllLanguages
                    (required to http://hl7.org/fhir/ValueSet/all-languages|5.0.0)

                    IETF language tag for a human language

                    Typecode
                    Is Modifierfalse
                    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                    Must Supportfalse
                    Summaryfalse
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    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 a 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
                    This element is affected by the following invariants: dom-6
                    TypeNarrative
                    Is Modifierfalse
                    Must Supportfalse
                    Summaryfalse
                    Alternate Namesnarrative, html, xhtml, display
                    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                    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
                    This element is affected by the following invariants: ele-1
                    Typeid
                    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 R5 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|5.0.0)

                      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, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

                      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..*
                      This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
                      TypeResource
                      Is Modifierfalse
                      Must Supportfalse
                      Summaryfalse
                      Alternate Namesinline resources, anonymous resources, contained resources
                      42. ConceptMap.extension
                      Definition

                      An Extension

                      ShortExtension
                      Control2..*
                      TypeExtension
                      Is Modifierfalse
                      Must Supportfalse
                      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] (new:Reference(ValueSet,StructureDefinition), uri)

                        ShortDSTU2: Identifies the source of the concepts which are being mapped (new)
                        Comments

                        Element ConceptMap.source[x] has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.source[x] has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Should be a version specific reference. URIs SHOULD be absolute.

                        Control1..1
                        TypeExtension(DSTU2: Identifies the source of the concepts which are being mapped (new)) (Extension Type: Choice of: uri, Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R5, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5, StructureDefinition))
                        Is Modifierfalse
                        Must Supportfalse
                        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] (new:Reference(ValueSet,StructureDefinition), uri)

                        ShortDSTU2: Provides context to the mappings (new)
                        Comments

                        Element ConceptMap.target[x] has a context of ConceptMap based on following the parent source element upwards and mapping to ConceptMap. Element ConceptMap.target[x] has no mapping targets in FHIR R5. Typically, this is because the element has been added (is a new element). Should be a version specific reference. URIs SHOULD be absolute.

                        Control1..1
                        TypeExtension(DSTU2: Provides context to the mappings (new)) (Extension Type: Choice of: uri, Reference(Cross-version Profile for DSTU2.ValueSet for use in FHIR R5, ValueSet, Cross-version Profile for DSTU2.StructureDefinition for use in FHIR R5, StructureDefinition))
                        Is Modifierfalse
                        Must Supportfalse
                        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 managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

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

                        ShortExtensions that cannot be ignored
                        Comments

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

                        Control0..*
                        TypeExtension
                        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
                        Must Supportfalse
                        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
                        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 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
                        Must Supportfalse
                        Summarytrue
                        Requirements

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

                        Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
                        ele-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..*
                        TypeIdentifier
                        Is Modifierfalse
                        Must Supportfalse
                        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
                        This element is affected by the following invariants: ele-1
                        Typeid
                        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 R5 element ConceptMap.identifier as RelatedTo. 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|5.0.0)

                          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 IdentifierTypeCodes
                          (extensible to http://hl7.org/fhir/ValueSet/identifier-type|5.0.0)

                          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, an absolute 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 http://hl7.org/fhir/StructureDefinition/rendered-value). 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
                          This element is affected by the following invariants: ident-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]. The version SHOULD NOT contain a '#' - see Business 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
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          74. ConceptMap.versionAlgorithm[x]
                          Definition

                          Indicates the mechanism used to compare versions to determine which ConceptMap is more current.

                          ShortHow to compare versions
                          Comments

                          If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

                          Control0..1
                          BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
                          (extensible to http://hl7.org/fhir/ValueSet/version-algorithm|5.0.0)
                          TypeChoice of: string, Coding
                          [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
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          76. 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: cnl-0
                          Typestring
                          Is Modifierfalse
                          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                          Must Supportfalse
                          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()))
                          78. 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
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          80. 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.

                          See guidance around (not) making local changes to elements here.

                          Control1..1
                          This element is affected by the following invariants: cmd-1
                          BindingThe codes SHALL be taken from PublicationStatus
                          (required to http://hl7.org/fhir/ValueSet/publication-status|5.0.0)

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

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

                          Meaning if MissingIf absent, this resource is treated as though it is not experimental.
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          84. ConceptMap.date
                          Definition

                          The date (and optionally time) when the concept map was last significantly changed. 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

                          The date is often not tracked until the resource is published, but may be present on draft content. 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.

                          See guidance around (not) making local changes to elements here.

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

                          The name of the organization or individual responsible for the release and ongoing maintenance of the concept map.

                          ShortName of the publisher/steward (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
                          Must Supportfalse
                          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()))
                          88. 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.

                          See guidance around (not) making local changes to elements here.

                          Control0..*
                          TypeContactDetail
                          Is Modifierfalse
                          Must Supportfalse
                          Summarytrue
                          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                          90. 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
                          This element is affected by the following invariants: ele-1
                          Typeid
                          Is Modifierfalse
                          XML FormatIn the XML format, this property is represented as an attribute.
                          Summaryfalse
                          92. 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
                          • 94. 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 R5. 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())
                            96. 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 R5. 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())
                            98. 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()))
                            100. 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()))
                            102. 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
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            104. 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
                            Must Supportfalse
                            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()))
                            106. 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.

                            DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

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

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

                            TypeCodeableConcept
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            108. 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
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            110. 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
                            Must Supportfalse
                            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()))
                            112. ConceptMap.copyrightLabel
                            Definition

                            A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

                            ShortCopyright holder and year(s)
                            Comments

                            The (c) symbol should NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

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

                            Defines the content expected to be rendered in all representations of the artifact.

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

                            The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.

                            ShortWhen the ConceptMap was approved by publisher
                            Comments

                            The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

                            See guidance around (not) making local changes to elements here.

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

                            The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.

                            ShortWhen the ConceptMap was last reviewed by the publisher
                            Comments

                            If specified, this date follows the original approval date.

                            See guidance around (not) making local changes to elements here.

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

                            Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

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

                            The period during which the ConceptMap content was or is planned to be in active use.

                            ShortWhen the ConceptMap is expected to be used
                            Comments

                            The effective period for a ConceptMap determines when the content is applicable for usage and is independent of publication and review dates. For example, a map intended to be used for the year 2016 might be published in 2015.

                            See guidance around (not) making local changes to elements here.

                            Control0..1
                            TypePeriod
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Requirements

                            Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the ConceptMap are or are expected to be used instead.

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

                            Descriptions related to the content of the ConceptMap. Topics provide a high-level categorization as well as keywords for the ConceptMap that can be useful for filtering and searching.

                            ShortE.g. Education, Treatment, Assessment, etc
                            Comments

                            DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'topic' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#topic and useContext.valueCodeableConcept indicating the topic)

                            Control0..*
                            BindingFor example codes, see DefinitionTopic
                            (example to http://hl7.org/fhir/ValueSet/definition-topic|5.0.0)
                            TypeCodeableConcept
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Requirements

                            Repositories must be able to determine how to categorize the ConceptMap so that it can be found by topical and keyword searches.

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

                            An individiual or organization primarily involved in the creation and maintenance of the ConceptMap.

                            ShortWho authored the ConceptMap
                            Control0..*
                            TypeContactDetail
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            124. ConceptMap.editor
                            Definition

                            An individual or organization primarily responsible for internal coherence of the ConceptMap.

                            ShortWho edited the ConceptMap
                            Control0..*
                            TypeContactDetail
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            126. ConceptMap.reviewer
                            Definition

                            An individual or organization asserted by the publisher to be primarily responsible for review of some aspect of the ConceptMap.

                            ShortWho reviewed the ConceptMap
                            Comments

                            See guidance around (not) making local changes to elements here.

                            Control0..*
                            TypeContactDetail
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            128. ConceptMap.endorser
                            Definition

                            An individual or organization asserted by the publisher to be responsible for officially endorsing the ConceptMap for use in some setting.

                            ShortWho endorsed the ConceptMap
                            Comments

                            See guidance around (not) making local changes to elements here.

                            Control0..*
                            TypeContactDetail
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            130. ConceptMap.relatedArtifact
                            Definition

                            Related artifacts such as additional documentation, justification, dependencies, bibliographic references, and predecessor and successor artifacts.

                            ShortAdditional documentation, citations, etc
                            Comments

                            Each related artifact is either an attachment, or a reference to another resource, but not both.

                            Control0..*
                            TypeRelatedArtifact
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Requirements

                            A ConceptMap must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content.

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

                            A property defines a slot through which additional information can be provided about a map from source -> target.

                            ShortAdditional properties of the mapping
                            Comments

                            Properties may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation. Multiple occurrences of ConceptMap.group.element.target.property may occur for a ConceptMap.property where ConceptMap.group.element.target.property.code is the same and the values in ConceptMap.group.element.target.property.value differ.

                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantscmd-11: If the property type is code, a system SHALL be specified (type = 'code' implies system.exists())
                            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            134. ConceptMap.property.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
                            This element is affected by the following invariants: ele-1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            136. ConceptMap.property.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 managable, 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())
                            138. ConceptMap.property.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 managable, 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())
                            140. ConceptMap.property.code
                            Definition

                            A code that is used to identify the property. The code is used internally (in ConceptMap.group.element.target.property.code) and also in the $translate operation.

                            ShortIdentifies the property on the mappings, and when referred to in the $translate operation
                            Control1..1
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            142. ConceptMap.property.uri
                            Definition

                            Reference to the formal meaning of the property.

                            ShortFormal identifier for the property
                            Control0..1
                            Typeuri
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            144. ConceptMap.property.description
                            Definition

                            A description of the property - why it is defined, and how its value might be used.

                            ShortWhy the property is defined, and/or what it conveys
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            146. ConceptMap.property.type
                            Definition

                            The type of the property value.

                            ShortCoding | string | integer | boolean | dateTime | decimal | code
                            Control1..1
                            This element is affected by the following invariants: cmd-11
                            BindingThe codes SHALL be taken from ConceptMapPropertyType
                            (required to http://hl7.org/fhir/ValueSet/conceptmap-property-type|5.0.0)

                            The type of a property value.

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            148. ConceptMap.property.system
                            Definition

                            The CodeSystem that defines the codes from which values of type code in property values.

                            ShortThe CodeSystem from which code values come
                            Control0..1
                            This element is affected by the following invariants: cmd-11
                            Typecanonical(CodeSystem)
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            150. ConceptMap.additionalAttribute
                            Definition

                            An additionalAttribute defines an additional data element found in the source or target data model where the data will come from or be mapped to. Some mappings are based on data in addition to the source data element, where codes in multiple fields are combined to a single field (or vice versa).

                            ShortDefinition of an additional attribute to act as a data source or target
                            Comments

                            Additional attributes are used to define additional data elements where mapping data can be found. For an example, see [Specimen Type v2 -> SNOMED CT Mapping(conceptmap-example-specimen-type.html)

                            Control0..*
                            TypeBackboneElement
                            Is Modifierfalse
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            152. ConceptMap.additionalAttribute.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
                            This element is affected by the following invariants: ele-1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            154. ConceptMap.additionalAttribute.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 managable, 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())
                            156. ConceptMap.additionalAttribute.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 managable, 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())
                            158. ConceptMap.additionalAttribute.code
                            Definition

                            A code that is used to identify this additional data attribute. The code is used internally in ConceptMap.group.element.target.dependsOn.attribute and ConceptMap.group.element.target.product.attribute.

                            ShortIdentifies this additional attribute through this resource
                            Control1..1
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            160. ConceptMap.additionalAttribute.uri
                            Definition

                            Reference to the formal definition of the source/target data element. For elements defined by the FHIR specification, or using a FHIR logical model, the correct format is {canonical-url}#{element-id}.

                            ShortFormal identifier for the data element referred to in this attribte
                            Control0..1
                            Typeuri
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            162. ConceptMap.additionalAttribute.description
                            Definition

                            A description of the additional attribute and/or the data element it refers to - why it is defined, and how the value might be used in mappings, and a discussion of issues associated with the use of the data element.

                            ShortWhy the additional attribute is defined, and/or what the data element it refers to is
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            164. ConceptMap.additionalAttribute.type
                            Definition

                            The type of the source data contained in this concept map for this data element.

                            Shortcode | Coding | string | boolean | Quantity
                            Comments

                            When the source or target is not content defined by FHIR, some additional application logic might be required to map from the FHIR Datatype to the externally defined content

                            Control1..1
                            BindingThe codes SHALL be taken from ConceptMapAttributeType
                            (required to http://hl7.org/fhir/ValueSet/conceptmap-attribute-type|5.0.0)

                            The type of a mapping attribute value.

                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            166. ConceptMap.sourceScope[x]
                            Definition

                            Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappings. Limits the scope of the map to source codes (ConceptMap.group.element code or valueSet) that are members of this value set.

                            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 sourceScope or targetScope value set, there is no specified context for the map (not recommended). The sourceScope 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
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            168. ConceptMap.targetScope[x]
                            Definition

                            Identifier for the target value set that provides important context about how the mapping choices are made. Limits the scope of the map to target codes (ConceptMap.group.element.target code or valueSet) that are members of this value set.

                            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 sourceScope or targetScope value set, there is no specified context for the map (not recommended). The targetScope 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
                            Must Supportfalse
                            Summarytrue
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            170. 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
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            172. 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
                            This element is affected by the following invariants: ele-1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            174. 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 managable, 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())
                            176. 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 managable, 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())
                            178. 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
                            Typecanonical(CodeSystem)
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            180. 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 relationship values are 'not-related-to'.

                            Control0..1
                            Typecanonical(CodeSystem)
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            182. 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
                            Must Supportfalse
                            Summaryfalse
                            Alternate Namescode, concept, item
                            Invariantscmd-4: If noMap is present, target SHALL NOT be present ((noMap.exists() and noMap=true) implies target.empty())
                            cmd-5: Either code or valueSet SHALL be present but not both. ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()))
                            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            184. 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
                            This element is affected by the following invariants: ele-1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            186. 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 managable, 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())
                            188. 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 managable, 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())
                            190. ConceptMap.group.element.code
                            Definition

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

                            ShortIdentifies element being mapped
                            Control0..1
                            This element is affected by the following invariants: cmd-5
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            192. 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
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            194. ConceptMap.group.element.valueSet
                            Definition

                            The set of concepts from the ConceptMap.group.source code system which are all being mapped to the target as part of this mapping rule.

                            ShortIdentifies the set of concepts being mapped
                            Comments

                            If the value set expansion is empty then there are no source concepts to map in this rule.

                            Control0..1
                            This element is affected by the following invariants: cmd-5
                            Typecanonical(ValueSet)
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            196. ConceptMap.group.element.noMap
                            Definition

                            If noMap = true this indicates that no mapping to a target concept exists for this source concept.

                            ShortNo mapping to a target concept for this source concept
                            Comments

                            If noMap = true, then the behavior of ConceptMap.group.unmapped (if present) does not apply.

                            Control0..1
                            This element is affected by the following invariants: cmd-4
                            Typeboolean
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            198. 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 an 'equivalent' mapping. But multiple maps are allowed for several narrower (i.e. source-is-broader-than-target) options, or to assert that other concepts are not related.

                            Control0..*
                            This element is affected by the following invariants: cmd-4
                            TypeBackboneElement
                            Is Modifierfalse
                            Must Supportfalse
                            Summaryfalse
                            Invariantscmd-1: If the map is source-is-broader-than-target or not-related-to, there SHALL be some comments, unless the status is 'draft' (comment.exists() or (%resource.status = 'draft') or relationship.empty() or ((relationship != 'source-is-broader-than-target') and (relationship != 'not-related-to')))
                            cmd-7: Either code or valueSet SHALL be present but not both. ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists()))
                            ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            200. 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
                            This element is affected by the following invariants: ele-1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            202. 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 managable, 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())
                            204. 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 managable, 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())
                            206. 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
                            This element is affected by the following invariants: cmd-7
                            Typecode
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            208. 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
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            210. ConceptMap.group.element.target.valueSet
                            Definition

                            The set of concepts from the ConceptMap.group.target code system which are all being mapped to as part of this mapping rule. The effect of using this data element is the same as having multiple ConceptMap.group.element.target elements with one for each concept in the ConceptMap.group.element.target.valueSet value set.

                            ShortIdentifies the set of target concepts
                            Comments

                            If the the value set expansion is empty then the source concept(s) are unmapped and the behavior of ConceptMap.group.unmapped (if present) applies.

                            Control0..1
                            This element is affected by the following invariants: cmd-7
                            Typecanonical(ValueSet)
                            Is Modifierfalse
                            Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            212. ConceptMap.group.element.target.relationship
                            Definition

                            The relationship between the source and target concepts. The relationship is read from source to target (e.g. source-is-narrower-than-target).

                            Shortrelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
                            Comments

                            This element is labeled as a modifier because it may indicate that there is no mapping.

                            Control1..1
                            This element is affected by the following invariants: cmd-1
                            BindingThe codes SHALL be taken from ConceptMapRelationship
                            (required to http://hl7.org/fhir/ValueSet/concept-map-relationship|5.0.0)

                            The relationship between concepts.

                            Typecode
                            Is Modifiertrue because The 'not-related-to' relationship means that there is no mapping from the source to the target, 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
                            Must Supportfalse
                            Summaryfalse
                            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                            214. ConceptMap.group.element.target.relationship.id
                            Definition

                            unique id for the element within a resource (for internal references)

                            Shortxml:id (or equivalent in JSON)
                            Control0..1
                            Typestring
                            Is Modifierfalse
                            XML FormatIn the XML format, this property is represented as an attribute.
                            Summaryfalse
                            216. ConceptMap.group.element.target.relationship.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.group.element.target.relationship.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                            • value @ url
                            • 218. ConceptMap.group.element.target.relationship.extension:equivalence
                              Slice Nameequivalence
                              Definition

                              DSTU2: ConceptMap.element.target.equivalence additional codes

                              ShortDSTU2: equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint additional codes
                              Comments

                              Element ConceptMap.element.target.equivalence is mapped to FHIR R5 element ConceptMap.group.element.target.relationship as RelatedTo. The mappings for ConceptMap.element.target.equivalence do not allow expression of the necessary codes, per the bindings on the source and target. The target context ConceptMap.group.element.target.relationship is a modifier element, so this extension does not need to be defined as a modifier.

                              Control0..1
                              TypeExtension(DSTU2: equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint additional codes) (Extension Type: code)
                              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())
                              220. ConceptMap.group.element.target.relationship.value
                              Definition

                              Primitive value for code

                              ShortPrimitive value for code
                              Control0..1
                              Typecode
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              222. 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
                              Must Supportfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              224. ConceptMap.group.element.target.property
                              Definition

                              A property value for this source -> target mapping.

                              ShortProperty value for the source -> target mapping
                              Control0..*
                              TypeBackboneElement
                              Is Modifierfalse
                              Must Supportfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              226. ConceptMap.group.element.target.property.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
                              This element is affected by the following invariants: ele-1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              228. ConceptMap.group.element.target.property.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 managable, 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())
                              230. ConceptMap.group.element.target.property.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 managable, 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())
                              232. ConceptMap.group.element.target.property.code
                              Definition

                              A reference to a mapping property defined in ConceptMap.property.

                              ShortReference to ConceptMap.property.code
                              Control1..1
                              Typecode
                              Is Modifierfalse
                              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                              Must Supportfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              234. ConceptMap.group.element.target.property.value[x]
                              Definition

                              The value of this property. If the type chosen for this element is 'code', then the property SHALL be defined in a ConceptMap.property element.

                              ShortValue of the property for this concept
                              Control1..1
                              TypeChoice of: Coding, string, integer, boolean, dateTime, decimal, code
                              [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
                              Must Supportfalse
                              Summaryfalse
                              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              236. ConceptMap.group.element.target.dependsOn
                              Definition

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

                              ShortOther properties required for this mapping
                              Control0..*
                              TypeBackboneElement
                              Is Modifierfalse
                              Must Supportfalse
                              Summaryfalse
                              Invariantscmd-6: One of value[x] or valueSet must exist, but not both. ((value.exists() and valueSet.empty()) or (value.empty() and valueSet.exists()))
                              ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                              238. 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
                              This element is affected by the following invariants: ele-1
                              Typestring
                              Is Modifierfalse
                              XML FormatIn the XML format, this property is represented as an attribute.
                              Summaryfalse
                              240. ConceptMap.group.element.target.dependsOn.extension
                              Definition

                              An Extension

                              ShortExtension
                              Control1..*
                              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.group.element.target.dependsOn.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                              • value @ url
                              • 242. ConceptMap.group.element.target.dependsOn.extension:codeSystem
                                Slice NamecodeSystem
                                Definition

                                DSTU2: ConceptMap.element.target.dependsOn.codeSystem (new:uri)

                                ShortDSTU2: Code System (if necessary) (new)
                                Comments

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

                                Control1..1
                                TypeExtension(DSTU2: Code System (if necessary) (new)) (Extension Type: uri)
                                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())
                                244. 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 managable, 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())
                                246. ConceptMap.group.element.target.dependsOn.attribute
                                Definition

                                A reference to the additional attribute that holds a value the map depends on.

                                ShortA reference to a mapping attribute defined in ConceptMap.additionalAttribute
                                Control1..1
                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                248. ConceptMap.group.element.target.dependsOn.value[x]
                                Definition

                                Data element value that the map depends on / produces.

                                ShortValue of the referenced data element
                                Comments

                                If the data type is a code, then the code system is .group.source for .dependsOn.valueCode and .group.target for .product.valueCode.

                                Control0..1
                                This element is affected by the following invariants: cmd-6
                                TypeChoice of: code, Coding, string, boolean, Quantity
                                [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
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                250. ConceptMap.group.element.target.dependsOn.valueSet
                                Definition

                                This mapping applies if the data element value is a code from this value set.

                                ShortThe mapping depends on a data element with a value from this value set
                                Control0..1
                                This element is affected by the following invariants: cmd-6
                                Typecanonical(ValueSet)
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                252. ConceptMap.group.element.target.product
                                Definition

                                Product is the output of a ConceptMap that provides additional values that go in other attributes / data elemnts of the target data.

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

                                What to do when there is no mapping to a target concept from the source concept and ConceptMap.group.element.noMap is not true. This provides the "default" to be applied when there is no target concept mapping specified or the expansion of ConceptMap.group.element.target.valueSet is empty.

                                ShortWhat to do when there is no mapping target for the source concept and ConceptMap.group.element.noMap is not true
                                Comments

                                The 'unmapped' element is ignored if a code is specified to have relationship = not-related-to or if ConceptMap.group.element.noMap = true.

                                Control0..1
                                TypeBackboneElement
                                Is Modifierfalse
                                Must Supportfalse
                                Summaryfalse
                                Invariantscmd-2: If the mode is 'fixed', either a code or valueSet must be provided, but not both. ((mode = 'fixed') implies ((code.exists() and valueSet.empty()) or (code.empty() and valueSet.exists())))
                                cmd-3: If the mode is 'other-map', a url for the other map must be provided ((mode = 'other-map') implies otherMap.exists())
                                cmd-8: If the mode is not 'fixed', code, display and valueSet are not allowed ((mode != 'fixed') implies (code.empty() and display.empty() and valueSet.empty()))
                                cmd-9: If the mode is not 'other-map', relationship must be provided ((mode != 'other-map') implies relationship.exists())
                                cmd-10: If the mode is not 'other-map', otherMap is not allowed ((mode != 'other-map') implies otherMap.empty())
                                ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                256. 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
                                This element is affected by the following invariants: ele-1
                                Typestring
                                Is Modifierfalse
                                XML FormatIn the XML format, this property is represented as an attribute.
                                Summaryfalse
                                258. 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 managable, 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())
                                260. 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 managable, 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())
                                262. 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 source 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).

                                Shortuse-source-code | fixed | other-map
                                Control1..1
                                This element is affected by the following invariants: cmd-3, cmd-2, cmd-8, cmd-9, cmd-10
                                BindingThe codes SHALL be taken from ConceptMapGroupUnmappedMode
                                (required to http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|5.0.0)

                                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
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                264. 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
                                This element is affected by the following invariants: cmd-2, cmd-8
                                Typecode
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                266. 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
                                This element is affected by the following invariants: cmd-8
                                Typestring
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                268. ConceptMap.group.unmapped.valueSet
                                Definition

                                The set of fixed codes to use when the mode = 'fixed' - all unmapped codes are mapped to each of the fixed codes.

                                ShortFixed code set when mode = fixed
                                Control0..1
                                This element is affected by the following invariants: cmd-2, cmd-8
                                Typecanonical(ValueSet)
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                270. ConceptMap.group.unmapped.relationship
                                Definition

                                The default relationship value to apply between the source and target concepts when the source code is unmapped and the mode is 'fixed' or 'use-source-code'.

                                Shortrelated-to | equivalent | source-is-narrower-than-target | source-is-broader-than-target | not-related-to
                                Comments

                                This element is labeled as a modifier because it may indicate that there is no mapping.

                                Control0..1
                                This element is affected by the following invariants: cmd-9
                                BindingThe codes SHALL be taken from ConceptMapRelationship
                                (required to http://hl7.org/fhir/ValueSet/concept-map-relationship|5.0.0)

                                The default relationship value to apply between the source and target concepts when no concept mapping is specified.

                                Typecode
                                Is Modifiertrue because The 'not-related-to' relationship means that there is no mapping from the source to the target, 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
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                                272. ConceptMap.group.unmapped.otherMap
                                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
                                This element is affected by the following invariants: cmd-3, cmd-10
                                Typecanonical(ConceptMap)
                                Is Modifierfalse
                                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                                Must Supportfalse
                                Summaryfalse
                                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))