This
page
is
part
of
the
FHIR
Specification
(v1.0.2:
DSTU
(v3.0.2:
STU
2).
3).
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
R3
R2
Vocabulary
Work
Group
| Maturity Level : 3 | Trial Use | Compartments : Not linked to any defined compartments |
Detailed Descriptions for the elements in the ConceptMap resource.
| ConceptMap | |
| Definition |
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. |
| Control | 1..1 |
| ConceptMap.url | |
| Definition |
An
absolute
|
| Control | 0..1 |
| Type | uri |
| Requirements | Allows the concept map to be referenced by a single globally unique identifier. |
| Summary | true |
| Comments | Can be a urn:uuid: or a urn:oid:, but real http: addresses are preferred. Multiple instances may share the same url if they have a distinct version. |
| ConceptMap.identifier | |
| Definition |
|
| Note | This is a business identifer, not a resource identifier (see discussion ) |
| Control | 0..1 |
| Type | Identifier |
| Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. |
| Summary | true |
| Comments |
Typically,
this
is
used
for
|
| ConceptMap.version | |
| Definition |
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
|
| Note |
This
is
a
business
versionId,
not
a
resource
|
| Control | 0..1 |
| Type | string |
| Summary | true |
| Comments |
There
may
be
|
| ConceptMap.name | |
| Definition |
A
|
| Control | 0..1 |
| Type | string |
| Requirements |
Support
human
|
| Summary | true |
| Comments |
|
|
|
|
| Definition |
|
| Control |
|
| Type |
|
|
|
true |
|
|
|
|
|
|
|
|
|
|
Control
|
1..1 |
|
|
|
|
|
|
|
|
|
| Summary | true |
| Comments |
Allows
filtering
of
|
|
|
|
| Definition |
|
| Control | 0..1 |
| Type |
|
| Is Modifier | true |
| Requirements |
|
| Summary | true |
| Comments |
|
|
|
|
| Definition |
|
| Control |
|
| Type | dateTime |
| Alternate Names | Revision Date |
| Summary | true |
| Comments |
|
|
|
|
| Definition |
The
name
of
|
| Control | 0..1 |
| Type | string |
| Requirements | Helps establish the "authority/credibility" of the concept map. May also allow for contact. |
| Summary | true |
| Comments |
|
|
|
|
| Definition |
Contact
details
|
| Control | 0..* |
| Type |
|
| Summary | true |
| Comments | May be a web site, an email address, a telephone number, etc. |
|
|
|
| Definition |
|
| Control | 0..1 |
| Type |
|
| Comments |
|
|
|
|
| Definition |
|
| Control |
|
| Type |
|
| Requirements |
|
| Summary | true |
| Comments |
|
|
|
|
| Definition |
|
| Control | 0..* |
| Terminology Binding |
|
| Type | CodeableConcept |
|
|
|
|
|
It may be possible for the concept map to be used in jurisdictions other than those for which it was originally designed or intended. |
|
|
|
| Definition |
|
| Control | 0..1 |
| Type |
|
| Comments |
This
element
does
not
describe
the
usage
of
the
concept
map
|
| ConceptMap.copyright | |
| Definition |
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 map. |
| Control | 0..1 |
| Type |
|
| Requirements | Consumers must be able to determine any legal restrictions on the use of the concept map and/or its content. |
| Alternate Names | License; Restrictions |
| Comments |
null Frequently, the copyright differs between the concept map, and codes that are included. The copyright statement should clearly differentiate between these when required. |
| ConceptMap.source[x] | |
| Definition |
The source value set that specifies the concepts that are being mapped. |
| Control |
|
| Type |
uri
|
Reference
(
ValueSet
|
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Summary | true |
| Comments |
Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map. |
| ConceptMap.target[x] | |
| Definition |
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 made. |
| Control |
|
| Type |
uri
|
Reference
(
ValueSet
|
| [x] Note | See Choice of Data Types for further information about how to use [x] |
| Summary | true |
| Comments |
Should be a version specific reference. URIs SHOULD be absolute. If there is no source or target value set, the is no specified context for the map. |
|
| |
| Definition | A group of mappings that all have the same source and target system. |
| Control | 0..* |
| ConceptMap.group.source | |
| Definition | An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system). |
| Control | 0..1 |
| Type | uri |
| ConceptMap.group.sourceVersion | |
| Definition | The specific version of the code system, as determined by the code system authority. |
| Control | 0..1 |
| Type | string |
| Comments | The specification of a particular code system version may be required for code systems which lack concept permanence. |
| ConceptMap.group.target | |
| Definition | An absolute URI that identifies the code system of the target code (if the target is a value set that cross code systems). |
| Control | 0..1 |
| Type | uri |
| Comments | Target may be omitted if all the targget element equivalence values are 'unmatched'. |
| ConceptMap.group.targetVersion | |
| Definition | The specific version of the code system, as determined by the code system authority. |
| Control | 0..1 |
| Type | string |
| Comments | The specification of a particular code system version may be required for code systems which lack concept permanence. |
| ConceptMap.group.element | |
| Definition |
Mappings for an individual concept in the source to one or more concepts in the target. |
| Control |
|
| Alternate Names | code; concept; item |
| Comments |
Generally, the ideal is that there would only be one mapping for each concept in the source value set, but a given concept may be mapped multiple times with different comments or dependencies. |
|
|
|
| Definition |
|
| Control | 0..1 |
| Type |
|
|
|
|
| Definition |
|
| Control | 0..1 |
| Type |
|
| Comments | The display is ignored when processing the map. |
|
|
|
| Definition |
A concept from the target value set that this concept maps to. |
| Control | 0..* |
| Comments |
Ideally there would only be one map, with equal or equivalent mapping. But multiple maps are allowed for several narrower options, or to assert that other concepts are unmatched. |
| Invariants |
Defined
on
this
element
cmd-1 : If the map is narrower or inexact, there SHALL be some comments :
comment.exists()
or
equivalence.empty()
or
((equivalence
!=
'narrower')
and
(equivalence
!=
'inexact')),
xpath:
exists(f:comment)
or
not(exists(f:equivalence))
or
((f:equivalence/@value
!=
'narrower')
and
(f:equivalence/@value
!=
'inexact')))
|
|
|
|
| Definition |
|
| Control | 0..1 |
| Type |
|
|
|
|
| Definition |
|
| Control | 0..1 |
| Type |
|
| Comments | The display is ignored when processing the map. |
|
|
|
| Definition |
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). |
| Control |
|
| Terminology Binding |
|
| Type | code |
| Is Modifier | true |
| Default Value | equivalent |
| Comments | This element is labeled as a modifier because it may indicate that a target does not apply. |
|
|
|
| Definition |
A description of status/issues in mapping that conveys additional information not represented in the structured data. |
| Control | 0..1 |
| Type | string |
| Invariants |
Affect
this
element
cmd-1 : If the map is narrower or inexact, there SHALL be some comments :
comment.exists()
or
equivalence.empty()
or
((equivalence
!=
'narrower')
and
(equivalence
!=
'inexact')),
xpath:
exists(f:comment)
or
not(exists(f:equivalence))
or
((f:equivalence/@value
!=
'narrower')
and
(f:equivalence/@value
!=
'inexact')))
|
|
|
|
| Definition |
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 value. |
| Control | 0..* |
|
|
|
| Definition |
A
reference
to
|
| Control | 1..1 |
| Type | uri |
|
|
|
| Definition |
An absolute URI that identifies the code system of the dependency code (if the source/dependency is a value set that crosses code systems). |
| Control |
|
| Type | uri |
| Meaning if Missing | The code is in the source (dependsOn) or target (product) system |
|
|
|
| Definition |
Identity (code or path) or the element/item/ValueSet that the map depends on / refers to. |
| Control | 1..1 |
| Type | string |
|
| |
| Definition | The display for the code. The display is only provided to help editors when editing the concept map. |
| Control | 0..1 |
| Type | string |
| Comments | The display is ignored when processing the map. |
| ConceptMap.group.element.target.product | |
| Definition |
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 on. |
| Control | 0..* |
| Type |
See
|
| ConceptMap.group.unmapped | |
| Definition | What to do when there is no match in the mappings in the group. |
| Control | 0..1 |
| Comments | This only applies if the source code is in the system defined for the group. |
| Invariants |
Defined
on
this
element
cmd-2 : If the mode is 'fixed', a code must be provided ( expression :
(mode
=
'fixed')
implies
code.exists(),
xpath:
(f:mode/@value
!=
'fixed')
or
exists(f:code))
cmd-3 : If the mode is 'other-map', a code must be provided ( expression :
(mode
=
'other-map')
implies
url.exists(),
xpath:
(f:mode/@value
!=
'other-map')
or
exists(f:url))
|
| ConceptMap.group.unmapped.mode | |
| Definition | Defines which action to take if there is no match in the group. One of 3 actions is possible: use the unmapped code (this is useful when doing a mapping between versions, and only a few codes have changed), use a fixed code (a default code), or alternatively, a reference to a different concept map can be provided (by canonical URL). |
| Control | 1..1 |
| Terminology Binding | ConceptMapGroupUnmappedMode ( Required ) |
| Type | code |
| ConceptMap.group.unmapped.code | |
| Definition | The fixed code to use when the mode = 'fixed' - all unmapped codes are mapped to a single fixed code. |
| Control | 0..1 |
| Type | code |
| ConceptMap.group.unmapped.display | |
| Definition | The display for the code. The display is only provided to help editors when editing the concept map. |
| Control | 0..1 |
| Type | string |
| Comments | The display is ignored when processing the map. |
| ConceptMap.group.unmapped.url | |
| Definition | The canonical URL of the map to use if this map contains no mapping. |
| Control | 0..1 |
| Type | uri |