6.24 Resource ConceptMap - Content
This resource cultivated 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.
## 6.24.1 Scope and Usage
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).
## 6.24.2 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.
6.24.3
Resource Content
Structure UML
XML JSON
All
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | DomainResource | A map from one set of concepts to one or more other concepts | ||
identifier | Σ | 0..1 | string | Logical id to reference this 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 |
publisher | Σ | 0..1 | string | Name of the publisher (Organization or individual) |
telecom | Σ | 0.. |
ValueSetStatus (Required)
If the map is narrower or inexact, there SHALL be some comments
ConceptMapEquivalence (Required)
UML Diagram
XML Template
<ConceptMap xmlns="http://hl7.org/fhir">
<!– from Resource: id, meta, implicitRules, and language –>
<!– from DomainResource: text, contained, extension, and modifierExtension –>
<identifier value="[string]"/><!– 0..1 Logical id to reference this concept map –>
<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 –>
<publisher value="[string]"/><!– 0..1 Name of the publisher (Organization or individual) –>
<telecom><!– 0..* ContactPoint Contact information of the publisher –></telecom>
<description value="[string]"/><!– 0..1 Human language description of the concept map –>
<copyright value="[string]"/><!– 0..1 About the concept map or its content –>
<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|Profile)
Identifies the source of the concepts which are being mapped –></source[x]>
<target[x]><!– 1..1 uri|Reference(ValueSet|Profile) 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
todo
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
ConceptMap | DomainResource | A map from one set of concepts to one or more other concepts | ||
identifier | Σ | 0..1 | string | Logical id to reference this 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 |
publisher | Σ | 0..1 | string | Name of the publisher (Organization or individual) |
telecom | Σ | 0.. | ContactPoint | Contact information of the publisher |
description | Σ | 0..1 | string | Human language description of the concept map |
copyright | 0..1 | string | About the concept map or its content | |
status | M Σ | 1..1 | code | draft | active | retired ValueSetStatus (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 | Profile | ||
target[x] | Σ | Provides context to the mappings | ||
targetUri | 1..1 | uri | ||
targetReference | 1..1 | ValueSet | Profile | ||
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 | M | 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 –>
<identifier value="[string]"/><!– 0..1 Logical id to reference this concept map –>
<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 –>
<publisher value="[string]"/><!– 0..1 Name of the publisher (Organization or individual) –>
<telecom><!– 0..* ContactPoint Contact information of the publisher –></telecom>
<description value="[string]"/><!– 0..1 Human language description of the concept map –>
<copyright value="[string]"/><!– 0..1 About the concept map or its content –>
<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|Profile)
Identifies the source of the concepts which are being mapped –></source[x]>
<target[x]><!– 1..1 uri|Reference(ValueSet|Profile) 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>
Alternate definitions: Schema/Schematron,
Resource Profile (XML, JSON),
Questionnaire
6.24.3.1
Terminology Bindings
Path | Definition | Type | Reference |
---|---|---|---|
ConceptMap.status | The lifecycle status of a Value Set or Concept Map | Fixed | http://hl7.org/fhir/valueset-status |
ConceptMap.element.map.equivalence | The degree of equivalence between concepts | Fixed | http://hl7.org/fhir/concept-equivalence |
6.24.3.2 Constraints
- Inv-1: On ConceptMap.element.map: If the map is narrower or inexact, there SHALL be some comments (xpath on f:ConceptMap/f:element/f:map: exists(f:comments) or ((f:equivalence/@value != ‘narrower’) and (f:equivalence/@value != ‘inexact’)))
6.24.4 Notes
- The value of the system and code element 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
6.24.5 Search Parameters
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 |
date | date | The concept map publication date | ConceptMap.date |
dependson | token | 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 | The identifier of the concept map | ConceptMap.identifier |
name | string | Name of the concept map | ConceptMap.name |
product | token | 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, Profile) |
status | token | Status of the concept map | ConceptMap.status |
system | token | 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, Profile) |
version | token | The version identifier of the concept map | ConceptMap.version |
</div> <!-- /inner-wrapper -->
</div> <!-- /row -->
</div> <!-- /container -->
</div> <!-- /segment-content -->
<div id="segment-footer" class="segment"> <!-- segment-footer -->
<div class="container"> <!-- container -->
<div class="inner-wrapper">
© HL7.org 2011+. FHIR DSTU (v0.4.0-3900) generated on Sat, Dec 20, 2014 22:29+0000. <!-- [QA Report](qa.html) --> <!-- achive note -->
<span style="color: #FFFF77">
Links: [What's a DSTU?](timelines.html) |
[Version History](history.html) |
[Compare to DSTU](http://services.w3.org/htmldiff?doc1=http%3A%2F%2Fhl7.org%2Fimplement%2Fstandards%2Ffhir%2Fconceptmap.html&doc2=http%3A%2F%2Fhl7-fhir.github.io%2F%2Fconceptmap.html) |
[![CC0](cc0.png)](license.html) |
[Propose a change](http://gforge.hl7.org/gf/project/fhir/tracker/?action=TrackerItemAdd&tracker_id=677)
</span>
</div> <!-- /inner-wrapper -->
</div> <!-- /container -->
</div> <!-- /segment-footer -->