This page is part of the FHIR Specification (v1.2.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
Vocabulary Work Group | Maturity Level: 2 | Compartments: 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.
A concept map defines a mapping from a concept defined in one system to one or more concepts defined in other 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:
There SHOULD be at least one target for each element, but some incomplete concept maps may not have a target for each concept.
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.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | DomainResource | A map from one set of concepts to one or more other concepts | ||
url | Σ | 0..1 | uri | Globally unique logical id for concept map |
identifier | Σ | 0..1 | Identifier | Additional identifier for the concept map |
version | Σ | 0..1 | string | Logical id for this version of the concept map |
name | Σ | 0..1 | string | Informal name for this concept map |
status | ?! Σ | 1..1 | code | draft | active | retired ConformanceResourceStatus (Required) |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | BackboneElement | Contact details of the publisher |
name | Σ | 0..1 | string | Name of a individual to contact |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or publisher |
date | Σ | 0..1 | dateTime | Date for given status |
description | Σ | 0..1 | string | Human language description of the concept map |
useContext | Σ | 0..* | CodeableConcept | Content intends to support these contexts Context of Use ValueSet (Extensible) |
requirements | 0..1 | string | Why needed | |
copyright | 0..1 | string | Use and/or publishing restrictions | |
source[x] | Σ | 1..1 | Identifies the source of the concepts which are being mapped | |
sourceUri | uri | |||
sourceReference | Reference(ValueSet | StructureDefinition) | |||
target[x] | Σ | 1..1 | Provides context to the mappings | |
targetUri | uri | |||
targetReference | Reference(ValueSet | StructureDefinition) | |||
element | 0..* | BackboneElement | Mappings for a concept from the source set | |
codeSystem | 0..1 | uri | Code System (if value set crosses code systems) | |
code | 0..1 | code | Identifies element being mapped | |
target | I | 0..* | BackboneElement | Concept in target system for element If the map is narrower or inexact, there SHALL be some comments |
codeSystem | 0..1 | uri | System of the target (if necessary) | |
code | 0..1 | code | Code that identifies the target element | |
equivalence | ?! | 1..1 | code | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint ConceptMapEquivalence (Required) |
comments | I | 0..1 | string | Description of status/issues in mapping |
dependsOn | 0..* | BackboneElement | Other elements required for this mapping (from context) | |
element | 1..1 | uri | Reference to element/field/ValueSet mapping depends on | |
codeSystem | 1..1 | uri | Code System (if necessary) | |
code | 1..1 | string | Value of the referenced element | |
product | 0..* | see dependsOn | Other concepts that this mapping also produces | |
Documentation for this format |
UML Diagram
XML Template
<ConceptMap xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Globally unique logical id for concept map --> <identifier><!-- 0..1 Identifier Additional identifier for the concept map --></identifier> <version value="[string]"/><!-- 0..1 Logical id for this version of the concept map --> <name value="[string]"/><!-- 0..1 Informal name for this concept map --> <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..* Contact details of the publisher --> <name value="[string]"/><!-- 0..1 Name of a individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact> <date value="[dateTime]"/><!-- 0..1 Date for given status --> <description value="[string]"/><!-- 0..1 Human language description of the concept map --> <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <requirements value="[string]"/><!-- 0..1 Why needed --> <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions --> <source[x]><!-- 1..1 uri|Reference(ValueSet|StructureDefinition) Identifies the source of the concepts which are being mapped --></source[x]> <target[x]><!-- 1..1 uri|Reference(ValueSet|StructureDefinition) Provides context to the mappings --></target[x]> <element> <!-- 0..* Mappings for a concept from the source set --> <codeSystem value="[uri]"/><!-- 0..1 Code System (if value set crosses code systems) --> <code value="[code]"/><!-- 0..1 Identifies element being mapped --> <target> <!-- 0..* Concept in target system for element --> <codeSystem value="[uri]"/><!-- 0..1 System of the target (if necessary) --> <code value="[code]"/><!-- 0..1 Code that identifies the target element --> <equivalence value="[code]"/><!-- 1..1 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) --> <element value="[uri]"/><!-- 1..1 Reference to element/field/ValueSet mapping depends on --> <codeSystem value="[uri]"/><!-- 1..1 Code System (if necessary) --> <code value="[string]"/><!-- 1..1 Value of the referenced element --> </dependsOn> <product><!-- 0..* Content as for ConceptMap.element.target.dependsOn Other concepts that this mapping also produces --></product> </target> </element> </ConceptMap>
JSON Template
{ "resourceType" : "ConceptMap", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Globally unique logical id for concept map "identifier" : { Identifier }, // Additional identifier for the concept map "version" : "<string>", // Logical id for this version of the concept map "name" : "<string>", // Informal name for this concept map "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" : [{ // Contact details of the publisher "name" : "<string>", // Name of a individual to contact "telecom" : [{ ContactPoint }] // Contact details for individual or publisher }], "date" : "<dateTime>", // Date for given status "description" : "<string>", // Human language description of the concept map "useContext" : [{ CodeableConcept }], // Content intends to support these contexts "requirements" : "<string>", // Why needed "copyright" : "<string>", // 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|StructureDefinition) }, // target[x]: Provides context to the mappings. One of these 2: "targetUri" : "<uri>", "targetReference" : { Reference(ValueSet|StructureDefinition) }, "element" : [{ // Mappings for a concept from the source set "codeSystem" : "<uri>", // Code System (if value set crosses code systems) "code" : "<code>", // Identifies element being mapped "target" : [{ // Concept in target system for element "codeSystem" : "<uri>", // System of the target (if necessary) "code" : "<code>", // Code that identifies the target element "equivalence" : "<code>", // R! 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) "element" : "<uri>", // R! Reference to element/field/ValueSet mapping depends on "codeSystem" : "<uri>", // R! Code System (if necessary) "code" : "<string>" // R! Value of the referenced element }], "product" : [{ Content as for ConceptMap.element.target.dependsOn }] // Other concepts that this mapping also produces }] }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | DomainResource | A map from one set of concepts to one or more other concepts | ||
url | Σ | 0..1 | uri | Globally unique logical id for concept map |
identifier | Σ | 0..1 | Identifier | Additional identifier for the concept map |
version | Σ | 0..1 | string | Logical id for this version of the concept map |
name | Σ | 0..1 | string | Informal name for this concept map |
status | ?! Σ | 1..1 | code | draft | active | retired ConformanceResourceStatus (Required) |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
publisher | Σ | 0..1 | string | Name of the publisher (organization or individual) |
contact | Σ | 0..* | BackboneElement | Contact details of the publisher |
name | Σ | 0..1 | string | Name of a individual to contact |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or publisher |
date | Σ | 0..1 | dateTime | Date for given status |
description | Σ | 0..1 | string | Human language description of the concept map |
useContext | Σ | 0..* | CodeableConcept | Content intends to support these contexts Context of Use ValueSet (Extensible) |
requirements | 0..1 | string | Why needed | |
copyright | 0..1 | string | Use and/or publishing restrictions | |
source[x] | Σ | 1..1 | Identifies the source of the concepts which are being mapped | |
sourceUri | uri | |||
sourceReference | Reference(ValueSet | StructureDefinition) | |||
target[x] | Σ | 1..1 | Provides context to the mappings | |
targetUri | uri | |||
targetReference | Reference(ValueSet | StructureDefinition) | |||
element | 0..* | BackboneElement | Mappings for a concept from the source set | |
codeSystem | 0..1 | uri | Code System (if value set crosses code systems) | |
code | 0..1 | code | Identifies element being mapped | |
target | I | 0..* | BackboneElement | Concept in target system for element If the map is narrower or inexact, there SHALL be some comments |
codeSystem | 0..1 | uri | System of the target (if necessary) | |
code | 0..1 | code | Code that identifies the target element | |
equivalence | ?! | 1..1 | code | equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint ConceptMapEquivalence (Required) |
comments | I | 0..1 | string | Description of status/issues in mapping |
dependsOn | 0..* | BackboneElement | Other elements required for this mapping (from context) | |
element | 1..1 | uri | Reference to element/field/ValueSet mapping depends on | |
codeSystem | 1..1 | uri | Code System (if necessary) | |
code | 1..1 | string | Value of the referenced element | |
product | 0..* | see dependsOn | Other concepts that this mapping also produces | |
Documentation for this format |
XML Template
<ConceptMap xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <url value="[uri]"/><!-- 0..1 Globally unique logical id for concept map --> <identifier><!-- 0..1 Identifier Additional identifier for the concept map --></identifier> <version value="[string]"/><!-- 0..1 Logical id for this version of the concept map --> <name value="[string]"/><!-- 0..1 Informal name for this concept map --> <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..* Contact details of the publisher --> <name value="[string]"/><!-- 0..1 Name of a individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact> <date value="[dateTime]"/><!-- 0..1 Date for given status --> <description value="[string]"/><!-- 0..1 Human language description of the concept map --> <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <requirements value="[string]"/><!-- 0..1 Why needed --> <copyright value="[string]"/><!-- 0..1 Use and/or publishing restrictions --> <source[x]><!-- 1..1 uri|Reference(ValueSet|StructureDefinition) Identifies the source of the concepts which are being mapped --></source[x]> <target[x]><!-- 1..1 uri|Reference(ValueSet|StructureDefinition) Provides context to the mappings --></target[x]> <element> <!-- 0..* Mappings for a concept from the source set --> <codeSystem value="[uri]"/><!-- 0..1 Code System (if value set crosses code systems) --> <code value="[code]"/><!-- 0..1 Identifies element being mapped --> <target> <!-- 0..* Concept in target system for element --> <codeSystem value="[uri]"/><!-- 0..1 System of the target (if necessary) --> <code value="[code]"/><!-- 0..1 Code that identifies the target element --> <equivalence value="[code]"/><!-- 1..1 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) --> <element value="[uri]"/><!-- 1..1 Reference to element/field/ValueSet mapping depends on --> <codeSystem value="[uri]"/><!-- 1..1 Code System (if necessary) --> <code value="[string]"/><!-- 1..1 Value of the referenced element --> </dependsOn> <product><!-- 0..* Content as for ConceptMap.element.target.dependsOn Other concepts that this mapping also produces --></product> </target> </element> </ConceptMap>
JSON Template
{ "resourceType" : "ConceptMap", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "url" : "<uri>", // Globally unique logical id for concept map "identifier" : { Identifier }, // Additional identifier for the concept map "version" : "<string>", // Logical id for this version of the concept map "name" : "<string>", // Informal name for this concept map "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" : [{ // Contact details of the publisher "name" : "<string>", // Name of a individual to contact "telecom" : [{ ContactPoint }] // Contact details for individual or publisher }], "date" : "<dateTime>", // Date for given status "description" : "<string>", // Human language description of the concept map "useContext" : [{ CodeableConcept }], // Content intends to support these contexts "requirements" : "<string>", // Why needed "copyright" : "<string>", // 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|StructureDefinition) }, // target[x]: Provides context to the mappings. One of these 2: "targetUri" : "<uri>", "targetReference" : { Reference(ValueSet|StructureDefinition) }, "element" : [{ // Mappings for a concept from the source set "codeSystem" : "<uri>", // Code System (if value set crosses code systems) "code" : "<code>", // Identifies element being mapped "target" : [{ // Concept in target system for element "codeSystem" : "<uri>", // System of the target (if necessary) "code" : "<code>", // Code that identifies the target element "equivalence" : "<code>", // R! 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) "element" : "<uri>", // R! Reference to element/field/ValueSet mapping depends on "codeSystem" : "<uri>", // R! Code System (if necessary) "code" : "<string>" // R! Value of the referenced element }], "product" : [{ Content as for ConceptMap.element.target.dependsOn }] // Other concepts that this mapping also produces }] }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
ConceptMap.status | The lifecycle status of a Value Set or Concept Map. | Required | ConformanceResourceStatus |
ConceptMap.useContext | Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use. | Extensible | Context of Use ValueSet |
ConceptMap.element.target.equivalence | The degree of equivalence between concepts. | Required | ConceptMapEquivalence |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
context | token | A use context assigned to the concept map | ConceptMap.useContext |
date | date | The concept map publication date | ConceptMap.date |
dependson | uri | Reference to element/field/ValueSet mapping depends on | ConceptMap.element.target.dependsOn.element |
description | string | Text search in the description of the concept map | ConceptMap.description |
identifier | token | Additional identifier for the concept map | ConceptMap.identifier |
name | string | Name of the concept map | ConceptMap.name |
product | uri | Reference to element/field/ValueSet mapping depends on | ConceptMap.element.target.product.element |
publisher | string | Name of the publisher of the concept map | ConceptMap.publisher |
source | reference | Identifies the source of the concepts which are being mapped | ConceptMap.sourceReference (ValueSet, StructureDefinition) |
sourcecode | token | Identifies element being mapped | ConceptMap.element.code |
sourcesystem | uri | Code System (if value set crosses code systems) | ConceptMap.element.codeSystem |
sourceuri | reference | Identifies the source of the concepts which are being mapped | ConceptMap.sourceUri (ValueSet, StructureDefinition) |
status | token | Status of the concept map | ConceptMap.status |
target | reference | Provides context to the mappings | ConceptMap.target[x] (ValueSet, StructureDefinition) |
targetcode | token | Code that identifies the target element | ConceptMap.element.target.code |
targetsystem | uri | System of the target (if necessary) | ConceptMap.element.target.codeSystem |
url | uri | The URL of the concept map | ConceptMap.url |
version | token | The version identifier of the concept map | ConceptMap.version |