candidhealth 1.14.3 → 1.17.3

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 (118) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candid/claims/types/claim.rb +1 -1
  3. data/lib/candid/client.rb +7 -7
  4. data/lib/candid/commons/types/{http_service_unavailable_error_message.rb → bad_request_error_message.rb} +1 -1
  5. data/lib/candid/commons/types/claim_adjustment_group_codes.rb +22 -0
  6. data/lib/candid/commons/types/internal_error_message.rb +11 -0
  7. data/lib/candid/commons/types/procedure_modifier.rb +1 -0
  8. data/lib/candid/contracts/client.rb +5 -0
  9. data/lib/candid/contracts/v_2/client.rb +4 -0
  10. data/lib/candid/contracts/v_3/client.rb +176 -0
  11. data/lib/candid/contracts/v_3/types/contract.rb +18 -0
  12. data/lib/candid/contracts/v_3/types/contract_base.rb +28 -0
  13. data/lib/candid/contracts/v_3/types/contract_create.rb +15 -0
  14. data/lib/candid/contracts/v_3/types/contract_create_union.rb +18 -0
  15. data/lib/candid/contracts/v_3/types/contract_service_facility.rb +14 -0
  16. data/lib/candid/contracts/v_3/types/contract_service_facility_base.rb +14 -0
  17. data/lib/candid/contracts/v_3/types/contract_service_facility_create.rb +15 -0
  18. data/lib/candid/contracts/v_3/types/contract_service_facility_update.rb +16 -0
  19. data/lib/candid/contracts/v_3/types/contract_type.rb +16 -0
  20. data/lib/candid/contracts/v_3/types/contract_union.rb +18 -0
  21. data/lib/candid/contracts/v_3/types/contract_update.rb +28 -0
  22. data/lib/candid/contracts/v_3/types/contract_update_union.rb +18 -0
  23. data/lib/candid/contracts/v_3/types/contract_with_providers_union.rb +18 -0
  24. data/lib/candid/contracts/v_3/types/contracts_page.rb +15 -0
  25. data/lib/candid/contracts/v_3/types/get_multi_contracts_request.rb +22 -0
  26. data/lib/candid/contracts/v_3/types/institutional_contract.rb +15 -0
  27. data/lib/candid/contracts/v_3/types/institutional_contract_create.rb +15 -0
  28. data/lib/candid/contracts/v_3/types/institutional_contract_update.rb +13 -0
  29. data/lib/candid/contracts/v_3/types/professional_contract.rb +13 -0
  30. data/lib/candid/contracts/v_3/types/professional_contract_create.rb +13 -0
  31. data/lib/candid/contracts/v_3/types/professional_contract_update.rb +13 -0
  32. data/lib/candid/eligibility/v_2/client.rb +0 -38
  33. data/lib/candid/encounter_providers/v_2/types/billing_provider.rb +3 -0
  34. data/lib/candid/encounter_providers/v_2/types/billing_provider_update.rb +3 -0
  35. data/lib/candid/encounter_providers/v_2/types/billing_provider_update_with_optional_address.rb +3 -0
  36. data/lib/candid/encounter_providers/v_2/types/encounter_provider.rb +3 -0
  37. data/lib/candid/encounter_providers/v_2/types/provider_secondary_identification.rb +16 -0
  38. data/lib/candid/{expected_network_status/v_2/types/line_of_business.rb → encounter_providers/v_2/types/provider_secondary_identification_qualifier.rb} +4 -5
  39. data/lib/candid/encounter_providers/v_2/types/rendering_provider.rb +3 -0
  40. data/lib/candid/encounter_providers/v_2/types/rendering_provider_update.rb +3 -0
  41. data/lib/candid/encounter_providers/v_2/types/rendering_provider_update_with_optional_address.rb +3 -0
  42. data/lib/candid/encounters/v_4/client.rb +15 -0
  43. data/lib/candid/encounters/v_4/types/encounter.rb +3 -0
  44. data/lib/candid/encounters/v_4/types/encounter_deep_optional.rb +3 -0
  45. data/lib/candid/encounters_universal/types/universal_encounter_create_base.rb +3 -0
  46. data/lib/candid/encounters_universal/types/universal_encounter_create_from_pre_encounter_base.rb +3 -0
  47. data/lib/candid/encounters_universal/types/universal_encounter_update_base.rb +3 -0
  48. data/lib/candid/{era → eras}/types/era.rb +1 -1
  49. data/lib/candid/{era → eras}/types/era_base.rb +1 -1
  50. data/lib/candid/{insurance_payments → events}/client.rb +3 -3
  51. data/lib/candid/{insurance_payments → events}/v_1/client.rb +11 -15
  52. data/lib/candid/events/v_1/types/event.rb +18 -0
  53. data/lib/candid/events/v_1/types/event_scan_page.rb +16 -0
  54. data/lib/candid/events/v_1/types/get_event_scan_request.rb +17 -0
  55. data/lib/candid/fee_schedules/v_3/client.rb +9 -1
  56. data/lib/candid/fee_schedules/v_3/types/payer_threshold.rb +6 -1
  57. data/lib/candid/financials/types/allocation_create.rb +1 -0
  58. data/lib/candid/financials/types/allocation_earmark_type.rb +19 -0
  59. data/lib/candid/insurance_adjudications/client.rb +17 -0
  60. data/lib/candid/{expected_network_status → insurance_adjudications}/v_1/client.rb +8 -9
  61. data/lib/candid/insurance_adjudications/v_1/types/claim_adjudication.rb +23 -0
  62. data/lib/candid/insurance_adjudications/v_1/types/insurance_adjudication.rb +21 -0
  63. data/lib/candid/insurance_adjudications/v_1/types/service_line_adjudication.rb +27 -0
  64. data/lib/candid/insurance_cards/v_2/types/insurance_card_base.rb +1 -0
  65. data/lib/candid/patient_ar/v_1/client.rb +0 -4
  66. data/lib/candid/patient_payments/v_4/types/card_payment_method.rb +11 -0
  67. data/lib/candid/patient_payments/v_4/types/cash_payment_method.rb +11 -0
  68. data/lib/candid/patient_payments/v_4/types/check_payment_method.rb +13 -0
  69. data/lib/candid/patient_payments/v_4/types/patient_payment.rb +3 -0
  70. data/lib/candid/patient_payments/v_4/types/payment_method.rb +19 -0
  71. data/lib/candid/patient_payments/v_4/types/payment_method_detail.rb +18 -0
  72. data/lib/candid/pre_encounter/eligibility_checks/v_1/types/eligibility_request.rb +2 -0
  73. data/lib/candid/related_causes_information/v_1/types/related_causes_code.rb +20 -0
  74. data/lib/candid/related_causes_information/v_1/types/related_causes_information.rb +19 -0
  75. data/lib/candid/related_causes_information/v_1/types/related_causes_information_create.rb +11 -0
  76. data/lib/candid/related_causes_information/v_1/types/related_causes_information_update.rb +11 -0
  77. data/lib/candid/service_lines/v_2/types/service_line.rb +2 -0
  78. data/lib/candid/service_lines/v_2/types/service_line_create_base_base.rb +2 -0
  79. data/lib/candid/service_lines/v_2/types/service_line_create_optional.rb +2 -0
  80. data/lib/candid/service_lines/v_2/types/service_line_create_standalone.rb +2 -0
  81. data/lib/candid/service_lines/v_2/types/service_line_update_base.rb +2 -0
  82. data/lib/candid/service_lines/v_2/types/test_result_type.rb +1 -0
  83. data/lib/candid/service_lines/v_2/types/universal_service_line_create_standalone.rb +2 -0
  84. data/lib/candid/tasks/commons/types/task_type.rb +1 -0
  85. data/lib/candid/version.rb +1 -1
  86. data/lib/candid/x_12/v_1/types/carc.rb +418 -0
  87. data/lib/candid/x_12/v_1/types/claim_adjustment_reason_code.rb +15 -0
  88. data/lib/candid/x_12/v_1/types/rarc.rb +1201 -0
  89. data/lib/candid/x_12/v_1/types/remittance_advice_remark_code.rb +13 -0
  90. data/lib/candid.rb +56 -36
  91. data/reference.md +515 -363
  92. metadata +54 -34
  93. data/lib/candid/expected_network_status/client.rb +0 -22
  94. data/lib/candid/expected_network_status/v_1/types/expected_network_status.rb +0 -17
  95. data/lib/candid/expected_network_status/v_1/types/expected_network_status_request.rb +0 -24
  96. data/lib/candid/expected_network_status/v_1/types/expected_network_status_response.rb +0 -17
  97. data/lib/candid/expected_network_status/v_2/client.rb +0 -66
  98. data/lib/candid/expected_network_status/v_2/types/compute_all_in_network_providers_request.rb +0 -25
  99. data/lib/candid/expected_network_status/v_2/types/compute_all_in_network_providers_response.rb +0 -16
  100. data/lib/candid/expected_network_status/v_2/types/compute_all_in_network_rendering_providers_result.rb +0 -21
  101. data/lib/candid/expected_network_status/v_2/types/empty_object.rb +0 -11
  102. data/lib/candid/expected_network_status/v_2/types/expected_network_status_check_error_message.rb +0 -13
  103. data/lib/candid/expected_network_status/v_2/types/expected_network_status_request_v_2.rb +0 -25
  104. data/lib/candid/expected_network_status/v_2/types/expected_network_status_response_v_2.rb +0 -16
  105. data/lib/candid/expected_network_status/v_2/types/expected_network_status_subscriber_information.rb +0 -17
  106. data/lib/candid/expected_network_status/v_2/types/expected_network_status_v_2.rb +0 -19
  107. data/lib/candid/expected_network_status/v_2/types/explanation.rb +0 -22
  108. data/lib/candid/expected_network_status/v_2/types/in_network_rendering_providers_detail.rb +0 -15
  109. data/lib/candid/expected_network_status/v_2/types/in_network_status.rb +0 -14
  110. data/lib/candid/expected_network_status/v_2/types/indeterminate_network_status.rb +0 -18
  111. data/lib/candid/expected_network_status/v_2/types/insurance_type.rb +0 -18
  112. data/lib/candid/expected_network_status/v_2/types/insurance_type_codes.rb +0 -19
  113. data/lib/candid/expected_network_status/v_2/types/out_of_network_status.rb +0 -17
  114. data/lib/candid/expected_network_status/v_2/types/service_type.rb +0 -55
  115. data/lib/candid/insurance_payments/v_1/types/get_multi_insurance_payment_request.rb +0 -22
  116. data/lib/candid/insurance_payments/v_1/types/insurance_payment.rb +0 -20
  117. data/lib/candid/insurance_payments/v_1/types/insurance_payment_sort_field.rb +0 -17
  118. data/lib/candid/insurance_payments/v_1/types/insurance_payments_page.rb +0 -15
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module InsuranceAdjudications
5
+ module V1
6
+ module Types
7
+ class ServiceLineAdjudication < Internal::Types::Model
8
+ field :service_line_adjudication_id, -> { String }, optional: false, nullable: false
9
+ field :denial_reason, lambda {
10
+ Candid::ServiceLines::V2::Types::DenialReasonContent
11
+ }, optional: true, nullable: false
12
+ field :insurance_allowed_amount_cents, -> { Integer }, optional: true, nullable: false
13
+ field :insurance_paid_amount_cents, -> { Integer }, optional: true, nullable: false
14
+ field :deductible_amount_cents, -> { Integer }, optional: true, nullable: false
15
+ field :coinsurance_amount_cents, -> { Integer }, optional: true, nullable: false
16
+ field :copay_amount_cents, -> { Integer }, optional: true, nullable: false
17
+ field :carcs, lambda {
18
+ Internal::Types::Array[Candid::X12::V1::Types::ClaimAdjustmentReasonCode]
19
+ }, optional: false, nullable: false
20
+ field :rarcs, lambda {
21
+ Internal::Types::Array[Candid::X12::V1::Types::RemittanceAdviceRemarkCode]
22
+ }, optional: false, nullable: false
23
+ end
24
+ end
25
+ end
26
+ end
27
+ end
@@ -10,6 +10,7 @@ module Candid
10
10
  field :plan_type, -> { Candid::Commons::Types::SourceOfPaymentCode }, optional: true, nullable: false
11
11
  field :insurance_type, -> { Candid::Commons::Types::InsuranceTypeCode }, optional: true, nullable: false
12
12
  field :payer_plan_group_id, -> { String }, optional: true, nullable: false
13
+ field :payer_address, -> { Candid::Commons::Types::StreetAddressLongZip }, optional: true, nullable: false
13
14
  end
14
15
  end
15
16
  end
@@ -9,8 +9,6 @@ module Candid
9
9
  @client = client
10
10
  end
11
11
 
12
- # NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
13
- #
14
12
  # Retrieve a list of inventory records based on the provided filters. Each inventory record provides the latest invoiceable status of the associated claim.
15
13
  # The response is paginated, and the `page_token` can be used to retrieve subsequent pages. Initial requests should not include `page_token`.
16
14
  #
@@ -41,8 +39,6 @@ module Candid
41
39
  end
42
40
  end
43
41
 
44
- # NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
45
- #
46
42
  # Provides detailed itemization of invoice data for a specific claim.
47
43
  #
48
44
  # @return [Candid::PatientAr::V1::Types::InvoiceItemizationResponse]
@@ -0,0 +1,11 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module PatientPayments
5
+ module V4
6
+ module Types
7
+ class CardPaymentMethod < 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 PatientPayments
5
+ module V4
6
+ module Types
7
+ class CashPaymentMethod < Internal::Types::Model; end
8
+ end
9
+ end
10
+ end
11
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module PatientPayments
5
+ module V4
6
+ module Types
7
+ class CheckPaymentMethod < Internal::Types::Model
8
+ field :check_number, -> { String }, optional: false, nullable: false
9
+ end
10
+ end
11
+ end
12
+ end
13
+ end
@@ -19,6 +19,9 @@ module Candid
19
19
  Internal::Types::Array[Candid::Financials::Types::Allocation]
20
20
  }, optional: false, nullable: false
21
21
  field :invoice, -> { String }, optional: true, nullable: false
22
+ field :payment_method_detail, lambda {
23
+ Candid::PatientPayments::V4::Types::PaymentMethodDetail
24
+ }, optional: true, nullable: false
22
25
  end
23
26
  end
24
27
  end
@@ -0,0 +1,19 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module PatientPayments
5
+ module V4
6
+ module Types
7
+ class PaymentMethod < Internal::Types::Model
8
+ extend Candid::Internal::Types::Union
9
+
10
+ discriminant :type
11
+
12
+ member -> { Candid::PatientPayments::V4::Types::CashPaymentMethod }, key: "CASH"
13
+ member -> { Candid::PatientPayments::V4::Types::CheckPaymentMethod }, key: "CHECK"
14
+ member -> { Candid::PatientPayments::V4::Types::CardPaymentMethod }, key: "CARD"
15
+ end
16
+ end
17
+ end
18
+ end
19
+ end
@@ -0,0 +1,18 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module PatientPayments
5
+ module V4
6
+ module Types
7
+ class PaymentMethodDetail < Internal::Types::Model
8
+ field :payment_method, lambda {
9
+ Candid::PatientPayments::V4::Types::PaymentMethod
10
+ }, optional: false, nullable: false
11
+ field :collected_at_address, lambda {
12
+ Candid::Commons::Types::StreetAddressShortZip
13
+ }, optional: true, nullable: false
14
+ end
15
+ end
16
+ end
17
+ end
18
+ end
@@ -21,6 +21,8 @@ module Candid
21
21
  field :encounter, lambda {
22
22
  Candid::PreEncounter::EligibilityChecks::V1::Types::Encounter
23
23
  }, optional: true, nullable: false
24
+ field :get_existing_check_initiated_after, -> { String }, optional: true, nullable: false
25
+ field :source, -> { String }, optional: true, nullable: false
24
26
  end
25
27
  end
26
28
  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
@@ -68,6 +68,8 @@ module Candid
68
68
  field :has_epsdt_indicator, -> { Internal::Types::Boolean }, optional: true, nullable: false
69
69
  field :has_family_planning_indicator, -> { Internal::Types::Boolean }, optional: true, nullable: false
70
70
  field :note, -> { String }, optional: true, nullable: false
71
+ field :prior_authorization_number, -> { String }, optional: true, nullable: false
72
+ field :external_id, -> { String }, optional: true, nullable: false
71
73
  end
72
74
  end
73
75
  end
@@ -27,6 +27,8 @@ module Candid
27
27
  Internal::Types::Array[Candid::ServiceLines::V2::Types::TestResult]
28
28
  }, optional: true, nullable: false
29
29
  field :note, -> { String }, optional: true, nullable: false
30
+ field :prior_authorization_number, -> { String }, optional: true, nullable: false
31
+ field :external_id, -> { String }, optional: true, nullable: false
30
32
  end
31
33
  end
32
34
  end
@@ -30,6 +30,8 @@ module Candid
30
30
  }, optional: true, nullable: false
31
31
  field :note, -> { String }, optional: true, nullable: false
32
32
  field :revenue_code, -> { String }, optional: true, nullable: false
33
+ field :prior_authorization_number, -> { String }, optional: true, nullable: false
34
+ field :external_id, -> { String }, optional: true, nullable: false
33
35
  end
34
36
  end
35
37
  end
@@ -9,6 +9,8 @@ module Candid
9
9
  field :diagnosis_id_one, -> { String }, optional: true, nullable: false
10
10
  field :diagnosis_id_two, -> { String }, optional: true, nullable: false
11
11
  field :diagnosis_id_three, -> { String }, optional: true, nullable: false
12
+ field :prior_authorization_number, -> { String }, optional: true, nullable: false
13
+ field :external_id, -> { String }, optional: true, nullable: false
12
14
  end
13
15
  end
14
16
  end
@@ -29,6 +29,8 @@ module Candid
29
29
  field :has_epsdt_indicator, -> { Internal::Types::Boolean }, optional: true, nullable: false
30
30
  field :has_family_planning_indicator, -> { Internal::Types::Boolean }, optional: true, nullable: false
31
31
  field :note, -> { String }, optional: true, nullable: false
32
+ field :prior_authorization_number, -> { String }, optional: true, nullable: false
33
+ field :external_id, -> { String }, optional: true, nullable: false
32
34
  end
33
35
  end
34
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
@@ -11,6 +11,8 @@ module Candid
11
11
  field :diagnosis_id_three, -> { String }, optional: true, nullable: false
12
12
  field :revenue_code, -> { String }, optional: true, nullable: false
13
13
  field :procedure_code, -> { String }, optional: true, nullable: false
14
+ field :prior_authorization_number, -> { String }, optional: true, nullable: false
15
+ field :external_id, -> { String }, optional: true, nullable: false
14
16
  end
15
17
  end
16
18
  end
@@ -19,6 +19,7 @@ module Candid
19
19
  PAYER_CONFIGURATION_ERROR = "PAYER_CONFIGURATION_ERROR"
20
20
  DENIAL_RESOLUTION = "DENIAL_RESOLUTION"
21
21
  MISSING_ENROLLMENT = "MISSING_ENROLLMENT"
22
+ CHARGE_CAPTURE_UPDATE = "CHARGE_CAPTURE_UPDATE"
22
23
  end
23
24
  end
24
25
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Candid
4
- VERSION = "1.14.3"
4
+ VERSION = "1.17.3"
5
5
  end