APIs

RxTerms API

getAllRxTermInfo

Information returned
RxTerms information for a specified RxNorm concept
Service domain
https://rxnav.nlm.nih.gov
HTTP request
GET  /REST/RxTerms/rxcui/rxcui/allinfo.xml

Description

This resource gets the RxTerms information for the RxNorm drug product specified by rxcui.

RxTerms includes concepts of term types SCD, SBD, BPCK, and GPCK.

Parameters

ParameterLocationUseDescriptionDefault
rxcuiPathRequiredRxNorm identifier
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
rxtermsProperties
Properties of an RxTerms concept
brandName
RxTerms BRAND_NAME field
displayName
RxTerms DISPLAY_NAME field
synonym
RxTerms DISPLAY_NAME_SYNONYM field
fullName
RxTerms FULL_NAME field
fullGenericName
RxTerms FULL_GENERIC_NAME field
strength
RxTerms STRENGTH field
rxtermsDoseForm
RxTerms NEW_DOSE_FORM field
route
RxTerms ROUTE field
termType
RxTerms TTY field
rxcui
RxNorm identifier
genericRxcui
RxTerms GENERIC_RXCUI field
rxnormDoseForm
RxTerms RXN_DOSE_FORM field
suppress
RxTerms SUPPRESS_FOR field

Example: Concept information

XML: https://rxnav.nlm.nih.gov/REST/RxTerms/rxcui/198440/allinfo

JSON: https://rxnav.nlm.nih.gov/REST/RxTerms/rxcui/198440/allinfo.json

An XML result is shown below.

<rxtermsdata>
    <rxtermsProperties>
        <brandName/>
        <displayName>Acetaminophen (Oral Pill)</displayName>
        <synonym>APAP</synonym>
        <fullName>acetaminophen 500 MG Oral Tablet</fullName>
        <fullGenericName>acetaminophen 500 MG Oral Tablet</fullGenericName>
        <strength>500 mg</strength>
        <rxtermsDoseForm>Tab</rxtermsDoseForm>
        <route>Oral Pill</route>
        <termType>SCD</termType>
        <rxcui>198440</rxcui>
        <genericRxcui/>
        <rxnormDoseForm>Oral Tablet</rxnormDoseForm>
        <suppress/>
    </rxtermsProperties>
</rxtermsdata>