RxTerms API
getRxTermDisplayName
- Information returned
- RxTerms display name for a specified RxNorm concept
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GETÂ /REST/RxTerms/rxcui/rxcui/name.xml
Description
Get the RxTerms display name for the RxNorm drug product specified by rxcui.
RxTerms includes concepts of term types SCD, SBD, BPCK, and GPCK.
Parameters
Parameter | Location | Use | Description | Default |
---|---|---|---|---|
rxcui | Path | Required | RxNorm identifier | |
format | Path | Optional | Notation for results One of:
| .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
- displayGroup
- RxTerms concept ID and display name
- rxcui
- (Always empty)
- displayName
- RxTerms DISPLAY_NAME field
Example: RxTerms display name
XML: https://rxnav.nlm.nih.gov/REST/RxTerms/rxcui/198440/name
JSON: https://rxnav.nlm.nih.gov/REST/RxTerms/rxcui/198440/name.json
An XML result is shown below.
<rxtermsdata> <displayGroup> ... <displayName>Acetaminophen (Oral Pill)</displayName> </displayGroup> </rxtermsdata>