CodeSystem - FHIR v1.4.0

STU 3 Candidate

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

6.28.14 Resource CodeSystem - Operations

This resource has 1 operation associated with it:

$lookup

Concept Look Up

For more information about operations, including how they are invoked, see Operations.

6.28.14.1 Concept Look Up

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

Formal Definition (as a OperationDefinition).

URL: [base]/CodeSystem/$lookup

In Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

code

0..1

(code

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

system

0..1

(uri

The system for the code that is to be validated

version

0..1

(string

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

coding

0..1

Coding

A coding to look up

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.

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

Out Parameters:

Name

Cardinality

Type

Binding

Profile

Documentation

name

1..1

(string

A display name for the code system

version

0..1

(string

The version that these details are based on

display

1..1

(string

The preferred display for this concept

property

0..*

property.code

0..1

(code

property.value

1..1

(string

property.description

0..1

(string

Human Readable representation of the propery value

designation

0..*

Additional representations for this concept

designation.language

0..1

(code

The language this designation is defined for

designation.use

0..1

Coding

A code that details how this designation would be used

designation.value

1..1

(string

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.

6.28.14.1.1 Examples

Looking up a code/system (Request):

GET [base]/CodeSystem/$lookup?system=http://loinc.org&code=1963-8

Lookup using a Coding (Request):

POST [base]/CodeSystem/$lookup
[other headers]

<Parameters xmlns="http://hl7.org/fhir">
  <parameter>
    <name value="coding"/>
  <valueCoding>
    <system value="http://loinc.org"/>
    <code value="1963-8"/>
  </valueCoding>
  </parameter>
</Parameters>

Response:

HTTP/1.1 200 OK
[other headers]

{
  "resourceType" : "Parameters",
  "parameter" : [
    {
    "name" : "name",
    "valueString" : "LOINC"
  },
  {
    "name" : "version",
    "valueString" : "2.48"
  },
  {
    "name" : "designation",
    "valueString" : "Bicarbonate [Moles/volume] in Serum"
  },
  {
    "name" : "abstract",
    "valueString" : "false"
  },
  {
      "name" : "designation",
    "part" : [
    {
      "name" : "value",
      "valueString" : "Bicarbonate [Moles/volume] in Serum "
    }
    ]
  }
  ]
}