candidhealth 1.17.0 → 1.17.2

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 (70) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candid/claims/types/claim.rb +1 -1
  3. data/lib/candid/client.rb +1 -11
  4. data/lib/candid/eligibility/v_2/client.rb +0 -38
  5. data/lib/candid/encounter_providers/v_2/types/billing_provider.rb +3 -0
  6. data/lib/candid/encounter_providers/v_2/types/billing_provider_update.rb +3 -0
  7. data/lib/candid/encounter_providers/v_2/types/billing_provider_update_with_optional_address.rb +3 -0
  8. data/lib/candid/encounter_providers/v_2/types/encounter_provider.rb +3 -0
  9. data/lib/candid/encounter_providers/v_2/types/provider_secondary_identification.rb +13 -0
  10. data/lib/candid/encounter_providers/v_2/types/rendering_provider.rb +3 -0
  11. data/lib/candid/encounter_providers/v_2/types/rendering_provider_update.rb +3 -0
  12. data/lib/candid/encounter_providers/v_2/types/rendering_provider_update_with_optional_address.rb +3 -0
  13. data/lib/candid/encounters/v_4/client.rb +15 -0
  14. data/lib/candid/encounters/v_4/types/encounter.rb +3 -0
  15. data/lib/candid/encounters/v_4/types/encounter_deep_optional.rb +3 -0
  16. data/lib/candid/encounters_universal/types/universal_encounter_create_base.rb +3 -0
  17. data/lib/candid/encounters_universal/types/universal_encounter_create_from_pre_encounter_base.rb +3 -0
  18. data/lib/candid/encounters_universal/types/universal_encounter_update_base.rb +3 -0
  19. data/lib/candid/{era → eras}/types/era.rb +1 -1
  20. data/lib/candid/{era → eras}/types/era_base.rb +1 -1
  21. data/lib/candid/fee_schedules/v_3/client.rb +9 -1
  22. data/lib/candid/fee_schedules/v_3/types/payer_threshold.rb +6 -1
  23. data/lib/candid/financials/types/allocation_create.rb +1 -0
  24. data/lib/candid/financials/types/allocation_earmark_type.rb +19 -0
  25. data/lib/candid/related_causes_information/v_1/types/related_causes_code.rb +20 -0
  26. data/lib/candid/related_causes_information/v_1/types/related_causes_information.rb +19 -0
  27. data/lib/candid/related_causes_information/v_1/types/related_causes_information_create.rb +11 -0
  28. data/lib/candid/related_causes_information/v_1/types/related_causes_information_update.rb +11 -0
  29. data/lib/candid/service_lines/v_2/types/service_line.rb +1 -0
  30. data/lib/candid/service_lines/v_2/types/service_line_create_base_base.rb +1 -0
  31. data/lib/candid/service_lines/v_2/types/service_line_create_optional.rb +1 -0
  32. data/lib/candid/service_lines/v_2/types/service_line_create_standalone.rb +1 -0
  33. data/lib/candid/service_lines/v_2/types/service_line_update_base.rb +1 -0
  34. data/lib/candid/service_lines/v_2/types/test_result_type.rb +1 -0
  35. data/lib/candid/service_lines/v_2/types/universal_service_line_create_standalone.rb +1 -0
  36. data/lib/candid/version.rb +1 -1
  37. data/lib/candid.rb +9 -34
  38. data/reference.md +62 -522
  39. metadata +9 -34
  40. data/lib/candid/commons/types/http_service_unavailable_error_message.rb +0 -11
  41. data/lib/candid/expected_network_status/client.rb +0 -22
  42. data/lib/candid/expected_network_status/v_1/client.rb +0 -38
  43. data/lib/candid/expected_network_status/v_1/types/expected_network_status.rb +0 -17
  44. data/lib/candid/expected_network_status/v_1/types/expected_network_status_request.rb +0 -24
  45. data/lib/candid/expected_network_status/v_1/types/expected_network_status_response.rb +0 -17
  46. data/lib/candid/expected_network_status/v_2/client.rb +0 -66
  47. data/lib/candid/expected_network_status/v_2/types/compute_all_in_network_providers_request.rb +0 -25
  48. data/lib/candid/expected_network_status/v_2/types/compute_all_in_network_providers_response.rb +0 -16
  49. data/lib/candid/expected_network_status/v_2/types/compute_all_in_network_rendering_providers_result.rb +0 -21
  50. data/lib/candid/expected_network_status/v_2/types/empty_object.rb +0 -11
  51. data/lib/candid/expected_network_status/v_2/types/expected_network_status_check_error_message.rb +0 -13
  52. data/lib/candid/expected_network_status/v_2/types/expected_network_status_request_v_2.rb +0 -25
  53. data/lib/candid/expected_network_status/v_2/types/expected_network_status_response_v_2.rb +0 -16
  54. data/lib/candid/expected_network_status/v_2/types/expected_network_status_subscriber_information.rb +0 -17
  55. data/lib/candid/expected_network_status/v_2/types/expected_network_status_v_2.rb +0 -19
  56. data/lib/candid/expected_network_status/v_2/types/explanation.rb +0 -22
  57. data/lib/candid/expected_network_status/v_2/types/in_network_rendering_providers_detail.rb +0 -15
  58. data/lib/candid/expected_network_status/v_2/types/in_network_status.rb +0 -14
  59. data/lib/candid/expected_network_status/v_2/types/indeterminate_network_status.rb +0 -18
  60. data/lib/candid/expected_network_status/v_2/types/insurance_type.rb +0 -18
  61. data/lib/candid/expected_network_status/v_2/types/insurance_type_codes.rb +0 -19
  62. data/lib/candid/expected_network_status/v_2/types/line_of_business.rb +0 -17
  63. data/lib/candid/expected_network_status/v_2/types/out_of_network_status.rb +0 -17
  64. data/lib/candid/expected_network_status/v_2/types/service_type.rb +0 -55
  65. data/lib/candid/insurance_payments/client.rb +0 -17
  66. data/lib/candid/insurance_payments/v_1/client.rb +0 -68
  67. data/lib/candid/insurance_payments/v_1/types/get_multi_insurance_payment_request.rb +0 -22
  68. data/lib/candid/insurance_payments/v_1/types/insurance_payment.rb +0 -20
  69. data/lib/candid/insurance_payments/v_1/types/insurance_payment_sort_field.rb +0 -17
  70. 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: f3eb7a40db31098feb00087d7c723d1b7591fab773c2be2888a91ddf1d0c184a
4
+ data.tar.gz: 5d0364b74a509eef5b7a086469c27db74579f2fd31bec58a24465a8b7317e51e
5
5
  SHA512:
6
- metadata.gz: 2266e660bc9202a895da85672882c61e5909d30e4ea56bdbb6132e859797ea5e345b573651d7d5c7f4a22aa6911e599931f69d1ae4d0c7ca5af23399768d6140
7
- data.tar.gz: 98ed5edbe35a94a3b2bda0f88c35a8277bf017524a6738bf318c617c1fc68f8c15cc2dafb9384497a16644536e30195268c1b57eb9698df13e8097f403d6bc25
6
+ metadata.gz: 864a5f17ec17836105e54c80a340bd95f052550684e4dd00998b1778b9c9d42b59e365725ddd622401433affa3b44a24ecc07ea166948024a4e3c1dced864433
7
+ data.tar.gz: be0a035e096169ccc7bff6a2fb7ba5580ceb8e90d0b3e981b6cfa2ae077c8194b3d4db409101008985422cbba109d55bc593759e70627948df72daa4661ed444
@@ -13,7 +13,7 @@ module Candid
13
13
  field :service_lines, lambda {
14
14
  Internal::Types::Array[Candid::ServiceLines::V2::Types::ServiceLine]
15
15
  }, optional: false, nullable: false
16
- field :eras, -> { Internal::Types::Array[Candid::Era::Types::Era] }, optional: false, nullable: false
16
+ field :eras, -> { Internal::Types::Array[Candid::Eras::Types::Era] }, optional: false, nullable: false
17
17
  end
18
18
  end
19
19
  end
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.2",
11
11
  "X-Fern-Language": "Ruby"
12
12
  }
13
13
  )
@@ -78,11 +78,6 @@ module Candid
78
78
  @events ||= Candid::Events::Client.new(client: @raw_client)
79
79
  end
80
80
 
81
- # @return [Candid::ExpectedNetworkStatus::Client]
82
- def expected_network_status
83
- @expected_network_status ||= Candid::ExpectedNetworkStatus::Client.new(client: @raw_client)
84
- end
85
-
86
81
  # @return [Candid::Exports::Client]
87
82
  def exports
88
83
  @exports ||= Candid::Exports::Client.new(client: @raw_client)
@@ -118,11 +113,6 @@ module Candid
118
113
  @insurance_adjudications ||= Candid::InsuranceAdjudications::Client.new(client: @raw_client)
119
114
  end
120
115
 
121
- # @return [Candid::InsurancePayments::Client]
122
- def insurance_payments
123
- @insurance_payments ||= Candid::InsurancePayments::Client.new(client: @raw_client)
124
- end
125
-
126
116
  # @return [Candid::InsuranceRefunds::Client]
127
117
  def insurance_refunds
128
118
  @insurance_refunds ||= Candid::InsuranceRefunds::Client.new(client: @raw_client)
@@ -9,44 +9,6 @@ module Candid
9
9
  @client = client
10
10
  end
11
11
 
12
- # <Tip>Candid is deprecating support for this endpoint. It is instead recommended to use [Candid's Stedi passthrough endpoint](https://docs.joincandidhealth.com/api-reference/pre-encounter/eligibility-checks/v-1/post).
13
- # 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>
14
- #
15
- # This API is a wrapper around Change Healthcare's eligibility API. Below are some helpful documentation links:
16
- #
17
- # - [Change Healthcare - Guides: Contents of the Eligibility Request Body](https://developers.changehealthcare.com/eligibilityandclaims/docs/contents-of-the-eligibility-request-body)
18
- # - [Change Healthcare - Guides: Use "Bare Minimum" Eligibility Requests](https://developers.changehealthcare.com/eligibilityandclaims/docs/use-bare-minimum-eligibility-requests)
19
- # - [Change Healthcare - Guides: Contents of the Eligibility Response](https://developers.changehealthcare.com/eligibilityandclaims/docs/contents-of-the-eligibility-response)
20
- # - [Change Healthcare - Guides: Eligibility JSON-to-EDI API Contents](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-json-to-edi-api-contents)
21
- # - [Change Healthcare - Guides: Eligibility Error Messages](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-error-messages)
22
- # - [Change Healthcare - Guides: FAQ](https://developers.changehealthcare.com/eligibilityandclaims/docs/frequently-asked-questions)
23
- # - [Change Healthcare - Guides: Eligibility FAQs](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-api-requests)
24
- # - [Change Healthcare - Guides: Sandbox API Values and Test Responses](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-sandbox-api-values-and-test-responses)
25
- # - [Change Healthcare - Guides: Sandbox Predefined Fields and Values](https://developers.changehealthcare.com/eligibilityandclaims/docs/sandbox-predefined-fields-and-values)
26
- # - [Change Healthcare - Guides: Using Test Payers in the Sandbox](https://developers.changehealthcare.com/eligibilityandclaims/docs/use-the-test-payers-in-the-sandbox-api)
27
- #
28
- # A schema of the response object can be found here: [Change Healthcare Docs](https://developers.changehealthcare.com/eligibilityandclaims/reference/medicaleligibility)
29
- #
30
- # @return [Hash[String, Object]]
31
- def submit_eligibility_check(request_options: {}, **params)
32
- _request = Candid::Internal::JSON::Request.new(
33
- base_url: request_options[:base_url] || Candid::Environment::PRODUCTION,
34
- method: "POST",
35
- path: "/api/eligibility/v2",
36
- body: params
37
- )
38
- begin
39
- _response = @client.send(_request)
40
- rescue Net::HTTPRequestTimeout
41
- raise Candid::Errors::TimeoutError
42
- end
43
- code = _response.code.to_i
44
- return if code.between?(200, 299)
45
-
46
- error_class = Candid::Errors::ResponseError.subclass_for_code(code)
47
- raise error_class.new(_response.body, code: code)
48
- end
49
-
50
12
  # <Tip>Candid is deprecating support for this endpoint. It is instead recommended to use [Candid's Stedi passthrough endpoint](https://docs.joincandidhealth.com/api-reference/pre-encounter/eligibility-checks/v-1/post).
51
13
  # 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>
52
14
  #
@@ -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
@@ -73,6 +73,9 @@ module Candid
73
73
  field :pay_to_address, lambda {
74
74
  Candid::Commons::Types::StreetAddressShortZipOptional
75
75
  }, optional: true, nullable: false
76
+ field :related_causes_information, lambda {
77
+ Candid::RelatedCausesInformation::V1::Types::RelatedCausesInformationCreate
78
+ }, optional: true, nullable: false
76
79
  end
77
80
  end
78
81
  end
@@ -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
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Candid
4
- module Era
4
+ module Eras
5
5
  module Types
6
6
  class Era < Internal::Types::Model
7
7
  field :era_id, -> { String }, optional: false, nullable: false
@@ -1,7 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Candid
4
- module Era
4
+ module Eras
5
5
  module Types
6
6
  class EraBase < Internal::Types::Model
7
7
  field :check_number, -> { String }, optional: false, nullable: false
@@ -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
@@ -8,6 +8,7 @@ module Candid
8
8
  class AllocationCreate < Internal::Types::Model
9
9
  field :amount_cents, -> { Integer }, optional: false, nullable: false
10
10
  field :target, -> { Candid::Financials::Types::AllocationTargetCreate }, optional: false, nullable: false
11
+ field :earmark, -> { Candid::Financials::Types::AllocationEarmarkType }, optional: true, nullable: false
11
12
  end
12
13
  end
13
14
  end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module Financials
5
+ module Types
6
+ # CURRENTLY UNIMPLEMENTED - Defines how a patient prepayment allocation should be earmarked for future auto-allocation.
7
+ # When implemented, earmarks will hold the allocation until a matching encounter is created, then attempt to allocate to that encounter.
8
+ # Only applicable for unattributed allocations.
9
+ class AllocationEarmarkType < Internal::Types::Model
10
+ extend Candid::Internal::Types::Union
11
+
12
+ discriminant :type
13
+
14
+ member -> { String }, key: "DATE_OF_SERVICE"
15
+ member -> { String }, key: "EXTERNAL_ENCOUNTER_ID"
16
+ end
17
+ end
18
+ end
19
+ end
@@ -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
@@ -69,6 +69,7 @@ module Candid
69
69
  field :has_family_planning_indicator, -> { Internal::Types::Boolean }, optional: true, nullable: false
70
70
  field :note, -> { String }, optional: true, nullable: false
71
71
  field :prior_authorization_number, -> { String }, optional: true, nullable: false
72
+ field :external_id, -> { String }, optional: true, nullable: false
72
73
  end
73
74
  end
74
75
  end
@@ -28,6 +28,7 @@ module Candid
28
28
  }, optional: true, nullable: false
29
29
  field :note, -> { String }, optional: true, nullable: false
30
30
  field :prior_authorization_number, -> { String }, optional: true, nullable: false
31
+ field :external_id, -> { String }, optional: true, nullable: false
31
32
  end
32
33
  end
33
34
  end
@@ -31,6 +31,7 @@ module Candid
31
31
  field :note, -> { String }, optional: true, nullable: false
32
32
  field :revenue_code, -> { String }, optional: true, nullable: false
33
33
  field :prior_authorization_number, -> { String }, optional: true, nullable: false
34
+ field :external_id, -> { String }, optional: true, nullable: false
34
35
  end
35
36
  end
36
37
  end
@@ -10,6 +10,7 @@ module Candid
10
10
  field :diagnosis_id_two, -> { String }, optional: true, nullable: false
11
11
  field :diagnosis_id_three, -> { String }, optional: true, nullable: false
12
12
  field :prior_authorization_number, -> { String }, optional: true, nullable: false
13
+ field :external_id, -> { String }, optional: true, nullable: false
13
14
  end
14
15
  end
15
16
  end
@@ -30,6 +30,7 @@ module Candid
30
30
  field :has_family_planning_indicator, -> { Internal::Types::Boolean }, optional: true, nullable: false
31
31
  field :note, -> { String }, optional: true, nullable: false
32
32
  field :prior_authorization_number, -> { String }, optional: true, nullable: false
33
+ field :external_id, -> { String }, optional: true, nullable: false
33
34
  end
34
35
  end
35
36
  end
@@ -10,6 +10,7 @@ module Candid
10
10
  HEMATOCRIT = "HEMATOCRIT"
11
11
  HEMOGLOBIN = "HEMOGLOBIN"
12
12
  LDL = "LDL"
13
+ VITAMIN_D = "VITAMIN_D"
13
14
  end
14
15
  end
15
16
  end
@@ -12,6 +12,7 @@ module Candid
12
12
  field :revenue_code, -> { String }, optional: true, nullable: false
13
13
  field :procedure_code, -> { String }, optional: true, nullable: false
14
14
  field :prior_authorization_number, -> { String }, optional: true, nullable: false
15
+ field :external_id, -> { String }, optional: true, nullable: false
15
16
  end
16
17
  end
17
18
  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.2"
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"
@@ -95,6 +96,9 @@ require_relative "candid/commons/types/insurance_type_code"
95
96
  require_relative "candid/insurance_cards/v_2/types/insurance_card_base"
96
97
  require_relative "candid/commons/types/emr_payer_crosswalk"
97
98
  require_relative "candid/insurance_cards/v_2/types/insurance_card_create_optional"
99
+ require_relative "candid/related_causes_information/v_1/types/related_causes_code"
100
+ require_relative "candid/related_causes_information/v_1/types/related_causes_information"
101
+ require_relative "candid/related_causes_information/v_1/types/related_causes_information_create"
98
102
  require_relative "candid/service_lines/v_2/types/service_id_qualifier"
99
103
  require_relative "candid/service_lines/v_2/types/measurement_unit_code"
100
104
  require_relative "candid/service_lines/v_2/types/drug_identification_optional"
@@ -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"
@@ -367,8 +372,8 @@ require_relative "candid/invoices/types/invoice"
367
372
  require_relative "candid/service_lines/v_2/types/service_line"
368
373
  require_relative "candid/x_12/v_1/types/type_of_bill_composite"
369
374
  require_relative "candid/claims/types/claim_status"
370
- require_relative "candid/era/types/era_base"
371
- require_relative "candid/era/types/era"
375
+ require_relative "candid/eras/types/era_base"
376
+ require_relative "candid/eras/types/era"
372
377
  require_relative "candid/claims/types/claim"
373
378
  require_relative "candid/commons/types/next_responsible_party"
374
379
  require_relative "candid/diagnoses/types/standalone_diagnosis_create"
@@ -401,26 +406,6 @@ require_relative "candid/encounters/v_4/types/payer_plan_group_payer_does_not_ma
401
406
  require_relative "candid/encounters/v_4/types/encounter_rendering_or_attending_provider_required_error"
402
407
  require_relative "candid/events/v_1/types/event"
403
408
  require_relative "candid/events/v_1/types/event_scan_page"
404
- require_relative "candid/expected_network_status/v_1/types/expected_network_status"
405
- require_relative "candid/expected_network_status/v_1/types/expected_network_status_response"
406
- require_relative "candid/expected_network_status/v_2/types/line_of_business"
407
- require_relative "candid/expected_network_status/v_2/types/empty_object"
408
- require_relative "candid/expected_network_status/v_2/types/insurance_type_codes"
409
- require_relative "candid/expected_network_status/v_2/types/insurance_type"
410
- require_relative "candid/expected_network_status/v_2/types/explanation"
411
- require_relative "candid/expected_network_status/v_2/types/service_type"
412
- require_relative "candid/expected_network_status/v_2/types/expected_network_status_subscriber_information"
413
- require_relative "candid/expected_network_status/v_2/types/expected_network_status_request_v_2"
414
- require_relative "candid/expected_network_status/v_2/types/compute_all_in_network_providers_request"
415
- require_relative "candid/expected_network_status/v_2/types/in_network_rendering_providers_detail"
416
- require_relative "candid/expected_network_status/v_2/types/indeterminate_network_status"
417
- require_relative "candid/expected_network_status/v_2/types/in_network_status"
418
- require_relative "candid/expected_network_status/v_2/types/out_of_network_status"
419
- require_relative "candid/expected_network_status/v_2/types/compute_all_in_network_rendering_providers_result"
420
- require_relative "candid/expected_network_status/v_2/types/compute_all_in_network_providers_response"
421
- require_relative "candid/expected_network_status/v_2/types/expected_network_status_v_2"
422
- require_relative "candid/expected_network_status/v_2/types/expected_network_status_response_v_2"
423
- require_relative "candid/expected_network_status/v_2/types/expected_network_status_check_error_message"
424
409
  require_relative "candid/exports/v_3/types/get_exports_response"
425
410
  require_relative "candid/external_payment_account_config/v_1/types/external_payment_account_config"
426
411
  require_relative "candid/external_payment_account_config/v_1/types/external_payment_account_config_page"
@@ -475,19 +460,17 @@ require_relative "candid/x_12/v_1/types/remittance_advice_remark_code"
475
460
  require_relative "candid/insurance_adjudications/v_1/types/service_line_adjudication"
476
461
  require_relative "candid/insurance_adjudications/v_1/types/claim_adjudication"
477
462
  require_relative "candid/insurance_adjudications/v_1/types/insurance_adjudication"
463
+ require_relative "candid/financials/types/refund_reason"
478
464
  require_relative "candid/financials/types/service_line_allocation_target"
479
465
  require_relative "candid/financials/types/claim_allocation_target"
480
466
  require_relative "candid/financials/types/billing_provider_allocation_target"
481
467
  require_relative "candid/financials/types/appointment_allocation_target"
482
468
  require_relative "candid/financials/types/allocation_target"
483
469
  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
470
  require_relative "candid/insurance_refunds/v_1/types/insurance_refund"
489
471
  require_relative "candid/payers/v_3/types/payer_info"
490
472
  require_relative "candid/payers/v_3/types/payer_identifier"
473
+ require_relative "candid/financials/types/allocation_earmark_type"
491
474
  require_relative "candid/financials/types/appointment_by_id_and_patient_external_id"
492
475
  require_relative "candid/financials/types/allocation_target_create"
493
476
  require_relative "candid/financials/types/allocation_create"
@@ -722,7 +705,6 @@ require_relative "candid/pre_encounter/tags/v_1/types/tag_page"
722
705
  require_relative "candid/commons/types/sort_direction"
723
706
  require_relative "candid/commons/types/unauthorized_error_message"
724
707
  require_relative "candid/commons/types/unprocessable_entity_error_message"
725
- require_relative "candid/commons/types/http_service_unavailable_error_message"
726
708
  require_relative "candid/commons/types/request_validation_error"
727
709
  require_relative "candid/commons/types/updates_disabled_due_to_external_system_integration_error_message"
728
710
  require_relative "candid/commons/types/organization_not_authorized_error_message"
@@ -795,10 +777,6 @@ require_relative "candid/encounters/v_4/types/get_all_encounters_request"
795
777
  require_relative "candid/events/client"
796
778
  require_relative "candid/events/v_1/client"
797
779
  require_relative "candid/events/v_1/types/get_event_scan_request"
798
- require_relative "candid/expected_network_status/client"
799
- require_relative "candid/expected_network_status/v_1/client"
800
- require_relative "candid/expected_network_status/v_1/types/expected_network_status_request"
801
- require_relative "candid/expected_network_status/v_2/client"
802
780
  require_relative "candid/exports/client"
803
781
  require_relative "candid/exports/v_3/client"
804
782
  require_relative "candid/exports/v_3/types/get_exports_request"
@@ -821,9 +799,6 @@ require_relative "candid/import_invoice/v_1/client"
821
799
  require_relative "candid/import_invoice/v_1/types/search_imported_invoices_request"
822
800
  require_relative "candid/insurance_adjudications/client"
823
801
  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
802
  require_relative "candid/insurance_refunds/client"
828
803
  require_relative "candid/insurance_refunds/v_1/client"
829
804
  require_relative "candid/insurance_refunds/v_1/types/get_multi_insurance_refunds_request"