Terminology - Standardize Lab

Standardize a lab observation or report code.

Note
If you are unsure if codings are labs or other observations or reports, use Standardize Observation operation.

Contents

Guides
Endpoints
Inputs
- Body Parameters
- Request Headers
Output
- Reference Codings
- Response Fields
Details
- Batch Mode
Example

Guides

See the Programming Guide for general Terminology API information.

Endpoints

POST /terminology/v1/standardize/lab

POST /terminology/v1/standardize/lab/batch

Inputs

The body specifies the input coding. See the Standardize API Overview for details.

Body Parameters

code string

Code value. Either code or display is required.

display string

Display string. Either code or display is required.

system string

The source code system (as a name or URL).

targetSystem string

The desired code system (as a name or URL).

Request Headers

Header	Value
`x-api-key`	`YOUR_API_KEY`, obtained from the Developer Portal
`content-type`	`application/json`
`accept`	`application/json`

Output

The output is a list of matching reference codings from several standard code systems based on domain. See the Standardize API Overview for details.

Reference Codings

May return reference codings from:

LOINC
SNOMED

Response Fields

coding collection

List of matching code values.

Element Fields

coding[n].code string

Code value.

coding[n].system string

The source code system (as a URL).

coding[n].display string

Display string.

coding[n].mapMethod string

Describes how the coding was determined from the original field value. See Mapping Methods.

Details

The following sections provide additional details about the message handling.

Batch Mode

For batch mode, specify the body parameters in the items field, as explained in Batch Operations. The output data will then contain an items array with the usual standardize output for each item.

Example

Try It
Try out the operations, with examples, in the Developer Portal Sandbox.

Sample Input

{
    "display": "hba1c 1/15/22 from outside lab"
}

Sample Response

{
    "coding": [
        {
            "system": "http://loinc.org",
            "code": "4548-4",
            "display": "HbA1c MFr Bld",
            "mapMethod": "NLP"
        },
        {
            "system": "http://snomed.info/sct",
            "code": "43396009",
            "display": "Hemoglobin A1c measurement (procedure)",
            "mapMethod": "NLP"
        }
    ]
}

For additional examples, or to try out the API live, see the Developer Portal Sandbox