Skip to main content
GET
Look up a code

Authorizations

Authorization
string
header
required

Your platform API key (haau3_sk_…), sent as Authorization: Bearer <key>.

Query Parameters

code
string
required

The code to look up in the code system.

Minimum string length: 1
system
string
default:http://loinc.org

Code system URI to look up against. Defaults to LOINC (http://loinc.org).

Minimum string length: 1
version
string

Optional code system version. Defaults to the server's current version.

Minimum string length: 1
property

Property to return, repeatable. Narrows the response to the named properties of the code system; omit it to receive all of them. An unrecognised property name is silently omitted from the response, so treat an absent property as 'no answer', never as a negative.

Minimum string length: 1
displayLanguage
string

Language for the returned display and designations. Defaults to en-US, which also keeps responses small — the upstream otherwise returns ~30 translations per code.

Minimum string length: 1
date
string

The date for which the lookup should be valid.

Minimum string length: 1

Response

A FHIR Parameters resource describing the code.

The response is of type object.