getPropNames
- Information returned
- Property names
- Service domain
- https://rxnav.nlm.nih.gov
- HTTP request
- GETÂ /REST/propnames.xml
Description
Return the property names.
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 |
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
- propNameList
- propName (array)
- Property name
Example: Property names
XML: https://rxnav.nlm.nih.gov/REST/propnames
JSON: https://rxnav.nlm.nih.gov/REST/propnames.json
An XML result is shown below.
<rxnormdata>
<propNameList>
<propName>ACTIVATED</propName>
<propName>ANADA</propName>
<propName>ANDA</propName>
<propName>ATC</propName>
<propName>AVAILABLE_STRENGTH</propName>
<propName>Active_ingredient</propName>
<propName>Active_moiety</propName>
<propName>BLA</propName>
<propName>BN_CARDINALITY</propName>
<propName>BoSS</propName>
<propName>CVX</propName>
<propName>DRUGBANK</propName>
<propName>Denominator_Units</propName>
<propName>Denominator_Value</propName>
<propName>GENERAL_CARDINALITY</propName>
<propName>HUMAN_DRUG</propName>
<propName>IN_EXPRESSED_FLAG</propName>
<propName>MESH</propName>
<propName>MMSL_CODE</propName>
<propName>NADA</propName>
<propName>NDA</propName>
<propName>NHRIC</propName>
<propName>Numerator_Units</propName>
<propName>Numerator_Value</propName>
<propName>ORIG_CODE</propName>
<propName>ORIG_SOURCE</propName>
<propName>PRESCRIBABLE</propName>
<propName>Prescribable Synonym</propName>
<propName>QUALITATIVE_DISTINCTION</propName>
<propName>QUANTITY</propName>
<propName>RxCUI</propName>
<propName>RxNorm Name</propName>
<propName>RxNorm Synonym</propName>
<propName>SCHEDULE</propName>
<propName>SNOMEDCT</propName>
<propName>SPL_SET_ID</propName>
<propName>STRENGTH</propName>
<propName>Source</propName>
<propName>TTY</propName>
<propName>Tallman Synonym</propName>
<propName>UNII_CODE</propName>
<propName>USP</propName>
<propName>VET_DRUG</propName>
<propName>VUID</propName>
</propNameList>
</rxnormdata>