APIs

RxNorm API

getRelatedByType

Information returned
Concepts of specified types that are directly or indirectly related to a specified concept
Service domain
https://rxnav.nlm.nih.gov
HTTP request
GET  /REST/rxcui/rxcui/related.xml?tty=yourTTYs&expand=fields

Description

Get RxNorm concepts, of term types specified by the tty parameter, related directly or indirectly to RxNorm concept rxcui. See default paths for the paths of RxNorm relationships traveled to get concepts for each term type.

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

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
ttyQueryRequiredTerm type(s)

(Space-separated list. See getTermTypes for the menu.)

expandQueryOptionalAdditional result fields to retrieve
One or more of:
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
relatedGroup
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)
psn
Prescribable Name

Example: Branded drugs and branded forms for Plavix (RxCUI=174742)

XML: https://rxnav.nlm.nih.gov/REST/rxcui/174742/related?tty=SBD+SBDF

JSON: https://rxnav.nlm.nih.gov/REST/rxcui/174742/related.json?tty=SBD+SBDF

An XML result is shown below.

<rxnormdata>
    <relatedGroup>
        ...
        <conceptGroup>
            <tty>SBD</tty>
            <conceptProperties>
                <rxcui>213169</rxcui>
                <name>clopidogrel 75 MG Oral Tablet [Plavix]</name>
                <synonym>Plavix 75 MG Oral Tablet</synonym>
                <tty>SBD</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
            <conceptProperties>
                <rxcui>749198</rxcui>
                <name>clopidogrel 300 MG Oral Tablet [Plavix]</name>
                <synonym>Plavix 300 MG Oral Tablet</synonym>
                <tty>SBD</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
        <conceptGroup>
            <tty>SBDF</tty>
            <conceptProperties>
                <rxcui>368301</rxcui>
                <name>clopidogrel Oral Tablet [Plavix]</name>
                <synonym/>
                <tty>SBDF</tty>
                <language>ENG</language>
                <suppress>N</suppress>
                <umlscui/>
            </conceptProperties>
        </conceptGroup>
    </relatedGroup>
</rxnormdata>