STU3 Candidate

This page is part of the FHIR Specification (v1.8.0: STU 3 Draft). 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: 2Compartments: Not linked to any defined compartments

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

4.10.1 Scope and Usage

A concept map defines a mapping from a set of concepts defined in a code system to one or more concepts defined in other code systems. Mappings are one way - from the source to the destination. In many cases, the reverse mappings are valid, but this cannot be assumed to be the case.

Mappings between code systems are only defined in the context of the specified source and destination value sets - they are specific to a particular context of use. 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. Note that all code systems have value sets that include the entire code system, and these value sets can be used for mappings that are valid in all contexts.

Each mapping for a concept from source to target 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 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 may not have a target for each concept.

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 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 exectuable transform for instances that conform to a known structure.

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 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap DomainResourceA map from one set of concepts to one or more other concepts
... url Σ0..1uriLogical uri to reference this concept map (globally unique)
... identifier Σ0..1IdentifierAdditional identifier for the concept map
... version Σ0..1stringBusiness version of the concept map
... name Σ0..1stringName for this concept map (Computer friendly)
... title Σ0..1stringName for this concept map (Human friendly)
... status ?!Σ1..1codedraft | active | retired
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... date Σ0..1dateTimeDate this was last changed
... description 0..1markdownNatural language description of the concept map
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
Jurisdiction ValueSet (Extensible)
... purpose 0..1markdownWhy this concept map is defined
... copyright 0..1markdownUse and/or publishing restrictions
... source[x] Σ0..1Identifies the source of the concepts which are being mapped
.... sourceUriuri
.... sourceReferenceReference(ValueSet)
... target[x] Σ0..1Provides context to the mappings
.... targetUriuri
.... targetReferenceReference(ValueSet)
... group 0..*BackboneElementSame source and target systems
.... source 1..1uriCode System (if value set crosses code systems)
.... sourceVersion 0..1stringSpecific version of the code system
.... target 0..1uriSystem of the target (if necessary)
.... targetVersion 0..1stringSpecific version of the code system
.... element 1..*BackboneElementMappings for a concept from the source set
..... code 0..1codeIdentifies element being mapped
..... target I0..*BackboneElementConcept in target system for element
If the map is narrower or inexact, there SHALL be some comments
...... code 0..1codeCode that identifies the target element
...... equivalence ?!0..1coderelatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence (Required)
...... comments 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..1uriCode System (if necessary)
....... code 1..1stringValue of the referenced element
...... product 0..*see dependsOnOther concepts that this mapping also produces

doco Documentation for this format

UML Diagram (Legend)

ConceptMap (DomainResource)An absolute URL that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions)url : 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 are orderableversion : 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 a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A flag 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 (this element modifies the meaning of other elements)experimental : boolean [0..1]The name of the individual or organization that published the concept mappublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]The date (and optionally time) when the concept map was published. The date must change when the business version changes, if it does, 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]A free text natural language description of the concept map from the consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitionsuseContext : UsageContext [0..*]A jurisdiction 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+ »Explains 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]The source value set that specifies the concepts that are being mappedsource[x] : Type [0..1] « uri|Reference(ValueSet) »The target value set provides context to 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] : Type [0..1] « uri|Reference(ValueSet) »GroupAn absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system)source : uri [1..1]The specific version of the code system, as determined by the code system authoritysourceVersion : string [0..1]An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems)target : 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]TargetElementIdentity (code or path) or the element/item that the map refers tocode : code [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 [0..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 datacomments : 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 somwhere that is labelled 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 : uri [0..1]Identity (code or path) or the element/item/ValueSet that the map depends on / refers tocode : string [1..1]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..*]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 Logical uri to reference this concept map (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 -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <description value="[markdown]"/><!-- 0..1 Natural language description of the concept map -->
 <useContext><!-- 0..* UsageContext Content intends to support these contexts --></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|Reference(ValueSet) Identifies the source of the concepts which are being mapped --></source[x]>
 <target[x]><!-- 0..1 uri|Reference(ValueSet) Provides context to the mappings --></target[x]>
 <group>  <!-- 0..* Same source and target systems -->
  <source value="[uri]"/><!-- 1..1 Code System (if value set crosses code systems) -->
  <sourceVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <target value="[uri]"/><!-- 0..1 System of the target (if necessary) -->
  <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 -->
   <target>  <!-- 0..* Concept in target system for element -->
    <code value="[code]"/><!-- 0..1 Code that identifies the target element -->
    <equivalence value="[code]"/><!-- 0..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint -->
    <comments 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 value="[uri]"/><!-- 0..1 Code System (if necessary) -->
     <code value="[string]"/><!-- 1..1 Value of the referenced element -->
    </dependsOn>
    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other concepts that this mapping also produces --></product>
   </target>
  </element>
 </group>
</ConceptMap>

JSON Template

{doco
  "resourceType" : "ConceptMap",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical uri to reference this concept map (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
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "date" : "<dateTime>", // Date this was last changed
  "description" : "<markdown>", // Natural language description of the concept map
  "useContext" : [{ UsageContext }], // Content intends to support these contexts
  "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]: Identifies the source of the concepts which are being mapped. One of these 2:
  "sourceUri" : "<uri>",
  "sourceReference" : { Reference(ValueSet) },
  // target[x]: Provides context to the mappings. One of these 2:
  "targetUri" : "<uri>",
  "targetReference" : { Reference(ValueSet) },
  "group" : [{ // Same source and target systems
    "source" : "<uri>", // R!  Code System (if value set crosses code systems)
    "sourceVersion" : "<string>", // Specific version of the  code system
    "target" : "<uri>", // System of the target (if necessary)
    "targetVersion" : "<string>", // Specific version of the  code system
    "element" : [{ // R!  Mappings for a concept from the source set
      "code" : "<code>", // Identifies element being mapped
      "target" : [{ // Concept in target system for element
        "code" : "<code>", // Code that identifies the target element
        "equivalence" : "<code>", // relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        "comments" : "<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" : "<uri>", // Code System (if necessary)
          "code" : "<string>" // R!  Value of the referenced element
        }],
        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other concepts that this mapping also produces
      }]
    }]
  }]
}

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 Logical uri to reference this concept map (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
  fhir:ConceptMap.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  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.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ConceptMap.description [ markdown ]; # 0..1 Natural language description of the concept map
  fhir:ConceptMap.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  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 Identifies the source of the concepts which are being mapped. One of these 2
    fhir:ConceptMap.sourceUri [ uri ]
    fhir:ConceptMap.sourceReference [ Reference(ValueSet) ]
  # ConceptMap.target[x] : 0..1 Provides context to the mappings. One of these 2
    fhir:ConceptMap.targetUri [ uri ]
    fhir:ConceptMap.targetReference [ Reference(ValueSet) ]
  fhir:ConceptMap.group [ # 0..* Same source and target systems
    fhir:ConceptMap.group.source [ uri ]; # 1..1 Code System (if value set crosses code systems)
    fhir:ConceptMap.group.sourceVersion [ string ]; # 0..1 Specific version of the  code system
    fhir:ConceptMap.group.target [ uri ]; # 0..1 System of the target (if necessary)
    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.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.equivalence [ code ]; # 0..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        fhir:ConceptMap.group.element.target.comments [ 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 [ uri ]; # 0..1 Code System (if necessary)
          fhir:ConceptMap.group.element.target.dependsOn.code [ string ]; # 1..1 Value of the referenced element
        ], ...;
        fhir:ConceptMap.group.element.target.product [ See ConceptMap.group.element.target.dependsOn ], ... ; # 0..* Other concepts that this mapping also produces
      ], ...;
    ], ...;
  ], ...;
]

Changes since DSTU2

ConceptMap
ConceptMap.title added Element
ConceptMap.status Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status to http://hl7.org/fhir/ValueSet/publication-status
ConceptMap.experimental Now marked as Modifier
ConceptMap.contact Type changed from BackboneElement to ContactDetail
ConceptMap.description Type changed from string to markdown
ConceptMap.useContext Type changed from CodeableConcept to UsageContext
Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible)
ConceptMap.jurisdiction added Element
ConceptMap.purpose added Element
ConceptMap.copyright Type changed from string to markdown
ConceptMap.source[x] Min Cardinality changed from 1 to 0
Remove Reference(StructureDefinition)
ConceptMap.target[x] Min Cardinality changed from 1 to 0
Remove Reference(StructureDefinition)
ConceptMap.group added Element
ConceptMap.group.source added Element
ConceptMap.group.sourceVersion added Element
ConceptMap.group.target added Element
ConceptMap.group.targetVersion added Element
ConceptMap.group.element Min Cardinality changed from 0 to 1
ConceptMap.group.element.target.equivalence Min Cardinality changed from 1 to 0
Default Value "equivalent" added
ConceptMap.group.element.target.dependsOn.property added Element
ConceptMap.group.element.target.dependsOn.system added Element
ConceptMap.contact.name deleted
ConceptMap.contact.telecom deleted
ConceptMap.requirements deleted
ConceptMap.element.codeSystem deleted
ConceptMap.element.target.codeSystem deleted
ConceptMap.element.target.dependsOn.element deleted
ConceptMap.element.target.dependsOn.codeSystem deleted

See the Full Difference for further information

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. ConceptMap DomainResourceA map from one set of concepts to one or more other concepts
... url Σ0..1uriLogical uri to reference this concept map (globally unique)
... identifier Σ0..1IdentifierAdditional identifier for the concept map
... version Σ0..1stringBusiness version of the concept map
... name Σ0..1stringName for this concept map (Computer friendly)
... title Σ0..1stringName for this concept map (Human friendly)
... status ?!Σ1..1codedraft | active | retired
PublicationStatus (Required)
... experimental ?!Σ0..1booleanIf for testing purposes, not real usage
... publisher Σ0..1stringName of the publisher (Organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... date Σ0..1dateTimeDate this was last changed
... description 0..1markdownNatural language description of the concept map
... useContext Σ0..*UsageContextContent intends to support these contexts
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for concept map (if applicable)
Jurisdiction ValueSet (Extensible)
... purpose 0..1markdownWhy this concept map is defined
... copyright 0..1markdownUse and/or publishing restrictions
... source[x] Σ0..1Identifies the source of the concepts which are being mapped
.... sourceUriuri
.... sourceReferenceReference(ValueSet)
... target[x] Σ0..1Provides context to the mappings
.... targetUriuri
.... targetReferenceReference(ValueSet)
... group 0..*BackboneElementSame source and target systems
.... source 1..1uriCode System (if value set crosses code systems)
.... sourceVersion 0..1stringSpecific version of the code system
.... target 0..1uriSystem of the target (if necessary)
.... targetVersion 0..1stringSpecific version of the code system
.... element 1..*BackboneElementMappings for a concept from the source set
..... code 0..1codeIdentifies element being mapped
..... target I0..*BackboneElementConcept in target system for element
If the map is narrower or inexact, there SHALL be some comments
...... code 0..1codeCode that identifies the target element
...... equivalence ?!0..1coderelatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
ConceptMapEquivalence (Required)
...... comments 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..1uriCode System (if necessary)
....... code 1..1stringValue of the referenced element
...... product 0..*see dependsOnOther concepts that this mapping also produces

doco Documentation for this format

UML Diagram (Legend)

ConceptMap (DomainResource)An absolute URL that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published. The URL SHOULD include the major version of the concept map. For more information see [Technical and Business Versions](resource.html#versions)url : 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 are orderableversion : 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 a Value Set or Concept Map. (Strength=Required)PublicationStatus! »A flag 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 (this element modifies the meaning of other elements)experimental : boolean [0..1]The name of the individual or organization that published the concept mappublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishercontact : ContactDetail [0..*]The date (and optionally time) when the concept map was published. The date must change when the business version changes, if it does, 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]A free text natural language description of the concept map from the consumer's perspectivedescription : markdown [0..1]The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of code system definitionsuseContext : UsageContext [0..*]A jurisdiction 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+ »Explains 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]The source value set that specifies the concepts that are being mappedsource[x] : Type [0..1] « uri|Reference(ValueSet) »The target value set provides context to 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] : Type [0..1] « uri|Reference(ValueSet) »GroupAn absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system)source : uri [1..1]The specific version of the code system, as determined by the code system authoritysourceVersion : string [0..1]An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems)target : 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]TargetElementIdentity (code or path) or the element/item that the map refers tocode : code [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 [0..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 datacomments : 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 somwhere that is labelled 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 : uri [0..1]Identity (code or path) or the element/item/ValueSet that the map depends on / refers tocode : string [1..1]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..*]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 Logical uri to reference this concept map (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 -->
 <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (Organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <date value="[dateTime]"/><!-- 0..1 Date this was last changed -->
 <description value="[markdown]"/><!-- 0..1 Natural language description of the concept map -->
 <useContext><!-- 0..* UsageContext Content intends to support these contexts --></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|Reference(ValueSet) Identifies the source of the concepts which are being mapped --></source[x]>
 <target[x]><!-- 0..1 uri|Reference(ValueSet) Provides context to the mappings --></target[x]>
 <group>  <!-- 0..* Same source and target systems -->
  <source value="[uri]"/><!-- 1..1 Code System (if value set crosses code systems) -->
  <sourceVersion value="[string]"/><!-- 0..1 Specific version of the  code system -->
  <target value="[uri]"/><!-- 0..1 System of the target (if necessary) -->
  <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 -->
   <target>  <!-- 0..* Concept in target system for element -->
    <code value="[code]"/><!-- 0..1 Code that identifies the target element -->
    <equivalence value="[code]"/><!-- 0..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint -->
    <comments 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 value="[uri]"/><!-- 0..1 Code System (if necessary) -->
     <code value="[string]"/><!-- 1..1 Value of the referenced element -->
    </dependsOn>
    <product><!-- 0..* Content as for ConceptMap.group.element.target.dependsOn Other concepts that this mapping also produces --></product>
   </target>
  </element>
 </group>
</ConceptMap>

JSON Template

{doco
  "resourceType" : "ConceptMap",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "url" : "<uri>", // Logical uri to reference this concept map (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
  "experimental" : <boolean>, // If for testing purposes, not real usage
  "publisher" : "<string>", // Name of the publisher (Organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "date" : "<dateTime>", // Date this was last changed
  "description" : "<markdown>", // Natural language description of the concept map
  "useContext" : [{ UsageContext }], // Content intends to support these contexts
  "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]: Identifies the source of the concepts which are being mapped. One of these 2:
  "sourceUri" : "<uri>",
  "sourceReference" : { Reference(ValueSet) },
  // target[x]: Provides context to the mappings. One of these 2:
  "targetUri" : "<uri>",
  "targetReference" : { Reference(ValueSet) },
  "group" : [{ // Same source and target systems
    "source" : "<uri>", // R!  Code System (if value set crosses code systems)
    "sourceVersion" : "<string>", // Specific version of the  code system
    "target" : "<uri>", // System of the target (if necessary)
    "targetVersion" : "<string>", // Specific version of the  code system
    "element" : [{ // R!  Mappings for a concept from the source set
      "code" : "<code>", // Identifies element being mapped
      "target" : [{ // Concept in target system for element
        "code" : "<code>", // Code that identifies the target element
        "equivalence" : "<code>", // relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        "comments" : "<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" : "<uri>", // Code System (if necessary)
          "code" : "<string>" // R!  Value of the referenced element
        }],
        "product" : [{ Content as for ConceptMap.group.element.target.dependsOn }] // Other concepts that this mapping also produces
      }]
    }]
  }]
}

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 Logical uri to reference this concept map (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
  fhir:ConceptMap.experimental [ boolean ]; # 0..1 If for testing purposes, not real usage
  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.date [ dateTime ]; # 0..1 Date this was last changed
  fhir:ConceptMap.description [ markdown ]; # 0..1 Natural language description of the concept map
  fhir:ConceptMap.useContext [ UsageContext ], ... ; # 0..* Content intends to support these contexts
  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 Identifies the source of the concepts which are being mapped. One of these 2
    fhir:ConceptMap.sourceUri [ uri ]
    fhir:ConceptMap.sourceReference [ Reference(ValueSet) ]
  # ConceptMap.target[x] : 0..1 Provides context to the mappings. One of these 2
    fhir:ConceptMap.targetUri [ uri ]
    fhir:ConceptMap.targetReference [ Reference(ValueSet) ]
  fhir:ConceptMap.group [ # 0..* Same source and target systems
    fhir:ConceptMap.group.source [ uri ]; # 1..1 Code System (if value set crosses code systems)
    fhir:ConceptMap.group.sourceVersion [ string ]; # 0..1 Specific version of the  code system
    fhir:ConceptMap.group.target [ uri ]; # 0..1 System of the target (if necessary)
    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.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.equivalence [ code ]; # 0..1 relatedto | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint
        fhir:ConceptMap.group.element.target.comments [ 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 [ uri ]; # 0..1 Code System (if necessary)
          fhir:ConceptMap.group.element.target.dependsOn.code [ string ]; # 1..1 Value of the referenced element
        ], ...;
        fhir:ConceptMap.group.element.target.product [ See ConceptMap.group.element.target.dependsOn ], ... ; # 0..* Other concepts that this mapping also produces
      ], ...;
    ], ...;
  ], ...;
]

Changes since DSTU2

ConceptMap
ConceptMap.title added Element
ConceptMap.status Change value set from http://hl7.org/fhir/ValueSet/conformance-resource-status to http://hl7.org/fhir/ValueSet/publication-status
ConceptMap.experimental Now marked as Modifier
ConceptMap.contact Type changed from BackboneElement to ContactDetail
ConceptMap.description Type changed from string to markdown
ConceptMap.useContext Type changed from CodeableConcept to UsageContext
Remove Binding http://hl7.org/fhir/ValueSet/use-context (extensible)
ConceptMap.jurisdiction added Element
ConceptMap.purpose added Element
ConceptMap.copyright Type changed from string to markdown
ConceptMap.source[x] Min Cardinality changed from 1 to 0
Remove Reference(StructureDefinition)
ConceptMap.target[x] Min Cardinality changed from 1 to 0
Remove Reference(StructureDefinition)
ConceptMap.group added Element
ConceptMap.group.source added Element
ConceptMap.group.sourceVersion added Element
ConceptMap.group.target added Element
ConceptMap.group.targetVersion added Element
ConceptMap.group.element Min Cardinality changed from 0 to 1
ConceptMap.group.element.target.equivalence Min Cardinality changed from 1 to 0
Default Value "equivalent" added
ConceptMap.group.element.target.dependsOn.property added Element
ConceptMap.group.element.target.dependsOn.system added Element
ConceptMap.contact.name deleted
ConceptMap.contact.telecom deleted
ConceptMap.requirements deleted
ConceptMap.element.codeSystem deleted
ConceptMap.element.target.codeSystem deleted
ConceptMap.element.target.dependsOn.element deleted
ConceptMap.element.target.dependsOn.codeSystem deleted

See the Full Difference for further information

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle), JSON-LD (for RDF as JSON-LD),

4.10.4.1 Terminology Bindings

PathDefinitionTypeReference
ConceptMap.status The lifecycle status of a Value Set or Concept Map.RequiredPublicationStatus
ConceptMap.jurisdiction Countries and regions within which this artifact is targeted for useExtensibleJurisdiction ValueSet
ConceptMap.group.element.target.equivalence The degree of equivalence between concepts.RequiredConceptMapEquivalence

4.10.4.2 Constraints

  • cmd-1: On ConceptMap.group.element.target: If the map is narrower or inexact, there SHALL be some comments (expression on ConceptMap.group.element.target: comments.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact')))

4.10.5 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.
  • There should be only one element for each source concept. If there is more than one, the target statements are cumulative across them

4.10.6 Grouping Mappings

The concept mappings in element are arranged into groups that share common source/target systems. These groups have no semantic signficance; 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 labelled 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.7 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). Note that this is different from StructureMap because that is intended to define an executional transform between structures, not a conceptual model.

This table summarizes how to treat these items as a terminology:

StructureDefinition The StructureDefinition.url (canonical URL) is the system. Each .snapshot.element.id in the snapshot is a code in the code system
Questionnaire The Questionnaire.url (canonical URL) is the system. Each .item.linkId in the snapshot is a code in the code system. Items with no linkId cannot be addressed
DataElement The DataElement.url (canonical URL) is the system. Each .element.id in the snapshot is a code in the code system. Elements with no id cannot be addressed
Medication Medication resources are a bit different, since they don't have a canonical URL, and there are not multiple items in a resource. So to refer to a medication resource, the system is [base]/Medication, where base is the server address. The Logical Id of the resource is the code

4.10.8 Search Parameters

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

NameTypeDescriptionPathsIn Common
datedateThe concept map publication dateConceptMap.date
dependsonuriReference to property mapping depends onConceptMap.group.element.target.dependsOn.property
descriptionstringText search against the description of the concept mapConceptMap.description
identifiertokenExternal identifiers for the concept mapConceptMap.identifier
jurisdictiontokenIntended jurisdiction for concept mapConceptMap.jurisdiction
namestringName of the concept mapConceptMap.name
producturiReference to property mapping depends onConceptMap.group.element.target.product.property
publisherstringName of the publisher of the concept mapConceptMap.publisher
sourcereferenceIdentifies the source of the concepts which are being mappedConceptMap.sourceReference
(ValueSet)
source-codetokenIdentifies element being mappedConceptMap.group.element.code
source-systemuriCode System (if value set crosses code systems)ConceptMap.group.source
source-urireferenceIdentifies the source of the concepts which are being mappedConceptMap.sourceUri
(ValueSet)
statustokenThe current status of the concept mapConceptMap.status
targetreferenceProvides context to the mappingsConceptMap.targetReference
(ValueSet)
target-codetokenCode that identifies the target elementConceptMap.group.element.target.code
target-systemuriSystem of the target (if necessary)ConceptMap.group.target
target-urireferenceProvides context to the mappingsConceptMap.targetUri
(ValueSet)
titlestringText search against the title of the concept mapConceptMap.title
urluriThe uri that identifies the concept mapConceptMap.url
versiontokenThe version identifier of the concept mapConceptMap.version