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.

Scope

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

Parameters

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

See also

• getRxConceptProperties

• getRxProperty

• getRxcuiHistoryStatus

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>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>