This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
Continuous
Integration
Build
of
available
versions,
see
FHIR
(will
be
incorrect/inconsistent
at
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
|
Responsible
Owner:
|
|
Compartments
:
|
This
is
the
narrative
for
the
resource.
See
also
the
XML
or
,
JSON
or
Turtle
format.
Note
that
this
operation
is
the
formal
definition
is:
for
the
translate
operation
as
an
OperationDefinition
on
ConceptMap.
See
the
Operation
documentation
Generated
Narrative:
OperationDefinition
ConceptMap-translate
Translate
a
code
from
one
value
set
to
another,
based
on
the
existing
value
set
and
concept
maps
resources,
and/or
other
additional
knowledge
available
to
the
server.
URL: [base]/ConceptMap/$translate
URL: [base]/ConceptMap/[id]/$translate
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | url | type | 0..1 | uri |
A canonical URL for a concept map. The server must know the concept map (e.g. it is defined explicitly in the server's concept maps, or it is defined implicitly by some code system known to the server. |
|
| IN | conceptMap | type | 0..1 | ConceptMap |
|
The concept map is provided directly as part of the request. Servers may choose not to accept concept maps in this fashion. |
| IN | conceptMapVersion | type | 0..1 | string | The identifier that is used to identify a specific version of the concept map to be used for the translation. This is an arbitrary value managed by the concept map author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. | |
| IN | sourceCode | 0..1 | code |
The code that is to be translated. If a code is provided, a system must be provided |
||
| IN |
|
0..1 | uri |
The
system
for
the
|
||
| IN |
|
0..1 | string |
The
version
for
the
system
of
the
|
||
| IN | sourceScope | 0..1 | uri |
Limits the scope of the $translate operation to source codes (ConceptMap.group.element.code) that are members of this value set. | ||
| IN | sourceCoding | 0..1 | Coding |
|
A coding to translate |
|
| IN | sourceCodeableConcept | 0..1 | CodeableConcept |
| ||
| IN | targetCode | 0..1 | code |
The
|
||
| IN |
|
0..1 | Coding |
A target coding to translate to |
||
| IN |
|
0..1 | CodeableConcept |
A full codeableConcept to validate. The server can translate any of the coding values (e.g. existing translations) as it chooses |
||
| IN |
|
0..1 | uri |
|
||
| IN |
|
0..1 | uri |
identifies
a
target
code
system
in
which
a
mapping
is
sought.
This
parameter
is
an
alternative
to
the
|
||
| IN | dependency | 0..* |
|
|||
| IN |
|
0..1 | uri |
The
|
||
| IN |
|
0..1 |
|
The data value for this dependency |
||
|
|
|
|
|
|
|
True
if
the
concept
could
be
translated
successfully.
The
value
can
only
be
true
if
at
least
one
returned
match
has
|
| OUT | message | 0..1 | string |
Error details, for display to a human. If this is provided when result = true, the message carries hints and warnings (e.g. a note that the matches could be improved by providing additional detail) |
||
| OUT | match | 0..* |
A
concept
in
the
target
value
set
with
|
|||
| OUT |
|
0..1 | code |
A
code
indicating
the
|
||
| OUT | match.concept | 0..1 | Coding |
The translation outcome. Note that this would never have userSelected = true, since the process of translations implies that the user is not selecting the code (and only the client could know differently) |
||
| OUT | match.property | 0..* | A property of this mapping (may be used to supply for example, mapping priority, provenance, presentation hints, flag as experimental, and additional documentation) |
|||
| OUT | match.property.uri |
|
uri |
|
The uri that identifies the property | |
| OUT | match.property.value | 1..1 | Element |
| ||
| OUT | match.product | 0..* | A data value to go in an attribute that is the product of this mapping |
|||
| OUT | match.product.attribute |
|
uri |
|
The attribute for this product | |
|
|
match.product.value | 1..1 | Element |
The
|
||
| OUT | match.dependsOn | 0..* | An data value in an additional attribute that this mapping depends on | |||
| OUT | match.dependsOn.attribute |
|
uri |
|
The attribute that this mapping depends on | |
| OUT | match.dependsOn.value |
|
Element |
The
value
|
||
| OUT |
|
0..1 | uri |
The
canonical
|
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.