getAllRelatedInfo

RxNorm API

Information returned: Concepts related directly or indirectly to a specified concept
Service domain: https://rxnav.nlm.nih.gov
HTTP request: GET /REST/rxcui/rxcui/allrelated.xml?expand=fields

Description

Get RxNorm concepts related by RxNav's default paths to the concept identified by rxcui.

The results include the concept identified by rxcui as well as related concepts.

Concepts linked by RxNorm relationships reformulation_of and reformulated_to are not included. They can be retrieved with getRelatedByRelationship or getReformulationConcepts.

Concepts linked by RxNorm relationships quantified_form_of and has_quantified_form are not included. They can be retrieved with getRelatedByRelationship or getRxcuiHistoryStatus (has_quantified_form only).

The GENERAL_CARDINALITY property of each concept is returned (in the genCard element) if requested with the expand parameter.

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
rxcui	Path	Required	RxNorm identifier
format	Path	Optional	Notation for results One of: .xml Get results in XML .json Get results in JSON	.xml
expand	Query	Optional	Additional result fields to retrieve One or more of: genCard General cardinality (genCard) psn Prescribable Name (PSN) (Space-separated list.)

Parameter

Location

Use

Description

Default

rxcui

Path

Required

RxNorm identifier

format

Path

Optional

Notation for results

One of:

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

.xml

expand

Query

Optional

Additional result fields to retrieve

One or more of:

genCard: General cardinality (genCard)
psn: Prescribable Name (PSN)

(Space-separated list.)

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

allRelatedGroup

rxcui: (Always empty)

conceptGroup (array)

Related concepts having a certain TTY

tty: Term type of the concepts in this group

conceptProperties (array)

Related concept

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

genCard: GENERAL_CARDINALITY property

psn: Prescribable Name

Example: Concepts related to Zonalon (RxCUI=9801)

XML: https://rxnav.nlm.nih.gov/REST/rxcui/9801/allrelated

JSON: https://rxnav.nlm.nih.gov/REST/rxcui/9801/allrelated.json

An XML result is shown below.

<rxnormdata>
    <allRelatedGroup>
        ...
        <conceptGroup>
            <tty>BN</tty>
            <conceptProperties>
                <rxcui>9801</rxcui>
                <name>Zonalon</name>
                <synonym/>
                <tty>BN</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>BPCK</tty>
        </conceptGroup>
        <conceptGroup>
            <tty>DF</tty>
            <conceptProperties>
                <rxcui>316982</rxcui>
                <name>Topical Cream</name>
                <synonym/>
                <tty>DF</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>DFG</tty>
            <conceptProperties>
                <rxcui>1151122</rxcui>
                <name>Topical Product</name>
                <synonym/>
                <tty>DFG</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>GPCK</tty>
        </conceptGroup>
        <conceptGroup>
            <tty>IN</tty>
            <conceptProperties>
                <rxcui>3638</rxcui>
                <name>doxepin</name>
                <synonym/>
                <tty>IN</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>MIN</tty>
        </conceptGroup>
        <conceptGroup>
            <tty>PIN</tty>
            <conceptProperties>
                <rxcui>203179</rxcui>
                <name>doxepin hydrochloride</name>
                <synonym/>
                <tty>PIN</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SBD</tty>
            <conceptProperties>
                <rxcui>1000095</rxcui>
                <name>doxepin hydrochloride 50 MG/ML Topical Cream [Zonalon]</name>
                <synonym>Zonalon 5 % Topical Cream</synonym>
                <tty>SBD</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SBDC</tty>
            <conceptProperties>
                <rxcui>1000094</rxcui>
                <name>doxepin hydrochloride 50 MG/ML [Zonalon]</name>
                <synonym/>
                <tty>SBDC</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SBDF</tty>
            <conceptProperties>
                <rxcui>362333</rxcui>
                <name>doxepin Topical Cream [Zonalon]</name>
                <synonym/>
                <tty>SBDF</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SBDFP</tty>
            <conceptProperties>
                <rxcui>2656146</rxcui>
                <name>doxepin hydrochloride Topical Cream [Zonalon]</name>
                <synonym/>
                <tty>SBDFP</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SBDG</tty>
            <conceptProperties>
                <rxcui>1188181</rxcui>
                <name>Zonalon Topical Product</name>
                <synonym/>
                <tty>SBDG</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SCD</tty>
            <conceptProperties>
                <rxcui>1000091</rxcui>
                <name>doxepin hydrochloride 50 MG/ML Topical Cream</name>
                <synonym>doxepin hydrochloride 5 % Topical Cream</synonym>
                <tty>SCD</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SCDC</tty>
            <conceptProperties>
                <rxcui>1000090</rxcui>
                <name>doxepin hydrochloride 50 MG/ML</name>
                <synonym/>
                <tty>SCDC</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SCDF</tty>
            <conceptProperties>
                <rxcui>377691</rxcui>
                <name>doxepin Topical Cream</name>
                <synonym/>
                <tty>SCDF</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SCDFP</tty>
            <conceptProperties>
                <rxcui>2647559</rxcui>
                <name>doxepin hydrochloride Topical Cream</name>
                <synonym/>
                <tty>SCDFP</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SCDG</tty>
            <conceptProperties>
                <rxcui>1160770</rxcui>
                <name>doxepin Topical Product</name>
                <synonym/>
                <tty>SCDG</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SCDGP</tty>
            <conceptProperties>
                <rxcui>2660570</rxcui>
                <name>doxepin hydrochloride Topical Product</name>
                <synonym/>
                <tty>SCDGP</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
    </allRelatedGroup>
</rxnormdata>

APIs

RxNorm API