eligible 2.3 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db1f19b35719b1eeb1e339ae413fc36038d6e322
-  data.tar.gz: a1a9e247377c3fdb52f54150066ef554616a3dc7
+  metadata.gz: b1ed13fe5084703a13e0d531de177e73e1f38a4e
+  data.tar.gz: 43b6296949c68d3113f6ec1f1db1d5d6aaaf6d43
 SHA512:
-  metadata.gz: 87c4140d9b5940479d5f5cab0d0f95a6ed738046963e93714aabcd3a9078746edf0eceefe3ca7631344cf15e972b4ca9b0ccde2d13174983fac4f6462f15827a
-  data.tar.gz: 0e2a53d43aa60655f4d15628a065a540a022827ddc4e2bf55d5883d332c8d8a00584b754260582b5c1528fccfc81acec67ad781459e7dda23ca860ffca82d1b9
+  metadata.gz: 5769440475201703b7162d82cf4d28156389e9e52c2e0c5ac83b3c560589848c014898bc41831383ce70a830a34fa26a1517e8b0c6fcaf877d83088d6e551a14
+  data.tar.gz: da1097a703dc3d255c6fea2871c43e2ccc087f2ee3298252205113f5328981aa156624adf85d4b401bdc6660dafbd0814ebad35076b1c62ddf5c12db4841bbe1

data/CONTRIBUTORS

@@ -1 +1,5 @@
-Andy Brett <andy@andybrett.com>
+Andy Brett <andy@andybrett.com>
+Ivan Müller <mulleivan@gmail.com>
+Janet Chang <janetlaichang@gmail.com>
+Katelyn Gleason <k@eligibleapi.com>
+Rodrigo Dominguez <rod@eligibleapi.com>

data/README.md

@@ -16,22 +16,113 @@ Or install it yourself with:
 
     $ gem install eligible
 
-## Usage
+# Important notes
+
+## Payer List for Eligibility
+
+the parameter *payer_id*, required for most of the api calls, is provided by EligibleAPI from its website,
+in xml and json format, which you can embed into your applications.
+
+[https://eligibleapi.com/resources/information-sources.xml](https://eligibleapi.com/resources/information-sources.xml)
+[https://eligibleapi.com/resources/information-sources.json](https://eligibleapi.com/resources/information-sources.json)
+
+## Payer List for Claims
+
+the parameter *payer_id*, required for claims, is provided by EligibleAPI from its website,
+in xml and json format, which you can embed into your applications.
+
+[https://eligibleapi.com/resources/claims-payer.xml](https://eligibleapi.com/resources/claims-payer.xml)
+[https://eligibleapi.com/resources/claims-payer.json](https://eligibleapi.com/resources/claims-payer.json)
+
+## Service Type Codes
+
+the parameter *service_type*, required on the api calls, is provided by EligibleAPI from its website,
+in xml and json format, which you can embed into your applications.
+[https://eligibleapi.com/resources/service-codes.xml](https://eligibleapi.com/resources/service-codes.xml)
+https://eligibleapi.com/resources/service-codes.json](ttps://eligibleapi.com/resources/service-codes.json)
+
+## Place of Service
+
+[https://eligibleapi.com/resources/place_of_service.json](https://eligibleapi.com/resources/place_of_service.json)
+
+## Health Care Provider Taxonomy
+
+[https://eligibleapi.com/resources/health-care-provider-taxonomy-code-set.json](https://eligibleapi.com/resources/health-care-provider-taxonomy-code-set.json)
+
+
+# Usage
 
 ### Setup
+```ruby
     require 'eligible'
     Eligible.api_key = 'YOUR_KEY'
+```
+
 ### Test
 ```ruby
 Eligible.test = true
- ```
-Include `{ :test => "true" }` in the params for sandbox access.
-### Format
+```
 
-Include `{ :format => "X12" }` in the params hash to get back the raw X12 response.
+### Parameters overwrite
 
+On each api call, you can overwrite the api key or the test parameter, i.e.
 
-### Retrieve Demographic object and query it
+```ruby
+   Eligible::Demographic.get(params.merge({:api_key => 'NEW_KEY', :test => false})
+```
+
+### Response Format
+
+By default, all the responses came in JSON, but you can request raw access to X12 by adding is as a parameter on the api call.
+
+```ruby
+   Eligible::Demographic.get(params.merge({:format => "x12"}))
+```
+
+### Api Call Results
+
+On all the results, you can check for errors in *result.error*, you can get get the raw json format in a has by using *result.to_hash*.
+
+```ruby
+demographic = Eligible::Demographic.get(params)
+demographic.error
+demographic.to_hash
+```
+
+## Coverage
+
+### Reference
+
+[https://eligibleapi.com/rest-api-v1-1/coverage-all#apiCoverageInfo](https://eligibleapi.com/rest-api-v1-1/coverage-all#apiCoverageInfo)
+
+### Retrieve eligibility & benefit information
+
+```ruby
+params = {
+  :service_type => "33",
+  :network => "OUT",
+  :payer_id   => "000001",
+  :provider_last_name => "Last",
+  :provider_first_name => "First",
+  :provider_npi => "12345678",
+  :member_id => "12345678",
+  :member_last_name => "Austen",
+  :member_first_name => "Jane",
+  :member_dob => "1955-12-14"
+}
+
+coverage = Eligible::Coverage.get(params)
+coverage.to_hash # returns all coverage info for the request
+coverage.error   # return error, if any
+```
+
+## Demographic
+
+### Reference
+
+[https://eligibleapi.com/rest-api-v1-1/demographic-all#apiDemographics](https://eligibleapi.com/rest-api-v1-1/demographic-all#apiDemographics)
+
+### Fetch demographics for a patient
 
 ```ruby
 params = {
@@ -47,18 +138,52 @@ params = {
 }
 
 demographic = Eligible::Demographic.get(params)
-demographic.all # returns all fields for the demographic, per demographic/all
+demographic.to_hash # returns all coverage info for the request
+demographic.error   # return error, if any
 ```
 
+## Medicare
+
+### Reference
 
+[https://eligibleapi.com/rest-api-v1-1/medicare#apiMedicare](https://eligibleapi.com/rest-api-v1-1/medicare#apiMedicare)
 
-##Batch post Demographic
-**POST** `https://gds.eligibleapi.com/v1.1/demographic/all/batch.json`
+### Retrieve eligibility & benefit information from CMS Medicare for a patient.
 
 ```ruby
+params = {
+  :payer_id   => "000001",
+  :provider_last_name => "Last",
+  :provider_first_name => "First",
+  :provider_npi => "12345678",
+  :member_id => "12345678",
+  :member_last_name => "Austen",
+  :member_first_name => "Jane",
+  :member_dob => "1955-12-14"
+}
+medicare = Eligible::Medicare.get(params)
+medicare.to_hash # returns all coverage info for the request
+medicare.error   # return error, if any
 
-Eligible.test = true
+```
+
+## Batch API
+
+### Reference
+
+[https://github.com/EligibleAPI/tools/wiki/Batch-Api](https://github.com/EligibleAPI/tools/wiki/Batch-Api)
+
+Its important to notice that all the batch api calls, will notify the results by a webhook.
+
+You can setup a webhook in your [Dashboard](https://www.eligibleapi.com/dashboard/webhooks).
+
+All the batch api calls, returns a *reference_id* value and the *number_of_items* submitted.
+
+### Coverage Batch API
+
+```ruby
 params = {
+    "api_key"=>"81ef98e5-4584-19fb-0d8c-6e987b95d695",
     "parameters"=>[
         {
             "id"=>1,
@@ -86,41 +211,16 @@ params = {
         }
     ]
 }
-Eligible::Demographic.batch_post params
-# return
-Eligible::EligibleObject:0x000000058914a8 @api_key="XXX",
-                                          @values={:reference_id=>"1ea06414-2132-52e1-1580-aea92f37720b",
-                                                   :number_of_items=>2},
-                                          @unsaved_values=#<Set: {}>,
-                                          @transient_values=#<Set: {}>>
-```
-
-### Retrieve Coverage object
-
-```ruby
-params = {
-  :service_type => "33",
-  :network => "OUT",
-  :payer_id   => "000001",
-  :provider_last_name => "Last",
-  :provider_first_name => "First",
-  :provider_npi => "12345678",
-  :member_id => "12345678",
-  :member_last_name => "Austen",
-  :member_first_name => "Jane",
-  :member_dob => "1955-12-14"
-}
 
-coverage = Eligible::Coverage.get(params)
-coverage.all # returns all coverage info for the request
+result = Eligible::Coverage.batch_post(params)
+result.to_hash # returns the api call results
+result.error   # return error, if any
 ```
-##Batch post Coverage
-**POST** `https://gds.eligibleapi.com/v1.1/coverage/all/batch.json`
+
+### Demographic Batch API
 
 ```ruby
-Eligible.test = true
 params = {
-    "api_key"=>"81ef98e5-4584-19fb-0d8c-6e987b95d695",
     "parameters"=>[
         {
             "id"=>1,
@@ -148,21 +248,14 @@ params = {
         }
     ]
 }
-
-Eligible::Coverage.batch_post params
-#Return:
-Eligible::EligibleObject:0x000000059a11b8 @api_key="XXX",
-                                          @values={:reference_id=>"1ea06414-2132-52e1-1580-aea92f37720b",
-                                                    :number_of_items=>2},
-                                          @unsaved_values=#<Set: {}>,
-                                          @transient_values=#<Set: {}>>
-
+result = Eligible::Demographic.batch_post(params)
+result.to_hash # returns the api call results
+result.error   # return error, if any
 ```
-##Batch post Medicare
-**POST** `https://gds.eligibleapi.com/v1.1/medicare/coverage/batch.json`
+
+### Medicare Batch API
 
 ```ruby
-Eligible.test = true
 params = {
     "parameters"=>[
         {
@@ -189,19 +282,20 @@ params = {
 }
 
 Eligible::Coverage.batch_medicare_post params
-#Return:
- Eligible::EligibleObject:0x00000004db0188 @api_key="72cbca2e-1da7-b030-d2e6-a05cbae11c1b",
-                                           @values={:reference_id=>"1ea06414-2132-52e1-1580-aea92f37720b",
-                                                    :number_of_items=>2},
-                                           @unsaved_values=#<Set: {}>,
-                                           @transient_values=#<Set: {}>>
+result.to_hash # returns the api call results
+result.error   # return error, if any
 ```
 
+## Enrollment
 
+### Reference
 
+[https://github.com/EligibleAPI/tools/wiki/Enrollments](https://github.com/EligibleAPI/tools/wiki/Enrollments)
 
+Its important to notice than an Enrollment Request can have multiple Enrollment NPIs, and that the API has been designed
+in a way that you can repeat the enrollment for a NPI multiple times across different Enrollment request.
 
-### Post Enrollment object
+### Create an Enrollment Request
 
 ```ruby
 params = {
@@ -234,21 +328,34 @@ params = {
       "00282"
     ]
 }
+result = Eligible::Enrollment.post(params)
+result.to_hash # returns the api call results
+result.error   # return error, if any
 
-Eligible::Enrollment.post(params)
 ```
 
-### Retrieve Enrollment object
+### Retrieve an Enrollment Request
 
 ```ruby
-params = { "enrollment_request_id" => "123" }
+params = { :enrollment_request_id => 123 }
+enrollment = Eligible::Enrollment.get(params)
+enrollment.to_hash # return the api call results
+enrollment.error  # return error, if any
+enrollment.enrollment_npis # quick access to the enrollment npis within the enrollment request object
 
+params = { :npis => %w(123 456 789).join(',') }
 enrollment = Eligible::Enrollment.get(params)
 
-enrollment.enrollment_npis # returns a list of enroll the provider(s)
 ```
 
-### Post Claim object
+
+## Claims
+
+### Reference
+
+[https://github.com/EligibleAPI/tools/wiki/Claims](https://github.com/EligibleAPI/tools/wiki/Claims)
+
+### Create Claim object
 
 ```ruby
 params = {
@@ -318,7 +425,9 @@ params = {
     }
 }
 
-Eligible::Claim.post(params)
+result = Eligible::Claim.post(params)
+enrollment.to_hash # return the api call results
+enrollment.error  # return error, if any
 ```
 
 ### Retrieve all Claim objects/acknowledgments
@@ -337,6 +446,12 @@ params = {
 claim = Eligible::Claim.get(params) # returns acknoweldement information on an individual claim identified by its reference_id
 ```
 
+## Payment Status
+
+### Reference
+
+[https://eligibleapi.com/rest-api-v1-1/beta/payment-status#apiPaymentStatus](https://eligibleapi.com/rest-api-v1-1/beta/payment-status#apiPaymentStatus)
+
 ### Retrieve  Payment status
 
 ```ruby
@@ -345,18 +460,84 @@ params = { :reference_id => "89898989" }
 Eligible::Payment.get(params) # returns status information on an individual payment identified by its reference_id
 ```
 
+## X12
+
+### Reference
 
+[https://github.com/EligibleAPI/tools/wiki/X12](https://github.com/EligibleAPI/tools/wiki/X12)
 
 ### X12 post
 
 ```ruby
-param = "ISA*00*          *00*          *ZZ*SENDERID       *ZZ*ELIGIB         *130610*0409*^*00501*100000001*0*T*:~GS*HS*SENDERID*ELIGIB*20130610*0409*1*X*005010X279A1~ST*270*0001*005010X279A1~BHT*0022*13*137083739083716126837*20130610*0409~HL*1**20*1~NM1*PR*2*UnitedHealthCare*****PI*112~HL*2*1*21*1~NM1*1P*1*AUSTEN*JANE****XX*1222494919~HL*3*2*22*0~TRN*1*1*1453915417~NM1*IL*1*FRANKLIN*BENJAMIN****MI*23412342~DMG*D8*17371207~DTP*291*D8*20130610~EQ*30~SE*13*0001~GE*1*1~IEA*1*100000001~"
+params = { :x12 => "ISA*00*          *00*          *ZZ*SENDERID       *ZZ*ELIGIB         *130610*0409*^*00501*100000001*0*T*:~GS*HS*SENDERID*ELIGIB*20130610*0409*1*X*005010X279A1~ST*270*0001*005010X279A1~BHT*0022*13*137083739083716126837*20130610*0409~HL*1**20*1~NM1*PR*2*UnitedHealthCare*****PI*112~HL*2*1*21*1~NM1*1P*1*AUSTEN*JANE****XX*1222494919~HL*3*2*22*0~TRN*1*1*1453915417~NM1*IL*1*FRANKLIN*BENJAMIN****MI*23412342~DMG*D8*17371207~DTP*291*D8*20130610~EQ*30~SE*13*0001~GE*1*1~IEA*1*100000001~" }
+
+result = Eligible::X12.post(params)
+```
+
+## Tickets
+
+### Reference
+
+[https://github.com/EligibleAPI/tools/wiki/Tickets](https://github.com/EligibleAPI/tools/wiki/Tickets)
+
+### Create a ticket
+
+```ruby
+params = {:priority => 'normal',
+          :title => 'TITLE',
+          :notification_email => 'admin@eligibleapi.com',
+          :body => 'Your comment'}
+result = Eligible::Ticket.create params
+result.to_hash # return the api call results
+enrollment.error  # return error, if any
+```
+
+### Get a ticket
+
+```ruby
+ticket = Eligible::Ticket.get(:id => 1)
+ticket.to_hash # return the api call result
+ticket.error   # return error, if any
+```
+
+### Update a ticket
+
+```ruby
+params = { :id => 1,
+           :priority => 'normal',
+           :title => 'TITLE',
+           :notification_email => 'your_email@test.com',
+           :body => 'Your comment'}
+result = Eligible::Ticket.update(params)
+result.to_hash # return the api call results
+enrollment.error  # return error, if any
+```
+
+### Get comments for a ticket
+
+```ruby
+comments = Eligible::Ticket.get(:id => 1)
+comments.to_hash # return the api call result
+comments.error   # return error, if any
+
+```
+
+### Delete a ticket
+```ruby
+result = Eligible::Ticket.delete(:id => 1)
+comments.to_hash # return the api call result
+comments.error   # return error, if any
+```
+
+
+### Get all tickets
 
-Eligible::X12.post param # <Net::HTTPOK 200 OK readbody=true>
+```ruby
+Eligible::Ticket.all
 ```
 
 
-## Tests
+# Tests
 
 You can run tests with 
 
@@ -376,10 +557,25 @@ If you do send a pull request, please add passing tests for the new feature/fix.
 6. Create new Pull Request
 
 ## Changelog
+
+#### 2.4
+- Refactoring Code
+- More test cases
+- Removed legacy endpoint for *plans*, *coverage* should be used instead.
+- Removed legacy endpoint for *services*, *coverage* should be used instead.
+- List of contributors and documentation updated.
+- Gemfile updated, dependencies updated as well.
+- Removed json gem in favor of multi_json
+- Fixed the code to let the users make x12 requests at anytime.
+- New endpoint for Tickets
+
+#### 2.3
+- New endpoint for Batch
+
 #### 2.2
 - New endpoint for x12 POST
-#### 2.1 
 
+#### 2.1 
 - New endpoint for payment status
 
 #### 2.0