RxClass API


Information returned
Class types
Service domain
HTTP request
GET  /REST/rxclass/classTypes.xml


Get the class types. The resources findClassByName, getClassTree, getClassGraphBySource, and getAllClasses use the class types as filters for the output.



Notation for results

One of:
Get results in XML
Get results in JSON

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 rxclassdata. It is described in the XML Schema for the RxClass 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 rxclassdata. 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:

Root element in XML, or anonymous object in JSON
classTypeName (array)
Class type

Example: Class types

XML: https://rxnav.nlm.nih.gov/REST/rxclass/classTypes

JSON: https://rxnav.nlm.nih.gov/REST/rxclass/classTypes.json

An XML result is shown below.