Release 4B Ballot #1

This page is part of the FHIR Specification v4.1.0: R4B Ballot. About the R4B version of FHIR. The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

4.10 Resource ConceptMap - Content

Vocabulary Work GroupMaturity Level: 3 Trial UseSecurity Category: Anonymous Compartments: Not linked to any defined compartments

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.

4.10.1 Scope and Usage

ConceptMap will have significant changes in R5. The R5 CI build version of ConceptMap can be found here: http://build.fhir.org/conceptmap.html.

 

A concept map defines a mapping from a set of concepts defined in a code system (commonly referred to as the "system") to one or more concepts defined in other code systems. In the mapping context, a system can be a typical code system based on a recognized standard or local terminology (in any of its forms), or in some cases it may be an "implicit" code system that is not based on a recognized terminology but still represents a set of "concepts" that can be usefully mapped. Mappings are one way - from the source to the target system. In many cases, the reverse mappings are valid, but this cannot be assumed to be the case.

Mappings between code system concepts are only intended to be defined in the context of a particular business usage. The business use case is normally defined by the specification of the source and target value sets. The mappings may be useful in other contexts, but this must be determined based on the context of use and meaning; it cannot be taken for granted automatically. An example where the usage context is important for choosing the correct mapping is mapping from a clinical terminology (e.g. SNOMED CT) to a classification (e.g. ICD-10) for either data analysis or billing. Mappings in the data analysis context would be targeted for an appropriate classification (often at a higher level), whereas in the billing context there may be specific requirements to be met (e.g. leaf level codes only) that could result in multiple mappings for a single source concept and then require additional information beyond the source concept itself in order to select the correct final mapping.

Note that all code systems (explicit or implicit) represented in FHIR have URI identifiers for value sets (also either explicit or implicit) that include the entire code system, and these "all codes" value sets can be used for mappings that are valid in all use contexts that are appropriate for the code system.

Each mapping for a concept from the source to target system includes an equivalence property that specifies how similar the mapping is (or, in some cases, that there is no valid mapping). There is one element for each concept or field in the source value set or system that needs to be mapped. Each source concept may have multiple targets:

  • because there are multiple possible mappings (e.g., ambiguous)
  • to specify a correct map, and specify other mappings as invalid
  • when there are multiple mappings depending on the values of other elements (dependsOn)

There SHOULD be at least one target for each element, but some incomplete concept maps might not have a target for each concept.

A key concept for the ConceptMap resource is the $translate operation. This operation is a formal definition of an API by which a terminology server can allow clients to ask for a translation to be done based on the content in the ConceptMap resource. As such it also provides useful perspective on the operational use of ConceptMap resources in any context.

4.10.2 Boundaries and Relationships

While ConceptMap resources are not referred to directly from any other resource, they may be included and used in ImplementationGuide resources, and provide background knowledge that is useful in many contexts, including operations defined in this specification.

In addition to ConceptMap, there is also the StructureMap resource. The ConceptMap resource defines relationships between concepts in their own right, along with grading of their equivalencies, while the StructureMap defines an executable transform for instances that conform to a known structure.

Both Code System supplements and Concept Maps may be used to define relationships between concepts in different systems. ConceptMaps are assertions of the relationships between different concepts that are associated with particular contexts of use, while CodeSystem supplements are used to define inherent properties and semantics of the concepts in the code system

4.10.3 Background and Context

Further discussion of the issues involved in mapping between concept definition systems can be found in the HL7 v3 Core Principles document and the functionality described in the OMG CTS 2 specification.

4.10.4 References

This resource is referenced by itself.

This resource does not implement any patterns.

4.10.5 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap TUDomainResourceA map from one set of concepts to one or more other concepts
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this concept map, represented as a URI (globally unique)
... identifier Σ0..1IdentifierAdditional identifier for the concept map
... version Σ0..1stringBusiness version of the concept map
... title Σ0..1stringName for this concept map (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the concept map
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this concept map is defined
... copyright 0..1markdownUse and/or publishing restrictions
... source[x] Σ0..1The source value set that contains the concepts that are being mapped
.... sourceUriuri
.... sourceCanonicalcanonical(ValueSet)
... target[x] Σ0..1The target value set which provides context for the mappings
.... targetUriuri
.... targetCanonicalcanonical(ValueSet)
... group 0..*BackboneElementSame source and target systems
.... source 0..1uriSource system where concepts to be mapped are defined
.... sourceVersion 0..1stringSpecific version of the code system
.... target 0..1uriTarget system that the concepts are to be mapped to
.... targetVersion 0..1stringSpecific version of the code system
.... element 1..*BackboneElementMappings for a concept from the source set
..... code 0..1codeIdentifies element being mapped
..... display 0..1stringDisplay for the code
..... target I0..*BackboneElementConcept in target system for element
+ Rule: If the map is narrower or inexact, there SHALL be some comments
...... code 0..1codeCode that identifies the target element
...... display 0..1stringDisplay for the code
...... equivalence ?!1..1coderelatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence (Required)
...... comment I0..1stringDescription of status/issues in mapping
...... dependsOn 0..*BackboneElementOther elements required for this mapping (from context)
....... property 1..1uriReference to property mapping depends on
....... system 0..1canonical(CodeSystem)Code System (if necessary)
....... value 1..1stringValue of the referenced element
....... display 0..1stringDisplay for the code (if value is a code)
...... product 0..*see dependsOnOther concepts that this mapping also produces
.... unmapped I0..1BackboneElementWhat to do when there is no mapping for the source concept
+ Rule: If the mode is 'fixed', a code must be provided
+ Rule: If the mode is 'other-map', a url must be provided
..... mode 1..1codeprovided | fixed | other-map
ConceptMapGroupUnmappedMode (Required)
..... code 0..1codeFixed code when mode = fixed
..... display 0..1stringDisplay for the code
..... url 0..1canonical(ConceptMap)canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

doco Documentation for this format

UML Diagram (Legend)

ConceptMap (DomainResource)An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different serversurl : uri [0..1]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 instanceidentifier : Identifier [0..1]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 sequenceversion : string [0..1]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 generationname : string [0..1]A short, descriptive, user-friendly title for the concept maptitle : string [0..1]The status of this concept map. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »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 usageexperimental : boolean [0..1]The date (and optionally time) when the concept map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changesdate : dateTime [0..1]The name of the organization or individual that published the concept mappublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the concept map from a consumer's perspectivedescription : markdown [0..1]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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the concept map is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this concept map is needed and why it has been designed as it haspurpose : markdown [0..1]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 mapcopyright : markdown [0..1]Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappingssource[x] : Element [0..1] « uri|canonical(ValueSet) »The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are madetarget[x] : Element [0..1] « uri|canonical(ValueSet) »GroupAn absolute URI that identifies the source system where the concepts to be mapped are definedsource : uri [0..1]The specific version of the code system, as determined by the code system authoritysourceVersion : string [0..1]An absolute URI that identifies the target system that the concepts will be mapped totarget : uri [0..1]The specific version of the code system, as determined by the code system authoritytargetVersion : string [0..1]SourceElementIdentity (code or path) or the element/item being mappedcode : code [0..1]The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]TargetElementIdentity (code or path) or the element/item that the map refers tocode : code [0..1]The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source) (this element modifies the meaning of other elements)equivalence : code [1..1] « The degree of equivalence between concepts. (Strength=Required)ConceptMapEquivalence! »A description of status/issues in mapping that conveys additional information not represented in the structured datacomment : string [0..1]OtherElementA reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system propertyproperty : uri [1..1]An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems)system : canonical [0..1] « CodeSystem »Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers tovalue : string [1..1]The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]UnmappedDefines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL)mode : code [1..1] « Defines which action to take if there is no match in the group. (Strength=Required)ConceptMapGroupUnmappedMode! »The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed codecode : code [0..1]The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concepturl : canonical [0..1] « ConceptMap »A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified valuedependsOn[0..*]A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied onproduct[0..*]A concept from the target value set that this concept maps totarget[0..*]Mappings for an individual concept in the source to one or more concepts in the targetelement[1..*]What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatchedunmapped[0..1]A group of mappings that all have the same source and target systemgroup[0..*]

XML Template

<ConceptMap xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this concept map, represented as a URI (globally unique) -->
 <identifier><!-- 0..1 Identifier Additional identifier for the concept map --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the concept map -->
 <name value="[string]"/><!-- 0..1 Name for this concept map (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this concept map (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the concept map -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for concept map (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this concept map is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <source[x]><!-- 0..1 uri|canonical(ValueSet) The source value set that contains the concepts that are being mapped --></source[x]>
 <target[x]><!-- 0..1 uri|canonical(ValueSet) The target value set which provides context for the mappings --></target[x]>
 <group>  <!-- 0..* Same source and target systems -->
  <source value="[uri]"/><!-- 0..1 Source system where concepts to be mapped are defined -->
  <sourceVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <target value="[uri]"/><!-- 0..1 Target system that the concepts are to be mapped to -->
  <targetVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <element>  <!-- 1..* Mappings for a concept from the source set -->
   <code value="[code]"/><!-- 0..1 Identifies element being mapped -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <target>  <!-- 0..* Concept in target system for element -->
    <code value="[code]"/><!-- 0..1 Code that identifies the target element -->
    <display value="[string]"/><!-- 0..1 Display for the code -->
    <equivalence value="[code]"/><!-- 1..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint -->
    <comment value="[string]"/><!-- ?? 0..1 Description of status/issues in mapping -->
    <dependsOn>  <!-- 0..* Other elements required for this mapping (from context) -->
     <property value="[uri]"/><!-- 1..1 Reference to property mapping depends on -->
     <system><!-- 0..1 canonical(CodeSystem) Code System (if necessary) --></system>
     <value value="[string]"/><!-- 1..1 Value of the referenced element -->
     <display value="[string]"/><!-- 0..1 Display for the code (if value is a code) -->
    </dependsOn>
    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other concepts that this mapping also produces --></product>
   </target>
  </element>
  <unmapped>  <!-- 0..1 What to do when there is no mapping for the source concept -->
   <mode value="[code]"/><!-- 1..1 provided | fixed | other-map -->
   <code value="[code]"/><!-- 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <url><!-- 0..1 canonical(ConceptMap) canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped --></url>
  </unmapped>
 </group>
</ConceptMap>

JSON Template

{doco
  "resourceType" : "ConceptMap",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this concept map, represented as a URI (globally unique)
  "identifier" : { Identifier }, // Additional identifier for the concept map
  "version" : "<string>", // Business version of the concept map
  "name" : "<string>", // Name for this concept map (computer friendly)
  "title" : "<string>", // Name for this concept map (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the concept map
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for concept map (if applicable)
  "purpose" : "<markdown>", // Why this concept map is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  // source[x]: The source value set that contains the concepts that are being mapped. One of these 2:
  "sourceUri" : "<uri>",
  "sourceCanonical" : { canonical(ValueSet) },
  // target[x]: The target value set which provides context for the mappings. One of these 2:
  "targetUri" : "<uri>",
  "targetCanonical" : { canonical(ValueSet) },
  "group" : [{ // Same source and target systems
    "source" : "<uri>", // Source system where concepts to be mapped are defined
    "sourceVersion" : "<string>", // Specific version of the  code system
    "target" : "<uri>", // Target system that the concepts are to be mapped to
    "targetVersion" : "<string>", // Specific version of the  code system
    "element" : [{ // R!  Mappings for a concept from the source set
      "code" : "<code>", // Identifies element being mapped
      "display" : "<string>", // Display for the code
      "target" : [{ // Concept in target system for element
        "code" : "<code>", // Code that identifies the target element
        "display" : "<string>", // Display for the code
        "equivalence" : "<code>", // R!  relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        "comment" : "<string>", // C? Description of status/issues in mapping
        "dependsOn" : [{ // Other elements required for this mapping (from context)
          "property" : "<uri>", // R!  Reference to property mapping depends on
          "system" : { canonical(CodeSystem) }, // Code System (if necessary)
          "value" : "<string>", // R!  Value of the referenced element
          "display" : "<string>" // Display for the code (if value is a code)
        }],
        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other concepts that this mapping also produces
      }]
    }],
    "unmapped" : { // What to do when there is no mapping for the source concept
      "mode" : "<code>", // R!  provided | fixed | other-map
      "code" : "<code>", // Fixed code when mode = fixed
      "display" : "<string>", // Display for the code
      "url" : { canonical(ConceptMap) } // canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
    }
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ConceptMap;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ConceptMap.url [ uri ]; # 0..1 Canonical identifier for this concept map, represented as a URI (globally unique)
  fhir:ConceptMap.identifier [ Identifier ]; # 0..1 Additional identifier for the concept map
  fhir:ConceptMap.version [ string ]; # 0..1 Business version of the concept map
  fhir:ConceptMap.name [ string ]; # 0..1 Name for this concept map (computer friendly)
  fhir:ConceptMap.title [ string ]; # 0..1 Name for this concept map (human friendly)
  fhir:ConceptMap.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ConceptMap.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ConceptMap.date [ dateTime ]; # 0..1 Date last changed
  fhir:ConceptMap.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ConceptMap.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ConceptMap.description [ markdown ]; # 0..1 Natural language description of the concept map
  fhir:ConceptMap.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ConceptMap.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for concept map (if applicable)
  fhir:ConceptMap.purpose [ markdown ]; # 0..1 Why this concept map is defined
  fhir:ConceptMap.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  # ConceptMap.source[x] : 0..1 The source value set that contains the concepts that are being mapped. One of these 2
    fhir:ConceptMap.sourceUri [ uri ]
    fhir:ConceptMap.sourceCanonical [ canonical(ValueSet) ]
  # ConceptMap.target[x] : 0..1 The target value set which provides context for the mappings. One of these 2
    fhir:ConceptMap.targetUri [ uri ]
    fhir:ConceptMap.targetCanonical [ canonical(ValueSet) ]
  fhir:ConceptMap.group [ # 0..* Same source and target systems
    fhir:ConceptMap.group.source [ uri ]; # 0..1 Source system where concepts to be mapped are defined
    fhir:ConceptMap.group.sourceVersion [ string ]; # 0..1 Specific version of the  code system
    fhir:ConceptMap.group.target [ uri ]; # 0..1 Target system that the concepts are to be mapped to
    fhir:ConceptMap.group.targetVersion [ string ]; # 0..1 Specific version of the  code system
    fhir:ConceptMap.group.element [ # 1..* Mappings for a concept from the source set
      fhir:ConceptMap.group.element.code [ code ]; # 0..1 Identifies element being mapped
      fhir:ConceptMap.group.element.display [ string ]; # 0..1 Display for the code
      fhir:ConceptMap.group.element.target [ # 0..* Concept in target system for element
        fhir:ConceptMap.group.element.target.code [ code ]; # 0..1 Code that identifies the target element
        fhir:ConceptMap.group.element.target.display [ string ]; # 0..1 Display for the code
        fhir:ConceptMap.group.element.target.equivalence [ code ]; # 1..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        fhir:ConceptMap.group.element.target.comment [ string ]; # 0..1 Description of status/issues in mapping
        fhir:ConceptMap.group.element.target.dependsOn [ # 0..* Other elements required for this mapping (from context)
          fhir:ConceptMap.group.element.target.dependsOn.property [ uri ]; # 1..1 Reference to property mapping depends on
          fhir:ConceptMap.group.element.target.dependsOn.system [ canonical(CodeSystem) ]; # 0..1 Code System (if necessary)
          fhir:ConceptMap.group.element.target.dependsOn.value [ string ]; # 1..1 Value of the referenced element
          fhir:ConceptMap.group.element.target.dependsOn.display [ string ]; # 0..1 Display for the code (if value is a code)
        ], ...;
        fhir:ConceptMap.group.element.target.product [ See ConceptMap.group.element.target.dependsOn ], ... ; # 0..* Other concepts that this mapping also produces
      ], ...;
    ], ...;
    fhir:ConceptMap.group.unmapped [ # 0..1 What to do when there is no mapping for the source concept
      fhir:ConceptMap.group.unmapped.mode [ code ]; # 1..1 provided | fixed | other-map
      fhir:ConceptMap.group.unmapped.code [ code ]; # 0..1 Fixed code when mode = fixed
      fhir:ConceptMap.group.unmapped.display [ string ]; # 0..1 Display for the code
      fhir:ConceptMap.group.unmapped.url [ canonical(ConceptMap) ]; # 0..1 canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
    ];
  ], ...;
]

Changes since R3

ConceptMap
ConceptMap.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.1.0
ConceptMap.group.element.target.equivalence
  • Change value set from http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.0 to http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.1.0
ConceptMap.group.unmapped.mode
  • Change value set from http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.0 to http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 4 tests that all execute ok. All tests pass round-trip testing and 4 r3 resources are invalid (0 errors).)

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap TUDomainResourceA map from one set of concepts to one or more other concepts
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... url Σ0..1uriCanonical identifier for this concept map, represented as a URI (globally unique)
... identifier Σ0..1IdentifierAdditional identifier for the concept map
... version Σ0..1stringBusiness version of the concept map
... title Σ0..1stringName for this concept map (human friendly)
... status ?!Σ1..1codedraft | active | retired | unknown
PublicationStatus (Required)
... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description 0..1markdownNatural language description of the concept map
... useContext Σ0..*UsageContextThe context that the content is intended to support
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
Jurisdiction (Extensible)
... purpose 0..1markdownWhy this concept map is defined
... copyright 0..1markdownUse and/or publishing restrictions
... source[x] Σ0..1The source value set that contains the concepts that are being mapped
.... sourceUriuri
.... sourceCanonicalcanonical(ValueSet)
... target[x] Σ0..1The target value set which provides context for the mappings
.... targetUriuri
.... targetCanonicalcanonical(ValueSet)
... group 0..*BackboneElementSame source and target systems
.... source 0..1uriSource system where concepts to be mapped are defined
.... sourceVersion 0..1stringSpecific version of the code system
.... target 0..1uriTarget system that the concepts are to be mapped to
.... targetVersion 0..1stringSpecific version of the code system
.... element 1..*BackboneElementMappings for a concept from the source set
..... code 0..1codeIdentifies element being mapped
..... display 0..1stringDisplay for the code
..... target I0..*BackboneElementConcept in target system for element
+ Rule: If the map is narrower or inexact, there SHALL be some comments
...... code 0..1codeCode that identifies the target element
...... display 0..1stringDisplay for the code
...... equivalence ?!1..1coderelatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence (Required)
...... comment I0..1stringDescription of status/issues in mapping
...... dependsOn 0..*BackboneElementOther elements required for this mapping (from context)
....... property 1..1uriReference to property mapping depends on
....... system 0..1canonical(CodeSystem)Code System (if necessary)
....... value 1..1stringValue of the referenced element
....... display 0..1stringDisplay for the code (if value is a code)
...... product 0..*see dependsOnOther concepts that this mapping also produces
.... unmapped I0..1BackboneElementWhat to do when there is no mapping for the source concept
+ Rule: If the mode is 'fixed', a code must be provided
+ Rule: If the mode is 'other-map', a url must be provided
..... mode 1..1codeprovided | fixed | other-map
ConceptMapGroupUnmappedMode (Required)
..... code 0..1codeFixed code when mode = fixed
..... display 0..1stringDisplay for the code
..... url 0..1canonical(ConceptMap)canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped

doco Documentation for this format

UML Diagram (Legend)

ConceptMap (DomainResource)An absolute URI that is used to identify this concept map when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this concept map is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the concept map is stored on different serversurl : uri [0..1]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 instanceidentifier : Identifier [0..1]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 sequenceversion : string [0..1]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 generationname : string [0..1]A short, descriptive, user-friendly title for the concept maptitle : string [0..1]The status of this concept map. Enables tracking the life-cycle of the content (this element modifies the meaning of other elements)status : code [1..1] « The lifecycle status of an artifact. (Strength=Required)PublicationStatus! »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 usageexperimental : boolean [0..1]The date (and optionally time) when the concept map was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changesdate : dateTime [0..1]The name of the organization or individual that published the concept mappublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]A free text natural language description of the concept map from a consumer's perspectivedescription : markdown [0..1]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 instancesuseContext : UsageContext [0..*]A legal or geographic region in which the concept map is intended to be usedjurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible)Jurisdiction ValueSet+ »Explanation of why this concept map is needed and why it has been designed as it haspurpose : markdown [0..1]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 mapcopyright : markdown [0..1]Identifier for the source value set that contains the concepts that are being mapped and provides context for the mappingssource[x] : Element [0..1] « uri|canonical(ValueSet) »The target value set provides context for the mappings. Note that the mapping is made between concepts, not between value sets, but the value set provides important context about how the concept mapping choices are madetarget[x] : Element [0..1] « uri|canonical(ValueSet) »GroupAn absolute URI that identifies the source system where the concepts to be mapped are definedsource : uri [0..1]The specific version of the code system, as determined by the code system authoritysourceVersion : string [0..1]An absolute URI that identifies the target system that the concepts will be mapped totarget : uri [0..1]The specific version of the code system, as determined by the code system authoritytargetVersion : string [0..1]SourceElementIdentity (code or path) or the element/item being mappedcode : code [0..1]The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]TargetElementIdentity (code or path) or the element/item that the map refers tocode : code [0..1]The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]The equivalence between the source and target concepts (counting for the dependencies and products). The equivalence is read from target to source (e.g. the target is 'wider' than the source) (this element modifies the meaning of other elements)equivalence : code [1..1] « The degree of equivalence between concepts. (Strength=Required)ConceptMapEquivalence! »A description of status/issues in mapping that conveys additional information not represented in the structured datacomment : string [0..1]OtherElementA reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somewhere that is labeled to correspond with a code system propertyproperty : uri [1..1]An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems)system : canonical [0..1] « CodeSystem »Identity (code or path) or the element/item/ValueSet/text that the map depends on / refers tovalue : string [1..1]The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]UnmappedDefines which action to take if there is no match for the source concept in the target system designated for the group. One of 3 actions are possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL)mode : code [1..1] « Defines which action to take if there is no match in the group. (Strength=Required)ConceptMapGroupUnmappedMode! »The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed codecode : code [0..1]The display for the code. The display is only provided to help editors when editing the concept mapdisplay : string [0..1]The canonical reference to an additional ConceptMap resource instance to use for mapping if this ConceptMap resource contains no matching mapping for the source concepturl : canonical [0..1] « ConceptMap »A set of additional dependencies for this mapping to hold. This mapping is only applicable if the specified element can be resolved, and it has the specified valuedependsOn[0..*]A set of additional outcomes from this mapping to other elements. To properly execute this mapping, the specified element must be mapped to some data element or source that is in context. The mapping may still be useful without a place for the additional data elements, but the equivalence cannot be relied onproduct[0..*]A concept from the target value set that this concept maps totarget[0..*]Mappings for an individual concept in the source to one or more concepts in the targetelement[1..*]What to do when there is no mapping for the source concept. "Unmapped" does not include codes that are unmatched, and the unmapped element is ignored in a code is specified to have equivalence = unmatchedunmapped[0..1]A group of mappings that all have the same source and target systemgroup[0..*]

XML Template

<ConceptMap xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <url value="[uri]"/><!-- 0..1 Canonical identifier for this concept map, represented as a URI (globally unique) -->
 <identifier><!-- 0..1 Identifier Additional identifier for the concept map --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the concept map -->
 <name value="[string]"/><!-- 0..1 Name for this concept map (computer friendly) -->
 <title value="[string]"/><!-- 0..1 Name for this concept map (human friendly) -->
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the concept map -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for concept map (if applicable) --></jurisdiction>
 <purpose value="[markdown]"/><!-- 0..1 Why this concept map is defined -->
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <source[x]><!-- 0..1 uri|canonical(ValueSet) The source value set that contains the concepts that are being mapped --></source[x]>
 <target[x]><!-- 0..1 uri|canonical(ValueSet) The target value set which provides context for the mappings --></target[x]>
 <group>  <!-- 0..* Same source and target systems -->
  <source value="[uri]"/><!-- 0..1 Source system where concepts to be mapped are defined -->
  <sourceVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <target value="[uri]"/><!-- 0..1 Target system that the concepts are to be mapped to -->
  <targetVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <element>  <!-- 1..* Mappings for a concept from the source set -->
   <code value="[code]"/><!-- 0..1 Identifies element being mapped -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <target>  <!-- 0..* Concept in target system for element -->
    <code value="[code]"/><!-- 0..1 Code that identifies the target element -->
    <display value="[string]"/><!-- 0..1 Display for the code -->
    <equivalence value="[code]"/><!-- 1..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint -->
    <comment value="[string]"/><!-- ?? 0..1 Description of status/issues in mapping -->
    <dependsOn>  <!-- 0..* Other elements required for this mapping (from context) -->
     <property value="[uri]"/><!-- 1..1 Reference to property mapping depends on -->
     <system><!-- 0..1 canonical(CodeSystem) Code System (if necessary) --></system>
     <value value="[string]"/><!-- 1..1 Value of the referenced element -->
     <display value="[string]"/><!-- 0..1 Display for the code (if value is a code) -->
    </dependsOn>
    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other concepts that this mapping also produces --></product>
   </target>
  </element>
  <unmapped>  <!-- 0..1 What to do when there is no mapping for the source concept -->
   <mode value="[code]"/><!-- 1..1 provided | fixed | other-map -->
   <code value="[code]"/><!-- 0..1 Fixed code when mode = fixed -->
   <display value="[string]"/><!-- 0..1 Display for the code -->
   <url><!-- 0..1 canonical(ConceptMap) canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped --></url>
  </unmapped>
 </group>
</ConceptMap>

JSON Template

{doco
  "resourceType" : "ConceptMap",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Canonical identifier for this concept map, represented as a URI (globally unique)
  "identifier" : { Identifier }, // Additional identifier for the concept map
  "version" : "<string>", // Business version of the concept map
  "name" : "<string>", // Name for this concept map (computer friendly)
  "title" : "<string>", // Name for this concept map (human friendly)
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the concept map
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for concept map (if applicable)
  "purpose" : "<markdown>", // Why this concept map is defined
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  // source[x]: The source value set that contains the concepts that are being mapped. One of these 2:
  "sourceUri" : "<uri>",
  "sourceCanonical" : { canonical(ValueSet) },
  // target[x]: The target value set which provides context for the mappings. One of these 2:
  "targetUri" : "<uri>",
  "targetCanonical" : { canonical(ValueSet) },
  "group" : [{ // Same source and target systems
    "source" : "<uri>", // Source system where concepts to be mapped are defined
    "sourceVersion" : "<string>", // Specific version of the  code system
    "target" : "<uri>", // Target system that the concepts are to be mapped to
    "targetVersion" : "<string>", // Specific version of the  code system
    "element" : [{ // R!  Mappings for a concept from the source set
      "code" : "<code>", // Identifies element being mapped
      "display" : "<string>", // Display for the code
      "target" : [{ // Concept in target system for element
        "code" : "<code>", // Code that identifies the target element
        "display" : "<string>", // Display for the code
        "equivalence" : "<code>", // R!  relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        "comment" : "<string>", // C? Description of status/issues in mapping
        "dependsOn" : [{ // Other elements required for this mapping (from context)
          "property" : "<uri>", // R!  Reference to property mapping depends on
          "system" : { canonical(CodeSystem) }, // Code System (if necessary)
          "value" : "<string>", // R!  Value of the referenced element
          "display" : "<string>" // Display for the code (if value is a code)
        }],
        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other concepts that this mapping also produces
      }]
    }],
    "unmapped" : { // What to do when there is no mapping for the source concept
      "mode" : "<code>", // R!  provided | fixed | other-map
      "code" : "<code>", // Fixed code when mode = fixed
      "display" : "<string>", // Display for the code
      "url" : { canonical(ConceptMap) } // canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
    }
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco


[ a fhir:ConceptMap;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root

  # from Resource: .id, .meta, .implicitRules, and .language
  # from DomainResource: .text, .contained, .extension, and .modifierExtension
  fhir:ConceptMap.url [ uri ]; # 0..1 Canonical identifier for this concept map, represented as a URI (globally unique)
  fhir:ConceptMap.identifier [ Identifier ]; # 0..1 Additional identifier for the concept map
  fhir:ConceptMap.version [ string ]; # 0..1 Business version of the concept map
  fhir:ConceptMap.name [ string ]; # 0..1 Name for this concept map (computer friendly)
  fhir:ConceptMap.title [ string ]; # 0..1 Name for this concept map (human friendly)
  fhir:ConceptMap.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ConceptMap.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ConceptMap.date [ dateTime ]; # 0..1 Date last changed
  fhir:ConceptMap.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ConceptMap.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ConceptMap.description [ markdown ]; # 0..1 Natural language description of the concept map
  fhir:ConceptMap.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ConceptMap.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for concept map (if applicable)
  fhir:ConceptMap.purpose [ markdown ]; # 0..1 Why this concept map is defined
  fhir:ConceptMap.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  # ConceptMap.source[x] : 0..1 The source value set that contains the concepts that are being mapped. One of these 2
    fhir:ConceptMap.sourceUri [ uri ]
    fhir:ConceptMap.sourceCanonical [ canonical(ValueSet) ]
  # ConceptMap.target[x] : 0..1 The target value set which provides context for the mappings. One of these 2
    fhir:ConceptMap.targetUri [ uri ]
    fhir:ConceptMap.targetCanonical [ canonical(ValueSet) ]
  fhir:ConceptMap.group [ # 0..* Same source and target systems
    fhir:ConceptMap.group.source [ uri ]; # 0..1 Source system where concepts to be mapped are defined
    fhir:ConceptMap.group.sourceVersion [ string ]; # 0..1 Specific version of the  code system
    fhir:ConceptMap.group.target [ uri ]; # 0..1 Target system that the concepts are to be mapped to
    fhir:ConceptMap.group.targetVersion [ string ]; # 0..1 Specific version of the  code system
    fhir:ConceptMap.group.element [ # 1..* Mappings for a concept from the source set
      fhir:ConceptMap.group.element.code [ code ]; # 0..1 Identifies element being mapped
      fhir:ConceptMap.group.element.display [ string ]; # 0..1 Display for the code
      fhir:ConceptMap.group.element.target [ # 0..* Concept in target system for element
        fhir:ConceptMap.group.element.target.code [ code ]; # 0..1 Code that identifies the target element
        fhir:ConceptMap.group.element.target.display [ string ]; # 0..1 Display for the code
        fhir:ConceptMap.group.element.target.equivalence [ code ]; # 1..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        fhir:ConceptMap.group.element.target.comment [ string ]; # 0..1 Description of status/issues in mapping
        fhir:ConceptMap.group.element.target.dependsOn [ # 0..* Other elements required for this mapping (from context)
          fhir:ConceptMap.group.element.target.dependsOn.property [ uri ]; # 1..1 Reference to property mapping depends on
          fhir:ConceptMap.group.element.target.dependsOn.system [ canonical(CodeSystem) ]; # 0..1 Code System (if necessary)
          fhir:ConceptMap.group.element.target.dependsOn.value [ string ]; # 1..1 Value of the referenced element
          fhir:ConceptMap.group.element.target.dependsOn.display [ string ]; # 0..1 Display for the code (if value is a code)
        ], ...;
        fhir:ConceptMap.group.element.target.product [ See ConceptMap.group.element.target.dependsOn ], ... ; # 0..* Other concepts that this mapping also produces
      ], ...;
    ], ...;
    fhir:ConceptMap.group.unmapped [ # 0..1 What to do when there is no mapping for the source concept
      fhir:ConceptMap.group.unmapped.mode [ code ]; # 1..1 provided | fixed | other-map
      fhir:ConceptMap.group.unmapped.code [ code ]; # 0..1 Fixed code when mode = fixed
      fhir:ConceptMap.group.unmapped.display [ string ]; # 0..1 Display for the code
      fhir:ConceptMap.group.unmapped.url [ canonical(ConceptMap) ]; # 0..1 canonical reference to an additional ConceptMap to use for mapping if the source concept is unmapped
    ];
  ], ...;
]

Changes since Release 3

ConceptMap
ConceptMap.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.1.0
ConceptMap.group.element.target.equivalence
  • Change value set from http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.0.0 to http://hl7.org/fhir/ValueSet/concept-map-equivalence|4.1.0
ConceptMap.group.unmapped.mode
  • Change value set from http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.0.0 to http://hl7.org/fhir/ValueSet/conceptmap-unmapped-mode|4.1.0

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 4 tests that all execute ok. All tests pass round-trip testing and 4 r3 resources are invalid (0 errors).)

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

4.10.5.1 Terminology Bindings

PathDefinitionTypeReference
ConceptMap.status The lifecycle status of an artifact.RequiredPublicationStatus
ConceptMap.jurisdiction Countries and regions within which this artifact is targeted for use.ExtensibleJurisdiction ValueSet
ConceptMap.group.element.target.equivalence The degree of equivalence between concepts.RequiredConceptMapEquivalence
ConceptMap.group.unmapped.mode Defines which action to take if there is no match in the group.RequiredConceptMapGroupUnmappedMode

4.10.5.2 Constraints

idLevelLocationDescriptionExpression
cmd-0Warning (base)Name should be usable as an identifier for the module by machine processing applications such as code generationname.matches('[A-Z]([A-Za-z0-9_]){0,254}')
cmd-1Rule ConceptMap.group.element.targetIf the map is narrower or inexact, there SHALL be some commentscomment.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
cmd-2Rule ConceptMap.group.unmappedIf the mode is 'fixed', a code must be provided(mode = 'fixed') implies code.exists()
cmd-3Rule ConceptMap.group.unmappedIf the mode is 'other-map', a url must be provided(mode = 'other-map') implies url.exists()

4.10.6 Notes

  • The value of the system, version and code elements are the same as used by the Coding data type
  • When a mapping equivalence is characterized as "narrower", some explanation of the scope difference SHALL be provided in the comments
  • The concept map is a statement of mapping in a single direction. The existence of a matching mapping in the reverse direction cannot be assumed to exist automatically, but only through human review.
  • For simplicity, it is better if is only one element for each source concept. if there is more than one, then just as one element can have multiple targets, multiple occurrences of element with the same element.code simply aggregate their target elements as if there was only one element

4.10.7 Grouping Mappings

The concept mappings in element are arranged into groups that share common source/target systems. These groups have no semantic significance; they exist to make the representation more concise. Concept maps may contain more than one group with the same source and target - this would be a less concise representation but may be useful in order to maintain a fixed order for the concepts that are mapped.

Concepts that are labeled as 'unmatched' are considered to be unmatched in the target value set, irrespective of whether they are contained in a group with a stated target system or not. Groups that contain no target system may only contained 'unmatched' concepts. There is no difference in the meaning of an unmatched target whether or not there is a stated target system.

4.10.8 Mapping Dependencies

In the simple case, a mapping is made from one code to another. E.g. from "home address" in one code system to "address - home" in another. But in other cases, the mapping is not a simple one to one mapping. A typical example might be mapping between a radiology imaging request that has 2 elements: modality, and body site, and another radiology imaging request that pre-coordinates both of these into a single code modality+body site. In this case, it is not possible to map from one code to another. Instead, the mapping might contain entries like this:

Source ConceptDependsOn.propertyDependsOn ConceptTarget Concept
X-RayBodysiteChestChest-XRay

When attempting to translate the source to the target, an application must also provide a value for the element identified in dependsOn.property so that the correct mapping can be performed. To support the reverse operation, product is the converse, and works in reverse.

To see a real example of a mapping with dependencies, check the Specimen Type Mapping.

4.10.9 Handling Unmapped Codes

If there is no explicit mapping for a code - that is, the engine processing the ConceptMap finds a group with a matching source system, but not matching element for the code it is translating, processing proceeds to the unmapped element that specifies what should happen.

The unmapped element can specify one of the following different actions to take if there is no mapping for a concept:

providedUse the code source as provided in the $translate request. This is especially useful for translations between versions of the same code system, where only a few codes have changed
fixedUse the code (and display) explicitly provided in the group.unmapped. This is useful when there's a fall back general code - especially for classifications
other-mapUse the map identified by the canonical URL in url. This is useful when a published concept map needs to be varied for a few specific cases on an institutional bass - the institution can create a simple concept that expresses their special cases, and then refer to the general purpose mappings

Note that this element is not used when there is an element with a matching code value, and an equivalence value of unmatched (or disjoint).

4.10.10 Implicit Code Systems

The ConceptMap resource is intended to map between concepts defined in a code system. It can also be useful to use the ConceptMap resource to define relationships between concepts defined in other kinds of resources. Here are some common kind of conceptual maps:

Though these resources are not explicitly defining code systems, they do define 'concept's that can still usefully be treated as code systems for the sake of subsetting (e.g. ValueSet) and defining relationships (e.g. ConceptMap). See Implicit Code Systems for further information.

Note that this is different from StructureMap because that is intended to define an executional transform between structures, not a conceptual model.

4.10.11 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

NameTypeDescriptionExpressionIn Common
contexttokenA use context assigned to the concept map(ConceptMap.useContext.value as CodeableConcept)
context-quantityquantityA quantity- or range-valued use context assigned to the concept map(ConceptMap.useContext.value as Quantity) | (ConceptMap.useContext.value as Range)
context-typetokenA type of use context assigned to the concept mapConceptMap.useContext.code
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the concept mapOn ConceptMap.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-valuecompositeA use context type and value assigned to the concept mapOn ConceptMap.useContext:
  context-type: code
  context: value.as(CodeableConcept)
datedateThe concept map publication dateConceptMap.date
dependsonuriReference to property mapping depends onConceptMap.group.element.target.dependsOn.property
descriptionstringThe description of the concept mapConceptMap.description
identifiertokenExternal identifier for the concept mapConceptMap.identifier
jurisdictiontokenIntended jurisdiction for the concept mapConceptMap.jurisdiction
namestringComputationally friendly name of the concept mapConceptMap.name
otherreferencecanonical reference to an additional ConceptMap to use for mapping if the source concept is unmappedConceptMap.group.unmapped.url
(ConceptMap)
producturiReference to property mapping depends onConceptMap.group.element.target.product.property
publisherstringName of the publisher of the concept mapConceptMap.publisher
sourcereferenceThe source value set that contains the concepts that are being mapped(ConceptMap.source as canonical)
(ValueSet)
source-codetokenIdentifies element being mappedConceptMap.group.element.code
source-systemuriSource system where concepts to be mapped are definedConceptMap.group.source
source-urireferenceThe source value set that contains the concepts that are being mapped(ConceptMap.source as uri)
(ValueSet)
statustokenThe current status of the concept mapConceptMap.status
targetreferenceThe target value set which provides context for the mappings(ConceptMap.target as canonical)
(ValueSet)
target-codetokenCode that identifies the target elementConceptMap.group.element.target.code
target-systemuriTarget system that the concepts are to be mapped toConceptMap.group.target
target-urireferenceThe target value set which provides context for the mappings(ConceptMap.target as uri)
(ValueSet)
titlestringThe human-friendly name of the concept mapConceptMap.title
urluriThe uri that identifies the concept mapConceptMap.url
versiontokenThe business version of the concept mapConceptMap.version