APIs

RxTerms API

getAllConcepts

Information returned
All RxTerms concepts
Service domain
https://rxnav.nlm.nih.gov
HTTP request
GET  /REST/RxTerms/allconcepts.xml

Description

This resource returns concept information for all RxTerms concepts.

getAllConcepts does not exclude concepts that have a non-empty SUPPRESS_FOR field in the RxTerms file. The SUPPRESS_FOR field can be retrieved from getAllRxTermInfo.

Parameters

ParameterLocationUseDescriptionDefault
formatPathOptional

Notation for results

One of:
.xml
Get results in XML
.json
Get results in JSON
.xml

Note that HTTP requires that query parameters be "URL encoded". 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 rxtermsdata. It is described in the XML Schema for the RxTerms 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 rxtermsdata. 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:

rxtermsdata
Root element in XML, or anonymous object in JSON
minConceptGroup
Container of RxTerms concepts
minConcept (array)
RxTerms concept
fullName
RxTerms FULL_NAME field
termType
RxTerms TTY field
rxcui
RxNorm identifier

Example: All concepts in RxTerms

XML: https://rxnav.nlm.nih.gov/REST/RxTerms/allconcepts

JSON: https://rxnav.nlm.nih.gov/REST/RxTerms/allconcepts.json

An XML result is shown below.

<rxtermsdata>
    <minConceptGroup>
        <minConcept>
            <fullName>0.005 ML dexamethasone 103.4 MG/ML Injection</fullName>
            <termType>SCD</termType>
            <rxcui>2045404</rxcui>
        </minConcept>
        <minConcept>
            <fullName>0.005 ML dexamethasone 103.4 MG/ML Injection [Dexycu]</fullName>
            <termType>SBD</termType>
            <rxcui>2045409</rxcui>
        </minConcept>
        ...
    </minConceptGroup>
</rxtermsdata>