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.

PropertyCategoryRxNorm fileDetails
ACTIVATEDATTRIBUTESRXNSATATN='RXN_ACTIVATED'
ANADACODESRXNSATATN='ANADA'
ANDACODESRXNSATATN='ANDA'
ATCCODESRXNCONSOCODE field when SAB='ATC'
AVAILABLE_STRENGTHATTRIBUTESRXNSATATN='RXN_AVAILABLE_STRENGTH'
Active_ingredientATTRIBUTESRXNSATATN='RXN_BOSS_AI'
Active_moietyATTRIBUTESRXNSATATN='RXN_BOSS_AM'
BLACODESRXNSATATN='BLA'
BN_CARDINALITYATTRIBUTESRXNSATATN='RXN_BN_CARDINALITY'
BoSSATTRIBUTESRXNSATDerived from ATN='RXN_BOSS_FROM'. Values are 'Active_ingredient' or 'Active_moiety'
CVXCODESRXNCONSOCODE field when SAB='CVX'
DRUGBANKCODESRXNCONSOCODE field when SAB='DRUGBANK'
Denominator_UnitsATTRIBUTESRXNSATATN='RXN_BOSS_STRENGTH_DENOM_UNIT'
Denominator_ValueATTRIBUTESRXNSATATN='RXN_BOSS_STRENGTH_DENOM_VALUE'
GENERAL_CARDINALITYATTRIBUTESRXNCONSODerived using TTY and related concepts. Values are SINGLE, MULTI or HYBRID.
HUMAN_DRUGATTRIBUTESRXNSATATN='RXN_HUMAN_DRUG'
IN_EXPRESSED_FLAGATTRIBUTESRXNSATATN='RXN_IN_EXPRESSED_FLAG'
MESHCODESRXNSATATN='MESH'
MMSL_CODECODESRXNSATATN='MMSL_CODE'
NADACODESRXNSATATN='NADA'
NDACODESRXNSATATN='NDA'
NHRICCODESRXNSATATN='NHRIC'
Numerator_UnitsATTRIBUTESRXNSATATN='RXN_BOSS_STRENGTH_NUM_UNIT'
Numerator_ValueATTRIBUTESRXNSATATN='RXN_BOSS_STRENGTH_NUM_VALUE'
ORIG_CODECODESRXNSATATN='orig_code'
ORIG_SOURCESOURCESRXNSATATN='orig_source'
PRESCRIBABLEATTRIBUTESRXNCONSO'Y' when CVF=4096
Prescribable SynonymNAMESRXNCONSOSTR field when TTY='PSN'
QUALITATIVE_DISTINCTIONATTRIBUTESRXNSATATN='RXN_QUALITATIVE_DISTINCTION'
QUANTITYATTRIBUTESRXNSATATN='RXN_QUANTITY'
RxCUICODESRXNCONSORXCUI field
RxNorm NameNAMESRXNCONSOSTR field when SAB='RXNORM'
RxNorm SynonymNAMESRXNCONSOShortest length STR field for TTY='SY'
SCHEDULEATTRIBUTESRXNSATDerived from ATN='DCSA'
SNOMEDCTCODESRXNCONSOCODE field when SAB='SNOMEDCT_US'
SPL_SET_IDCODESRXNSATATN='SPL_SET_ID'
STRENGTHATTRIBUTESRXNSATATN='RXN_STRENGTH'
SourceSOURCESRXNCONSODerived from SAB field
TTYATTRIBUTESRXNCONSOTTY field
Tallman SynonymNAMESRXNCONSOSTR field when TTY='TMSY'
UNII_CODECODESRXNSATATN='UNII_CODE'
USPCODESRXNCONSOCODE field when SAB='USP'
VET_DRUGATTRIBUTESRXNSATATN='RXN_VET_DRUG'
VUIDCODESRXNCONSOCODE field when SAB='VANDF'

Scope

Active: concepts in the current RxNorm data set that have an atom with SAB=RXNORM and SUPPRESS=N

Parameters

ParameterLocationUseDescriptionDefault
rxcuiPathRequiredRxNorm identifier
formatPathOptional

Notation for results

One of:
.xml
Get results in XML
.json
Get results in JSON
.xml
propQueryRequiredProperty categories to retrieve, or ALL

(Space-separated list. See getPropCategories for the menu.)

All query parameters are case-insensitive.

Note that parameters must be "URL encoded", so a "space-separated list" in a URL 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>NAMES</propCategory>
            <propName>RxNorm Name</propName>
            <propValue>azatadine</propValue>
        </propConcept>
        <propConcept>
            <propCategory>CODES</propCategory>
            <propName>RxCUI</propName>
            <propValue>18600</propValue>
        </propConcept>
        <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>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>CODES</propCategory>
            <propName>MMSL_CODE</propName>
            <propValue>GNd00791</propValue>
        </propConcept>
    </propConceptGroup>
</rxnormdata>