candidhealth 1.17.0 → 1.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candid/client.rb +1 -6
  3. data/lib/candid/encounter_providers/v_2/types/billing_provider.rb +3 -0
  4. data/lib/candid/encounter_providers/v_2/types/billing_provider_update.rb +3 -0
  5. data/lib/candid/encounter_providers/v_2/types/billing_provider_update_with_optional_address.rb +3 -0
  6. data/lib/candid/encounter_providers/v_2/types/encounter_provider.rb +3 -0
  7. data/lib/candid/encounter_providers/v_2/types/provider_secondary_identification.rb +13 -0
  8. data/lib/candid/encounter_providers/v_2/types/rendering_provider.rb +3 -0
  9. data/lib/candid/encounter_providers/v_2/types/rendering_provider_update.rb +3 -0
  10. data/lib/candid/encounter_providers/v_2/types/rendering_provider_update_with_optional_address.rb +3 -0
  11. data/lib/candid/encounters/v_4/client.rb +15 -0
  12. data/lib/candid/encounters/v_4/types/encounter.rb +3 -0
  13. data/lib/candid/encounters_universal/types/universal_encounter_create_base.rb +3 -0
  14. data/lib/candid/encounters_universal/types/universal_encounter_create_from_pre_encounter_base.rb +3 -0
  15. data/lib/candid/encounters_universal/types/universal_encounter_update_base.rb +3 -0
  16. data/lib/candid/fee_schedules/v_3/client.rb +9 -1
  17. data/lib/candid/fee_schedules/v_3/types/payer_threshold.rb +6 -1
  18. data/lib/candid/related_causes_information/v_1/types/related_causes_code.rb +20 -0
  19. data/lib/candid/related_causes_information/v_1/types/related_causes_information.rb +19 -0
  20. data/lib/candid/related_causes_information/v_1/types/related_causes_information_create.rb +11 -0
  21. data/lib/candid/related_causes_information/v_1/types/related_causes_information_update.rb +11 -0
  22. data/lib/candid/version.rb +1 -1
  23. data/lib/candid.rb +6 -7
  24. data/reference.md +62 -168
  25. metadata +6 -7
  26. data/lib/candid/insurance_payments/client.rb +0 -17
  27. data/lib/candid/insurance_payments/v_1/client.rb +0 -68
  28. data/lib/candid/insurance_payments/v_1/types/get_multi_insurance_payment_request.rb +0 -22
  29. data/lib/candid/insurance_payments/v_1/types/insurance_payment.rb +0 -20
  30. data/lib/candid/insurance_payments/v_1/types/insurance_payment_sort_field.rb +0 -17
  31. data/lib/candid/insurance_payments/v_1/types/insurance_payments_page.rb +0 -15
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 853cc42ee8abf8c4143310b93223536552422f6b5df3a3985c39eb0e37426464
4
- data.tar.gz: 8a38a7886555681dcc72f0a9169196a9c98d3d372cdfecd2894311fdf2a13979
3
+ metadata.gz: 6216b846646f6d4f67bf117597fba91822a5055020bd90b7e5fe8dd437cba1af
4
+ data.tar.gz: 4b8061c0931b7076543f6c629a71f7b85410c9d4b8af7f01a721428e66904dd2
5
5
  SHA512:
6
- metadata.gz: 2266e660bc9202a895da85672882c61e5909d30e4ea56bdbb6132e859797ea5e345b573651d7d5c7f4a22aa6911e599931f69d1ae4d0c7ca5af23399768d6140
7
- data.tar.gz: 98ed5edbe35a94a3b2bda0f88c35a8277bf017524a6738bf318c617c1fc68f8c15cc2dafb9384497a16644536e30195268c1b57eb9698df13e8097f403d6bc25
6
+ metadata.gz: 95d0909dc1a1bcaa14953cfab64acb80c06704a412371ce0bb28be99d875a3ca0a402a833b8b2efd1c64064a1b68b785076ca86ac6e71896ece655aea2baec1a
7
+ data.tar.gz: ba7a7847a5bbbd6344cc846378d5d2bccd4ea7fca3817db140a55c6c7487649208360da9c8b85c72fc859598a66f1a7ca46d19611f02c3e477a5186bdd562ab4
data/lib/candid/client.rb CHANGED
@@ -7,7 +7,7 @@ module Candid
7
7
  @raw_client = Candid::Internal::Http::RawClient.new(
8
8
  base_url: base_url,
9
9
  headers: {
10
- "User-Agent": "candidhealth/1.17.0",
10
+ "User-Agent": "candidhealth/1.17.1",
11
11
  "X-Fern-Language": "Ruby"
12
12
  }
13
13
  )
@@ -118,11 +118,6 @@ module Candid
118
118
  @insurance_adjudications ||= Candid::InsuranceAdjudications::Client.new(client: @raw_client)
119
119
  end
120
120
 
121
- # @return [Candid::InsurancePayments::Client]
122
- def insurance_payments
123
- @insurance_payments ||= Candid::InsurancePayments::Client.new(client: @raw_client)
124
- end
125
-
126
121
  # @return [Candid::InsuranceRefunds::Client]
127
122
  def insurance_refunds
128
123
  @insurance_refunds ||= Candid::InsuranceRefunds::Client.new(client: @raw_client)
@@ -20,6 +20,9 @@ module Candid
20
20
  field :provider_commercial_license_type, lambda {
21
21
  Candid::Commons::Types::BillingProviderCommercialLicenseType
22
22
  }, optional: true, nullable: false
23
+ field :secondary_identification, lambda {
24
+ Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
25
+ }, optional: true, nullable: false
23
26
  end
24
27
  end
25
28
  end
@@ -20,6 +20,9 @@ module Candid
20
20
  field :provider_commercial_license_type, lambda {
21
21
  Candid::Commons::Types::BillingProviderCommercialLicenseType
22
22
  }, optional: true, nullable: false
23
+ field :secondary_identification, lambda {
24
+ Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
25
+ }, optional: true, nullable: false
23
26
  end
24
27
  end
25
28
  end
@@ -21,6 +21,9 @@ module Candid
21
21
  field :provider_commercial_license_type, lambda {
22
22
  Candid::Commons::Types::BillingProviderCommercialLicenseType
23
23
  }, optional: true, nullable: false
24
+ field :secondary_identification, lambda {
25
+ Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
26
+ }, optional: true, nullable: false
24
27
  end
25
28
  end
26
29
  end
@@ -14,6 +14,9 @@ module Candid
14
14
  field :provider_commercial_license_type, lambda {
15
15
  Candid::Commons::Types::BillingProviderCommercialLicenseType
16
16
  }, optional: true, nullable: false
17
+ field :secondary_identification, lambda {
18
+ Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
19
+ }, optional: true, nullable: false
17
20
  end
18
21
  end
19
22
  end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module EncounterProviders
5
+ module V2
6
+ module Types
7
+ class ProviderSecondaryIdentification < Internal::Types::Model
8
+ field :reference_identification, -> { String }, optional: false, nullable: false
9
+ end
10
+ end
11
+ end
12
+ end
13
+ end
@@ -8,6 +8,9 @@ module Candid
8
8
  field :npi, -> { String }, optional: false, nullable: false
9
9
  field :taxonomy_code, -> { String }, optional: true, nullable: false
10
10
  field :address, -> { Candid::Commons::Types::StreetAddressLongZip }, optional: true, nullable: false
11
+ field :secondary_identification, lambda {
12
+ Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
13
+ }, optional: true, nullable: false
11
14
  end
12
15
  end
13
16
  end
@@ -8,6 +8,9 @@ module Candid
8
8
  field :npi, -> { String }, optional: true, nullable: false
9
9
  field :taxonomy_code, -> { String }, optional: true, nullable: false
10
10
  field :address, -> { Candid::Commons::Types::StreetAddressLongZip }, optional: true, nullable: false
11
+ field :secondary_identification, lambda {
12
+ Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
13
+ }, optional: true, nullable: false
11
14
  end
12
15
  end
13
16
  end
@@ -8,6 +8,9 @@ module Candid
8
8
  field :npi, -> { String }, optional: true, nullable: false
9
9
  field :taxonomy_code, -> { String }, optional: true, nullable: false
10
10
  field :address, -> { Candid::Commons::Types::StreetAddressShortZipOptional }, optional: true, nullable: false
11
+ field :secondary_identification, lambda {
12
+ Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
13
+ }, optional: true, nullable: false
11
14
  end
12
15
  end
13
16
  end
@@ -58,6 +58,11 @@ module Candid
58
58
  end
59
59
  end
60
60
 
61
+ # Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
62
+ # No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
63
+ # in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
64
+ # express, written consent of AHA.
65
+ #
61
66
  # @return [Candid::Encounters::V4::Types::Encounter]
62
67
  def create_universal(request_options: {}, **params)
63
68
  _request = Candid::Internal::JSON::Request.new(
@@ -119,6 +124,11 @@ module Candid
119
124
  # Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the
120
125
  # encounter has not already been submitted or adjudicated.
121
126
  #
127
+ # Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
128
+ # No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
129
+ # in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
130
+ # express, written consent of AHA.
131
+ #
122
132
  # @return [Candid::Encounters::V4::Types::Encounter]
123
133
  def create_from_pre_encounter_patient_universal(request_options: {}, **params)
124
134
  _request = Candid::Internal::JSON::Request.new(
@@ -180,6 +190,11 @@ module Candid
180
190
  end
181
191
  end
182
192
 
193
+ # Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
194
+ # No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
195
+ # in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
196
+ # express, written consent of AHA.
197
+ #
183
198
  # @return [Candid::Encounters::V4::Types::Encounter]
184
199
  def update_universal(request_options: {}, **params)
185
200
  _request = Candid::Internal::JSON::Request.new(
@@ -38,6 +38,9 @@ module Candid
38
38
  field :other_operating_provider, lambda {
39
39
  Candid::EncounterProviders::V2::Types::EncounterProvider
40
40
  }, optional: true, nullable: false
41
+ field :related_causes_information, lambda {
42
+ Candid::RelatedCausesInformation::V1::Types::RelatedCausesInformation
43
+ }, optional: true, nullable: false
41
44
  field :submission_expectation, lambda {
42
45
  Candid::Encounters::V4::Types::EncounterSubmissionExpectation
43
46
  }, optional: true, nullable: false
@@ -47,6 +47,9 @@ module Candid
47
47
  Internal::Types::Array[Candid::Encounters::V4::Types::ClaimSupplementalInformation]
48
48
  }, optional: true, nullable: false
49
49
  field :secondary_payer_carrier_code, -> { String }, optional: true, nullable: false
50
+ field :related_causes_information, lambda {
51
+ Candid::RelatedCausesInformation::V1::Types::RelatedCausesInformationCreate
52
+ }, optional: true, nullable: false
50
53
  end
51
54
  end
52
55
  end
@@ -34,6 +34,9 @@ module Candid
34
34
  field :schema_instances, lambda {
35
35
  Internal::Types::Array[Candid::CustomSchemas::V1::Types::SchemaInstance]
36
36
  }, optional: true, nullable: false
37
+ field :related_causes_information, lambda {
38
+ Candid::RelatedCausesInformation::V1::Types::RelatedCausesInformationCreate
39
+ }, optional: true, nullable: false
37
40
  end
38
41
  end
39
42
  end
@@ -44,6 +44,9 @@ module Candid
44
44
  field :place_of_service_code_as_submitted, lambda {
45
45
  Candid::Commons::Types::FacilityTypeCode
46
46
  }, optional: true, nullable: false
47
+ field :related_causes_information, lambda {
48
+ Candid::RelatedCausesInformation::V1::Types::RelatedCausesInformationUpdate
49
+ }, optional: true, nullable: false
47
50
  end
48
51
  end
49
52
  end
@@ -134,7 +134,15 @@ module Candid
134
134
  raise error_class.new(_response.body, code: code)
135
135
  end
136
136
 
137
- # Uploads a new fee schedule.\n Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate.\n If adding a new version to an existing rate, the rate must be posted with the next version number (previous version + 1) or a EntityConflictError will be returned.\n Use the dry run flag to discover already existing rates and to run validations. If validations for any rate fail, no rates will be saved to the system.
137
+ # Uploads a new fee schedule.
138
+ #
139
+ # Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate.
140
+ #
141
+ # If adding a new version to an existing rate, the rate must be posted with the next version number (previous version + 1) or a EntityConflictError will
142
+ # be returned.
143
+ #
144
+ # Use the dry run flag to discover already existing rates and to run validations. If validations for any rate fail, no rates will
145
+ # be saved to the system.
138
146
  #
139
147
  # @return [Array[Candid::FeeSchedules::V3::Types::Rate]]
140
148
  def upload_fee_schedule(request_options: {}, **params)
@@ -4,7 +4,12 @@ module Candid
4
4
  module FeeSchedules
5
5
  module V3
6
6
  module Types
7
- # Rate thresholds that determine fee schedule rate matching behavior. When a service line is adjudicated by a payer Candid determines if the payer's allowed amount "matches" the rate value. If the allowed amount doesn't equal the rate value, Candid moves the claim to a PAID_INCORRECTLY state. These optional thresholds allow a user to set wiggle room to avoid claims moving to PAID_INCORRECTLY and instead have them move directly to FINALIZED_PAID when the payer's allowed amount is greater than [rate_cents - lower_threshold_cents] and less than [rate_cents + upper_threshold_cents].\n Additionally, a client can set disable_paid_incorrectly to avoid the PAID_INCORRECTLY claim status entirely.
7
+ # Rate thresholds that determine fee schedule rate matching behavior. When a service line is adjudicated by a payer Candid determines if the payer's
8
+ # allowed amount "matches" the rate value. If the allowed amount doesn't equal the rate value, Candid moves the claim to a PAID_INCORRECTLY state. These
9
+ # optional thresholds allow a user to set wiggle room to avoid claims moving to PAID_INCORRECTLY and instead have them move directly to FINALIZED_PAID
10
+ # when the payer's allowed amount is greater than [rate_cents - lower_threshold_cents] and less than [rate_cents + upper_threshold_cents].
11
+ #
12
+ # Additionally, a client can set disable_paid_incorrectly to avoid the PAID_INCORRECTLY claim status entirely.
8
13
  class PayerThreshold < Internal::Types::Model
9
14
  field :upper_threshold_cents, -> { Integer }, optional: true, nullable: false
10
15
  field :lower_threshold_cents, -> { Integer }, optional: true, nullable: false
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module RelatedCausesInformation
5
+ module V1
6
+ module Types
7
+ module RelatedCausesCode
8
+ extend Candid::Internal::Types::Enum
9
+
10
+ CAA = "AA"
11
+ CAB = "AB"
12
+ CAP = "AP"
13
+ CEM = "EM"
14
+ COA = "OA"
15
+ CZZ = "ZZ"
16
+ end
17
+ end
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module RelatedCausesInformation
5
+ module V1
6
+ module Types
7
+ class RelatedCausesInformation < Internal::Types::Model
8
+ field :related_causes_code_1, lambda {
9
+ Candid::RelatedCausesInformation::V1::Types::RelatedCausesCode
10
+ }, optional: false, nullable: false
11
+ field :related_causes_code_2, lambda {
12
+ Candid::RelatedCausesInformation::V1::Types::RelatedCausesCode
13
+ }, optional: true, nullable: false
14
+ field :state_or_province_code, -> { String }, optional: true, nullable: false
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module RelatedCausesInformation
5
+ module V1
6
+ module Types
7
+ class RelatedCausesInformationCreate < Internal::Types::Model; end
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module RelatedCausesInformation
5
+ module V1
6
+ module Types
7
+ class RelatedCausesInformationUpdate < Internal::Types::Model; end
8
+ end
9
+ end
10
+ end
11
+ end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Candid
4
- VERSION = "1.17.0"
4
+ VERSION = "1.17.1"
5
5
  end
data/lib/candid.rb CHANGED
@@ -53,6 +53,7 @@ require_relative "candid/commons/types/state"
53
53
  require_relative "candid/commons/types/street_address_optional_base"
54
54
  require_relative "candid/commons/types/street_address_long_zip_optional"
55
55
  require_relative "candid/encounter_providers/v_2/types/ordering_provider_optional"
56
+ require_relative "candid/encounter_providers/v_2/types/provider_secondary_identification"
56
57
  require_relative "candid/commons/types/street_address_short_zip_optional"
57
58
  require_relative "candid/commons/types/billing_provider_commercial_license_type"
58
59
  require_relative "candid/encounter_providers/v_2/types/billing_provider_update_with_optional_address"
@@ -251,6 +252,9 @@ require_relative "candid/guarantor/v_1/types/guarantor_base"
251
252
  require_relative "candid/commons/types/phone_number"
252
253
  require_relative "candid/guarantor/v_1/types/guarantor_create"
253
254
  require_relative "candid/insurance_cards/v_2/types/insurance_card_create"
255
+ require_relative "candid/related_causes_information/v_1/types/related_causes_code"
256
+ require_relative "candid/related_causes_information/v_1/types/related_causes_information"
257
+ require_relative "candid/related_causes_information/v_1/types/related_causes_information_create"
254
258
  require_relative "candid/individual/types/individual_base"
255
259
  require_relative "candid/individual/types/subscriber_base"
256
260
  require_relative "candid/individual/types/subscriber_create"
@@ -307,6 +311,7 @@ require_relative "candid/x_12/v_1/types/point_of_origin_for_admission_or_visit_c
307
311
  require_relative "candid/x_12/v_1/types/patient_discharge_status_code"
308
312
  require_relative "candid/encounters_universal/types/universal_encounter_create"
309
313
  require_relative "candid/guarantor/v_1/types/guarantor_update"
314
+ require_relative "candid/related_causes_information/v_1/types/related_causes_information_update"
310
315
  require_relative "candid/individual/types/patient_update"
311
316
  require_relative "candid/service_facility/types/encounter_service_facility_update"
312
317
  require_relative "candid/encounters_universal/types/universal_encounter_update_base"
@@ -475,16 +480,13 @@ require_relative "candid/x_12/v_1/types/remittance_advice_remark_code"
475
480
  require_relative "candid/insurance_adjudications/v_1/types/service_line_adjudication"
476
481
  require_relative "candid/insurance_adjudications/v_1/types/claim_adjudication"
477
482
  require_relative "candid/insurance_adjudications/v_1/types/insurance_adjudication"
483
+ require_relative "candid/financials/types/refund_reason"
478
484
  require_relative "candid/financials/types/service_line_allocation_target"
479
485
  require_relative "candid/financials/types/claim_allocation_target"
480
486
  require_relative "candid/financials/types/billing_provider_allocation_target"
481
487
  require_relative "candid/financials/types/appointment_allocation_target"
482
488
  require_relative "candid/financials/types/allocation_target"
483
489
  require_relative "candid/financials/types/allocation"
484
- require_relative "candid/insurance_payments/v_1/types/insurance_payment"
485
- require_relative "candid/insurance_payments/v_1/types/insurance_payments_page"
486
- require_relative "candid/insurance_payments/v_1/types/insurance_payment_sort_field"
487
- require_relative "candid/financials/types/refund_reason"
488
490
  require_relative "candid/insurance_refunds/v_1/types/insurance_refund"
489
491
  require_relative "candid/payers/v_3/types/payer_info"
490
492
  require_relative "candid/payers/v_3/types/payer_identifier"
@@ -821,9 +823,6 @@ require_relative "candid/import_invoice/v_1/client"
821
823
  require_relative "candid/import_invoice/v_1/types/search_imported_invoices_request"
822
824
  require_relative "candid/insurance_adjudications/client"
823
825
  require_relative "candid/insurance_adjudications/v_1/client"
824
- require_relative "candid/insurance_payments/client"
825
- require_relative "candid/insurance_payments/v_1/client"
826
- require_relative "candid/insurance_payments/v_1/types/get_multi_insurance_payment_request"
827
826
  require_relative "candid/insurance_refunds/client"
828
827
  require_relative "candid/insurance_refunds/v_1/client"
829
828
  require_relative "candid/insurance_refunds/v_1/types/get_multi_insurance_refunds_request"
data/reference.md CHANGED
@@ -4503,6 +4503,23 @@ client.encounters.v_4.get();
4503
4503
  <dl>
4504
4504
  <dd>
4505
4505
 
4506
+ #### 📝 Description
4507
+
4508
+ <dl>
4509
+ <dd>
4510
+
4511
+ <dl>
4512
+ <dd>
4513
+
4514
+ Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
4515
+ No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
4516
+ in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
4517
+ express, written consent of AHA.
4518
+ </dd>
4519
+ </dl>
4520
+ </dd>
4521
+ </dl>
4522
+
4506
4523
  #### 🔌 Usage
4507
4524
 
4508
4525
  <dl>
@@ -4667,6 +4684,11 @@ where applicable. In particular, the following fields are populated from the pat
4667
4684
 
4668
4685
  Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the
4669
4686
  encounter has not already been submitted or adjudicated.
4687
+
4688
+ Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
4689
+ No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
4690
+ in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
4691
+ express, written consent of AHA.
4670
4692
  </dd>
4671
4693
  </dl>
4672
4694
  </dd>
@@ -4823,6 +4845,23 @@ client.encounters.v_4.create_from_pre_encounter_patient({
4823
4845
  <dl>
4824
4846
  <dd>
4825
4847
 
4848
+ #### 📝 Description
4849
+
4850
+ <dl>
4851
+ <dd>
4852
+
4853
+ <dl>
4854
+ <dd>
4855
+
4856
+ Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
4857
+ No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
4858
+ in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
4859
+ express, written consent of AHA.
4860
+ </dd>
4861
+ </dl>
4862
+ </dd>
4863
+ </dl>
4864
+
4826
4865
  #### 🔌 Usage
4827
4866
 
4828
4867
  <dl>
@@ -4974,7 +5013,20 @@ client.events.v_1.scan();
4974
5013
  <dl>
4975
5014
  <dd>
4976
5015
 
4977
- **event_types:** `String` — Event types to filter on. Defaults to showing all event types.
5016
+ **event_types:** `String`
5017
+
5018
+ Event types to filter on. Defaults to showing all event types.
5019
+
5020
+ | Event Type | Description |
5021
+ |------------|-------------|
5022
+ | `CandidApi.Encounter.Created` | When a new claim is created |
5023
+ | `CandidApi.Encounter.StatusUpdated` | When a claim's status has been updated |
5024
+ | `PreEncounter.Patient.Created` | When a new patient has been created |
5025
+ | `PreEncounter.Patient.Updated` | When a patient's information has been updated |
5026
+ | `PreEncounter.Coverage.Created` | When a new coverage has been created for a patient |
5027
+ | `PreEncounter.Coverage.Updated` | When a patient's coverage has been updated |
5028
+ | `PreEncounter.Tag.Created` | When a new tag has been created for a patient |
5029
+ | `PreEncounter.Tag.Updated` | When a patient's tag has been updated |
4978
5030
 
4979
5031
  </dd>
4980
5032
  </dl>
@@ -5947,7 +5999,15 @@ client.fee_schedules.v_3.get_rate_history();
5947
5999
  <dl>
5948
6000
  <dd>
5949
6001
 
5950
- Uploads a new fee schedule.\n Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate.\n If adding a new version to an existing rate, the rate must be posted with the next version number (previous version + 1) or a EntityConflictError will be returned.\n Use the dry run flag to discover already existing rates and to run validations. If validations for any rate fail, no rates will be saved to the system.
6002
+ Uploads a new fee schedule.
6003
+
6004
+ Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate.
6005
+
6006
+ If adding a new version to an existing rate, the rate must be posted with the next version number (previous version + 1) or a EntityConflictError will
6007
+ be returned.
6008
+
6009
+ Use the dry run flag to discover already existing rates and to run validations. If validations for any rate fail, no rates will
6010
+ be saved to the system.
5951
6011
  </dd>
5952
6012
  </dl>
5953
6013
  </dd>
@@ -6970,172 +7030,6 @@ client.insurance_adjudications.v_1.get();
6970
7030
  </dl>
6971
7031
 
6972
7032
 
6973
- </dd>
6974
- </dl>
6975
- </details>
6976
-
6977
- ## InsurancePayments V1
6978
- <details><summary><code>client.insurance_payments.v_1.get_multi() -> Candid::InsurancePayments::V1::Types::InsurancePaymentsPage</code></summary>
6979
- <dl>
6980
- <dd>
6981
-
6982
- #### 📝 Description
6983
-
6984
- <dl>
6985
- <dd>
6986
-
6987
- <dl>
6988
- <dd>
6989
-
6990
- Returns all non-ERA originated insurance payments satisfying the search criteria
6991
- </dd>
6992
- </dl>
6993
- </dd>
6994
- </dl>
6995
-
6996
- #### 🔌 Usage
6997
-
6998
- <dl>
6999
- <dd>
7000
-
7001
- <dl>
7002
- <dd>
7003
-
7004
- ```ruby
7005
- client.insurance_payments.v_1.get_multi();
7006
- ```
7007
- </dd>
7008
- </dl>
7009
- </dd>
7010
- </dl>
7011
-
7012
- #### ⚙️ Parameters
7013
-
7014
- <dl>
7015
- <dd>
7016
-
7017
- <dl>
7018
- <dd>
7019
-
7020
- **limit:** `Integer` — Defaults to 100. The value must be greater than 0 and less than 1000.
7021
-
7022
- </dd>
7023
- </dl>
7024
-
7025
- <dl>
7026
- <dd>
7027
-
7028
- **payer_uuid:** `String`
7029
-
7030
- </dd>
7031
- </dl>
7032
-
7033
- <dl>
7034
- <dd>
7035
-
7036
- **claim_id:** `String`
7037
-
7038
- </dd>
7039
- </dl>
7040
-
7041
- <dl>
7042
- <dd>
7043
-
7044
- **service_line_id:** `String`
7045
-
7046
- </dd>
7047
- </dl>
7048
-
7049
- <dl>
7050
- <dd>
7051
-
7052
- **billing_provider_id:** `String`
7053
-
7054
- </dd>
7055
- </dl>
7056
-
7057
- <dl>
7058
- <dd>
7059
-
7060
- **sort:** `Candid::InsurancePayments::V1::Types::InsurancePaymentSortField` — Defaults to payment_timestamp
7061
-
7062
- </dd>
7063
- </dl>
7064
-
7065
- <dl>
7066
- <dd>
7067
-
7068
- **sort_direction:** `Candid::Commons::Types::SortDirection` — Sort direction. Defaults to descending order if not provided.
7069
-
7070
- </dd>
7071
- </dl>
7072
-
7073
- <dl>
7074
- <dd>
7075
-
7076
- **page_token:** `String`
7077
-
7078
- </dd>
7079
- </dl>
7080
- </dd>
7081
- </dl>
7082
-
7083
-
7084
- </dd>
7085
- </dl>
7086
- </details>
7087
-
7088
- <details><summary><code>client.insurance_payments.v_1.get(insurance_payment_id) -> Candid::InsurancePayments::V1::Types::InsurancePayment</code></summary>
7089
- <dl>
7090
- <dd>
7091
-
7092
- #### 📝 Description
7093
-
7094
- <dl>
7095
- <dd>
7096
-
7097
- <dl>
7098
- <dd>
7099
-
7100
- Retrieves a previously created insurance payment by its `insurance_payment_id`.
7101
- If the payment does not exist, a `403` will be thrown.
7102
- </dd>
7103
- </dl>
7104
- </dd>
7105
- </dl>
7106
-
7107
- #### 🔌 Usage
7108
-
7109
- <dl>
7110
- <dd>
7111
-
7112
- <dl>
7113
- <dd>
7114
-
7115
- ```ruby
7116
- client.insurance_payments.v_1.get();
7117
- ```
7118
- </dd>
7119
- </dl>
7120
- </dd>
7121
- </dl>
7122
-
7123
- #### ⚙️ Parameters
7124
-
7125
- <dl>
7126
- <dd>
7127
-
7128
- <dl>
7129
- <dd>
7130
-
7131
- **insurance_payment_id:** `String`
7132
-
7133
- </dd>
7134
- </dl>
7135
- </dd>
7136
- </dl>
7137
-
7138
-
7139
7033
  </dd>
7140
7034
  </dl>
7141
7035
  </details>
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: candidhealth
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.17.0
4
+ version: 1.17.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Candid
@@ -215,6 +215,7 @@ files:
215
215
  - lib/candid/encounter_providers/v_2/types/ordering_provider.rb
216
216
  - lib/candid/encounter_providers/v_2/types/ordering_provider_optional.rb
217
217
  - lib/candid/encounter_providers/v_2/types/ordering_provider_update.rb
218
+ - lib/candid/encounter_providers/v_2/types/provider_secondary_identification.rb
218
219
  - lib/candid/encounter_providers/v_2/types/referring_provider.rb
219
220
  - lib/candid/encounter_providers/v_2/types/referring_provider_update.rb
220
221
  - lib/candid/encounter_providers/v_2/types/referring_provider_update_with_optional_address.rb
@@ -504,12 +505,6 @@ files:
504
505
  - lib/candid/insurance_cards/v_2/types/insurance_card_base.rb
505
506
  - lib/candid/insurance_cards/v_2/types/insurance_card_create.rb
506
507
  - lib/candid/insurance_cards/v_2/types/insurance_card_create_optional.rb
507
- - lib/candid/insurance_payments/client.rb
508
- - lib/candid/insurance_payments/v_1/client.rb
509
- - lib/candid/insurance_payments/v_1/types/get_multi_insurance_payment_request.rb
510
- - lib/candid/insurance_payments/v_1/types/insurance_payment.rb
511
- - lib/candid/insurance_payments/v_1/types/insurance_payment_sort_field.rb
512
- - lib/candid/insurance_payments/v_1/types/insurance_payments_page.rb
513
508
  - lib/candid/insurance_refunds/client.rb
514
509
  - lib/candid/insurance_refunds/v_1/client.rb
515
510
  - lib/candid/insurance_refunds/v_1/types/get_multi_insurance_refunds_request.rb
@@ -840,6 +835,10 @@ files:
840
835
  - lib/candid/pre_encounter/tags/v_1/types/mutable_tag.rb
841
836
  - lib/candid/pre_encounter/tags/v_1/types/tag.rb
842
837
  - lib/candid/pre_encounter/tags/v_1/types/tag_page.rb
838
+ - lib/candid/related_causes_information/v_1/types/related_causes_code.rb
839
+ - lib/candid/related_causes_information/v_1/types/related_causes_information.rb
840
+ - lib/candid/related_causes_information/v_1/types/related_causes_information_create.rb
841
+ - lib/candid/related_causes_information/v_1/types/related_causes_information_update.rb
843
842
  - lib/candid/service_facility/types/encounter_service_facility.rb
844
843
  - lib/candid/service_facility/types/encounter_service_facility_base.rb
845
844
  - lib/candid/service_facility/types/encounter_service_facility_update.rb
@@ -1,17 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Candid
4
- module InsurancePayments
5
- class Client
6
- # @return [Candid::InsurancePayments::Client]
7
- def initialize(client:)
8
- @client = client
9
- end
10
-
11
- # @return [Candid::V1::Client]
12
- def v_1
13
- @v_1 ||= Candid::InsurancePayments::V1::Client.new(client: @client)
14
- end
15
- end
16
- end
17
- end
@@ -1,68 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Candid
4
- module InsurancePayments
5
- module V1
6
- class Client
7
- # @return [Candid::InsurancePayments::V1::Client]
8
- def initialize(client:)
9
- @client = client
10
- end
11
-
12
- # Returns all non-ERA originated insurance payments satisfying the search criteria
13
- #
14
- # @return [Candid::InsurancePayments::V1::Types::InsurancePaymentsPage]
15
- def get_multi(request_options: {}, **params)
16
- params = Candid::Internal::Types::Utils.symbolize_keys(params)
17
- _query_param_names = %i[limit payer_uuid claim_id service_line_id billing_provider_id sort sort_direction
18
- page_token]
19
- _query = params.slice(*_query_param_names)
20
- params.except(*_query_param_names)
21
-
22
- _request = Candid::Internal::JSON::Request.new(
23
- base_url: request_options[:base_url] || Candid::Environment::PRODUCTION,
24
- method: "GET",
25
- path: "/api/insurance-payments/v1",
26
- query: _query
27
- )
28
- begin
29
- _response = @client.send(_request)
30
- rescue Net::HTTPRequestTimeout
31
- raise Candid::Errors::TimeoutError
32
- end
33
- code = _response.code.to_i
34
- if code.between?(200, 299)
35
- Candid::InsurancePayments::V1::Types::InsurancePaymentsPage.load(_response.body)
36
- else
37
- error_class = Candid::Errors::ResponseError.subclass_for_code(code)
38
- raise error_class.new(_response.body, code: code)
39
- end
40
- end
41
-
42
- # Retrieves a previously created insurance payment by its `insurance_payment_id`.
43
- # If the payment does not exist, a `403` will be thrown.
44
- #
45
- # @return [Candid::InsurancePayments::V1::Types::InsurancePayment]
46
- def get(request_options: {}, **params)
47
- _request = Candid::Internal::JSON::Request.new(
48
- base_url: request_options[:base_url] || Candid::Environment::PRODUCTION,
49
- method: "GET",
50
- path: "/api/insurance-payments/v1/#{params[:insurance_payment_id]}"
51
- )
52
- begin
53
- _response = @client.send(_request)
54
- rescue Net::HTTPRequestTimeout
55
- raise Candid::Errors::TimeoutError
56
- end
57
- code = _response.code.to_i
58
- if code.between?(200, 299)
59
- Candid::InsurancePayments::V1::Types::InsurancePayment.load(_response.body)
60
- else
61
- error_class = Candid::Errors::ResponseError.subclass_for_code(code)
62
- raise error_class.new(_response.body, code: code)
63
- end
64
- end
65
- end
66
- end
67
- end
68
- end
@@ -1,22 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Candid
4
- module InsurancePayments
5
- module V1
6
- module Types
7
- class GetMultiInsurancePaymentRequest < Internal::Types::Model
8
- field :limit, -> { Integer }, optional: true, nullable: false
9
- field :payer_uuid, -> { String }, optional: true, nullable: false
10
- field :claim_id, -> { String }, optional: true, nullable: false
11
- field :service_line_id, -> { String }, optional: true, nullable: false
12
- field :billing_provider_id, -> { String }, optional: true, nullable: false
13
- field :sort, lambda {
14
- Candid::InsurancePayments::V1::Types::InsurancePaymentSortField
15
- }, optional: true, nullable: false
16
- field :sort_direction, -> { Candid::Commons::Types::SortDirection }, optional: true, nullable: false
17
- field :page_token, -> { String }, optional: true, nullable: false
18
- end
19
- end
20
- end
21
- end
22
- end
@@ -1,20 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Candid
4
- module InsurancePayments
5
- module V1
6
- module Types
7
- class InsurancePayment < Internal::Types::Model
8
- field :insurance_payment_id, -> { String }, optional: false, nullable: false
9
- field :payer, -> { Candid::Payers::V3::Types::Payer }, optional: false, nullable: false
10
- field :amount_cents, -> { Integer }, optional: false, nullable: false
11
- field :payment_timestamp, -> { String }, optional: true, nullable: false
12
- field :payment_note, -> { String }, optional: true, nullable: false
13
- field :allocations, lambda {
14
- Internal::Types::Array[Candid::Financials::Types::Allocation]
15
- }, optional: false, nullable: false
16
- end
17
- end
18
- end
19
- end
20
- end
@@ -1,17 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Candid
4
- module InsurancePayments
5
- module V1
6
- module Types
7
- module InsurancePaymentSortField
8
- extend Candid::Internal::Types::Enum
9
-
10
- AMOUNT_CENTS = "amount_cents"
11
- PAYMENT_TIMESTAMP = "payment_timestamp"
12
- PAYMENT_NOTE = "payment_note"
13
- end
14
- end
15
- end
16
- end
17
- end
@@ -1,15 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Candid
4
- module InsurancePayments
5
- module V1
6
- module Types
7
- class InsurancePaymentsPage < Internal::Types::Model
8
- field :items, lambda {
9
- Internal::Types::Array[Candid::InsurancePayments::V1::Types::InsurancePayment]
10
- }, optional: false, nullable: false
11
- end
12
- end
13
- end
14
- end
15
- end