RxNorm API
getAllProperties
- Information returned
- Concept details
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GETÂ /REST/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' | ||||||||||||||||||
ATC | CODES | RXNCONSO | CODE field when SAB='ATC' | ||||||||||||||||||
AVAILABLE_STRENGTH | ATTRIBUTES | RXNSAT | ATN='RXN_AVAILABLE_STRENGTH' | ||||||||||||||||||
BLA | CODES | RXNSAT | ATN='BLA' | ||||||||||||||||||
BN_CARDINALITY | ATTRIBUTES | RXNSAT | ATN='RXN_BN_CARDINALITY' | ||||||||||||||||||
CVX | CODES | RXNCONSO | CODE field when SAB='CVX' | ||||||||||||||||||
DRUGBANK | CODES | RXNCONSO | CODE field when SAB='DRUGBANK' | ||||||||||||||||||
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' | ||||||||||||||||||
MESH | CODES | RXNSAT | ATN='MESH' | ||||||||||||||||||
MMSL_CODE | CODES | RXNSAT | ATN='MMSL_CODE' | ||||||||||||||||||
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 | ||||||||||||||||||
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' | ||||||||||||||||||
SCHEDULE | ATTRIBUTES | RXNSAT | Derived from ATV where ATN='DCSA' using sources MMSL, MTHSPL and VANDF and converting ATV (e.g., CII) to range 1-5. If two sources disagree on the value, the lowest number is chosen. | ||||||||||||||||||
SNOMEDCT | CODES | RXNCONSO | CODE field when SAB='SNOMEDCT_US' | ||||||||||||||||||
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' | ||||||||||||||||||
USP | CODES | RXNCONSO | CODE field when SAB='USP' | ||||||||||||||||||
VET_DRUG | ATTRIBUTES | RXNSAT | ATN='RXN_VET_DRUG' | ||||||||||||||||||
VUID | CODES | RXNCONSO | CODE field when SAB='VANDF' |
The following SBD/SCD properties, regarding the ingredients or strength of individual drug components, will be removed on or after August 7, 2023. The corresponding information is reported more clearly by getRxcuiHistoryStatus.
Property | Category | RxNorm file | Details |
---|---|---|---|
Active_ingredient_name | ATTRIBUTES | RXNSAT | Derived from ATN='RXN_AI' |
Active_ingredient_RxCUI | ATTRIBUTES | RXNSAT | Derived from ATN='RXN_AI' |
Active_moiety_name | ATTRIBUTES | RXNSAT | Derived from ATN='RXN_AM' |
Active_moiety_RxCUI | ATTRIBUTES | RXNSAT | Derived from ATN='RXN_AM' |
BoSS_name | ATTRIBUTES | RXNSAT | Derived from ATN='RXN_BOSS_FROM' |
BoSS_RxCUI | ATTRIBUTES | RXNSAT | Derived from ATN='RXN_BOSS_FROM' |
Denominator_Units | ATTRIBUTES | RXNSAT | ATN='RXN_BOSS_STRENGTH_DENOM_UNIT', if any; otherwise, interpreted from ATN='RXN_STRENGTH'. RxNorm's denominator unit of "1" is represented by the word "EACH". |
Denominator_Value | ATTRIBUTES | RXNSAT | ATN='RXN_BOSS_STRENGTH_DENOM_VALUE', if any; otherwise, interpreted from ATN='RXN_STRENGTH' |
Numerator_Units | ATTRIBUTES | RXNSAT | ATN='RXN_BOSS_STRENGTH_NUM_UNIT', if any; otherwise, interpreted from ATN='RXN_STRENGTH' |
Numerator_Value | ATTRIBUTES | RXNSAT | ATN='RXN_BOSS_STRENGTH_NUM_VALUE', if any; otherwise, interpreted from ATN='RXN_STRENGTH' |
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 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: Names and Codes properties of azatadine (RxCUI=18600)
XML: https://rxnav.nlm.nih.gov/REST/rxcui/18600/allProperties?prop=names+codes
JSON: https://rxnav.nlm.nih.gov/REST/rxcui/18600/allProperties.json?prop=names+codes
An XML result is shown below.
<rxnormdata> <propConceptGroup> <propConcept> <propCategory>CODES</propCategory> <propName>ATC</propName> <propValue>R06AX09</propValue> </propConcept> <propConcept> <propCategory>CODES</propCategory> <propName>DRUGBANK</propName> <propValue>DB00719</propValue> </propConcept> <propConcept> <propCategory>CODES</propCategory> <propName>MESH</propName> <propValue>C006656</propValue> </propConcept> <propConcept> <propCategory>CODES</propCategory> <propName>MMSL_CODE</propName> <propValue>GNd00791</propValue> </propConcept> <propConcept> <propCategory>CODES</propCategory> <propName>RxCUI</propName> <propValue>18600</propValue> </propConcept> <propConcept> <propCategory>CODES</propCategory> <propName>SNOMEDCT</propName> <propValue>1594006</propValue> </propConcept> <propConcept> <propCategory>CODES</propCategory> <propName>SNOMEDCT</propName> <propValue>372662006</propValue> </propConcept> <propConcept> <propCategory>CODES</propCategory> <propName>VUID</propName> <propValue>4019620</propValue> </propConcept> <propConcept> <propCategory>NAMES</propCategory> <propName>RXNAV_STR</propName> <propValue>azatadine</propValue> </propConcept> <propConcept> <propCategory>NAMES</propCategory> <propName>RxNorm Name</propName> <propValue>azatadine</propValue> </propConcept> </propConceptGroup> </rxnormdata>