Prescribable RxNorm API
getAllRelatedInfo
- Information returned
- Concepts related directly or indirectly to a specified concept
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GETÂ /REST/Prescribe/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.
Concepts linked by RxNorm relationships quantified_form_of and has_quantified_form are not included. They can be retrieved with getRelatedByRelationship.
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 |
expand | Query | Optional | Additional result fields to retrieve One or more of:
(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 Prescribable 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 RxCUI 617312
XML: https://rxnav.nlm.nih.gov/REST/Prescribe/rxcui/617312/allrelated
JSON: https://rxnav.nlm.nih.gov/REST/Prescribe/rxcui/617312/allrelated.json
An XML result is shown below.
<rxnormdata> <allRelatedGroup> ... <conceptGroup> <tty>BN</tty> <conceptProperties> <rxcui>153165</rxcui> <name>Lipitor</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>317541</rxcui> <name>Oral Tablet</name> <synonym/> <tty>DF</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>DFG</tty> <conceptProperties> <rxcui>1151131</rxcui> <name>Oral Product</name> <synonym/> <tty>DFG</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> <conceptProperties> <rxcui>1151133</rxcui> <name>Pill</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>83367</rxcui> <name>atorvastatin</name> <synonym/> <tty>IN</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>MIN</tty> </conceptGroup> <conceptGroup> <tty>PIN</tty> </conceptGroup> <conceptGroup> <tty>SBD</tty> <conceptProperties> <rxcui>617314</rxcui> <name>atorvastatin 10 MG Oral Tablet [Lipitor]</name> <synonym>Lipitor 10 MG Oral Tablet</synonym> <tty>SBD</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>SBDC</tty> <conceptProperties> <rxcui>617313</rxcui> <name>atorvastatin 10 MG [Lipitor]</name> <synonym/> <tty>SBDC</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>SBDF</tty> <conceptProperties> <rxcui>367665</rxcui> <name>atorvastatin Oral Tablet [Lipitor]</name> <synonym/> <tty>SBDF</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>SBDFP</tty> </conceptGroup> <conceptGroup> <tty>SBDG</tty> <conceptProperties> <rxcui>1177400</rxcui> <name>Lipitor Oral Product</name> <synonym/> <tty>SBDG</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> <conceptProperties> <rxcui>1177401</rxcui> <name>Lipitor Pill</name> <synonym/> <tty>SBDG</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>SCD</tty> <conceptProperties> <rxcui>617312</rxcui> <name>atorvastatin 10 MG Oral Tablet</name> <synonym>atorvastatin (as atorvastatin calcium) 10 MG Oral Tablet</synonym> <tty>SCD</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>SCDC</tty> <conceptProperties> <rxcui>597970</rxcui> <name>atorvastatin 10 MG</name> <synonym/> <tty>SCDC</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>SCDF</tty> <conceptProperties> <rxcui>370621</rxcui> <name>atorvastatin Oral Tablet</name> <synonym/> <tty>SCDF</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>SCDFP</tty> </conceptGroup> <conceptGroup> <tty>SCDG</tty> <conceptProperties> <rxcui>1158284</rxcui> <name>atorvastatin Oral Product</name> <synonym/> <tty>SCDG</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> <conceptProperties> <rxcui>1158285</rxcui> <name>atorvastatin Pill</name> <synonym/> <tty>SCDG</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </conceptGroup> <conceptGroup> <tty>SCDGP</tty> </conceptGroup> </allRelatedGroup> </rxnormdata>