Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

Example OperationDefinition/CodeSystem-lookup (Narrative)

Vocabulary Work GroupMaturity Level: N/AStandards Status: InformativeCompartments: Not linked to any defined compartments

This is the narrative for the resource. See also the XML, JSON or Turtle format.

Note that this is the formal definition for the lookup operation as an OperationDefinition on CodeSystem. See the Operation documentation


URL: [base]/CodeSystem/$lookup

URL: [base]/CodeSystem/[id]/$lookup

Parameters

UseNameCardinalityTypeBindingDocumentation
INcode0..1code

The code that is to be located. If a code is provided, a system must be provided

INsystem0..1uri

The system for the code that is to be located

INversion0..1string

The version of the system, if one was provided in the source data

INcoding0..1Coding

A coding to look up

INdate0..1dateTime

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.

INdisplayLanguage0..1code

The requested language for display (see CodeSystem.concept.designation.language)

INproperty0..*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: url, name, version (code system info) and code information: display, definition, designation, parent and child, and for designations, lang.X where X is a designation language code. Some of the properties are returned explicit in named parameters (when the names match), and the rest (except for lang.X) in the property parameter group

INuseSupplement0..*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

OUTname1..1string

A display name for the code system

OUTversion0..1string

The version that these details are based on

OUTdisplay1..1string

The preferred display for this concept

OUTdefinition0..1string

A statement of the meaning of the concept from the code system

OUTdesignation0..*

Additional representations for this concept

OUTdesignation.language0..1code

The language this designation is defined for

OUTdesignation.use0..1Coding

A code that details how this designation would be used

OUTdesignation.additionalUse0..*Coding

Additional codes that detail how this designation would be used (if there is more than one)

OUTdesignation.value1..1string

The text value for this designation

OUTproperty0..*

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

OUTproperty.code1..1code

Identifies the property returned

OUTproperty.value0..1Coding | boolean | code | dateTime | decimal | integer | string

The value of the property returned

OUTproperty.description0..1string

Human Readable representation of the property value (e.g. display for a code)

OUTproperty.source0..1canonical

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.

OUTproperty.subproperty0..*

Nested Properties (mainly used for SNOMED CT decomposition, for relationship Groups)

OUTproperty.subproperty.code1..1code

Identifies the sub-property returned

OUTproperty.subproperty.value1..1Coding | boolean | code | dateTime | decimal | integer | string

The value of the sub-property returned

OUTproperty.subproperty.description0..1string

Human Readable representation of the sub-property value (e.g. display for a code)

OUTproperty.subproperty.source0..1canonical

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.