Release 5 FHIR CI-Build

This page is part of the Continuous Integration Build of FHIR Specification (v5.0.0: R5 - STU ). This is the current published version in it's permanent home (it will always (will be available incorrect/inconsistent at this URL). For a full list of available versions, see times).
See the Directory of published versions . Page versions: R5 R4B R4 R3

Example OperationDefinition/CodeSystem-lookup (Narrative)

Maturity Level : N/A
Responsible Owner: Terminology Infrastructure Work Group Standards Status : Informative Compartments : No 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

Generated Narrative: OperationDefinition CodeSystem-lookup

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 CodeSystem.concept.designation.language)

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: name, version (code system info) and code information: display, designation, and lang.X where X is a designation language code. These properties are returned explicitly in named out parameters with matching names, or in designations. In addition, any property codes defined by this specification or by the CodeSystem ( CodeSystem.property.code ) are allowed, and these are returned in the out parameter property

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 definition 0..1 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 Coding | boolean | code | dateTime | decimal | integer | string Element

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 property.source 0..1 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 Coding | boolean | code | dateTime | decimal | integer | string Element

The value of the sub-property returned

OUT property.subproperty.description 0..1 string

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

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.