Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

A live platform API key (haau3_sk_live_…), sent as Authorization: Bearer <key>. It works for every service outside the Sandbox. Create one on the API keys page at https://platform.haau3.com.

Headers

X-Request-Id
string<uuid>

An id of your own for this request, as a UUID. It comes back in the X-Correlation-Id header and is kept with haau3's record of the request. Any value that is not a UUID is ignored. See https://docs.haau3.com/errors#request-ids.

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 up to 100 times. 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. More than 100 is refused with a 400 coded too-long.

Minimum string length: 1
displayLanguage
string

Language for the returned display and designations. Defaults to en-US, which also keeps answers small, since a code can have about 30 translations. RxNorm and ICD-10-CM are held in English only: another language is answered in English, with a warning parameter saying so.

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.

A FHIR R4 Parameters.

resourceType
string
required
Allowed value: "Parameters"
parameter
object[]