Prescribable RxNorm API
getRxProperty
- Information returned
- A property of a concept
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GETÂ /REST/Prescribe/rxcui/rxcui/property.xml?propName=propName
Description
Get the value(s) of property propName of the RxNorm concept identified by rxcui.
Results include a category for each property. See getPropNames for the properties and their respective category.
Scope
Active: concepts in the current RxNorm data set that have an atom with SAB=RXNORM and SUPPRESS=N
Parameters
Parameter | Location | Use | Description | Default |
---|---|---|---|---|
rxcui | Path | Required | RxNorm identifier | |
format | Path | Optional | Notation for results One of:
| .xml |
propName | Query | Required | Property name (See getPropNames for the menu.) |
All query parameters are case-insensitive.
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 rxnormdata. It is described in the XML Schema for the Prescribable 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
- propConceptGroup
- Collection of properties
- propConcept (array)
- One property name and value. Repeated for additional values
- propCategory
- RxNav category that includes the property
- propName
- Property name
- propValue
- Value of the property
See also
Example: UNII_CODE identifier for morphine (RxCUI=7052)
XML: https://rxnav.nlm.nih.gov/REST/Prescribe/rxcui/7052/property?propName=UNII_CODE
JSON: https://rxnav.nlm.nih.gov/REST/Prescribe/rxcui/7052/property.json?propName=UNII_CODE
An XML result is shown below.
<rxnormdata> <propConceptGroup> <propConcept> <propCategory>CODES</propCategory> <propName>UNII_CODE</propName> <propValue>76I7G6D29C</propValue> </propConcept> </propConceptGroup> </rxnormdata>