APIs

RxNorm API

getPropNames

Information returned
Property names
Service domain
https://rxnav.nlm.nih.gov
HTTP request
GET  /REST/propnames.xml

Description

Return the property names.

The following table explains each property, its category (for use with getAllProperties), the RxNorm file it comes from or from which it is computed, and other details. 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'
BLACODESRXNSATATN='BLA'
BN_CARDINALITYATTRIBUTESRXNSATATN='RXN_BN_CARDINALITY'
CVXCODESRXNCONSOCODE field when SAB='CVX'
DRUGBANKCODESRXNCONSOCODE field when SAB='DRUGBANK'
GENERAL_CARDINALITYATTRIBUTESRXNCONSO

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:

Term type (TTY)With related TTY=MINWithout related TTY=MIN
INSINGLE
PINSINGLE
MINMULTI
SCDCHYBRIDSINGLE
otherMULTISINGLE
HUMAN_DRUGATTRIBUTESRXNSATATN='RXN_HUMAN_DRUG'
IN_EXPRESSED_FLAGATTRIBUTESRXNSATATN='RXN_IN_EXPRESSED_FLAG'
MMSL_CODECODESRXNSATATN='MMSL_CODE'
NADACODESRXNSATATN='NADA'
NDACODESRXNSATATN='NDA'
NHRICCODESRXNSATATN='NHRIC'
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
RXNAV_HUMAN_DRUGATTRIBUTESRXNSATDerived from RXN_HUMAN_DRUG attribute: "US" when there is a related SCD or SBD with RXN_HUMAN_DRUG="US", otherwise empty
RXNAV_STRNAMESRXNCONSOConcept name (or, for SBD or BPCK, a shortest SY synonym); in Tallman capitalization where available
RXNAV_VET_DRUGATTRIBUTESRXNSATDerived from RXN_VET_DRUG attribute: "US" when there is a related SCD or SBD with RXN_VET_DRUG="US", otherwise empty
RxNorm NameNAMESRXNCONSOSTR field when SAB='RXNORM'
RxNorm SynonymNAMESRXNCONSOShortest length STR field for TTY='SY'
SCHEDULEATTRIBUTESRXNSATDerived 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.
SNOMEDCTCODESRXNCONSOCODE field when SAB='SNOMEDCT_US'
SPL_SET_IDCODESRXNSATATN='SPL_SET_ID'
STRENGTHATTRIBUTESRXNSATATN='RXN_STRENGTH'
SourceSOURCESRXNCONSODerived from SAB field (non-RXNORM sources)
TTYATTRIBUTESRXNCONSOTTY field
Tallman SynonymNAMESRXNCONSOSTR field when TTY='TMSY'
UNII_CODECODESRXNCONSOCODE field when SAB='MTHSPL' and TTY='SU'
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
formatPathOptional

Notation for results

One of:
.xml
Get results in XML
.json
Get results in JSON
.xml

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 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
propNameList
propName (array)
Property name

Example: Property names

XML: https://rxnav.nlm.nih.gov/REST/propnames

JSON: https://rxnav.nlm.nih.gov/REST/propnames.json

An XML result is shown below.

<rxnormdata>
    <propNameList>
        <propName>ACTIVATED</propName>
        <propName>ANADA</propName>
        <propName>ANDA</propName>
        <propName>ATC</propName>
        <propName>AVAILABLE_STRENGTH</propName>
        <propName>BLA</propName>
        <propName>BN_CARDINALITY</propName>
        <propName>CVX</propName>
        <propName>DRUGBANK</propName>
        <propName>GENERAL_CARDINALITY</propName>
        <propName>HUMAN_DRUG</propName>
        <propName>IN_EXPRESSED_FLAG</propName>
        <propName>MMSL_CODE</propName>
        <propName>NADA</propName>
        <propName>NDA</propName>
        <propName>NHRIC</propName>
        <propName>ORIG_CODE</propName>
        <propName>ORIG_SOURCE</propName>
        <propName>PRESCRIBABLE</propName>
        <propName>Prescribable Synonym</propName>
        <propName>QUALITATIVE_DISTINCTION</propName>
        <propName>QUANTITY</propName>
        <propName>RXNAV_HUMAN_DRUG</propName>
        <propName>RXNAV_STR</propName>
        <propName>RXNAV_VET_DRUG</propName>
        <propName>RxCUI</propName>
        <propName>RxNorm Name</propName>
        <propName>RxNorm Synonym</propName>
        <propName>SCHEDULE</propName>
        <propName>SNOMEDCT</propName>
        <propName>SPL_SET_ID</propName>
        <propName>STRENGTH</propName>
        <propName>Source</propName>
        <propName>TTY</propName>
        <propName>Tallman Synonym</propName>
        <propName>UNII_CODE</propName>
        <propName>USP</propName>
        <propName>VET_DRUG</propName>
        <propName>VUID</propName>
    </propNameList>
</rxnormdata>