Code Monkey home page Code Monkey logo

rx_nav_ruby's Introduction

RxNav

Gem Version Dependency Status Code Climate Test Coverage Codeship Status for jbender/rx_nav_ruby

This gem makes it easier to work with the RxNav REST APIs, as enumerated on this page.

Currently, there are wrappers for the RxNorm, NDF-RT, and RxTerms APIs. Not all end points are covered, so be sure to check out the code to make sure the endpoint you're looking for is available in the wrapper. If it isn't, please feel free to fork, add it, and send a pull request.

Installation

Add this line to your application's Gemfile:

gem 'rx_nav'

And then execute:

$ bundle

Or install it yourself as:

$ gem install rx_nav

Usage

Each service has it's own class, which have the class methods enumerated below. When appropriate, these methods will return Concepts, which are further queryable to retrieve more information about a specific drug. Question marks indicate optional parameters.

Please note that according to the NLM Terms of Service, you can will only be able to make 20 requests/second/IP, so keep that in mind when implementing this project.

  • all_records_by_kind
  • get_info
  • find_by_name(name, kind?)
  • find_by_id(type, id)
  • find_by({type: x, id: y} OR {name: x, kind: y})
  • possible_roles
  • possible_properties
  • possible_kinds
  • possible_types
  • possible_associations
  • possible_options_for(type)
  • api_version
  • search_by_name(name, options?)
  • find_rxcui_by_id(type, id)
  • find_rxcui_by_name(name)
  • find_drugs_by_name(name)
  • spelling_suggestions(name)
  • status(id)
  • properties(id)
  • quantity(id)
  • strength(id)
  • all_concepts
  • all_info(id)

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

rx_nav_ruby's People

Contributors

jbender avatar joeadcock avatar

Stargazers

Seth Strawbridge avatar  avatar Dr. Lawrence Gerschel    avatar  avatar  avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.