APIs

RxNorm API

getRxcuiHistoryStatus

Information returned
Status, history, and other attributes of a concept
Service domain
https://rxnav.nlm.nih.gov
HTTP request
GET  /REST/rxcui/rxcui/historystatus.xml

Description

Return the status, attributes, and history of the RxNorm concept identified by the rxcui parameter.

The earliest reported releaseStartDate or activeStartDate is the first stand-alone issue of RxNorm unbundled from the UMLS, in April, 2005.

Concept status values:
Active
The concept is in the current RxNorm data set and has a non-suppressed term (SUPPRESS="N" in RXNCONSO) from the RxNorm vocabulary (SAB="RXNORM" in RXNCONSO).
Obsolete
The concept is designated as obsolete (SUPRRESS="O" in RXNCONSO) in the current data set. RxNorm has not designated any Active concept as equivalent.
Remapped
The concept was Active or Obsolete at one time, but is not in the RXNCONSO file in the current data set and has been remapped (in RXNATOMARCHIVE) to one or more Active or Obsolete concepts. Those concepts are returned in the remappedConcept element.
Quantified
The concept has been designated as non-dispensable for lack of a quantity factor (SUPPRESS="E" in RXNCONSO). Related concepts with a quantity factor are returned in the quantifiedConcept element.
NotCurrent
The concept satisfies one of the following conditions:
  • The concept exists in the current data set but has no RxNorm vocabulary terms.

  • The concept existed in previous monthly versions, but has been removed and is not remapped to any Active or Obsolete concepts.

Unknown
The RxCUI has never been present in an RxNorm monthly release.

Scope

Current and Historical: concepts in current and previous RxNorm data sets

Parameters

ParameterLocationUseDescriptionDefault
rxcuiPathRequiredRxNorm identifier
formatPathOptional

Notation for results

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

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
rxcuiStatusHistory
metaData
status
Concept status
source
A source vocabulary of the concept. It is "RXNORM" if the concept currently or previously contained an RxNorm vocabulary term (SAB=RXNORM).
releaseStartDate
the first monthly RxNorm release version that contains this concept. Format is MMYYYY.
releaseEndDate
the last monthly RxNorm release version that contains this concept. Format is MMYYYY. No value indicates the concept currently exists in the data set if there is a release start date.
isCurrent
YES or NO: whether the concept has an active RxNorm vocabulary term (SAB=RXNORM).
activeStartDate
Version of the first RxNorm monthly release in which this concept contained an active RxNorm vocabulary term (SAB=RXNORM). Format is MMYYYY. No value indicates the concept never contained an active RxNorm vocabulary term.
activeEndDate
Version of the last RxNorm monthly release in which this concept contained an active RxNorm vocabulary term (SAB=RXNORM). Format is MMYYYY. No value indicates either the concept never contained an active RxNorm vocabulary term (if active start date has no value), or the concept is currently active (if active start date value exists).
remappedDate
The earliest monthly RxNorm release version in which this concept was remapped. Format is MMYYYY. Note this only applies for concepts of status="Remapped"`
attributes
rxcui
The input RxCUI
name
Concept name
tty
Term type (of RxNorm-vocabulary concepts)
isMultipleIngredient
YES or NO: whether the concept has multiple ingredients
isBranded
YES or NO: whether the concept is branded
definitionalFeatures
ingredientAndStrength (array)
Ingredient and strength information. Applies to products (TTY=SBD, SCD, BPCK, or GPCK).
baseRxcui
base ingredient RxCUI
baseName
base ingredient name
bossRxcui
Basis of Strength Substance (BoSS) RxCUI
bossName
Basis of Strength Substance (BoSS) Name
activeIngredientRxcui
active ingredient RxCUI
activeIngredientName
active ingredient name
moietyRxcui
active moiety RxCUI
moietyName
active moiety name
numeratorValue
numerator value of strength
numeratorUnit
numerator unit of strength
denominatorValue
denominator value of strength
denominatorUnit
denominator unit of strength
quantityFactor
quantityFactorValue
(only applicable for products (TTY=SBD or TTY=SCD))
quantityFactorUnit
(only applicable for products (TTY=SBD or TTY=SCD))
qualitativeDistinction
(only applicable for products (TTY=SBD or TTY=SCD))
doseFormConcept (array)
(applies to products: TTY=SBD, SCD, BPCK, or GPCK)
doseFormRxcui
dose form RxCUI
doseFormName
dose form name
doseFormGroupConcept (array)
(applies to products: TTY=SBD, SCD, BPCK, or GPCK)
doseFormGroupRxcui
dose form group RxCUI
doseFormGroupName
dose form group name
pack
(Applicable to TTY=BPCK or TTY=GPCK)
packAlias
short name for the pack
packConcept (array)
Components of the pack
packRxcui
Pack component RxCUI
packName
Pack component name
packNumber
number of items in component
derivedConcepts
Concepts related to the specified one
ingredientConcept (array)
Ingredient information
ingredientRxcui
ingredient RxCUI
ingredientName
ingredient name
quantifiedConcept (array)
(Applicable to unquantified, non-dispensable drugs that have an active quantified form)
quantifiedRxcui
Quantified concept RxCUI
quantifiedName
Quantified concept name
quantifiedTTY
Quantified concept TTY
quantifiedActive
Quantified concept active indicator (YES/NO)
remappedConcept (array)
(Applicable to status=Remapped and status=NotCurrent concepts for which RxNorm has designated an equivalent, surviving concept)
remappedRxCui
Replacement concept RxCUI
remappedName
Replacement concept name
remappedTTY
Replacement concept TTY
remappedActive
Replacement concept is active (YES/NO)
scdConcept
SBD's related clinical drug product (TTY=SCD)
scdConceptRxcui
SCD concept RxCUI
scdConceptName
SCD concept RxCUI
qdFreeConcept
a similar concept that lacks a qualitative distinction. Applicable to concepts with a qualitative distinction value
qdFreeRxcui
QD free concept RxCUI
qdFreeName
QD free concept name

Example: Active concept

XML: https://rxnav.nlm.nih.gov/REST/rxcui/1801289/historystatus

JSON: https://rxnav.nlm.nih.gov/REST/rxcui/1801289/historystatus.json

An XML result is shown below.

<rxnormdata>
    <rxcuiStatusHistory>
        <metaData>
            <status>Active</status>
            <source>RXNORM</source>
            <releaseStartDate>082016</releaseStartDate>
            <releaseEndDate/>
            <isCurrent>YES</isCurrent>
            <activeStartDate>082016</activeStartDate>
            <activeEndDate/>
            <remappedDate/>
        </metaData>
        <attributes>
            <rxcui>1801289</rxcui>
            <name>Smoking Cessation 12 HR bupropion hydrochloride 150 MG Extended Release Oral Tablet</name>
            <tty>SCD</tty>
            <isMultipleIngredient>NO</isMultipleIngredient>
            <isBranded>NO</isBranded>
        </attributes>
        <definitionalFeatures>
            <ingredientAndStrength>
                <baseRxcui>42347</baseRxcui>
                <baseName>bupropion</baseName>
                <bossRxcui>203204</bossRxcui>
                <bossName>bupropion hydrochloride</bossName>
                <activeIngredientRxcui>203204</activeIngredientRxcui>
                <activeIngredientName>bupropion hydrochloride</activeIngredientName>
                <moietyRxcui>42347</moietyRxcui>
                <moietyName>bupropion</moietyName>
                <numeratorValue>150</numeratorValue>
                <numeratorUnit>MG</numeratorUnit>
                <denominatorValue>1</denominatorValue>
                <denominatorUnit>EACH</denominatorUnit>
            </ingredientAndStrength>
            <quantityFactor>
                <quantityFactorValue>12</quantityFactorValue>
                <quantityFactorUnit>HR</quantityFactorUnit>
            </quantityFactor>
            <qualitativeDistinction>Smoking Cessation</qualitativeDistinction>
            <doseFormConcept>
                <doseFormRxcui>316945</doseFormRxcui>
                <doseFormName>Extended Release Oral Tablet</doseFormName>
            </doseFormConcept>
            <doseFormGroupConcept>
                <doseFormGroupRxcui>1151131</doseFormGroupRxcui>
                <doseFormGroupName>Oral Product</doseFormGroupName>
            </doseFormGroupConcept>
            <doseFormGroupConcept>
                <doseFormGroupRxcui>1151133</doseFormGroupRxcui>
                <doseFormGroupName>Pill</doseFormGroupName>
            </doseFormGroupConcept>
        </definitionalFeatures>
        <pack/>
        <derivedConcepts>
            <ingredientConcept>
                <ingredientRxcui>42347</ingredientRxcui>
                <ingredientName>bupropion</ingredientName>
            </ingredientConcept>
            <qdFreeConcept>
                <qdFreeRxcui>993518</qdFreeRxcui>
                <qdFreeName>12 HR bupropion hydrochloride 150 MG Extended Release Oral Tablet</qdFreeName>
            </qdFreeConcept>
        </derivedConcepts>
    </rxcuiStatusHistory>
</rxnormdata>

Example: Obsolete concept

XML: https://rxnav.nlm.nih.gov/REST/rxcui/861765/historystatus

JSON: https://rxnav.nlm.nih.gov/REST/rxcui/861765/historystatus.json

An XML result is shown below.

<rxnormdata>
    <rxcuiStatusHistory>
        <metaData>
            <status>Obsolete</status>
            <source>RXNORM</source>
            <releaseStartDate>092009</releaseStartDate>
            <releaseEndDate/>
            <isCurrent>NO</isCurrent>
            <activeStartDate>092009</activeStartDate>
            <activeEndDate>062017</activeEndDate>
            <remappedDate/>
        </metaData>
        <attributes>
            <rxcui>861765</rxcui>
            <name>metformin hydrochloride 1000 MG / rosiglitazone 4 MG Oral Tablet [Avandamet]</name>
            <tty>SBD</tty>
            <isMultipleIngredient>YES</isMultipleIngredient>
            <isBranded>YES</isBranded>
        </attributes>
        <definitionalFeatures>
            <ingredientAndStrength>
                <baseRxcui>6809</baseRxcui>
                <baseName>metformin</baseName>
                <bossRxcui>235743</bossRxcui>
                <bossName>metformin hydrochloride</bossName>
                <activeIngredientRxcui>235743</activeIngredientRxcui>
                <activeIngredientName>metformin hydrochloride</activeIngredientName>
                <moietyRxcui>6809</moietyRxcui>
                <moietyName>metformin</moietyName>
                <numeratorValue>1000</numeratorValue>
                <numeratorUnit>MG</numeratorUnit>
                <denominatorValue>1</denominatorValue>
                <denominatorUnit>EACH</denominatorUnit>
            </ingredientAndStrength>
            <ingredientAndStrength>
                <baseRxcui>84108</baseRxcui>
                <baseName>rosiglitazone</baseName>
                <bossRxcui>84108</bossRxcui>
                <bossName>rosiglitazone</bossName>
                <activeIngredientRxcui>253198</activeIngredientRxcui>
                <activeIngredientName>rosiglitazone maleate</activeIngredientName>
                <moietyRxcui>84108</moietyRxcui>
                <moietyName>rosiglitazone</moietyName>
                <numeratorValue>4</numeratorValue>
                <numeratorUnit>MG</numeratorUnit>
                <denominatorValue>1</denominatorValue>
                <denominatorUnit>EACH</denominatorUnit>
            </ingredientAndStrength>
            <doseFormConcept>
                <doseFormRxcui>317541</doseFormRxcui>
                <doseFormName>Oral Tablet</doseFormName>
            </doseFormConcept>
            <doseFormGroupConcept>
                <doseFormGroupRxcui>1151131</doseFormGroupRxcui>
                <doseFormGroupName>Oral Product</doseFormGroupName>
            </doseFormGroupConcept>
            <doseFormGroupConcept>
                <doseFormGroupRxcui>1151133</doseFormGroupRxcui>
                <doseFormGroupName>Pill</doseFormGroupName>
            </doseFormGroupConcept>
        </definitionalFeatures>
        <pack/>
        <derivedConcepts>
            <ingredientConcept>
                <ingredientRxcui>6809</ingredientRxcui>
                <ingredientName>metformin</ingredientName>
            </ingredientConcept>
            <ingredientConcept>
                <ingredientRxcui>84108</ingredientRxcui>
                <ingredientName>rosiglitazone</ingredientName>
            </ingredientConcept>
            <scdConcept>
                <scdConceptRxcui>861763</scdConceptRxcui>
                <scdConceptName>metformin hydrochloride 1000 MG / rosiglitazone 4 MG Oral Tablet</scdConceptName>
            </scdConcept>
        </derivedConcepts>
    </rxcuiStatusHistory>
</rxnormdata>

Example: Remapped concept

XML: https://rxnav.nlm.nih.gov/REST/rxcui/105048/historystatus

JSON: https://rxnav.nlm.nih.gov/REST/rxcui/105048/historystatus.json

An XML result is shown below.

<rxnormdata>
    <rxcuiStatusHistory>
        <metaData>
            <status>Remapped</status>
            <source>RXNORM</source>
            <releaseStartDate>042005</releaseStartDate>
            <releaseEndDate>052009</releaseEndDate>
            <isCurrent>NO</isCurrent>
            <activeStartDate>042005</activeStartDate>
            <activeEndDate>052009</activeEndDate>
            <remappedDate>062009</remappedDate>
        </metaData>
        <attributes>
            <rxcui>105048</rxcui>
            <name>Amantadine 100 MG Oral Capsule [Symmetrel]</name>
            <tty>SBD</tty>
            <isMultipleIngredient/>
            <isBranded/>
        </attributes>
        <definitionalFeatures/>
        <pack/>
        <derivedConcepts>
            <remappedConcept>
                <remappedRxCui>849389</remappedRxCui>
                <remappedName>amantadine hydrochloride 100 MG Oral Capsule</remappedName>
                <remappedTTY>SCD</remappedTTY>
                <remappedActive>YES</remappedActive>
            </remappedConcept>
            <remappedConcept>
                <remappedRxCui>849394</remappedRxCui>
                <remappedName>amantadine hydrochloride 100 MG Oral Capsule [Symmetrel]</remappedName>
                <remappedTTY>SBD</remappedTTY>
                <remappedActive>NO</remappedActive>
            </remappedConcept>
        </derivedConcepts>
    </rxcuiStatusHistory>
</rxnormdata>

Example: Quantified concept

XML: https://rxnav.nlm.nih.gov/REST/rxcui/1360201/historystatus

JSON: https://rxnav.nlm.nih.gov/REST/rxcui/1360201/historystatus.json

An XML result is shown below.

<rxnormdata>
    <rxcuiStatusHistory>
        <metaData>
            <status>Quantified</status>
            <source>RXNORM</source>
            <releaseStartDate>122012</releaseStartDate>
            <releaseEndDate/>
            <isCurrent>NO</isCurrent>
            <activeStartDate>122012</activeStartDate>
            <activeEndDate>012013</activeEndDate>
            <remappedDate/>
        </metaData>
        <attributes>
            <rxcui>1360201</rxcui>
            <name>albuterol 0.09 MG/ACTUAT Metered Dose Inhaler</name>
            <tty>SCD</tty>
            <isMultipleIngredient>NO</isMultipleIngredient>
            <isBranded>NO</isBranded>
        </attributes>
        <definitionalFeatures>
            <ingredientAndStrength>
                <baseRxcui>435</baseRxcui>
                <baseName>albuterol</baseName>
                <bossRxcui>435</bossRxcui>
                <bossName>albuterol</bossName>
                <activeIngredientRxcui/>
                <activeIngredientName/>
                <moietyRxcui/>
                <moietyName/>
                <numeratorValue>0.09</numeratorValue>
                <numeratorUnit>MG</numeratorUnit>
                <denominatorValue>1</denominatorValue>
                <denominatorUnit>ACTUAT</denominatorUnit>
            </ingredientAndStrength>
            <doseFormConcept>
                <doseFormRxcui>721654</doseFormRxcui>
                <doseFormName>Metered Dose Inhaler</doseFormName>
            </doseFormConcept>
            <doseFormGroupConcept>
                <doseFormGroupRxcui>1151123</doseFormGroupRxcui>
                <doseFormGroupName>Inhalant Product</doseFormGroupName>
            </doseFormGroupConcept>
        </definitionalFeatures>
        <pack/>
        <derivedConcepts>
            <ingredientConcept>
                <ingredientRxcui>435</ingredientRxcui>
                <ingredientName>albuterol</ingredientName>
            </ingredientConcept>
            <quantifiedConcept>
                <quantifiedRxcui>745679</quantifiedRxcui>
                <quantifiedName>200 ACTUAT albuterol 0.09 MG/ACTUAT Metered Dose Inhaler</quantifiedName>
                <quantifiedTTY>SCD</quantifiedTTY>
                <quantifiedActive>NO</quantifiedActive>
            </quantifiedConcept>
            <quantifiedConcept>
                <quantifiedRxcui>745682</quantifiedRxcui>
                <quantifiedName>80 ACTUAT albuterol 0.09 MG/ACTUAT Metered Dose Inhaler</quantifiedName>
                <quantifiedTTY>SCD</quantifiedTTY>
                <quantifiedActive>NO</quantifiedActive>
            </quantifiedConcept>
        </derivedConcepts>
    </rxcuiStatusHistory>
</rxnormdata>

Example: NotCurrent concept: non-RxNorm terms only

XML: https://rxnav.nlm.nih.gov/REST/rxcui/3686/historystatus

JSON: https://rxnav.nlm.nih.gov/REST/rxcui/3686/historystatus.json

An XML result is shown below.

<rxnormdata>
    <rxcuiStatusHistory>
        <metaData>
            <status>NotCurrent</status>
            <source>MTHCMSFRF</source>
            <releaseStartDate>042005</releaseStartDate>
            <releaseEndDate/>
            <isCurrent>NO</isCurrent>
            <activeStartDate/>
            <activeEndDate/>
            <remappedDate/>
        </metaData>
        <attributes>
            <rxcui>3686</rxcui>
            <name>OTC product</name>
            <tty/>
            <isMultipleIngredient/>
            <isBranded/>
        </attributes>
        <definitionalFeatures/>
        <pack/>
        <derivedConcepts/>
    </rxcuiStatusHistory>
</rxnormdata>