$lookup

Concept Look Up & Decomposition

activeFHIR Core package4.3.0operation7 inputs5 outputs

Given a code/system, or a Coding, get additional details about the concept, including definition, status, designations, and properties. One of the products of this 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 the coding parameter. Other parameters are optional

Metadata

hl7.org/fhir
Canonical URL
http://hl7.org/fhir/OperationDefinition/CodeSystem-lookup
Code
$lookup
Kind
operation
Affects State
No
Publisher
HL7 (FHIR Project)

Invocation Context

Can be invoked at:
Type Level
Target Resources:
CodeSystem
Affects State:No

Implementation Notes

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.

Input Parameters (7)

NameTypeCard.Description
codecode0..1The code that is to be located. If a code is provided, a system must be provided
systemuri0..1The system for the code that is to be located
versionstring0..1The version of the system, if one was provided in the source data
codingCoding0..1A coding to look up
datedateTime0..1The 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.
displayLanguagecode0..1The requested language for display (see $expand.displayLanguage)
propertycode0..*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

Output Parameters (5)

NameTypeCard.Description
namestring1..1A display name for the code system
versionstring0..1The version that these details are based on
displaystring1..1The preferred display for this concept
designationany0..*Additional representations for this concept
propertyany0..*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

Additional Information

Version
4.3.0
Date
2022-05-28T12:47:40+10:00