This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 2). 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
This resource maintained by the Vocabulary Work Group
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 always framed within the concept of value sets - they are specific to a context of use.
Note that the 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 valuesets. 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. 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 destination also includes an [equivalence] property that specifies how similar the mapping is (or, in some cases, that there is no valid mapping).
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 |
useContext | Σ | 0..* | CodeableConcept | Content intends to support these contexts ConformanceUseContext (Extensible) |
publisher | Σ | 0..1 | string | Name of the publisher (Organization or individual) |
contact | Σ | 0..* | Element | Contact details of the publisher |
name | Σ | 0..1 | string | Name of a individual to contact |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or publisher |
description | Σ | 0..1 | string | Human language description of the concept map |
requirements | 0..1 | string | Why is this needed? | |
copyright | 0..1 | string | Use and/or Publishing restrictions | |
status | ?! Σ | 1..1 | code | draft | active | retired ConformanceResourceStatus (Required) |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date for given status |
source[x] | Σ | Identifies the source of the concepts which are being mapped | ||
sourceUri | 1..1 | uri | ||
sourceReference | 1..1 | ValueSet | StructureDefinition | ||
target[x] | Σ | Provides context to the mappings | ||
targetUri | 1..1 | uri | ||
targetReference | 1..1 | ValueSet | StructureDefinition | ||
element | 0..* | Element | 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 | |
dependsOn | 0..* | Element | 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 | |
map | I | 0..* | Element | Target of this map 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 | specialises | inexact | unmatched | disjoint ConceptMapEquivalence (Required) |
comments | I | 0..1 | string | Description of status/issues in mapping |
product | 0..* | see dependsOn | Other concepts that this mapping also produces |
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 --> <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <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> <description value="[string]"/><!-- 0..1 Human language description of the concept map --> <requirements value="[string]"/><!-- 0..1 Why is this needed? --> <copyright value="[string]"/><!-- 0..1 Use and/or Publishing restrictions --> <status value="[code]"/><!-- 1..1 draft | active | retired --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date for given status --> <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 --> <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> <map> <!-- 0..* Target of this map --> <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 | specialises | inexact | unmatched | disjoint --> <comments value="[string]"/><!-- 0..1 Description of status/issues in mapping --> <product><!-- 0..* Content as for ConceptMap.element.dependsOn Other concepts that this mapping also produces --></product> </map> </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 "useContext" : [{ CodeableConcept }], // Content intends to support these contexts "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 }], "description" : "<string>", // Human language description of the concept map "requirements" : "<string>", // Why is this needed? "copyright" : "<string>", // Use and/or Publishing restrictions "status" : "<code>", // R! draft | active | retired "experimental" : <boolean>, // If for testing purposes, not real usage "date" : "<dateTime>", // Date for given status // 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 "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 }], "map" : [{ // Target of this map "codeSystem" : "<uri>", // System of the target (if necessary) "code" : "<code>", // Code that identifies the target element "equivalence" : "<code>", // R! equivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint "comments" : "<string>", // C? Description of status/issues in mapping "product" : [{ Content as for ConceptMap.element.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 |
useContext | Σ | 0..* | CodeableConcept | Content intends to support these contexts ConformanceUseContext (Extensible) |
publisher | Σ | 0..1 | string | Name of the publisher (Organization or individual) |
contact | Σ | 0..* | Element | Contact details of the publisher |
name | Σ | 0..1 | string | Name of a individual to contact |
telecom | Σ | 0..* | ContactPoint | Contact details for individual or publisher |
description | Σ | 0..1 | string | Human language description of the concept map |
requirements | 0..1 | string | Why is this needed? | |
copyright | 0..1 | string | Use and/or Publishing restrictions | |
status | ?! Σ | 1..1 | code | draft | active | retired ConformanceResourceStatus (Required) |
experimental | Σ | 0..1 | boolean | If for testing purposes, not real usage |
date | Σ | 0..1 | dateTime | Date for given status |
source[x] | Σ | Identifies the source of the concepts which are being mapped | ||
sourceUri | 1..1 | uri | ||
sourceReference | 1..1 | ValueSet | StructureDefinition | ||
target[x] | Σ | Provides context to the mappings | ||
targetUri | 1..1 | uri | ||
targetReference | 1..1 | ValueSet | StructureDefinition | ||
element | 0..* | Element | 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 | |
dependsOn | 0..* | Element | 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 | |
map | I | 0..* | Element | Target of this map 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 | specialises | inexact | unmatched | disjoint ConceptMapEquivalence (Required) |
comments | I | 0..1 | string | Description of status/issues in mapping |
product | 0..* | see dependsOn | Other concepts that this mapping also produces |
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 --> <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <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> <description value="[string]"/><!-- 0..1 Human language description of the concept map --> <requirements value="[string]"/><!-- 0..1 Why is this needed? --> <copyright value="[string]"/><!-- 0..1 Use and/or Publishing restrictions --> <status value="[code]"/><!-- 1..1 draft | active | retired --> <experimental value="[boolean]"/><!-- 0..1 If for testing purposes, not real usage --> <date value="[dateTime]"/><!-- 0..1 Date for given status --> <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 --> <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> <map> <!-- 0..* Target of this map --> <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 | specialises | inexact | unmatched | disjoint --> <comments value="[string]"/><!-- 0..1 Description of status/issues in mapping --> <product><!-- 0..* Content as for ConceptMap.element.dependsOn Other concepts that this mapping also produces --></product> </map> </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 "useContext" : [{ CodeableConcept }], // Content intends to support these contexts "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 }], "description" : "<string>", // Human language description of the concept map "requirements" : "<string>", // Why is this needed? "copyright" : "<string>", // Use and/or Publishing restrictions "status" : "<code>", // R! draft | active | retired "experimental" : <boolean>, // If for testing purposes, not real usage "date" : "<dateTime>", // Date for given status // 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 "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 }], "map" : [{ // Target of this map "codeSystem" : "<uri>", // System of the target (if necessary) "code" : "<code>", // Code that identifies the target element "equivalence" : "<code>", // R! equivalent | equal | wider | subsumes | narrower | specialises | inexact | unmatched | disjoint "comments" : "<string>", // C? Description of status/issues in mapping "product" : [{ Content as for ConceptMap.element.dependsOn }] // Other concepts that this mapping also produces }] }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON)
Path | Definition | Type | Reference |
---|---|---|---|
ConceptMap.useContext | Indicates the countries, regions, disciplines and other aspects of use this artifact is targeted for use within | Extensible | http://hl7.org/fhir/vs/use-context |
ConceptMap.status | The lifecycle status of a Value Set or Concept Map | Required | http://hl7.org/fhir/conformance-resource-status |
ConceptMap.element.map.equivalence | The degree of equivalence between concepts | Required | http://hl7.org/fhir/concept-equivalence |
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.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.map.product.element |
publisher | string | Name of the publisher of the concept map | ConceptMap.publisher |
source | reference | The system for any concepts mapped by this concept map | ConceptMap.source[x] (ValueSet, StructureDefinition) |
status | token | Status of the concept map | ConceptMap.status |
system | uri | The system for any destination concepts mapped by this map | ConceptMap.element.map.codeSystem |
target | reference | Provides context to the mappings | ConceptMap.target[x] (ValueSet, StructureDefinition) |
url | uri | The url of the concept map | ConceptMap.url |
version | token | The version identifier of the concept map | ConceptMap.version |