Class: CandidApiClient::Credentialing::V2::AsyncV2Client

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::Credentialing::V2::AsyncV2Client

Parameters:



199
200
201
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 199

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_clientCandidApiClient::AsyncRequestClient (readonly)



195
196
197
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 195

def request_client
  @request_client
end

Instance Method Details

#create(rendering_provider_id:, contracting_provider_id:, payer_uuid:, regions:, start_date: nil, end_date: nil, submitted_date: nil, payer_loaded_date: nil, request_options: nil) ⇒ CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.credentialing.v_2.create(
  rendering_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  contracting_provider_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
  payer_uuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
)

Parameters:

  • rendering_provider_id (String)

    The ID of the rendering provider covered by the credentialing span.

  • contracting_provider_id (String)

    The ID of the practice location at which the rendering provider is covered by the credentialing span.

  • payer_uuid (String)

    The ID of the payer covered by the credentialing span.

  • start_date (Date) (defaults to: nil)

    Start date of the credentialing span.

  • end_date (Date) (defaults to: nil)

    End date of the credentialing span.

  • regions (CandidApiClient::Commons::Types::Regions)

    The states covered by the credentialing span. A span may be national and cover all states.

  • submitted_date (Date) (defaults to: nil)

    Date that the credential paperwork was submitted.

  • payer_loaded_date (Date) (defaults to: nil)

    Date that the payer loaded the credentialing span into their system.

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

Returns:



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 222

def create(rendering_provider_id:, contracting_provider_id:, payer_uuid:, regions:, start_date: nil,
           end_date: nil, submitted_date: nil, payer_loaded_date: nil, request_options: nil)
  Async do
    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_options&.additional_body_parameters || {}),
        rendering_provider_id: rendering_provider_id,
        contracting_provider_id: contracting_provider_id,
        payer_uuid: payer_uuid,
        start_date: start_date,
        end_date: end_date,
        regions: regions,
        submitted_date: ,
        payer_loaded_date: payer_loaded_date
      }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/provider-credentialing-span/v2"
    end
    CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan.from_json(json_object: response.body)
  end
end

#delete(provider_credentialing_id:, request_options: nil) ⇒ Void

Soft deletes a credentialing span rate from the system.

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.credentialing.v_2.delete(provider_credentialing_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:

  • (Void)


323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 323

def delete(provider_credentialing_id:, request_options: nil)
  Async do
    @request_client.conn.delete 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/provider-credentialing-span/v2/#{provider_credentialing_id}"
    end
  end
end

#get(provider_credentialing_id:, request_options: nil) ⇒ CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan

Examples:

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

Parameters:

Returns:



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 257

def get(provider_credentialing_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/provider-credentialing-span/v2/#{provider_credentialing_id}"
    end
    CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan.from_json(json_object: response.body)
  end
end

#get_all(limit: nil, page_token: nil, payer_uuid: nil, provider_id: nil, as_rendering_provider: nil, as_contracting_provider: nil, request_options: nil) ⇒ CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpanPage

Examples:

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

Parameters:

  • limit (Integer) (defaults to: nil)

    Maximum number of entities per page, defaults to 100.

  • page_token (String) (defaults to: nil)
  • payer_uuid (String) (defaults to: nil)

    Filter by payer.

  • provider_id (String) (defaults to: nil)

    Filter to a particular provider. Use in conjunction as_rendering_provider and as_contracting_provider.

  • as_rendering_provider (Boolean) (defaults to: nil)

    Filter to credentialing spans where the provider is a rendering provider. To use this filter provider_id is required.

  • as_contracting_provider (Boolean) (defaults to: nil)

    Filter to credentialing spans where the provider is a contracting provider. To use this filter provider_id is required.

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

Returns:



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 288

def get_all(limit: nil, page_token: nil, payer_uuid: nil, provider_id: nil, as_rendering_provider: nil,
            as_contracting_provider: 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,
        "page_token": page_token,
        "payer_uuid": payer_uuid,
        "provider_id": provider_id,
        "as_rendering_provider": as_rendering_provider,
        "as_contracting_provider": as_contracting_provider
      }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/provider-credentialing-span/v2"
    end
    CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpanPage.from_json(json_object: response.body)
  end
end

#update(provider_credentialing_id:, contracting_provider_id: nil, payer_uuid: nil, start_date: nil, end_date: nil, regions: nil, submitted_date: nil, payer_loaded_date: nil, request_options: nil) ⇒ CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.credentialing.v_2.update(provider_credentialing_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

  • provider_credentialing_id (String)
  • contracting_provider_id (String) (defaults to: nil)

    The ID of the practice location at which the rendering provider is covered by the credentialing span.

  • payer_uuid (String) (defaults to: nil)

    The ID of the payer doing the credentialing.

  • start_date (Date) (defaults to: nil)

    Start date of the credentialing span.

  • end_date (Date) (defaults to: nil)

    End date of the credentialing span.

  • regions (CandidApiClient::Commons::Types::Regions) (defaults to: nil)

    The states covered by the credentialing span. A span may be national and cover all states.

  • submitted_date (Date) (defaults to: nil)

    Date that the credential paperwork was submitted.

  • payer_loaded_date (Date) (defaults to: nil)

    Date that the payer loaded the credentialing span into their system.

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

Returns:



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 354

def update(provider_credentialing_id:, contracting_provider_id: nil, payer_uuid: nil, start_date: nil,
           end_date: nil, regions: nil, submitted_date: nil, payer_loaded_date: nil, request_options: nil)
  Async do
    response = @request_client.conn.patch 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_options&.additional_body_parameters || {}),
        contracting_provider_id: contracting_provider_id,
        payer_uuid: payer_uuid,
        start_date: start_date,
        end_date: end_date,
        regions: regions,
        submitted_date: ,
        payer_loaded_date: payer_loaded_date
      }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/provider-credentialing-span/v2/#{provider_credentialing_id}"
    end
    CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan.from_json(json_object: response.body)
  end
end