|
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.
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
URL
that
is
used
to
identify
this
concept
map
when
it
is
referenced
in
a
specification,
model,
design
or
an
instance.
This
SHALL
be
a
URL,
SHOULD
be
globally
unique,
and
SHOULD
be
an
address
at
which
this
concept
map
is
(or
will
be)
published.
An absolute URL that is used to identify this concept map when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this concept map is (or will be) published.
|
|
Control
|
0..1
|
|
Type
|
uri
|
|
Summary
|
true
|
|
ConceptMap.identifier
|
|
Definition
|
Formal
identifier
that
is
used
to
identify
this
concept
map
when
it
is
represented
in
other
formats,
or
referenced
in
a
specification,
model,
design
or
an
instance.
Formal identifier that is used to identify this concept map when it is represented in other formats, or referenced in a specification, model, design or an instance.
|
|
Note
|
This
is
a
business
identifer,
not
a
resource
identifier
(see
This is a business identifer, not a resource identifier (see
discussion
)
|
|
Control
|
0..1
|
|
Type
|
Identifier
|
|
Summary
|
true
|
|
Comments
|
Typically,
this
is
used
for
values
that
can
go
in
a
v3
II
data
type.
Typically, this is used for values that can go in a v3 II data type.
|
|
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
profile
author
manually
and
the
value
should
be
a
timestamp.
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 profile author manually and the value should be a timestamp.
|
|
Note
|
This
is
a
business
versionId,
not
a
resource
identifier
(see
This is a business versionId, not a resource version id (see
discussion
)
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
Comments
|
There
may
be
multiple
resource
versions
of
the
concept
map
that
have
this
same
identifier.
There may be multiple resource versions of the concept map that have this same identifier.
|
|
ConceptMap.name
|
|
Definition
|
A
free
text
natural
language
name
describing
the
concept
map.
A free text natural language name describing the concept map.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Requirements
|
Support
human
navigation.
Support human navigation.
|
|
Summary
|
true
|
|
Comments
|
Not
expected
to
be
unique.
Not expected to be unique.
|
|
ConceptMap.status
|
|
Definition
|
The
status
of
the
concept
map.
The status of the concept map.
|
|
Control
|
1..1
|
|
Binding
|
ConformanceResourceStatus:
The
lifecycle
status
of
a
Value
Set
or
Concept
Map.
(
ConformanceResourceStatus:
The lifecycle status of a Value Set or Concept Map.
(
Required
)
|
|
Type
|
code
|
Is
Modifier
Is Modifier
|
true
|
|
Requirements
|
Identify
when/if
the
concept
map
should
be
used.
Identify when/if the concept map should be used.
|
|
Summary
|
true
|
|
Comments
|
Allows
filtering
of
ConceptMap
resources
that
are
appropriate
for
use.
Allows filtering of ConceptMap resources that are appropriate for use.
|
|
ConceptMap.experimental
|
|
Definition
|
This
ConceptMap
was
authored
for
testing
purposes
(or
education/evaluation/marketing),
and
is
not
intended
to
be
used
for
genuine
usage.
This ConceptMap was authored for testing purposes (or education/evaluation/marketing), and is not intended to be used for genuine usage.
|
|
Control
|
0..1
|
|
Type
|
boolean
|
|
Summary
|
true
|
|
Comments
|
Allows
filtering
of
ConceptMap
resources
that
are
appropriate
for
use.
Allows filtering of ConceptMap resources that are appropriate for use.
|
|
ConceptMap.publisher
|
|
Definition
|
The
name
of
the
individual
or
organization
that
published
the
concept
map.
The name of the individual or organization that published the concept map.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Requirements
|
Helps
establish
the
"authority/credibility"
of
the
concept
map.
May
also
allow
for
contact.
Helps establish the "authority/credibility" of the concept map. May also allow for contact.
|
|
Summary
|
true
|
|
Comments
|
Usually
an
organization,
but
may
be
an
individual.
This
item
SHOULD
be
populated
unless
the
information
is
available
from
context.
Usually an organization, but may be an individual. This item SHOULD be populated unless the information is available from context.
|
|
ConceptMap.contact
|
|
Definition
|
Contacts
to
assist
a
user
in
finding
and
communicating
with
the
publisher.
Contacts to assist a user in finding and communicating with the publisher.
|
|
Control
|
0..*
|
|
Summary
|
true
|
|
Comments
|
May
be
a
web
site,
an
email
address,
a
telephone
number,
etc.
May be a web site, an email address, a telephone number, etc.
|
|
ConceptMap.contact.name
|
|
Definition
|
The
name
of
an
individual
to
contact
regarding
the
concept
map.
The name of an individual to contact regarding the concept map.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Summary
|
true
|
|
Comments
|
If
there
is
no
named
individual,
the
telecom
is
for
the
organization
as
a
whole.
If there is no named individual, the telecom is for the organization as a whole.
|
|
ConceptMap.contact.telecom
|
|
Definition
|
Contact
details
for
individual
(if
a
name
was
provided)
or
the
publisher.
Contact details for individual (if a name was provided) or the publisher.
|
|
Control
|
0..*
|
|
Type
|
ContactPoint
|
|
Summary
|
true
|
|
ConceptMap.date
|
|
Definition
|
The
date
this
version
of
the
concept
map
was
published.
The
date
must
change
when
the
business
version
changes,
if
it
does,
and
it
must
change
if
the
status
code
changes.
In
addition,
it
should
change
when
the
substantive
content
of
the
concept
map
changes.
The date this version of the concept map was published. The date must change when the business version changes, if it does, and it must change if the status code changes. In addition, it should change when the substantive content of the concept map changes.
|
|
Control
|
0..1
|
|
Type
|
dateTime
|
|
Requirements
|
Need
to
know
when
a
concept
map
was
first
legal
for
use
or
became
withdrawn
or
replaced.
Need to know when a concept map was first legal for use or became withdrawn or replaced.
|
|
Summary
|
true
|
|
Comments
|
Note
that
this
is
not
the
same
as
the
resource
last-modified-date,
since
the
resource
may
be
a
secondary
representation
of
the
concept
map.
Additional
specific
dates
may
be
added
as
extensions.
Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the concept map. Additional specific dates may be added as extensions.
|
|
ConceptMap.description
|
|
Definition
|
A
free
text
natural
language
description
of
the
use
of
the
concept
map
-
reason
for
definition,
conditions
of
use,
etc.
A free text natural language description of the use of the concept map - reason for definition, conditions of use, etc.
|
|
Control
|
0..1
|
|
Type
|
string
markdown
|
|
Requirements
|
Human
understandability.
Human understandability.
|
|
Summary
|
true
|
|
Comments
|
The
description
is
not
intended
to
describe
the
semantics
of
the
concept
map.
The
description
should
capture
its
intended
use,
which
is
needed
for
ensuring
integrity
for
its
use
in
models
across
future
changes.
The description is not intended to describe the semantics of the concept map. The description should capture its intended use, which is needed for ensuring integrity for its use in models across future changes.
|
|
ConceptMap.useContext
|
|
Definition
|
The
content
was
developed
with
a
focus
and
intent
of
supporting
the
contexts
that
are
listed.
These
terms
may
be
used
to
assist
with
indexing
and
searching
of
concept
map
instances.
The content was developed with a focus and intent of supporting the contexts that are listed. These terms may be used to assist with indexing and searching of concept map instances.
|
|
Control
|
0..*
|
|
Binding
|
Context
of
Use
ValueSet:
Indicates
the
countries,
regions,
disciplines
and
other
aspects
of
use
within
which
this
artifact
is
targeted
for
use.
(
Context of Use ValueSet:
Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.
(
Extensible
)
|
|
Type
|
CodeableConcept
|
|
Requirements
|
Assist
in
searching
for
appropriate
concept
map
instances.
Assist in searching for appropriate concept map instances.
|
|
Summary
|
true
|
|
ConceptMap.requirements
|
|
Definition
|
Explains
why
this
concept
map
is
needed
and
why
it
has
been
constrained
as
it
has.
Explains why this concept map is needed and why it has been constrained as it has.
|
|
Control
|
0..1
|
|
Type
|
string
markdown
|
|
Comments
|
This
element
does
not
describe
the
usage
of
the
concept
map
(that
is
done
in
comments),
rather
it's
for
traceability
of
''why''
the
element
is
either
needed
or
''why''
the
constraints
exist
as
they
do.
This
may
be
used
to
point
to
source
materials
or
specifications
that
drove
the
structure
of
this
data
element.
This element does not describe the usage of the concept map (that is done in comments), rather it's for traceability of ''why'' the element is either needed or ''why'' the constraints exist as they do. This may be used to point to source materials or specifications that drove the structure of this data element.
|
|
ConceptMap.copyright
|
|
Definition
|
A
copyright
statement
relating
to
the
concept
map
and/or
its
contents.
A copyright statement relating to the concept map and/or its contents.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Comments
|
Frequently,
the
copyright
differs
between
the
concept
map,
and
codes
that
are
included.
The
copyright
statement
should
clearly
differentiate
between
these
when
required.
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.
The source value set that specifies the concepts that are being mapped.
|
|
Control
|
1..1
|
|
Type
|
uri
|
Reference
(
ValueSet
|
|
StructureDefinition
)
|
[x]
Note
[x] Note
|
See
Choice
of
Data
Types
for
further
information
about
how
to
use
[x]
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.
Should be a version specific reference. URIs SHOULD be absolute.
|
|
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.
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
|
1..1
|
|
Type
|
uri
|
Reference
(
ValueSet
|
|
StructureDefinition
)
|
[x]
Note
[x] Note
|
See
Choice
of
Data
Types
for
further
information
about
how
to
use
[x]
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.
Should be a version specific reference. URIs SHOULD be absolute.
|
ConceptMap.element
ConceptMap.group
|
|
Definition
|
Mappings
for
an
individual
concept
in
the
source
to
one
or
more
concepts
in
the
target.
A group of mappings that all have the same source and target system.
|
|
Control
|
0..*
|
ConceptMap.group.source
Alternate
Names
|
code;
concept;
item
Definition
|
An absolute URI that identifies the Code System (if the source is a value set that crosses more than one code system).
|
Comments
Control
|
1..1
|
Type
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.
|
uri
|
ConceptMap.element.codeSystem
ConceptMap.group.sourceVersion
|
|
Definition
|
An
absolute
URI
that
identifies
the
Code
System
(if
the
source
is
a
value
set
that
crosses
more
than
one
code
system).
The specific version of the code system, as determined by the code system authority.
|
|
Control
|
0..1
|
|
Type
|
uri
string
|
|
Comments
|
The specification of a particular code system version may be required for code systems which lack concept permanence.
|
ConceptMap.element.code
ConceptMap.group.target
|
|
Definition
|
Identity
(code
or
path)
or
the
element/item
being
mapped.
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
|
code
uri
|
|
Comments
|
Target may be omitted if all the targget element equivalence values are 'unmatched'.
|
ConceptMap.element.target
ConceptMap.group.targetVersion
|
|
Definition
|
A
concept
from
the
target
value
set
that
this
concept
maps
to.
The specific version of the code system, as determined by the code system authority.
|
|
Control
|
0..*
0..1
|
Comments
Type
|
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.
string
|
Invariants
Comments
|
The specification of a particular code system version may be required for code systems which lack concept permanence.
|
Defined
on
this
element
ConceptMap.group.element
cmd-1
:
If
the
map
is
narrower
or
inexact,
there
SHALL
be
some
comments
(xpath:
exists(f:comments)
or
((f:equivalence/@value
!=
'narrower')
and
(f:equivalence/@value
!=
'inexact')))
|
|
Definition
|
Mappings for an individual concept in the source to one or more concepts in the target.
|
|
Control
|
1..*
|
|
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.
|
ConceptMap.element.target.codeSystem
ConceptMap.group.element.code
|
|
Definition
|
An
absolute
URI
that
identifies
the
code
system
of
the
target
code
(if
the
target
is
a
value
set
that
cross
code
systems).
Identity (code or path) or the element/item being mapped.
|
|
Control
|
0..1
|
|
Type
|
uri
code
|
|
ConceptMap.group.element.target
|
|
Definition
|
A concept from the target value set that this concept maps to.
|
|
Control
|
0..*
|
|
Comments
|
Should
be
a
version
specific
reference.
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 (
expression
: comments.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact')), xpath: exists(f:comments) or not(exists(f:equivalence)) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact'))) |
ConceptMap.element.target.code
ConceptMap.group.element.target.code
|
|
Definition
|
Identity
(code
or
path)
or
the
element/item
that
the
map
refers
to.
Identity (code or path) or the element/item that the map refers to.
|
|
Control
|
0..1
|
|
Type
|
code
|
ConceptMap.element.target.equivalence
ConceptMap.group.element.target.equivalence
|
|
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).
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
|
1..1
0..1
|
|
Binding
|
ConceptMapEquivalence:
The
degree
of
equivalence
between
concepts.
(
ConceptMapEquivalence:
The degree of equivalence between concepts.
(
Required
)
|
|
Type
|
code
|
Is
Modifier
Is Modifier
|
true
|
|
Default Value
|
equivalent
|
ConceptMap.element.target.comments
ConceptMap.group.element.target.comments
|
|
Definition
|
A
description
of
status/issues
in
mapping
that
conveys
additional
information
not
represented
in
the
structured
data.
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
Affect this element
cmd-1
:
If
the
map
is
narrower
or
inexact,
there
SHALL
be
some
comments
(xpath:
exists(f:comments)
or
((f:equivalence/@value
!=
'narrower')
and
(f:equivalence/@value
!=
'inexact')))
: If the map is narrower or inexact, there SHALL be some comments (
expression
: comments.exists() or equivalence.empty() or ((equivalence != 'narrower') and (equivalence != 'inexact')), xpath: exists(f:comments) or not(exists(f:equivalence)) or ((f:equivalence/@value != 'narrower') and (f:equivalence/@value != 'inexact')))
|
ConceptMap.element.target.dependsOn
ConceptMap.group.element.target.dependsOn
|
|
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.
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..*
|
ConceptMap.element.target.dependsOn.element
ConceptMap.group.element.target.dependsOn.property
|
|
Definition
|
A
reference
to
a
specific
concept
that
holds
a
coded
value.
This
can
be
an
element
in
a
FHIR
resource,
or
a
specific
reference
to
a
data
element
in
a
different
specification
(e.g.
HL7
v2)
or
a
general
reference
to
a
kind
of
data
field,
or
a
reference
to
a
value
set
with
an
appropriately
narrow
definition.
A reference to an element that holds a coded value that corresponds to a code system property. The idea is that the information model carries an element somwhere that is labelled to correspond with a code system property.
|
|
Control
|
1..1
|
|
Type
|
uri
|
ConceptMap.element.target.dependsOn.codeSystem
ConceptMap.group.element.target.dependsOn.system
|
|
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).
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
|
1..1
0..1
|
|
Type
|
uri
|
|
Meaning if Missing
|
The code is in the source (dependsOn) or target (product) system
|
ConceptMap.element.target.dependsOn.code
ConceptMap.group.element.target.dependsOn.code
|
|
Definition
|
Identity
(code
or
path)
or
the
element/item/ValueSet
that
the
map
depends
on
/
refers
to.
Identity (code or path) or the element/item/ValueSet that the map depends on / refers to.
|
|
Control
|
1..1
|
|
Type
|
string
|
ConceptMap.element.target.product
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.
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.element.target.dependsOn
See ConceptMap.group.element.target.dependsOn
|
©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
generated
on
Sat,
Oct
24,
2015
07:43+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Compare
to
DSTU1