getRxConceptProperties

Information returned
Concept name, TTY, and a synonym
Service domain
https://rxnav.nlm.nih.gov
HTTP request
GET  /REST/rxcui/rxcui/properties.xml

Description

Get the properties of the RxNorm concept identified by rxcui.

The response has no properties element if the RxCUI is not in the active data set.

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

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
properties
rxcui
RxNorm identifier
name
RxNorm concept name
synonym
Short or "Tallman" RxNorm synonym
tty
Term type
language
LAT attribute from RxNorm
suppress
SUPPRESS field from RxNorm
umlscui
(Always blank)

Example: Properties for Ambien (RxCUI=131725)

XML: https://rxnav.nlm.nih.gov/REST/rxcui/131725/properties

JSON: https://rxnav.nlm.nih.gov/REST/rxcui/131725/properties.json

An XML result is shown below.

<rxnormdata>
    <properties>
        <rxcui>131725</rxcui>
        <name>Ambien</name>
        <synonym/>
        <tty>BN</tty>
        <language>ENG</language>
        <suppress>N</suppress>
        <umlscui/>
    </properties>
</rxnormdata>