getPropNames

RxNorm API

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.

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:

Term type (TTY)	With related TTY=MIN	Without related TTY=MIN
IN	SINGLE
PIN	SINGLE
MIN	MULTI
SCDC	HYBRID	SINGLE
other	MULTI	SINGLE

HUMAN_DRUG

ATTRIBUTES

RXNSAT

ATN='RXN_HUMAN_DRUG'

IN_EXPRESSED_FLAG

ATTRIBUTES

RXNSAT

ATN='RXN_IN_EXPRESSED_FLAG'

MMSL_CODE

CODES

RXNCONSO

CODE field when SAB='MMSL'

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'

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'

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
format	Path	Optional	Notation for results One of: .xml Get results in XML .json Get results in JSON	.xml

Parameter

Location

Use

Description

Default

format

Path

Optional

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>

APIs

RxNorm API

getPropNames

Description

Scope

Parameters

Output structure

See also

Example: Property names