Prescribable RxNorm API
getMultiIngredBrand
- Information returned
- Brands containing specified ingredients
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GETÂ /REST/Prescribe/brands.xml?ingredientids=yourIngredientIdsList
Description
Get the brands that contain all the ingredients specified (as RXCUIs) by the ingredientids 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 |
---|---|---|---|---|
format | Path | Optional | Notation for results One of:
| .xml |
ingredientids | Query | Required | Ingredient RXCUI(s) (Space-separated list.) |
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 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
- brandGroup
- ingredientList
- rxnormId (array)
- (Always empty)
- 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)
Example: Brands with pseudoephedrine [RxCUI = 8896] and cetirizine [RxCUI = 20610]
XML: https://rxnav.nlm.nih.gov/REST/Prescribe/brands?ingredientids=8896+20610
JSON: https://rxnav.nlm.nih.gov/REST/Prescribe/brands.json?ingredientids=8896+20610
An XML result is shown below.
<rxnormdata> <brandGroup> ... <conceptProperties> <rxcui>353102</rxcui> <name>Zyrtec-D</name> <synonym/> <tty>BN</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> <conceptProperties> <rxcui>900604</rxcui> <name>Aller-Tec D</name> <synonym/> <tty>BN</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> <conceptProperties> <rxcui>977496</rxcui> <name>Wal Zyr D</name> <synonym/> <tty>BN</tty> <language>ENG</language> <suppress>N</suppress> <umlscui/> </conceptProperties> </brandGroup> </rxnormdata>