rxnav-api

notes

• This project is continuing to be developed with new functionality added daily - be sure to check back often.
• Released Drug Interaction API support 12/24/2018.
• Released rximage support 12/16/2018.
• Released Rxterms support.

description

• promise-based api to interact with rxnav system by NLM and NIH
• NOTE: the links here are relative to the README on the bitbucket page.
• docs
• examples

supports

rxnorm / rxclass / rxterms / drugInteractionApi

• to return xml, invoke new RxnavApi().xml() and then chain subsequent calls. (e.g. new RxnavApi().xml().restfulEndpointsList())

• by default, json is returned by the rxnav-api, but to explicitly return json, invoke new RxnavApi().json() and then chain subsequent calls. (e.g. new RxnavApi().json().restfulEndpointsList())

• restfulEndpointsList

drugInteractionApi

• main
• /interaction
• /list
• /sources
• /version

rximage

• [search - search for medication images]

rxterms

• allconcepts - allConcepts
• allinfo - rxnormTerms
• name - rxnormDisplayName
• version

rxclass

• byId
• byName
• classesTypeList
• similar - classesSimilarToClass
• similarByRxcuis - similarByRxnormList
• allClasses - byClassTypeList
• class/byRxcui - classesByRxnorm
• class/byDrugName - byDrugName
• classContext
• classGraph
• classMembers
• classTree
• classTypes - classTypeList
• relas - drug class relationTypeList
• similarInfo
• relaSources - sourceTypeList
• spellingsuggestions

rxnorm

• allConceptsByTtyList
• approximateTerm
• brands - brandsContainingIngredients
• displayNames - retrieve names
• doesRxnormHaveProperty
• drugs - search drug
• idtypes - idTypeList
• ndcproperties - ndcProperties - given an ndc code find its properties
• ndcstatus - ndcStatus - given an NDC return its status
• allhistoricalndcs - ndcsForRxnorm all NDC(s) for a given rxnorm
• propCategories - propertyCategoryList list the property categories
• propnames - propertyNameList list names of available properties
• relatypes - relationTypeList list relationship types
• related?rela - rxnormRelatedConceptListByRelationalAttributes
• related?tty - rxnormRelatedConceptListByTermTypes
• rxnormsForFdbGcnSeqno
• rxnormsForFdbIngredientId
• rxnormsForHcpcsCode
• rxnormsForNdc
• rxnormsForOtherVocabulary
• rxnormsForSnomedCode
• rxnormNdcList
• rxnormProperties
• rxnormProperty
• rxnormProprietaryInfo (requires UMLS service ticket)
• rxnormStatus
• sourcetypes - sourceTypeList list available vocabulary abbreviated source types
• spellingsuggestions - spellingSuggestionList given a med term return possible spellings
• termtypes - termTypes list available term types
• version returns the RxNorm data set version

install / setup

 npm install rxnav-api --save

Resources

• rxnav api
• rxnav endpoints
• rximage api | detail | parameters
• axios
• rxnav-api on bitbucket
• ndc list search
• umls-api
• momentjs
• nodemon
• jsonformatter online

glossary / terminology

• tty - term type

disclaimer

• The information accessed through this API is from a government provided site. The liability for the use of this data is solely at the user's discretion.

credit

• RxIMAGE is a product of the National Library of Medicine.