RxClass
 
RxClass RESTful API

Overview

The RxClass RESTful web API is a web service developed at the National Library of Medicine for accessing the RxNorm data. Representational state transfer (REST) is a style of software architecture for distributed hypermedia systems such as the World Wide Web. REST-style architectures consist of clients and servers. Clients initiate requests to servers; servers process requests and return appropriate responses. Requests and responses are built around the transfer of "representations" of "resources". A resource can be essentially any coherent and meaningful concept that may be addressed. A representation of a resource is typically a document that captures the current or intended state of a resource.

The RxClass RESTful web API is a simple web service implemented using HTTP and can be thought of as a collection of resources, specified as URIs. Some characteristics of the RxClass RESTful web API:
The following table lists the RxClass API resources. The query string fields are described in the detailed sections for each resource.

Resources

Resource Description
/ Resource Base
/allClasses Get all class information
/class/byId Retrieve class information from a class identifier
/class/byName Retrieve class information from a class name
/class/byDrugName Get the classes containing a specified drug name as a member
/class/byRxcui Get the classes containing a specified drug identifier as a member
/classContext Get the context of a class
/classGraph newGet the class graph of ancestors
/classMembers Get the drug members of a class
/classTree Get the descendents of a class
/classTypes Get the class types
/relas Get the relationships for a source of drug relations
/relaSources Get the sources of drug-class relationships
/similar newGet the classes with similar members
/similarByRxcuis newGet the classes with similar members from a list of RxNorm drug identifiers
/similarInfo newGet the similarity information between members of two classes
/spellingsuggestions Get the spelling suggestions for a drug or class name
 
RxClass