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 expand. Defaults to the implicit all-LOINC value set (http://loinc.org?fhir_vs), which is every LOINC code. That expansion is not served and answers 422: expand a LOINC group or answer list instead, or ask $validate-code whether a code is in LOINC. The RxNorm value sets this service holds are https://haau3.com/fhir/ValueSet/rxnorm-current-prescribable-content (every concept of the release it serves) and https://haau3.com/fhir/ValueSet/rxnorm-current-prescribable-products (its drug products: clinical and branded drugs and packs). The ICD-10-CM value sets are https://haau3.com/fhir/ValueSet/icd-10-cm (every code of the release it serves, headers included) and https://haau3.com/fhir/ValueSet/icd-10-cm-valid-for-submission (the codes valid for submission for HIPAA-covered transactions, so no header).

Minimum string length: 1
filter
string

Text to narrow the expansion: each word must be the start of a word in a concept's name, and every word must match, with case and accents ignored. On the RxNorm and ICD-10-CM value sets it is required, with at least 3 letters or digits, and the matches come ranked, best first; on ICD-10-CM a code is a name too, so E11 finds E11 and the codes below it. Without it, or with fewer, the answer is 422 coded too-costly. At most 500 characters. For a value set resolved from its own source, narrowing is refused with a 400 naming this parameter, because that source answers a whole expansion or nothing: expand it whole and filter the result.

Required string length: 1 - 500
count
integer

Maximum number of concepts to return (0 returns the total only). On the RxNorm and ICD-10-CM value sets the first 20 come back when it is not sent. For a value set resolved from its own source, narrowing is refused with a 400 naming this parameter, because that source answers a whole expansion or nothing: expand it whole and filter the result.

Required range: 0 <= x <= 1000
offset
integer

Number of concepts to skip, for paging; expansion.total is the number of matching concepts. For a value set resolved from its own source, narrowing is refused with a 400 naming this parameter, because that source answers a whole expansion or nothing: expand it whole and filter the result.

Required range: 0 <= x <= 9007199254740991
displayLanguage
string

Not supported on this operation, and refused with a 400 naming it. This service does not narrow an expansion by language, designation or status.

Minimum string length: 1
includeDesignations
boolean

Not supported on this operation, and refused with a 400 naming it. This service does not narrow an expansion by language, designation or status.

activeOnly
boolean

Not supported on this operation, and refused with a 400 naming it. This service does not narrow an expansion by language, designation or status.

Response

A FHIR ValueSet carrying an expansion.

A FHIR R4 ValueSet.

resourceType
string
required
Allowed value: "ValueSet"