STU 3 Ballot

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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

Operation-codesystem-lookup

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

Concept Look Up

OPERATION: Concept Look Up

Given a code/system, or a Coding, get additional details about the concept

URL: [base]/CodeSystem/$lookup

Parameters

UseNameCardinalityTypeBindingDocumentation
INcode0..1code

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

INsystem0..1uri

The system for the code that is to be validated

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.

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: system, version, display, definition, designation, parent, child, and lang.X where X is a language code in a designation. These properties refer to the directly return parameters documented for the operation

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

OUTproperty0..*
OUTproperty.code0..1code
OUTproperty.value1..1string
OUTproperty.description0..1string

Human Readable representation of the propery value

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.value1..1string

The text value for this designation

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 value set and 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.