Project

redox

0.01
The project is in a healthy, maintained state
Ruby wrapper for the Redox Engine API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
 Dependencies

Development

>= 1, < 3
~> 11
~> 5.0
~> 10.0
~> 3.1
~> 0.9

Runtime

~> 3.5
~> 0.18
 Project Readme

CircleCI

Redox

Ruby API wrapper for Redox Engine

Installation

Add this line to your application's Gemfile:

gem 'redox'

And then execute:

$ bundle

Or install it yourself as:

$ gem install redox

Usage

Setup

Make sure you're configured!

patient = Redox::Models::Patient.new
patient.demographics.first_name = 'Joe'
patient.demographics['LastName'] = 'Joerson'
patient.add_identifier(type: 'TheType', value: 'x13005')

meta = Redox::Models::Meta.new
meta.set_source(name: 'MySource', id: '123-584')
meta.add_destination(name: 'TheDest', id: '973-238')

Create

response = patient.create(meta: meta)

Update

response = patient.update(meta: meta)

Search

response = Redox::Models::Patient.query(patient, meta: meta)

Response

The response object is a base Redox::Models::Model class.

With the HTTParty response object

response.response
#<HTTParty::Response:0x7fa354c1fbe8>

response.response.ok?
true

And any Model objects that were returned

response.patient
{
  "Identifiers"=> [
      {"IDType"=>"MR", "ID"=>"0000000003"},
      {"ID"=>"e3fedf48-c8bf-4728-845f-cb810001b571", "IDType"=>"EHRID"}
    ],
  "Demographics"=> {
    "Race"=>"Black",
    "SSN"=>"303-03-0003",
    "Nickname"=>"Walt"
...
  }
  "PCP"=> {
    "NPI"=>nil,
  }
}

response.meta
{
  "EventDateTime"=>"2019-04-26T20:03:00.304866Z",
  "DataModel"=>"PatientAdmin",
  ...
  "Transmission"=>{"ID"=>797225234},
  "Message"=>{"ID"=>1095117817}
}

Configuration

Redox.configure do |c|
  c.api_key      = ENV['REDOX_API_KEY']
  c.secret       = ENV['REDOX_SECRET']
  c.api_endpoint = 'http://hello.com' # Defaults to Redox endpoint
  c.token_expiry_padding = 120 # Defaults to 60 seconds
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/WeInfuse/redox.