Description

Return concept information for specified status values.

The returned name and TTY reflect the concept as represented in the current RxNorm. For Remapped-status concepts, the name and TTY come from the atom archive if there is no current source. A TTY is provided only if the name is from the atom archive.

Active

The concept is in the current RxNorm data set and has a non-suppressed term (SUPPRESS="N" in RXNCONSO) from the RxNorm vocabulary (SAB="RXNORM" in RXNCONSO).

Obsolete

The concept is designated as obsolete (SUPRRESS="O" in RXNCONSO) in the current data set. RxNorm has not designated any Active concept as equivalent.

Remapped

The concept was Active or Obsolete at one time, but is not in the RXNCONSO file in the current data set and has been remapped (in RXNATOMARCHIVE) to one or more Active or Obsolete concepts. Those concepts are returned in the remappedConcept element.

Quantified

The concept has been designated as non-dispensable for lack of a quantity factor (SUPPRESS="E" in RXNCONSO). Related concepts with a quantity factor are returned in the quantifiedConcept element.

NotCurrent

The concept satisfies one of the following conditions:

• The concept exists in the current data set but has no RxNorm vocabulary terms.

• The concept existed in previous monthly versions, but has been removed and is not remapped to any Active or Obsolete concepts.

Unknown

The RxCUI has never been present in an RxNorm monthly release.

Scope

Current and Historical: concepts in current and previous RxNorm data sets

Parameters

All query parameters are case-insensitive.

Note that HTTP requires that query parameters be "URL encoded". For instance, a "space-separated list" will, in practice, usually appear to use either a plus sign (+) or %20 as the separator. For full information on URL encoding, please refer to IETF RFC 3986, "Uniform Resource Identifier".

Output structure

Results are available as either XML or JSON.

• The XML result has the root element rxnormdata. It is described in the XML Schema for the RxNorm API; the relevant element structure is summarized below. Elements that would be empty might be left out.

• The JSON result is an object {...}, analogous to the content of the XML rxnormdata. Fields that might occur multiple times in the XML are expressed as an array. Fields that would be empty might be null or left out. Numbers are expressed as strings.

Both XML and JSON results follow the same outline:

rxnormdata

Root element in XML, or anonymous object in JSON

minConceptGroup

minConcept (array)

RxNorm concept

rxcui

RxNorm identifier

name

Concept name from SAB=RXNORM

tty

Term type

Example: Obsolete concepts

XML: https://rxnav.nlm.nih.gov/REST/allstatus?status=obsolete

JSON: https://rxnav.nlm.nih.gov/REST/allstatus.json?status=obsolete

An XML result is shown below.

<rxnormdata>
    <minConceptGroup>
        <minConcept>
            <rxcui>1000016</rxcui>
            <name>Uritact</name>
            <tty>BN</tty>
        </minConcept>
        <minConcept>
            <rxcui>1000021</rxcui>
            <name>atropine / benzoate / hyoscyamine / methenamine / methylene blue / phenyl salicylate Oral Tablet [Uritact]</name>
            <tty>SBDF</tty>
        </minConcept>
        ...
    </minConceptGroup>
</rxnormdata>