getAllConceptsByStatus

Information returned
Concepts having a specified status
Service domain
https://rxnav.nlm.nih.gov
HTTP request
GET  /REST/allstatus.xml?status=values

Description

Return concept information for specified status values.

Scope

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

Parameters

ParameterLocationUseDescriptionDefault
formatPathOptional

Notation for results

One of:
.xml
Get results in XML
.json
Get results in JSON
.xml
statusQueryOptionalStatus(es)
One or more of:
Active
In RXNCONSO with SAB=RXNORM and SUPPRESS=N
Obsolete
In RXNCONSO with SUPPRESS=O
Quantified
In RXNCONSO with SUPPRESS=E
Remapped
Translated (perhaps iteratively) by RXNATOMARCHIVE to an Active concept
NotCurrent
Neither in RXNCONSO with SAB=RXNORM and SUPPRESS=N; nor translated by RXNATOMARCHIVE to an Active concept
ALL
Any status

(Space-separated list.)

ALL

All query parameters are case-insensitive.

Note that parameters must be "URL encoded", so a "space-separated list" in a URL 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>211</rxcui>
            <name>Topicycline</name>
            <tty>BN</tty>
        </minConcept>
        <minConcept>
            <rxcui>768</rxcui>
            <name>Synflex</name>
            <tty>BN</tty>
        </minConcept>
        ...
    </minConceptGroup>
</rxnormdata>