RxNorm API
findActiveProducts
- Information returned
- Active product(s) approximately corresponding to a possibly-archived or -obsolete product
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GET /REST/rxcui/rxcui/active.xml?results=all/sole
Description
Find active product(s) that may approximate, for clinical-analytics purposes, a given, possibly inactive, drug-product RxCUI. If the given RxCUI is already an active product, it is returned as-is.
The translation takes three steps:
Archive: If the given RxCUI is archived, it is translated to corrected RxCUIs from the RXNATOMARCHIVE file. The corrected RxCUIs might be active, obsolete, or non-dispensable. Processing continues with the next step for each corrected RxCUI, or for the original RxCUI if it is not in the archive.
Quantity factor: RxCUIs for products that are non-dispensable for lack of a quantity factor are translated to concepts that have a quantity factor by following the has_quantified_form relationship. Processing continues with the next step.
Brand: Obsolete branded RxCUIs are translated to the respective unbranded RxCUI by following the tradename_of relationship.
To find either one active RxCUI per submitted RxCUI or none at all, specify the results parameter as “sole”. In that case, no results are returned if there would be more than one good candidate. By default, all active codes are returned.
This function simplifies retrieval of information that is also available from RxNorm API functions getRxcuiHistoryStatus and getRelatedByRelationship.
Scope
Current and Historical: concepts in current and previous RxNorm data sets
Parameters
| Parameter | Location | Use | Description | Default |
|---|---|---|---|---|
| rxcui | Path | Required | RxNorm identifier of a product (SCD, SBD, GPCK, BPCK), which may be archived or inactive | |
| format | Path | Optional | Notation for results One of:
| .xml |
| results | Query | Optional | Cardinality of results One of:
| all |
All query parameters are case-insensitive.
Note that HTTP requires that query parameters be "URL encoded". 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
- minConceptGroup
- minConcept (array)
- RxNorm concept
- rxcui
- RxNorm identifier
- name
- Concept name from SAB=RXNORM
- tty
- Term type
Example: Multiple active products are found for an archived product
XML: https://rxnav.nlm.nih.gov/REST/rxcui/1012407/active
JSON: https://rxnav.nlm.nih.gov/REST/rxcui/1012407/active.json
An XML result is shown below.
<rxnormdata>
<minConceptGroup>
<minConcept>
<rxcui>1724784</rxcui>
<name>2 ML bupivacaine hydrochloride 7.5 MG/ML Injection</name>
<tty>SCD</tty>
</minConcept>
<minConcept>
<rxcui>1724786</rxcui>
<name>30 ML bupivacaine hydrochloride 7.5 MG/ML Injection</name>
<tty>SCD</tty>
</minConcept>
<minConcept>
<rxcui>1724787</rxcui>
<name>10 ML bupivacaine hydrochloride 7.5 MG/ML Injection</name>
<tty>SCD</tty>
</minConcept>
</minConceptGroup>
</rxnormdata>Example: An active dispensable product is found for a concept that is non-dispensable for lack of a quantity factor
XML: https://rxnav.nlm.nih.gov/REST/rxcui/1729355/active
JSON: https://rxnav.nlm.nih.gov/REST/rxcui/1729355/active.json
An XML result is shown below.
<rxnormdata>
<minConceptGroup>
<minConcept>
<rxcui>253113</rxcui>
<name>10 ML busulfan 6 MG/ML Injection</name>
<tty>SCD</tty>
</minConcept>
</minConceptGroup>
</rxnormdata>Example: An active unbranded concept is found for an inactive branded product
XML: https://rxnav.nlm.nih.gov/REST/rxcui/1921147/active
JSON: https://rxnav.nlm.nih.gov/REST/rxcui/1921147/active.json
An XML result is shown below.
<rxnormdata>
<minConceptGroup>
<minConcept>
<rxcui>847142</rxcui>
<name>carprofen 25 MG Chewable Tablet</name>
<tty>SCD</tty>
</minConcept>
</minConceptGroup>
</rxnormdata>Example: An active product RxCUI is returned as-is
XML: https://rxnav.nlm.nih.gov/REST/rxcui/617314/active
JSON: https://rxnav.nlm.nih.gov/REST/rxcui/617314/active.json
An XML result is shown below.
<rxnormdata>
<minConceptGroup>
<minConcept>
<rxcui>617314</rxcui>
<name>atorvastatin 10 MG Oral Tablet [Lipitor]</name>
<tty>SBD</tty>
</minConcept>
</minConceptGroup>
</rxnormdata>