Terminology - Classify

The Classify Terminology API takes an input coding and provides a set of classifications based on the domain. For example, a medication code may be classified by its ingredient(s) and strength, while a condition is classified by category and whether it is acute or chronic.

Overview

Each domain has its own classify operation, but they all work in a similar manner. In the body parameters of the request, you provide the code and system for the input coding. You may optionally provide a display value. For example:

{
    "code": "861004",
    "system": "RxNorm"
}

Rosetta will then classify the input coding into a set of domain-specific classifications.

{
    "medRtTherapeuticClass": [
        "Blood Glucose Regulators"
    ],
    "rxNormIngredient": [
        "metformin"
    ],
    "rxNormStrength": "1000MG",
    "rxNormGeneric": true,
    "immunization": false,
    "covid19Rx": null
}

Classifications

The classifications in the response data are represented as a set of key/value pairs. The values can take several forms, depending on the domain:

• String(s) - A simple string or a list of strings (e.g., RxNorm ingredients).
• Codeable Concept - A coding represented by a code, code system, and display value (e.g., HCC Category).
• Boolean - A true or false value (e.g., whether a condition is acute).
• Categorical - A string value with a defined set of possible values (e.g., types of COVID-19 lab reports).

If a particular classification was not found for the given input, the value for that key will be null.

Operations

The following classify operations are available:

Alternatively, you can use the $classify operation which is a superset of the individual domain-specific classify operations.