Class: CandidApiClient::Eligibility::V2::V2Client

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/eligibility/v_2/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::Eligibility::V2::V2Client

Parameters:



16
17
18
 
# File 'lib/candidhealth/eligibility/v_2/client.rb', line 16

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



12
13
14
 
# File 'lib/candidhealth/eligibility/v_2/client.rb', line 12

def request_client
  @request_client
end

Instance Method Details

#submit_eligibility_check(request: nil, request_options: nil) ⇒ Object

<Tip>Candid is deprecating support for this endpoint. It is instead recommended

to use [Candid's Stedi passthrough
s.joincandidhealth.com/api-reference/pre-encounter/eligibility-checks/v-1/post).
For assistance with the transition, please reference the [Transitioning to
Candid's New Eligibility
Endpoint](https://support.joincandidhealth.com/hc/en-us/articles/34918552872980)
document in the Candid Support Center.</Tip>
This API is a wrapper around Change Healthcare's eligibility API. Below are some
helpful documentation links:
- [Change Healthcare - Guides: Contents of the Eligibility Request
althcare.com/eligibilityandclaims/docs/contents-of-the-eligibility-request-body)
- [Change Healthcare - Guides: Use "Bare Minimum" Eligibility
ehealthcare.com/eligibilityandclaims/docs/use-bare-minimum-eligibility-requests)
- [Change Healthcare - Guides: Contents of the Eligibility
gehealthcare.com/eligibilityandclaims/docs/contents-of-the-eligibility-response)
- [Change Healthcare - Guides: Eligibility JSON-to-EDI API
gehealthcare.com/eligibilityandclaims/docs/eligibility-json-to-edi-api-contents)
- [Change Healthcare - Guides: Eligibility Error
opers.changehealthcare.com/eligibilityandclaims/docs/eligibility-error-messages)
- [Change Healthcare - Guides:
opers.changehealthcare.com/eligibilityandclaims/docs/frequently-asked-questions)
- [Change Healthcare - Guides: Eligibility
elopers.changehealthcare.com/eligibilityandclaims/docs/eligibility-api-requests)
- [Change Healthcare - Guides: Sandbox API Values and Test
com/eligibilityandclaims/docs/eligibility-sandbox-api-values-and-test-responses)
- [Change Healthcare - Guides: Sandbox Predefined Fields and
gehealthcare.com/eligibilityandclaims/docs/sandbox-predefined-fields-and-values)
- [Change Healthcare - Guides: Using Test Payers in the
healthcare.com/eligibilityandclaims/docs/use-the-test-payers-in-the-sandbox-api)
A schema of the response object can be found here: [Change Healthcare
velopers.changehealthcare.com/eligibilityandclaims/reference/medicaleligibility)

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.eligibility.v_2.submit_eligibility_check(request: {"key":"value"})

Parameters:

Returns:

  • (Object) 


58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/candidhealth/eligibility/v_2/client.rb', line 58

def submit_eligibility_check(request: nil, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/eligibility/v2"
  end
  JSON.parse(response.body)
end

#submit_eligibility_check_availity(request_options: nil) ⇒ Object

<Tip>Candid is deprecating support for this endpoint. It is instead recommended

to use [Candid's Stedi passthrough
s.joincandidhealth.com/api-reference/pre-encounter/eligibility-checks/v-1/post).
For assistance with the transition, please reference the [Transitioning to
Candid's New Eligibility
Endpoint](https://support.joincandidhealth.com/hc/en-us/articles/34918552872980)
document in the Candid Support Center.</Tip>
**Availity has transitioned their GET endpoint to a POST endpoint. Candid has
updated their pass-through integration to enable backwards compatibility for the
GET endpoint so that customers do not have to immediately update their
integrations.**
**Candid recommends integrations with the [POST
health.com/api-reference/eligibility/v-2/submit-eligibility-check-availity-post)
to ensure the best possible integration experience. Given the transition,
Availity

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.eligibility.v_2.submit_eligibility_check_availity

Parameters:

Returns:

  • (Object) 


109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/candidhealth/eligibility/v_2/client.rb', line 109

def submit_eligibility_check_availity(request_options: nil)
  response = @request_client.conn.get do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/eligibility/v2/availity"
  end
  JSON.parse(response.body)
end

#submit_eligibility_check_availity_post(request: nil, request_options: nil) ⇒ Object

<Tip>Candid is deprecating support for this endpoint. It is instead recommended

to use [Candid's Stedi passthrough
s.joincandidhealth.com/api-reference/pre-encounter/eligibility-checks/v-1/post).
For assistance with the transition, please reference the [Transitioning to
Candid's New Eligibility
Endpoint](https://support.joincandidhealth.com/hc/en-us/articles/34918552872980)
document in the Candid Support Center.</Tip>
If you'd like access to this endpoint, please reach out to
[email protected] with the subject line "Action: Activate Availity
Eligibility API Endpoint
This API is a wrapper around Availity's coverages API. Below are some helpful
documentation links:
- [Availity - Coverages 1.0.0
PI](https://developer.availity.com/partner/documentation#c_coverages_references)
- [Candid Availity Eligibility Integration
th.com/hc/en-us/articles/24218441631892--Availity-Eligibility-Integration-Guide)
A schema of the response object can be found here: [Availity
tner/product/191210/api/190898#/Coverages_100/operation/%2Fcoverages%2F{id}/get)
* Note Availity requires a free developer  to access this documentation.
Check connection status of Availity API and partners here:
- [Availity Trading Partner Connection Status](https://www.availity.com/status/)

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.eligibility.v_2.submit_eligibility_check_availity_post(request: {"key":"value"})

Parameters:

Returns:

  • (Object) 


152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/candidhealth/eligibility/v_2/client.rb', line 152

def submit_eligibility_check_availity_post(request: nil, request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/eligibility/v2/availity"
  end
  JSON.parse(response.body)
end