Prescribable RxNorm API
getAllProperties
- Information returned
- Concept details
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GETÂ /REST/Prescribe/rxcui/rxcui/allProperties.xml?prop=yourPropCategories
Description
Return certain categories of properties for the RxNorm concept specified by rxcui. Information returned includes property name, value and category. The prop parameter selects the categories of properties to retrieve.
The following table shows each property, its category, the RxNorm file where it resides, and other details. Note that only the properties that exist for the concept will be returned. The RxNorm technical documentation contains more details on RxNorm properties.
Property | Category | RxNorm file | Details | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ACTIVATED | ATTRIBUTES | RXNSAT | ATN='RXN_ACTIVATED' | ||||||||||||||||||
ANADA | CODES | RXNSAT | ATN='ANADA' | ||||||||||||||||||
ANDA | CODES | RXNSAT | ATN='ANDA' | ||||||||||||||||||
AVAILABLE_STRENGTH | ATTRIBUTES | RXNSAT | ATN='RXN_AVAILABLE_STRENGTH' | ||||||||||||||||||
BLA | CODES | RXNSAT | ATN='BLA' | ||||||||||||||||||
BN_CARDINALITY | ATTRIBUTES | RXNSAT | ATN='RXN_BN_CARDINALITY' | ||||||||||||||||||
GENERAL_CARDINALITY | ATTRIBUTES | RXNCONSO | SINGLE, MULTI or HYBRID, according to the term type and the number of ingredients as reflected by the presence of a related TTY=MIN (multiple ingredient) concept:
| ||||||||||||||||||
HUMAN_DRUG | ATTRIBUTES | RXNSAT | ATN='RXN_HUMAN_DRUG' | ||||||||||||||||||
IN_EXPRESSED_FLAG | ATTRIBUTES | RXNSAT | ATN='RXN_IN_EXPRESSED_FLAG' | ||||||||||||||||||
NADA | CODES | RXNSAT | ATN='NADA' | ||||||||||||||||||
NDA | CODES | RXNSAT | ATN='NDA' | ||||||||||||||||||
NHRIC | CODES | RXNSAT | ATN='NHRIC' | ||||||||||||||||||
ORIG_CODE | CODES | RXNSAT | ATN='orig_code' | ||||||||||||||||||
ORIG_SOURCE | SOURCES | RXNSAT | ATN='orig_source' | ||||||||||||||||||
PRESCRIBABLE | ATTRIBUTES | RXNCONSO | 'Y' when CVF=4096 | ||||||||||||||||||
Prescribable Synonym | NAMES | RXNCONSO | STR field when TTY='PSN' | ||||||||||||||||||
QUALITATIVE_DISTINCTION | ATTRIBUTES | RXNSAT | ATN='RXN_QUALITATIVE_DISTINCTION' | ||||||||||||||||||
QUANTITY | ATTRIBUTES | RXNSAT | ATN='RXN_QUANTITY' | ||||||||||||||||||
RxCUI | CODES | RXNCONSO | RXCUI field | ||||||||||||||||||
RXNAV_HUMAN_DRUG | ATTRIBUTES | RXNSAT | Derived from RXN_HUMAN_DRUG attribute: "US" when there is a related SCD or SBD with RXN_HUMAN_DRUG="US", otherwise empty. This property does not apply to drug packs (term types GPCK or BPCK). For drug packs, refer to property HUMAN_DRUG. | ||||||||||||||||||
RXNAV_STR | NAMES | RXNCONSO | Concept name (or, for SBD or BPCK, a shortest SY synonym); in Tallman capitalization where available | ||||||||||||||||||
RXNAV_VET_DRUG | ATTRIBUTES | RXNSAT | Derived from RXN_VET_DRUG attribute: "US" when there is a related SCD or SBD with RXN_VET_DRUG="US", otherwise empty | ||||||||||||||||||
RxNorm Name | NAMES | RXNCONSO | STR field when SAB='RXNORM' | ||||||||||||||||||
RxNorm Synonym | NAMES | RXNCONSO | Shortest length STR field for TTY='SY' | ||||||||||||||||||
SPL_SET_ID | CODES | RXNSAT | ATN='SPL_SET_ID' | ||||||||||||||||||
STRENGTH | ATTRIBUTES | RXNSAT | ATN='RXN_STRENGTH' | ||||||||||||||||||
Source | SOURCES | RXNCONSO | Derived from SAB field (non-RXNORM sources) | ||||||||||||||||||
TTY | ATTRIBUTES | RXNCONSO | TTY field | ||||||||||||||||||
Tallman Synonym | NAMES | RXNCONSO | STR field when TTY='TMSY' | ||||||||||||||||||
UNII_CODE | CODES | RXNCONSO | CODE field when SAB='MTHSPL' and TTY='SU' | ||||||||||||||||||
VET_DRUG | ATTRIBUTES | RXNSAT | ATN='RXN_VET_DRUG' |
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 |
prop | Query | Required | Property categories to retrieve, or ALL (Space-separated list. See getPropCategories for the menu.) |
All query parameters are case-insensitive.
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 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
Example: 'Attributes' properties of acetaminophen (RxCUI=161)
XML: https://rxnav.nlm.nih.gov/REST/Prescribe/rxcui/161/allProperties?prop=attributes
JSON: https://rxnav.nlm.nih.gov/REST/Prescribe/rxcui/161/allProperties.json?prop=attributes
An XML result is shown below.
<rxnormdata> <propConceptGroup> <propConcept> <propCategory>ATTRIBUTES</propCategory> <propName>GENERAL_CARDINALITY</propName> <propValue>SINGLE</propValue> </propConcept> <propConcept> <propCategory>ATTRIBUTES</propCategory> <propName>PRESCRIBABLE</propName> <propValue>Y</propValue> </propConcept> <propConcept> <propCategory>ATTRIBUTES</propCategory> <propName>RXNAV_HUMAN_DRUG</propName> <propValue>US</propValue> </propConcept> <propConcept> <propCategory>ATTRIBUTES</propCategory> <propName>TTY</propName> <propValue>IN</propValue> </propConcept> </propConceptGroup> </rxnormdata>