Terminology
This page is part of the FHIR Specification (v1.6.0:
STU
3 Ballot 4). The current version which supercedes this version is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
. For a full list of available versions, see the
Directory of published versions 
.
Page
versions:
. Page versions:
R5
R4B
R4
R3
R2
|
|
|
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 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
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: 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.
There SHOULD be at least one target for each element, but some incomplete concept maps may not have a target for each concept.
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 instancss that conform to a known structure.
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 |
|
|---|---|---|---|---|
ConceptMap
|
DomainResource |
|
||
url
|
Σ | 0..1 | uri |
|
identifier
|
Σ | 0..1 | Identifier |
|
|
version
|
Σ | 0..1 | string |
|
|
name
|
Σ | 0..1 | string |
|
|
status
|
?! Σ | 1..1 | code |
ConformanceResourceStatus |
|
experimental
|
Σ | 0..1 | boolean |
|
|
publisher
|
Σ | 0..1 | string |
|
contact
|
Σ | 0..* | BackboneElement |
|
name
|
Σ | 0..1 | string |
|
telecom
|
Σ | 0..* | ContactPoint |
|
|
date
|
Σ | 0..1 | dateTime |
|
|
description
|
Σ | 0..1 |
|
|
|
useContext
|
Σ | 0..* | CodeableConcept |
|
|
requirements
|
0..1 |
|
|
|
|
copyright
|
0..1 | string |
|
|
source[x]
|
Σ | 1..1 |
|
|
|
sourceUri
|
uri | |||
 sourceReference
|
Reference
(
ValueSet
|
|||
|
target[x]
|
Σ | 1..1 |
|
|
|
targetUri
|
uri | |||
|
targetReference
|
Reference
(
ValueSet
|
|||
|
group
|
0..* | BackboneElement |
|
|
source
|
|
uri |
|
|
|
sourceVersion
|
0..1 |
|
|
|
|
target
|
0..1 | uri | System of the target (if necessary) | |
|
targetVersion
|
|
|
| |
|
element
|
1..* | BackboneElement | Mappings for a concept from the source set | |
|
code
|
0..1 |
|
| |
|
target
|
I | 0..* | BackboneElement |
Concept in target system for element
If the map is narrower or inexact, there SHALL be some comments |
|
code
|
0..1 | code |
|
|
|
equivalence
|
?! |
|
code |
ConceptMapEquivalence |
|
comments
|
I | 0..1 | string |
|
|
dependsOn
|
0..* | BackboneElement |
|
|
|
property
|
1..1 | uri |
|
|
|
system
|
|
uri |
|
|
|
code
|
1..1 | string |
|
|
product
|
0..* |
|
|
|
|
Documentation for this format
|
||||
UML
Diagram
UML Diagram
(
Legend
)
XML
Template
XML Template
<
<ConceptMap xmlns="http://hl7.org/fhir"><!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension -->
< <</identifier> < < < < < < < <</telecom><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 an individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact>< < <</useContext> < < <</source[x]> <</target[x]> < < < < < < < < < < < < </dependsOn> <</product> </target> </element><date value="[dateTime]"/><!-- 0..1 Date for given status --> <description value="[markdown]"/><!-- 0..1 Human language description of the concept map --> <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <requirements value="[markdown]"/><!-- 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]> <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 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
JSON Template
{
"resourceType" : "",
{
"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 an individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"
"
"
"
"
"date" : "<dateTime>", // Date for given status
"description" : "<markdown>", // Human language description of the concept map
"useContext" : [{ CodeableConcept }], // Content intends to support these contexts
"requirements" : "<markdown>", // 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) },
"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>", // 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/> .
Changes since DSTU2
| ConceptMap | |
| ConceptMap.description | Type changed from string to markdown |
| ConceptMap.requirements | Type changed from string to markdown |
| ConceptMap.group | added |
| ConceptMap.group.source | added |
| ConceptMap.group.sourceVersion | added |
| ConceptMap.group.target | added |
| ConceptMap.group.targetVersion | added |
| 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 |
| ConceptMap.group.element.target.dependsOn.system | added |
| 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
| Name | Flags | Card. | Type |
|
|---|---|---|---|---|
|
ConceptMap
|
DomainResource |
|
||
|
url
|
Σ | 0..1 | uri |
|
|
identifier
|
Σ | 0..1 | Identifier |
|
|
version
|
Σ | 0..1 | string |
|
|
name
|
Σ | 0..1 | string |
|
|
status
|
?! Σ | 1..1 | code |
ConformanceResourceStatus |
|
experimental
|
Σ | 0..1 | boolean |
|
|
publisher
|
Σ | 0..1 | string |
|
|
contact
|
Σ | 0..* | BackboneElement |
|
|
name
|
Σ | 0..1 | string |
|
|
telecom
|
Σ | 0..* | ContactPoint |
|
|
date
|
Σ | 0..1 | dateTime |
|
|
description
|
Σ | 0..1 |
|
|
|
useContext
|
Σ | 0..* | CodeableConcept |
|
|
requirements
|
0..1 |
|
|
|
|
copyright
|
0..1 | string |
|
|
|
source[x]
|
Σ | 1..1 |
|
|
|
sourceUri
|
uri | |||
|
sourceReference
|
Reference
(
ValueSet
|
|||
|
target[x]
|
Σ | 1..1 |
|
|
|
targetUri
|
uri | |||
|
targetReference
|
Reference
(
ValueSet
|
|||
|
group
|
0..* | BackboneElement |
|
|
|
source
|
|
uri |
|
|
|
sourceVersion
|
0..1 |
|
|
|
|
target
|
0..1 | uri | System of the target (if necessary) | |
|
targetVersion
|
|
|
| |
|
element
|
1..* | BackboneElement | Mappings for a concept from the source set | |
|
code
|
0..1 |
|
| |
|
target
|
I | 0..* | BackboneElement |
Concept in target system for element
If the map is narrower or inexact, there SHALL be some comments |
|
code
|
0..1 | code |
|
|
|
equivalence
|
?! |
|
code |
ConceptMapEquivalence |
|
comments
|
I | 0..1 | string |
|
|
dependsOn
|
0..* | BackboneElement |
|
|
|
property
|
1..1 | uri |
|
|
|
system
|
|
uri |
|
|
|
code
|
1..1 | string |
|
|
|
product
|
0..* |
|
|
|
|
Documentation for this format
|
||||
XML
Template
XML Template
<
<ConceptMap xmlns="http://hl7.org/fhir">< <</identifier> < < < < < < < <</telecom><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 an individual to contact --> <telecom><!-- 0..* ContactPoint Contact details for individual or publisher --></telecom> </contact>< < <</useContext> < < <</source[x]> <</target[x]> < < < < < < < < < < < < </dependsOn> <</product> </target> </element><date value="[dateTime]"/><!-- 0..1 Date for given status --> <description value="[markdown]"/><!-- 0..1 Human language description of the concept map --> <useContext><!-- 0..* CodeableConcept Content intends to support these contexts --></useContext> <requirements value="[markdown]"/><!-- 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]> <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 equivalent | equal | wider | subsumes | narrower | specializes | inexact | unmatched | disjoint --> <comments value="[string]"/><!--
JSON
Template
JSON Template
{
"resourceType" : "",
{
"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 an individual to contact
"telecom" : [{ ContactPoint }] // Contact details for individual or publisher
}],
"
"
"
"
"
"date" : "<dateTime>", // Date for given status
"description" : "<markdown>", // Human language description of the concept map
"useContext" : [{ CodeableConcept }], // Content intends to support these contexts
"requirements" : "<markdown>", // 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) },
"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>", // 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
}]
}]
}]
}
Alternate
definitions:
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .
Changes since DSTU2
| ConceptMap | |
| ConceptMap.description | Type changed from string to markdown |
| ConceptMap.requirements | Type changed from string to markdown |
| ConceptMap.group | added |
| ConceptMap.group.source | added |
| ConceptMap.group.sourceVersion | added |
| ConceptMap.group.target | added |
| ConceptMap.group.targetVersion | added |
| 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 |
| ConceptMap.group.element.target.dependsOn.system | added |
| 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
,
Resource
Profile
(
XML
,
(for ) +
JSON
Schema
,
ShEx
(for
Turtle
),
Questionnaire
)
| Path | Definition | Type | Reference |
|---|---|---|---|
| ConceptMap.status |
|
Required | ConformanceResourceStatus |
| ConceptMap.useContext |
|
Extensible |
|
| ConceptMap.group.element.target.equivalence |
|
Required | ConceptMapEquivalence |
on ConceptMap.group.element.target:
comments.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact'))
)
system
version
and
code
element
are
the
same
as
used
by
the
elements are the same as used by the
Coding
data type
element
for each source concept. If there is more than one, the
target
statements are cumulative across them
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.
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
for
more
information
about
searching
in
REST,
messaging,
and
services.
) 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 |
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 |
|
ConceptMap.useContext |
| date | date |
|
ConceptMap.date |
| dependson | uri |
|
|
| description | string |
|
ConceptMap.description |
| identifier | token |
|
ConceptMap.identifier |
| name | string |
|
ConceptMap.name |
| product | uri |
|
|
| publisher | string |
|
ConceptMap.publisher |
| source | reference |
|
ConceptMap.sourceReference
( |
|
|
token |
|
|
|
|
uri |
|
|
|
|
reference |
|
ConceptMap.sourceUri
( |
| status | token |
|
ConceptMap.status |
| target | reference |
|
( |
|
|
token |
|
|
|
|
uri |
|
|
| target-uri | reference | Provides context to the mappings |
ConceptMap.targetUri
( StructureDefinition , ValueSet ) |
| url | uri |
|
ConceptMap.url |
| version | token |
|
ConceptMap.version |
© HL7.org 2011+. FHIR STU3 Ballot (v1.6.0-9663) generated on Thu, Aug 11, 2016 17:06+1000.
QA Page
Links:
Search
|
|
Version History
|
Table of Contents
|
Compare to DSTU2
|
|
Propose
a
change
try
{
var
currentTabIndex
=
sessionStorage.getItem('fhir-resource-tab-index');
}
catch(exception){
}
if
(!currentTabIndex)
currentTabIndex
=
'0';
$(
'#tabs'
).tabs({
active:
currentTabIndex,
activate:
function(
event,
ui
)
{
var
active
=
$('.selector').tabs('option',
'active');
currentTabIndex
=
ui.newTab.index();
document.activeElement.blur();
try
{
sessionStorage.setItem('fhir-resource-tab-index',
currentTabIndex);
}
catch(exception){
}
}
});
|
Propose a change