Class: CandidApiClient::Credentialing::V2::V2Client

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::V2Client

Parameters:



21
22
23
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 21

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



17
18
19
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 17

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 billing provider for which the service facility 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:



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 205

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)
  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: 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

#create_facility(service_facility_id:, contracting_provider_id:, payer_uuid:, start_date: nil, end_date: nil, submitted_date: nil, payer_loaded_date: nil, request_options: nil) ⇒ CandidApiClient::Credentialing::V2::Types::FacilityCredentialingSpan

Examples:

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

Parameters:

  • service_facility_id (String) —

    The ID of the service facility covered by the credentialing span.

  • contracting_provider_id (String) —

    The ID of the billing provider for which the service facility 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.

  • 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:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 42

def create_facility(service_facility_id:, contracting_provider_id:, payer_uuid:, start_date: nil,
                    end_date: nil, submitted_date: nil, payer_loaded_date: 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_options&.additional_body_parameters || {}),
      service_facility_id: service_facility_id,
      contracting_provider_id: contracting_provider_id,
      payer_uuid: payer_uuid,
      start_date: start_date,
      end_date: end_date,
      submitted_date: 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/facility"
  end
  CandidApiClient::Credentialing::V2::Types::FacilityCredentialingSpan.from_json(json_object: response.body)
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) 


300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 300

def delete(provider_credentialing_id:, request_options: nil)
  @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

#delete_facility(facility_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_facility(facility_credentialing_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:

  • (Void) 


131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 131

def delete_facility(facility_credentialing_id:, request_options: nil)
  @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/facility/#{facility_credentialing_id}"
  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:



238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 238

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 267

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)
  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

#get_all_facilities(limit: nil, page_token: nil, payer_uuid: nil, contracting_provider_id: nil, service_facility_id: nil, request_options: nil) ⇒ CandidApiClient::Credentialing::V2::Types::FacilityCredentialingSpanPage

Examples:

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

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.

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

    Filter to a particular contracting provider.

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

    Filter to a particular service facility.

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

Returns:



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 99

def get_all_facilities(limit: nil, page_token: nil, payer_uuid: nil, contracting_provider_id: nil,
                       service_facility_id: nil, 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.params = {
      **(request_options&.additional_query_parameters || {}),
      "limit": limit,
      "page_token": page_token,
      "payer_uuid": payer_uuid,
      "contracting_provider_id": contracting_provider_id,
      "service_facility_id": service_facility_id
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/provider-credentialing-span/v2/facility"
  end
  CandidApiClient::Credentialing::V2::Types::FacilityCredentialingSpanPage.from_json(json_object: response.body)
end

#get_facility(facility_credentialing_id:, request_options: nil) ⇒ CandidApiClient::Credentialing::V2::Types::FacilityCredentialingSpan

Examples:

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

Parameters:

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 74

def get_facility(facility_credentialing_id:, 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/provider-credentialing-span/v2/facility/#{facility_credentialing_id}"
  end
  CandidApiClient::Credentialing::V2::Types::FacilityCredentialingSpan.from_json(json_object: response.body)
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 billing provider for which the service facility 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:



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 329

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)
  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: 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

#update_facility(facility_credentialing_id:, contracting_provider_id:, 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::FacilityCredentialingSpan

Examples:

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

Parameters:

  • facility_credentialing_id (String)
  • contracting_provider_id (String) —

    The ID of the billing provider for which the service facility 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:



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/candidhealth/credentialing/v_2/client.rb', line 160

def update_facility(facility_credentialing_id:, contracting_provider_id:, payer_uuid: nil, start_date: nil,
                    end_date: nil, regions: nil, submitted_date: nil, payer_loaded_date: nil, request_options: nil)
  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: 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/facility/#{facility_credentialing_id}"
  end
  CandidApiClient::Credentialing::V2::Types::FacilityCredentialingSpan.from_json(json_object: response.body)
end