RxNorm API
getNDCProperties
- Information returned
- National Drug Code (NDC) details
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GETÂ /REST/ndcproperties.xml?id=value&ndcstatus=S
Description
Get National Drug Code (NDC) properties. This function returns NDC properties for an NDC, or for NDCs with a given two-segment prefix, or for the NDC related to a structured product label, or for the NDCs currently related to a concept by RxNorm.
By default, only active NDCs' properties are returned. This restriction can be adjusted with the ndcstatus parameter (see getNDCStatus for a description of NDC status values). However, when an RxCUI is given as the id, only active NDCs are available.
NDC properties come from two sources:
DailyMed (SAB=MTHSPL) in RXNSAT, except for the packaging information, which is provided by DailyMed external to the RxNorm data set.
The FDA NDC Directory and legacy NDC records from the FDA
The source element in the result indicates where the properties came from. Possible values are: FDA, MTHSPL, Hybrid (combination of FDA and MTHSPL), and RXNORM (no properties).
The following table shows property names, sources and example values (as of June 2022).
Property Name | Source | Example Value |
---|---|---|
AMBIGUITY_FLAG | MTHSPL | Duplicate |
ANADA | FDA, MTHSPL | ANADA200373 |
ANDA | FDA, MTHSPL | ANDA200465 |
BLA | FDA, MTHSPL | BLA761231 |
COATING | MTHSPL | false |
COLOR | MTHSPL | C48333 |
COLORTEXT | MTHSPL | BLUE |
CONDITIONAL_NADA | MTHSPL | NADA141475 |
DCSA | FDA, MTHSPL | CII |
DM_SPL_ID | MTHSPL | 633412 |
EXEMPT_DEVICE | MTHSPL | CAF |
IMPRINT_CODE | MTHSPL | M;AA8 |
LABELER | FDA, MTHSPL | Mylan Pharmaceuticals Inc. |
LABEL_TYPE | FDA, MTHSPL | HUMAN PRESCRIPTION DRUG (FDA) HUMAN PRESCRIPTION DRUG LABEL (MTHSPL) |
LEGALLY_MARKETED_UNAPPROVED_ NEW_ANIMAL_DRUGS_FOR_MINOR_SPECIES | MTHSPL | MIF900031 |
MARKETING_CATEGORY | FDA, MTHSPL | ANDA |
MARKETING_EFFECTIVE_TIME_HIGH | FDA, MTHSPL | 20191115 |
MARKETING_EFFECTIVE_TIME_LOW | FDA, MTHSPL | 20141106 |
MARKETING_STATUS | FDA, MTHSPL | ACTIVE |
NADA | FDA, MTHSPL | NADA065495 |
NDA | FDA, MTHSPL | NDA012827 |
NDA_AUTHORIZED_GENERIC | FDA, MTHSPL | NDA017381 |
NHRIC | MTHSPL | 10135-180-01 |
OTC_MONOGRAPH_FINAL | FDA, MTHSPL | part349 |
OTC_MONOGRAPH_NOT_FINAL | FDA, MTHSPL | part352 |
PREMARKET_APPLICATION | MTHSPL | P100044 |
PREMARKET_NOTIFICATION | MTHSPL | K965017 |
SCORE | MTHSPL | 1 |
SHAPE | MTHSPL | C48345 |
SHAPETEXT | MTHSPL | barrel shaped |
SIZE | MTHSPL | 11 mm |
SYMBOL | MTHSPL | true |
UNAPPROVED_DRUG_OTHER | FDA, MTHSPL | N/A |
UNAPPROVED_HOMEOPATHIC | FDA, MTHSPL | N/A |
UNAPPROVED_MEDICAL_GAS | FDA, MTHSPL | N/A |
The following forms of ID are accepted:
Form of ID | Example ID(s) | Details |
---|---|---|
NDC 2 segment |
| first two segments of the National Drug Code |
NDC 3 segment |
| three segment format of the National Drug Code. NDC notation containing asterisks is not accepted. |
NDC11 | 00904629161 | National Drug Code (NDC) in the 11 digit (no dashes) form, also referred to as the CMS 11-digit NDC derivative. |
RxCUI | 213270 | RxNorm Concept Identifier. |
SPL_SET_ID |
| FDA Structured Product Label Set Identifier |
Scope
Current and Historical: concepts in current and previous RxNorm data sets
Parameters
Parameter | Location | Use | Description | Default |
---|---|---|---|---|
format | Path | Optional | Notation for results One of:
| .xml |
id | Query | Required | NDC (CMS 11-digit, or 5-3 or 4-4-2), or RXCUI, or FDA SPL set ID | |
ndcstatus | Query | Optional | Status filter for NDCs to retrieve One or more of:
(Space-separated list.) | active |
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 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
- ndcPropertyList
- ndcProperty (array)
- ndcItem
- National Drug Code (NDC) in CMS 11-digit format
- ndc9
- 2-segment NDC
- ndc10
- 3-segment NDC
- rxcui
- RxNorm identifier
- splSetIdItem
- SPL Set Identifier
- packagingList
- packaging (array)
- packaging of the product
- propertyConceptList
- list of properties
- propertyConcept (array)
- Property name-and-value tuple
- propName
- Property name
- propValue
- Value of the property
- source
- Source of properties
Example: Properties of an NDC
XML: https://rxnav.nlm.nih.gov/REST/ndcproperties?id=0378-4517-93
JSON: https://rxnav.nlm.nih.gov/REST/ndcproperties.json?id=0378-4517-93
An XML result is shown below.
<rxnormdata> <ndcPropertyList> <ndcProperty> <ndcItem>00378451793</ndcItem> <ndc9>0378-4517</ndc9> <ndc10>0378-4517-93</ndc10> <rxcui>597987</rxcui> <splSetIdItem>4be76756-4114-4d50-a36c-fd410f6c773d</splSetIdItem> <packagingList> <packaging>30 TABLET, FILM COATED in 1 BOTTLE, PLASTIC (0378-4517-93)</packaging> </packagingList> <propertyConceptList> <propertyConcept> <propName>ANDA</propName> <propValue>ANDA200465</propValue> </propertyConcept> <propertyConcept> <propName>COLORTEXT</propName> <propValue>BLUE</propValue> </propertyConcept> <propertyConcept> <propName>COLOR</propName> <propValue>C48333</propValue> </propertyConcept> <propertyConcept> <propName>DM_SPL_ID</propName> <propValue>758005</propValue> </propertyConcept> <propertyConcept> <propName>IMPRINT_CODE</propName> <propValue>M;AA8</propValue> </propertyConcept> <propertyConcept> <propName>LABELER</propName> <propValue>Mylan Pharmaceuticals Inc.</propValue> </propertyConcept> <propertyConcept> <propName>LABEL_TYPE</propName> <propValue>HUMAN PRESCRIPTION DRUG</propValue> </propertyConcept> <propertyConcept> <propName>MARKETING_CATEGORY</propName> <propValue>ANDA</propValue> </propertyConcept> <propertyConcept> <propName>MARKETING_EFFECTIVE_TIME_LOW</propName> <propValue>20141106</propValue> </propertyConcept> <propertyConcept> <propName>MARKETING_STATUS</propName> <propValue>ACTIVE</propValue> </propertyConcept> <propertyConcept> <propName>SCORE</propName> <propValue>1</propValue> </propertyConcept> <propertyConcept> <propName>SHAPETEXT</propName> <propValue>barrel shaped</propValue> </propertyConcept> <propertyConcept> <propName>SHAPE</propName> <propValue>C48345</propValue> </propertyConcept> <propertyConcept> <propName>SIZE</propName> <propValue>11 mm</propValue> </propertyConcept> </propertyConceptList> <source>Hybrid</source> </ndcProperty> </ndcPropertyList> </rxnormdata>
Example: Properties of NDCs identified by SPL set ID
XML: https://rxnav.nlm.nih.gov/REST/ndcproperties?id=8d24bacb-feff-4c6a-b8df-625e1435387a
JSON: https://rxnav.nlm.nih.gov/REST/ndcproperties.json?id=8d24bacb-feff-4c6a-b8df-625e1435387a
An XML result is shown below.
<rxnormdata> <ndcPropertyList> <ndcProperty> <ndcItem>00069040001</ndcItem> <ndc9>0069-0400</ndc9> <ndc10>0069-0400-01</ndc10> <rxcui>1668240</rxcui> <splSetIdItem>8d24bacb-feff-4c6a-b8df-625e1435387a</splSetIdItem> <packagingList> <packaging>5 mL in 1 VIAL</packaging> </packagingList> <propertyConceptList> <propertyConcept> <propName>DM_SPL_ID</propName> <propValue>628818</propValue> </propertyConcept> <propertyConcept> <propName>LABELER</propName> <propValue>Pfizer Laboratories Div Pfizer Inc</propValue> </propertyConcept> <propertyConcept> <propName>LABEL_TYPE</propName> <propValue>HUMAN PRESCRIPTION DRUG</propValue> </propertyConcept> ... </propertyConceptList> <source>Hybrid</source> </ndcProperty> <ndcProperty> <ndcItem>00069040001</ndcItem> <ndc9>0069-0400</ndc9> <ndc10>0069-0400-01</ndc10> <rxcui>351772</rxcui> <splSetIdItem>8d24bacb-feff-4c6a-b8df-625e1435387a</splSetIdItem> <packagingList> <packaging>5 mL in 1 VIAL</packaging> </packagingList> <propertyConceptList> <propertyConcept> <propName>DM_SPL_ID</propName> <propValue>164369</propValue> </propertyConcept> <propertyConcept> <propName>LABELER</propName> <propValue>Pfizer Laboratories Div Pfizer Inc</propValue> </propertyConcept> <propertyConcept> <propName>LABEL_TYPE</propName> <propValue>HUMAN PRESCRIPTION DRUG</propValue> </propertyConcept> ... </propertyConceptList> <source>Hybrid</source> </ndcProperty> <ndcProperty> <ndcItem>00069040010</ndcItem> <ndc9>0069-0400</ndc9> <ndc10>0069-0400-10</ndc10> <rxcui>1668240</rxcui> <splSetIdItem>8d24bacb-feff-4c6a-b8df-625e1435387a</splSetIdItem> <packagingList> <packaging>10 VIAL in 1 CARTON (0069-0400-10) / 5 mL in 1 VIAL (0069-0400-01)</packaging> </packagingList> <propertyConceptList> <propertyConcept> <propName>DM_SPL_ID</propName> <propValue>628818</propValue> </propertyConcept> <propertyConcept> <propName>LABELER</propName> <propValue>Pfizer Laboratories Div Pfizer Inc</propValue> </propertyConcept> <propertyConcept> <propName>LABEL_TYPE</propName> <propValue>HUMAN PRESCRIPTION DRUG</propValue> </propertyConcept> ... </propertyConceptList> <source>Hybrid</source> </ndcProperty> <ndcProperty> <ndcItem>00069040010</ndcItem> <ndc9>0069-0400</ndc9> <ndc10>0069-0400-10</ndc10> <rxcui>351772</rxcui> <splSetIdItem>8d24bacb-feff-4c6a-b8df-625e1435387a</splSetIdItem> <packagingList> <packaging>10 VIAL in 1 CARTON (0069-0400-10) / 5 mL in 1 VIAL (0069-0400-01)</packaging> </packagingList> <propertyConceptList> <propertyConcept> <propName>DM_SPL_ID</propName> <propValue>164369</propValue> </propertyConcept> <propertyConcept> <propName>LABELER</propName> <propValue>Pfizer Laboratories Div Pfizer Inc</propValue> </propertyConcept> <propertyConcept> <propName>LABEL_TYPE</propName> <propValue>HUMAN PRESCRIPTION DRUG</propValue> </propertyConcept> ... </propertyConceptList> <source>Hybrid</source> </ndcProperty> </ndcPropertyList> </rxnormdata>