This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
(v5.0.0:
R5
-
Mixed
Normative
and
STU
)
).
This
is
the
current
published
version
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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
|
|
Maturity Level : N/A | Standards Status : Informative |
Compartments
:
|
This is the narrative for the resource. See also the XML , JSON or Turtle format.
Note
that
this
operation
definition
is:
http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup
Given
a
code/system,
or
a
Coding,
get
additional
details
about
is
the
concept,
including
definition,
status,
designations,
and
properties.
One
of
formal
definition
for
the
products
of
this
lookup
operation
is
a
full
decomposition
of
a
code
from
a
structured
terminology.
When
invoking
this
operation,
a
client
SHALL
provide
both
a
system
and
a
code,
either
using
the
system+code
parameters,
or
in
as
an
OperationDefinition
on
CodeSystem.
See
the
coding
parameter.
Other
parameters
are
optional
Operation
documentation
URL: [base]/CodeSystem/$lookup
URL: [base]/CodeSystem/[id]/$lookup
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | code | 0..1 | code |
The code that is to be located. If a code is provided, a system must be provided |
||
| IN | system | type | 0..1 | uri |
The system for the code that is to be located |
|
| IN | version | type | 0..1 | string |
The version of the system, if one was provided in the source data |
|
| IN | coding | 0..1 | Coding |
A coding to look up |
||
| IN | date | 0..1 | dateTime |
The date for which the information should be returned. Normally, this is the current conditions (which is the default value) but under some circumstances, systems need to acccess this information as it would have been in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy. |
||
| IN | displayLanguage | 0..1 | code |
The
requested
language
for
display
(see
|
||
| IN | property | 0..* | code |
A
property
that
the
client
wishes
to
be
returned
in
the
output.
If
no
properties
are
specified,
the
server
chooses
what
to
return.
The
following
properties
are
defined
for
all
code
systems:
|
||
| IN | useSupplement | 0..* | canonical |
Supplements
to
take
into
account
when
performing
the
$lookup
operation.
The
supplements
must
be
for
the
same
CodeSystem.
By
default,
supplements
for
the
code
system
are
not
automatically
included
except
where
they
provide
additional
designations
that
may
be
indicated
by,
for
example,
the
displayLanguage
parameter
|
||
| OUT | name | 1..1 | string |
A display name for the code system |
||
| OUT | version | 0..1 | string |
The version that these details are based on |
||
| OUT | display | 1..1 | string |
The preferred display for this concept |
||
| OUT |
|
|
string |
A statement of the meaning of the concept from the code system | ||
| OUT | designation | 0..* |
Additional representations for this concept |
|||
| OUT | designation.language | 0..1 | code |
The language this designation is defined for |
||
| OUT | designation.use | 0..1 | Coding |
A code that details how this designation would be used |
||
| OUT | designation.additionalUse | 0..* | Coding | Additional codes that detail how this designation would be used (if there is more than one) | ||
| OUT | designation.value | 1..1 | string |
The text value for this designation |
||
| OUT | property | 0..* |
One or more properties that contain additional information about the code, including status. For complex terminologies (e.g. SNOMED CT, LOINC, medications), these properties serve to decompose the code |
|||
| OUT | property.code | 1..1 | code |
Identifies the property returned |
||
| OUT | property.value | 0..1 |
|
The value of the property returned |
||
| OUT | property.description | 0..1 | string |
Human Readable representation of the property value (e.g. display for a code) |
||
| OUT |
|
|
canonical |
If information from a supplement is included as a property (e.g. any additional property or property value), then this parameter must assert the url of the supplement. |
||
| OUT | property.subproperty | 0..* |
Nested Properties (mainly used for SNOMED CT decomposition, for relationship Groups) |
|||
| OUT | property.subproperty.code | 1..1 | code |
Identifies the sub-property returned |
||
| OUT | property.subproperty.value | 1..1 |
|
The value of the sub-property returned |
||
| OUT | property.subproperty.description | 0..1 | string |
Human
Readable
representation
of
the
|
||
| OUT | property.subproperty.source | 0..1 | canonical | If information from a supplement is included as a subproperty (e.g. any additional subproperty or subproperty value), then this parameter must assert the url of the supplement. |
Note that the $lookup operation is more than just a code system search - the server finds the concept, and gathers the return information from the underlying code system definitions.
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.