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

url
string
default:http://loinc.org?fhir_vs

Canonical URL of the value set to validate against. Defaults to the implicit all-LOINC value set (http://loinc.org?fhir_vs), which is every LOINC code.

Minimum string length: 1
code
string
required

The code to validate.

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

Code system URI of the code. Defaults to LOINC (http://loinc.org).

Minimum string length: 1
display
string

Optional display to check against the code's own display. A mismatch returns result: false with the expected display alongside, which means the code is valid and only the label differs. Do not read that as an invalid code. On RxNorm and ICD-10-CM any name the code has matches: RxNorm's other names, and an ICD-10-CM code's short title.

Minimum string length: 1
displayLanguage
string

Language to use when checking the display. RxNorm and ICD-10-CM are held in English only: another language is checked against the English names, and the message says so.

Minimum string length: 1
date
string

The date for which the validation should be valid.

Minimum string length: 1

Response

A FHIR Parameters resource carrying result.

A FHIR R4 Parameters.

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