DSTU2

This page is part of the FHIR Specification (v0.0.82: (v1.0.2: DSTU 1). 2). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions

Operation-valueset-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]/ValueSet/$Concept Look Up [base]/ValueSet/$lookup

Parameters

Use Name Cardinality Type Binding Documentation
IN code 0..1 code

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

IN system 0..1 uri

The system for the code that is to be validated

IN version 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.

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 abstract 0..1 boolean

Whether this code is an abstract concept

OUT designation 0..*

Additional representations for this concept

OUT language designation.language 0..1 code

The language this designation is defined for

OUT use designation.use 0..1 Coding

A code that details how this designation would be used

OUT value designation.value 1..1 string

The text value for this designation

Note that the $lookup operation is more than just a value set 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.