RxNorm API
getRxNormVersion
- Information returned
- RxNorm data set and API versions
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GETÂ /REST/version.xml
Description
Get the version of the RxNorm data set and the version of the REST APIs.
Scope
Current: concepts in the current RxNorm data set that have an atom with SUPPRESS=N
Parameters
Parameter | Location | Use | Description | Default |
---|---|---|---|---|
format | Path | Optional | Notation for results One of:
| .xml |
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
- version
- Version of RxNorm that the API dispenses
- apiVersion
- Version of RxNorm API
Example: Current RxNorm version
XML: https://rxnav.nlm.nih.gov/REST/version
JSON: https://rxnav.nlm.nih.gov/REST/version.json
An XML result is shown below.
<rxnormdata> <version>05-Aug-2024</version> <apiVersion>3.1.298</apiVersion> </rxnormdata>