Class: CandidApiClient::ChargeCaptureBundles::V1::AsyncV1Client

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/charge_capture_bundles/v_1/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::ChargeCaptureBundles::V1::AsyncV1Client

Parameters:



160
161
162
 
# File 'lib/candidhealth/charge_capture_bundles/v_1/client.rb', line 160

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::AsyncRequestClient (readonly)

Returns:



156
157
158
 
# File 'lib/candidhealth/charge_capture_bundles/v_1/client.rb', line 156

def request_client
  @request_client
end

Instance Method Details

#get(charge_capture_claim_creation_id:, request_options: nil) ⇒ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.charge_capture_bundles.v_1.get(charge_capture_claim_creation_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/candidhealth/charge_capture_bundles/v_1/client.rb', line 170

def get(charge_capture_claim_creation_id:, request_options: nil)
  Async do
    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/charge_capture_claim_creation/v1/#{charge_capture_claim_creation_id}"
    end
    CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreation.from_json(json_object: response.body)
  end
end

#get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil, claim_creation_status: nil, charge_status: nil, charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, has_charge_capture_updates: nil, request_options: nil) ⇒ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationPage

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.charge_capture_bundles.v_1.get_all

Parameters:

  • limit (Integer) (defaults to: nil) —

    Maximum number of entities per page, defaults to 100.

  • sort (CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSortField) (defaults to: nil) —

    Defaults to created_at

  • sort_direction (CandidApiClient::Commons::Types::SortDirection) (defaults to: nil) —

    Sort direction. Defaults to descending order if not provided.

  • page_token (String) (defaults to: nil)
  • patient_external_id (String) (defaults to: nil) —

    The patient ID from the external EMR platform for the patient

  • claim_creation_status (CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationStatus) (defaults to: nil) —

    the status of the charge capture Claim Creation, refers to whether it was able to create a claim.

  • charge_status (CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus) (defaults to: nil) —

    the status of the charge captures

  • charge_external_id (String) (defaults to: nil) —

    A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.

  • date_of_service_min (Date) (defaults to: nil) —

    Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.

  • date_of_service_max (Date) (defaults to: nil) —

    Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.

  • claim_ids (String) (defaults to: nil) —

    A list of claim IDs to filter by. This will return all charge capture claim_creations that have a resulting claim with one of the IDs in this list.

  • claim_creation_ids (String) (defaults to: nil) —

    A list of Claim Creation IDs to filter by.

  • billing_provider_npis (String) (defaults to: nil) —

    A list of billing provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list.

  • service_facility_name (String) (defaults to: nil) —

    A string to filter by. This will return all charge capture claim_creations which include one or more charges with this service facility name.

  • primary_payer_ids (String) (defaults to: nil) —

    A list of primary payer IDs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the primary payer IDs in this list.

  • rendering_provider_npis (String) (defaults to: nil) —

    A list of rendering provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list.

  • rendering_provider_names (String) (defaults to: nil) —

    A list of rendering provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list.

  • supervising_provider_npis (String) (defaults to: nil) —

    A list of supervising provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list.

  • supervising_provider_names (String) (defaults to: nil) —

    A list of supervising provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list.

  • has_charge_capture_updates (Boolean) (defaults to: nil) —

    If true, only return claim_creations that have charge captures that have been updated since the Claim Creation has had a status of BILLED. See the updates property on ChargeCapture for more details.

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/candidhealth/charge_capture_bundles/v_1/client.rb', line 255

def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil,
            claim_creation_status: nil, charge_status: nil, charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, has_charge_capture_updates: nil, request_options: nil)
  Async do
    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.params = {
        **(request_options&.additional_query_parameters || {}),
        "limit": limit,
        "sort": sort,
        "sort_direction": sort_direction,
        "page_token": page_token,
        "patient_external_id": patient_external_id,
        "claim_creation_status": claim_creation_status,
        "charge_status": charge_status,
        "charge_external_id": charge_external_id,
        "date_of_service_min": date_of_service_min,
        "date_of_service_max": date_of_service_max,
        "claim_ids": claim_ids,
        "claim_creation_ids": claim_creation_ids,
        "billing_provider_npis": billing_provider_npis,
        "service_facility_name": service_facility_name,
        "primary_payer_ids": primary_payer_ids,
        "rendering_provider_npis": rendering_provider_npis,
        "rendering_provider_names": rendering_provider_names,
        "supervising_provider_npis": supervising_provider_npis,
        "supervising_provider_names": supervising_provider_names,
        "has_charge_capture_updates": has_charge_capture_updates
      }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/charge_capture_claim_creation/v1"
    end
    CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationPage.from_json(json_object: response.body)
  end
end

#get_summary(request_options: nil) ⇒ CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSummary

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.charge_capture_bundles.v_1.get_summary

Parameters:

Returns:



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/candidhealth/charge_capture_bundles/v_1/client.rb', line 192

def get_summary(request_options: nil)
  Async do
    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/charge_capture_claim_creation/v1/all/summary"
    end
    CandidApiClient::ChargeCaptureBundles::V1::Types::ChargeCaptureClaimCreationSummary.from_json(json_object: response.body)
  end
end