getProprietaryInformation

Information returned
Strings from sources that require a UMLS license
Service domain
https://rxnav.nlm.nih.gov
HTTP request
GET  /REST/rxcui/rxcui/proprietary.xml?srclist=yourList&ticket=yourTicket&rxaui=yourRxaui

Description

Get the concept information associated with the concept, or a specific atom within the concept, for the specified sources. The user must have a valid UMLS license and be able to access the UTS authority service to obtain service tickets to use this function. See UMLS API documentation for details on how to get a ticket.

Upcoming Changes On or After August 2, 2021:

Scope

Current: concepts in the current RxNorm data set that have an atom with SUPPRESS=N

Parameters

ParameterLocationUseDescriptionDefault
rxcuiPathRequiredRxNorm identifier
formatPathOptional

Notation for results

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

(Space-separated list. See getSourceTypes for the menu.)

ALL
ticketQueryRequiredSingle-use proxy ticket from the UTS
rxauiQueryOptionalRxNorm atom identifier

All query parameters are case-insensitive.

Note that parameters must be "URL encoded", so a "space-separated list" in a URL 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
proprietaryGroup
rxcui
RxNorm identifier
sourceList
Requested sources
sourceName (array)
Source vocabulary
rxaui
RxNorm RXAUI
proprietaryInfo (array)
rxcui
RxNorm identifier
name
RxNorm concept name
type
Term type
id
Source vocabulary's ID for the term
source
Source vocabulary

Example: MeSH and RxNorm strings for a concept

XML: https://rxnav.nlm.nih.gov/REST/rxcui/261455/proprietary?ticket=ST-12035-6IGLfuHZrCJCiwjK7fVD-cas&srclist=MSH+RXNORM

JSON: https://rxnav.nlm.nih.gov/REST/rxcui/261455/proprietary.json?ticket=ST-12035-6IGLfuHZrCJCiwjK7fVD-cas&srclist=MSH+RXNORM

In the example, the ticket is not functional and must be replaced with a ticket obtained from UTS by the user.

An XML result is shown below.

<rxnormdata>
    <proprietaryGroup>
        <rxcui>261455</rxcui>
        <sourceList>
            <sourceName>MSH</sourceName>
            <sourceName>RXNORM</sourceName>
        </sourceList>
        <proprietaryInfo>
            <rxcui>261455</rxcui>
            <name>Avandia</name>
            <type>PEP</type>
            <id>D000077154</id>
            <source>MSH</source>
        </proprietaryInfo>
        <proprietaryInfo>
            <rxcui>261455</rxcui>
            <name>Avandia</name>
            <type>BN</type>
            <id>261455</id>
            <source>RXNORM</source>
        </proprietaryInfo>
    </proprietaryGroup>
</rxnormdata>