candidhealth 1.7.0 → 1.8.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 (90) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candidhealth/auth/default/client.rb +34 -6
  3. data/lib/candidhealth/charge_capture/v_1/client.rb +119 -52
  4. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +70 -56
  5. data/lib/candidhealth/charge_capture_bundles/v_1/client.rb +33 -2
  6. data/lib/candidhealth/commons/types/clearinghouse.rb +18 -0
  7. data/lib/candidhealth/commons/types/procedure_modifier.rb +11 -0
  8. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider.rb +1 -1
  9. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider_update.rb +1 -1
  10. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider_update_with_optional_address.rb +1 -1
  11. data/lib/candidhealth/encounters/v_4/client.rb +3269 -2040
  12. data/lib/candidhealth/encounters/v_4/types/encounter.rb +111 -86
  13. data/lib/candidhealth/encounters/v_4/types/encounter_base.rb +39 -33
  14. data/lib/candidhealth/encounters/v_4/types/encounter_create.rb +796 -0
  15. data/lib/candidhealth/encounters/v_4/types/encounter_create_from_pre_encounter.rb +131 -117
  16. data/lib/candidhealth/encounters/v_4/types/encounter_deep_optional.rb +70 -56
  17. data/lib/candidhealth/encounters/v_4/types/encounter_optional.rb +29 -39
  18. data/lib/candidhealth/encounters/v_4/types/encounter_rendering_or_attending_provider_required_error.rb +55 -0
  19. data/lib/candidhealth/encounters/v_4/types/encounter_update.rb +736 -0
  20. data/lib/candidhealth/encounters_universal/types/universal_encounter_create.rb +944 -0
  21. data/lib/candidhealth/encounters_universal/types/universal_encounter_create_base.rb +691 -0
  22. data/lib/candidhealth/encounters_universal/types/universal_encounter_create_from_pre_encounter.rb +791 -0
  23. data/lib/candidhealth/encounters_universal/types/universal_encounter_create_from_pre_encounter_base.rb +572 -0
  24. data/lib/candidhealth/encounters_universal/types/universal_encounter_update.rb +872 -0
  25. data/lib/candidhealth/encounters_universal/types/universal_encounter_update_base.rb +700 -0
  26. data/lib/candidhealth/fee_schedules/v_3/client.rb +57 -0
  27. data/lib/candidhealth/fee_schedules/v_3/types/validation_error.rb +12 -0
  28. data/lib/candidhealth/financials/types/patient_transaction_source.rb +1 -0
  29. data/lib/candidhealth/guarantor/v_1/client.rb +4 -0
  30. data/lib/candidhealth/guarantor/v_1/types/guarantor.rb +10 -2
  31. data/lib/candidhealth/guarantor/v_1/types/guarantor_create.rb +10 -2
  32. data/lib/candidhealth/guarantor/v_1/types/guarantor_optional.rb +10 -2
  33. data/lib/candidhealth/guarantor/v_1/types/guarantor_update.rb +10 -2
  34. data/lib/candidhealth/health_care_code_information/v_1/types/admitting_diagnosis_new.rb +206 -0
  35. data/lib/candidhealth/health_care_code_information/v_1/types/condition_information_new.rb +207 -0
  36. data/lib/candidhealth/health_care_code_information/v_1/types/diagnosis_related_group_new.rb +206 -0
  37. data/lib/candidhealth/health_care_code_information/v_1/types/external_cause_of_injury_new.rb +245 -0
  38. data/lib/candidhealth/health_care_code_information/v_1/types/health_care_code_information_create.rb +225 -0
  39. data/lib/candidhealth/health_care_code_information/v_1/types/occurrence_information_new.rb +219 -0
  40. data/lib/candidhealth/health_care_code_information/v_1/types/occurrence_span_information_new.rb +222 -0
  41. data/lib/candidhealth/health_care_code_information/v_1/types/other_diagnosis_information_new.rb +215 -0
  42. data/lib/candidhealth/health_care_code_information/v_1/types/other_procedure_information_new.rb +218 -0
  43. data/lib/candidhealth/health_care_code_information/v_1/types/patient_reason_for_visit_new.rb +206 -0
  44. data/lib/candidhealth/health_care_code_information/v_1/types/principal_diagnosis_new.rb +215 -0
  45. data/lib/candidhealth/health_care_code_information/v_1/types/principal_procedure_information_new.rb +216 -0
  46. data/lib/candidhealth/health_care_code_information/v_1/types/treatment_code_information_new.rb +206 -0
  47. data/lib/candidhealth/health_care_code_information/v_1/types/value_information_new.rb +215 -0
  48. data/lib/candidhealth/individual/types/patient.rb +16 -8
  49. data/lib/candidhealth/individual/types/patient_base.rb +6 -6
  50. data/lib/candidhealth/individual/types/patient_create.rb +15 -7
  51. data/lib/candidhealth/individual/types/patient_update.rb +15 -7
  52. data/lib/candidhealth/individual/types/patient_update_with_optional_address.rb +15 -7
  53. data/lib/candidhealth/organization_providers/v_2/types/license_type.rb +2 -0
  54. data/lib/candidhealth/payers/client.rb +7 -0
  55. data/lib/candidhealth/payers/v_4/client.rb +137 -0
  56. data/lib/candidhealth/payers/v_4/types/clearinghouse_payer_info.rb +127 -0
  57. data/lib/candidhealth/payers/v_4/types/payer.rb +116 -0
  58. data/lib/candidhealth/payers/v_4/types/payer_ids.rb +84 -0
  59. data/lib/candidhealth/payers/v_4/types/payer_page.rb +88 -0
  60. data/lib/candidhealth/payers/v_4/types/primary_payer_ids.rb +84 -0
  61. data/lib/candidhealth/payers/v_4/types/support_state.rb +15 -0
  62. data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +4 -4
  63. data/lib/candidhealth/pre_encounter/coverages/v_1/types/subscriber.rb +3 -3
  64. data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +72 -6
  65. data/lib/candidhealth/pre_encounter/patients/v_1/types/guarantor.rb +3 -3
  66. data/lib/candidhealth/pre_encounter/patients/v_1/types/inferred_patient_metadata.rb +80 -0
  67. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb +19 -5
  68. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb +19 -5
  69. data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb +18 -4
  70. data/lib/candidhealth/pre_encounter/patients/v_1/types/referral_type.rb +1 -0
  71. data/lib/candidhealth/service_lines/v_2/client.rb +252 -10
  72. data/lib/candidhealth/service_lines/v_2/types/service_line.rb +28 -10
  73. data/lib/candidhealth/service_lines/v_2/types/service_line_create.rb +52 -40
  74. data/lib/candidhealth/service_lines/v_2/types/service_line_create_base.rb +251 -0
  75. data/lib/candidhealth/service_lines/v_2/types/service_line_create_base_base.rb +243 -0
  76. data/lib/candidhealth/service_lines/v_2/types/service_line_create_optional.rb +48 -24
  77. data/lib/candidhealth/service_lines/v_2/types/service_line_create_standalone.rb +58 -46
  78. data/lib/candidhealth/service_lines/v_2/types/service_line_create_standalone_base.rb +273 -0
  79. data/lib/candidhealth/service_lines/v_2/types/service_line_create_standalone_base_base.rb +265 -0
  80. data/lib/candidhealth/service_lines/v_2/types/service_line_update.rb +64 -54
  81. data/lib/candidhealth/service_lines/v_2/types/service_line_update_base.rb +263 -0
  82. data/lib/candidhealth/service_lines/v_2/types/universal_service_line_create.rb +271 -0
  83. data/lib/candidhealth/service_lines/v_2/types/universal_service_line_create_standalone.rb +317 -0
  84. data/lib/candidhealth/service_lines/v_2/types/universal_service_line_update.rb +307 -0
  85. data/lib/candidhealth/x_12/v_1/types/type_of_bill_composite.rb +2 -2
  86. data/lib/candidhealth/x_12/v_1/types/type_of_bill_composite_base.rb +90 -0
  87. data/lib/candidhealth/x_12/v_1/types/type_of_bill_composite_update.rb +112 -0
  88. data/lib/requests.rb +2 -2
  89. data/lib/types_export.rb +45 -4
  90. metadata +44 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 641a2130fcb9bef954b62a76d54487929955f1fcb064567a412b515fd8eff879
4
- data.tar.gz: 57509f499ae0e0cdb0a315da79a88e42a7748c827fd84e109982b51a9f1ab811
3
+ metadata.gz: 3c28843adc7ab38e2ec0f9fd831217363148401b29a7ec6f41addb7b5b0f9603
4
+ data.tar.gz: dff2dbb02bffd879177b3c1fe68d4d746ef06f734e7c292ccdc60dbe21600727
5
5
  SHA512:
6
- metadata.gz: e0929c7dab0c8a1d1289345e095981fe331e337c587652cf26ffce2cc9fd4b673a5a767521898098b2161fffd4432da7b2cc2af3f9e2e71fdeb5b39178619ea3
7
- data.tar.gz: 1f2f3cf79efae4a09ea0c87f09a3a18804fd481f139bc31e2144cf7cfb62008a9ea42b655f4e812bba1c743a9662e989b3d6fe36f6e9bfda3126876c9c3bb5d6
6
+ metadata.gz: 3cf256ef89320b522b60249f0f272933dfde82474e8ce8e2e188faf9229b4baba80d0cf43455e53b1535fe5783571dc525b7fdfe83170c381f7c2b3d31d380c5
7
+ data.tar.gz: b9df751ae2d27b1705c9bc65a9c2f3a156aa05ae6389e9b20f2d34c65df73cb46809dc12c3eca5226b5fdbf5fc530ed9093042a74a3d8f580331c6d829beeb01
@@ -85,12 +85,20 @@ module CandidApiClient
85
85
  end
86
86
 
87
87
  # @param org_id [String] Organization ID to generate token for.
88
+ # @param client_id [String] Your application's Client ID.
89
+ # @param client_secret [String] Your application's Client Secret.
90
+ # @param force_token_refresh [Boolean] Refreshes auth token for a given user <> org pair.
88
91
  # @param request_options [CandidApiClient::RequestOptions]
89
92
  # @return [CandidApiClient::Auth::Default::Types::AuthGetTokenResponse]
90
93
  # @example
91
94
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
92
- # api.auth.default.get_machine_token_for_org_id(org_id: "org_id")
93
- def get_machine_token_for_org_id(org_id:, request_options: nil)
95
+ # api.auth.default.get_machine_token_for_org_id(
96
+ # org_id: "org_id",
97
+ # client_id: "client_id",
98
+ # client_secret: "client_secret"
99
+ # )
100
+ def get_machine_token_for_org_id(org_id:, client_id:, client_secret:, force_token_refresh: nil,
101
+ request_options: nil)
94
102
  response = @request_client.conn.post do |req|
95
103
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
96
104
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -99,7 +107,13 @@ module CandidApiClient
99
107
  **@request_client.get_headers,
100
108
  **(request_options&.additional_headers || {})
101
109
  }.compact
102
- req.body = { **(request_options&.additional_body_parameters || {}), org_id: org_id }.compact
110
+ req.body = {
111
+ **(request_options&.additional_body_parameters || {}),
112
+ org_id: org_id,
113
+ client_id: client_id,
114
+ client_secret: client_secret,
115
+ force_token_refresh: force_token_refresh
116
+ }.compact
103
117
  req.url "#{@request_client.get_url(environment: CandidApi,
104
118
  request_options: request_options)}/api/auth/v2/machine-token-for-org-id"
105
119
  end
@@ -187,12 +201,20 @@ module CandidApiClient
187
201
  end
188
202
 
189
203
  # @param org_id [String] Organization ID to generate token for.
204
+ # @param client_id [String] Your application's Client ID.
205
+ # @param client_secret [String] Your application's Client Secret.
206
+ # @param force_token_refresh [Boolean] Refreshes auth token for a given user <> org pair.
190
207
  # @param request_options [CandidApiClient::RequestOptions]
191
208
  # @return [CandidApiClient::Auth::Default::Types::AuthGetTokenResponse]
192
209
  # @example
193
210
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
194
- # api.auth.default.get_machine_token_for_org_id(org_id: "org_id")
195
- def get_machine_token_for_org_id(org_id:, request_options: nil)
211
+ # api.auth.default.get_machine_token_for_org_id(
212
+ # org_id: "org_id",
213
+ # client_id: "client_id",
214
+ # client_secret: "client_secret"
215
+ # )
216
+ def get_machine_token_for_org_id(org_id:, client_id:, client_secret:, force_token_refresh: nil,
217
+ request_options: nil)
196
218
  Async do
197
219
  response = @request_client.conn.post do |req|
198
220
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -202,7 +224,13 @@ module CandidApiClient
202
224
  **@request_client.get_headers,
203
225
  **(request_options&.additional_headers || {})
204
226
  }.compact
205
- req.body = { **(request_options&.additional_body_parameters || {}), org_id: org_id }.compact
227
+ req.body = {
228
+ **(request_options&.additional_body_parameters || {}),
229
+ org_id: org_id,
230
+ client_id: client_id,
231
+ client_secret: client_secret,
232
+ force_token_refresh: force_token_refresh
233
+ }.compact
206
234
  req.url "#{@request_client.get_url(environment: CandidApi,
207
235
  request_options: request_options)}/api/auth/v2/machine-token-for-org-id"
208
236
  end
@@ -9,6 +9,7 @@ require_relative "../../commons/types/sort_direction"
9
9
  require "date"
10
10
  require_relative "../../encounters/v_4/types/billable_status_type"
11
11
  require_relative "../../encounters/v_4/types/responsible_party_type"
12
+ require_relative "../../claims/types/claim_status"
12
13
  require_relative "types/charge_capture_page"
13
14
  require_relative "types/charge_capture_post_billed_change"
14
15
  require "json"
@@ -30,6 +31,14 @@ module CandidApiClient
30
31
  # @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
31
32
  # listed as optional. Candid will use this data when attempting to bundle multiple
32
33
  # Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
34
+ # * :vitals (Hash)
35
+ # * :height_in (Integer)
36
+ # * :weight_lbs (Integer)
37
+ # * :blood_pressure_systolic_mmhg (Integer)
38
+ # * :blood_pressure_diastolic_mmhg (Integer)
39
+ # * :body_temperature_f (Float)
40
+ # * :hemoglobin_gdl (Float)
41
+ # * :hematocrit_pct (Float)
33
42
  # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
34
43
  # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
35
44
  # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
@@ -54,6 +63,7 @@ module CandidApiClient
54
63
  # * :phone_consent (Boolean)
55
64
  # * :email (String)
56
65
  # * :email_consent (Boolean)
66
+ # * :auto_charge_consent (Boolean)
57
67
  # * :subscriber_primary (Hash)
58
68
  # * :insurance_card (Hash)
59
69
  # * :member_id (String)
@@ -161,6 +171,7 @@ module CandidApiClient
161
171
  # * :phone_consent (Boolean)
162
172
  # * :email (String)
163
173
  # * :email_consent (Boolean)
174
+ # * :auto_charge_consent (Boolean)
164
175
  # * :non_insurance_payers (Array<String>)
165
176
  # * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
166
177
  # * :service_facility (Hash)
@@ -269,14 +280,6 @@ module CandidApiClient
269
280
  # * :last_menstrual_period_date (Date)
270
281
  # * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
271
282
  # * :patient_authorized_release (Boolean)
272
- # * :vitals (Hash)
273
- # * :height_in (Integer)
274
- # * :weight_lbs (Integer)
275
- # * :blood_pressure_systolic_mmhg (Integer)
276
- # * :blood_pressure_diastolic_mmhg (Integer)
277
- # * :body_temperature_f (Float)
278
- # * :hemoglobin_gdl (Float)
279
- # * :hematocrit_pct (Float)
280
283
  # * :referral_number (String)
281
284
  # * :secondary_payer_carrier_code (String)
282
285
  # @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
@@ -351,6 +354,14 @@ module CandidApiClient
351
354
  # @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
352
355
  # listed as optional. Candid will use this data when attempting to bundle multiple
353
356
  # Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
357
+ # * :vitals (Hash)
358
+ # * :height_in (Integer)
359
+ # * :weight_lbs (Integer)
360
+ # * :blood_pressure_systolic_mmhg (Integer)
361
+ # * :blood_pressure_diastolic_mmhg (Integer)
362
+ # * :body_temperature_f (Float)
363
+ # * :hemoglobin_gdl (Float)
364
+ # * :hematocrit_pct (Float)
354
365
  # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
355
366
  # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
356
367
  # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
@@ -375,6 +386,7 @@ module CandidApiClient
375
386
  # * :phone_consent (Boolean)
376
387
  # * :email (String)
377
388
  # * :email_consent (Boolean)
389
+ # * :auto_charge_consent (Boolean)
378
390
  # * :subscriber_primary (Hash)
379
391
  # * :insurance_card (Hash)
380
392
  # * :member_id (String)
@@ -482,6 +494,7 @@ module CandidApiClient
482
494
  # * :phone_consent (Boolean)
483
495
  # * :email (String)
484
496
  # * :email_consent (Boolean)
497
+ # * :auto_charge_consent (Boolean)
485
498
  # * :non_insurance_payers (Array<String>)
486
499
  # * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
487
500
  # * :service_facility (Hash)
@@ -590,14 +603,6 @@ module CandidApiClient
590
603
  # * :last_menstrual_period_date (Date)
591
604
  # * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
592
605
  # * :patient_authorized_release (Boolean)
593
- # * :vitals (Hash)
594
- # * :height_in (Integer)
595
- # * :weight_lbs (Integer)
596
- # * :blood_pressure_systolic_mmhg (Integer)
597
- # * :blood_pressure_diastolic_mmhg (Integer)
598
- # * :body_temperature_f (Float)
599
- # * :hemoglobin_gdl (Float)
600
- # * :hematocrit_pct (Float)
601
606
  # * :referral_number (String)
602
607
  # * :secondary_payer_carrier_code (String)
603
608
  # @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
@@ -652,6 +657,14 @@ module CandidApiClient
652
657
 
653
658
  # @param charge_capture_id [String]
654
659
  # @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
660
+ # * :vitals (Hash)
661
+ # * :height_in (Integer)
662
+ # * :weight_lbs (Integer)
663
+ # * :blood_pressure_systolic_mmhg (Integer)
664
+ # * :blood_pressure_diastolic_mmhg (Integer)
665
+ # * :body_temperature_f (Float)
666
+ # * :hemoglobin_gdl (Float)
667
+ # * :hematocrit_pct (Float)
655
668
  # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
656
669
  # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
657
670
  # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
@@ -676,6 +689,7 @@ module CandidApiClient
676
689
  # * :phone_consent (Boolean)
677
690
  # * :email (String)
678
691
  # * :email_consent (Boolean)
692
+ # * :auto_charge_consent (Boolean)
679
693
  # * :subscriber_primary (Hash)
680
694
  # * :insurance_card (Hash)
681
695
  # * :member_id (String)
@@ -783,6 +797,7 @@ module CandidApiClient
783
797
  # * :phone_consent (Boolean)
784
798
  # * :email (String)
785
799
  # * :email_consent (Boolean)
800
+ # * :auto_charge_consent (Boolean)
786
801
  # * :non_insurance_payers (Array<String>)
787
802
  # * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
788
803
  # * :service_facility (Hash)
@@ -891,14 +906,6 @@ module CandidApiClient
891
906
  # * :last_menstrual_period_date (Date)
892
907
  # * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
893
908
  # * :patient_authorized_release (Boolean)
894
- # * :vitals (Hash)
895
- # * :height_in (Integer)
896
- # * :weight_lbs (Integer)
897
- # * :blood_pressure_systolic_mmhg (Integer)
898
- # * :blood_pressure_diastolic_mmhg (Integer)
899
- # * :body_temperature_f (Float)
900
- # * :hemoglobin_gdl (Float)
901
- # * :hematocrit_pct (Float)
902
909
  # * :referral_number (String)
903
910
  # * :secondary_payer_carrier_code (String)
904
911
  # @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
@@ -995,6 +1002,15 @@ module CandidApiClient
995
1002
  # captures with one of the NPIs in this list.
996
1003
  # @param supervising_provider_names [String] A list of supervising provider names to filter by. This will return all charge
997
1004
  # captures with one of the names in this list.
1005
+ # @param claim_creation_category [String] A list of claim creation categories to filter by. This will return all charge
1006
+ # capture claim_creations which include one or more charges with one of the names
1007
+ # in this list.
1008
+ # @param tags [String] A list of tags to filter by. This will return all charge captures with one of
1009
+ # the tags.
1010
+ # @param primary_payer_names [String] A list of primary payer names to filter by. This will return all charge captures
1011
+ # with one of the names.
1012
+ # @param patient_names [String] A list of patient names to filter by. This will return all charge captures with
1013
+ # one of the names.
998
1014
  # @param exclude_charges_linked_to_claims [Boolean] Whether to exclude charge captures which are part of a claim creation.
999
1015
  # @param patient_external_id_ranked_sort [String] The patient ID from the external EMR platform for the patient
1000
1016
  # @param status_ranked_sort [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] The charge capture status to show first
@@ -1031,13 +1047,22 @@ module CandidApiClient
1031
1047
  # captures with one of the NPIs in this list.
1032
1048
  # @param supervising_provider_names_ranked_sort [String] A list of supervising provider names to show first. This will return all charge
1033
1049
  # captures with one of the names in this list.
1050
+ # @param claim_status [CandidApiClient::Claims::Types::ClaimStatus] the status of the claim to filter by created from charge capture bundle.
1051
+ # @param claim_creation_category_ranked_sort [String] A list of claim creation categories to sort by. This will return all charge
1052
+ # capture claim_creations which include one or more charges with one of the names
1053
+ # in this list.
1054
+ # @param tags_ranked_sort [String] A list of tags. This will return all charge captures with one of the tags.
1055
+ # @param primary_payer_names_ranked_sort [String] A list of primary payer names to sort by. This will return all charge captures
1056
+ # with one of the names.
1057
+ # @param patient_names_ranked_sort [String] A list of patient names to sort by. This will return all charge captures with
1058
+ # one of the names.
1034
1059
  # @param request_options [CandidApiClient::RequestOptions]
1035
1060
  # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePage]
1036
1061
  # @example
1037
1062
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1038
1063
  # api.charge_capture.v_1.get_all
1039
1064
  def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil, status: nil,
1040
- charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, search_term: nil, billable_status: nil, responsible_party: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
1065
+ charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, claim_creation_category: nil, tags: nil, primary_payer_names: nil, patient_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, search_term: nil, billable_status: nil, responsible_party: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, claim_status: nil, claim_creation_category_ranked_sort: nil, tags_ranked_sort: nil, primary_payer_names_ranked_sort: nil, patient_names_ranked_sort: nil, request_options: nil)
1041
1066
  response = @request_client.conn.get do |req|
1042
1067
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
1043
1068
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -1066,6 +1091,10 @@ module CandidApiClient
1066
1091
  "rendering_provider_names": rendering_provider_names,
1067
1092
  "supervising_provider_npis": supervising_provider_npis,
1068
1093
  "supervising_provider_names": supervising_provider_names,
1094
+ "claim_creation_category": claim_creation_category,
1095
+ "tags": tags,
1096
+ "primary_payer_names": primary_payer_names,
1097
+ "patient_names": patient_names,
1069
1098
  "exclude_charges_linked_to_claims": exclude_charges_linked_to_claims,
1070
1099
  "patient_external_id_ranked_sort": patient_external_id_ranked_sort,
1071
1100
  "status_ranked_sort": status_ranked_sort,
@@ -1083,7 +1112,12 @@ module CandidApiClient
1083
1112
  "rendering_provider_npis_ranked_sort": rendering_provider_npis_ranked_sort,
1084
1113
  "rendering_provider_names_ranked_sort": rendering_provider_names_ranked_sort,
1085
1114
  "supervising_provider_npis_ranked_sort": supervising_provider_npis_ranked_sort,
1086
- "supervising_provider_names_ranked_sort": supervising_provider_names_ranked_sort
1115
+ "supervising_provider_names_ranked_sort": supervising_provider_names_ranked_sort,
1116
+ "claim_status": claim_status,
1117
+ "claim_creation_category_ranked_sort": claim_creation_category_ranked_sort,
1118
+ "tags_ranked_sort": tags_ranked_sort,
1119
+ "primary_payer_names_ranked_sort": primary_payer_names_ranked_sort,
1120
+ "patient_names_ranked_sort": patient_names_ranked_sort
1087
1121
  }.compact
1088
1122
  req.url "#{@request_client.get_url(environment: CandidApi,
1089
1123
  request_options: request_options)}/api/charge_captures/v1"
@@ -1139,6 +1173,14 @@ module CandidApiClient
1139
1173
  # @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
1140
1174
  # listed as optional. Candid will use this data when attempting to bundle multiple
1141
1175
  # Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
1176
+ # * :vitals (Hash)
1177
+ # * :height_in (Integer)
1178
+ # * :weight_lbs (Integer)
1179
+ # * :blood_pressure_systolic_mmhg (Integer)
1180
+ # * :blood_pressure_diastolic_mmhg (Integer)
1181
+ # * :body_temperature_f (Float)
1182
+ # * :hemoglobin_gdl (Float)
1183
+ # * :hematocrit_pct (Float)
1142
1184
  # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
1143
1185
  # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
1144
1186
  # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
@@ -1163,6 +1205,7 @@ module CandidApiClient
1163
1205
  # * :phone_consent (Boolean)
1164
1206
  # * :email (String)
1165
1207
  # * :email_consent (Boolean)
1208
+ # * :auto_charge_consent (Boolean)
1166
1209
  # * :subscriber_primary (Hash)
1167
1210
  # * :insurance_card (Hash)
1168
1211
  # * :member_id (String)
@@ -1270,6 +1313,7 @@ module CandidApiClient
1270
1313
  # * :phone_consent (Boolean)
1271
1314
  # * :email (String)
1272
1315
  # * :email_consent (Boolean)
1316
+ # * :auto_charge_consent (Boolean)
1273
1317
  # * :non_insurance_payers (Array<String>)
1274
1318
  # * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
1275
1319
  # * :service_facility (Hash)
@@ -1378,14 +1422,6 @@ module CandidApiClient
1378
1422
  # * :last_menstrual_period_date (Date)
1379
1423
  # * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
1380
1424
  # * :patient_authorized_release (Boolean)
1381
- # * :vitals (Hash)
1382
- # * :height_in (Integer)
1383
- # * :weight_lbs (Integer)
1384
- # * :blood_pressure_systolic_mmhg (Integer)
1385
- # * :blood_pressure_diastolic_mmhg (Integer)
1386
- # * :body_temperature_f (Float)
1387
- # * :hemoglobin_gdl (Float)
1388
- # * :hematocrit_pct (Float)
1389
1425
  # * :referral_number (String)
1390
1426
  # * :secondary_payer_carrier_code (String)
1391
1427
  # @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
@@ -1462,6 +1498,14 @@ module CandidApiClient
1462
1498
  # @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
1463
1499
  # listed as optional. Candid will use this data when attempting to bundle multiple
1464
1500
  # Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
1501
+ # * :vitals (Hash)
1502
+ # * :height_in (Integer)
1503
+ # * :weight_lbs (Integer)
1504
+ # * :blood_pressure_systolic_mmhg (Integer)
1505
+ # * :blood_pressure_diastolic_mmhg (Integer)
1506
+ # * :body_temperature_f (Float)
1507
+ # * :hemoglobin_gdl (Float)
1508
+ # * :hematocrit_pct (Float)
1465
1509
  # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
1466
1510
  # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
1467
1511
  # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
@@ -1486,6 +1530,7 @@ module CandidApiClient
1486
1530
  # * :phone_consent (Boolean)
1487
1531
  # * :email (String)
1488
1532
  # * :email_consent (Boolean)
1533
+ # * :auto_charge_consent (Boolean)
1489
1534
  # * :subscriber_primary (Hash)
1490
1535
  # * :insurance_card (Hash)
1491
1536
  # * :member_id (String)
@@ -1593,6 +1638,7 @@ module CandidApiClient
1593
1638
  # * :phone_consent (Boolean)
1594
1639
  # * :email (String)
1595
1640
  # * :email_consent (Boolean)
1641
+ # * :auto_charge_consent (Boolean)
1596
1642
  # * :non_insurance_payers (Array<String>)
1597
1643
  # * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
1598
1644
  # * :service_facility (Hash)
@@ -1701,14 +1747,6 @@ module CandidApiClient
1701
1747
  # * :last_menstrual_period_date (Date)
1702
1748
  # * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
1703
1749
  # * :patient_authorized_release (Boolean)
1704
- # * :vitals (Hash)
1705
- # * :height_in (Integer)
1706
- # * :weight_lbs (Integer)
1707
- # * :blood_pressure_systolic_mmhg (Integer)
1708
- # * :blood_pressure_diastolic_mmhg (Integer)
1709
- # * :body_temperature_f (Float)
1710
- # * :hemoglobin_gdl (Float)
1711
- # * :hematocrit_pct (Float)
1712
1750
  # * :referral_number (String)
1713
1751
  # * :secondary_payer_carrier_code (String)
1714
1752
  # @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
@@ -1765,6 +1803,14 @@ module CandidApiClient
1765
1803
 
1766
1804
  # @param charge_capture_id [String]
1767
1805
  # @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
1806
+ # * :vitals (Hash)
1807
+ # * :height_in (Integer)
1808
+ # * :weight_lbs (Integer)
1809
+ # * :blood_pressure_systolic_mmhg (Integer)
1810
+ # * :blood_pressure_diastolic_mmhg (Integer)
1811
+ # * :body_temperature_f (Float)
1812
+ # * :hemoglobin_gdl (Float)
1813
+ # * :hematocrit_pct (Float)
1768
1814
  # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
1769
1815
  # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
1770
1816
  # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
@@ -1789,6 +1835,7 @@ module CandidApiClient
1789
1835
  # * :phone_consent (Boolean)
1790
1836
  # * :email (String)
1791
1837
  # * :email_consent (Boolean)
1838
+ # * :auto_charge_consent (Boolean)
1792
1839
  # * :subscriber_primary (Hash)
1793
1840
  # * :insurance_card (Hash)
1794
1841
  # * :member_id (String)
@@ -1896,6 +1943,7 @@ module CandidApiClient
1896
1943
  # * :phone_consent (Boolean)
1897
1944
  # * :email (String)
1898
1945
  # * :email_consent (Boolean)
1946
+ # * :auto_charge_consent (Boolean)
1899
1947
  # * :non_insurance_payers (Array<String>)
1900
1948
  # * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
1901
1949
  # * :service_facility (Hash)
@@ -2004,14 +2052,6 @@ module CandidApiClient
2004
2052
  # * :last_menstrual_period_date (Date)
2005
2053
  # * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
2006
2054
  # * :patient_authorized_release (Boolean)
2007
- # * :vitals (Hash)
2008
- # * :height_in (Integer)
2009
- # * :weight_lbs (Integer)
2010
- # * :blood_pressure_systolic_mmhg (Integer)
2011
- # * :blood_pressure_diastolic_mmhg (Integer)
2012
- # * :body_temperature_f (Float)
2013
- # * :hemoglobin_gdl (Float)
2014
- # * :hematocrit_pct (Float)
2015
2055
  # * :referral_number (String)
2016
2056
  # * :secondary_payer_carrier_code (String)
2017
2057
  # @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
@@ -2112,6 +2152,15 @@ module CandidApiClient
2112
2152
  # captures with one of the NPIs in this list.
2113
2153
  # @param supervising_provider_names [String] A list of supervising provider names to filter by. This will return all charge
2114
2154
  # captures with one of the names in this list.
2155
+ # @param claim_creation_category [String] A list of claim creation categories to filter by. This will return all charge
2156
+ # capture claim_creations which include one or more charges with one of the names
2157
+ # in this list.
2158
+ # @param tags [String] A list of tags to filter by. This will return all charge captures with one of
2159
+ # the tags.
2160
+ # @param primary_payer_names [String] A list of primary payer names to filter by. This will return all charge captures
2161
+ # with one of the names.
2162
+ # @param patient_names [String] A list of patient names to filter by. This will return all charge captures with
2163
+ # one of the names.
2115
2164
  # @param exclude_charges_linked_to_claims [Boolean] Whether to exclude charge captures which are part of a claim creation.
2116
2165
  # @param patient_external_id_ranked_sort [String] The patient ID from the external EMR platform for the patient
2117
2166
  # @param status_ranked_sort [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] The charge capture status to show first
@@ -2148,13 +2197,22 @@ module CandidApiClient
2148
2197
  # captures with one of the NPIs in this list.
2149
2198
  # @param supervising_provider_names_ranked_sort [String] A list of supervising provider names to show first. This will return all charge
2150
2199
  # captures with one of the names in this list.
2200
+ # @param claim_status [CandidApiClient::Claims::Types::ClaimStatus] the status of the claim to filter by created from charge capture bundle.
2201
+ # @param claim_creation_category_ranked_sort [String] A list of claim creation categories to sort by. This will return all charge
2202
+ # capture claim_creations which include one or more charges with one of the names
2203
+ # in this list.
2204
+ # @param tags_ranked_sort [String] A list of tags. This will return all charge captures with one of the tags.
2205
+ # @param primary_payer_names_ranked_sort [String] A list of primary payer names to sort by. This will return all charge captures
2206
+ # with one of the names.
2207
+ # @param patient_names_ranked_sort [String] A list of patient names to sort by. This will return all charge captures with
2208
+ # one of the names.
2151
2209
  # @param request_options [CandidApiClient::RequestOptions]
2152
2210
  # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePage]
2153
2211
  # @example
2154
2212
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
2155
2213
  # api.charge_capture.v_1.get_all
2156
2214
  def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil, status: nil,
2157
- charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, search_term: nil, billable_status: nil, responsible_party: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
2215
+ charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, claim_creation_category: nil, tags: nil, primary_payer_names: nil, patient_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, search_term: nil, billable_status: nil, responsible_party: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, claim_status: nil, claim_creation_category_ranked_sort: nil, tags_ranked_sort: nil, primary_payer_names_ranked_sort: nil, patient_names_ranked_sort: nil, request_options: nil)
2158
2216
  Async do
2159
2217
  response = @request_client.conn.get do |req|
2160
2218
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -2184,6 +2242,10 @@ module CandidApiClient
2184
2242
  "rendering_provider_names": rendering_provider_names,
2185
2243
  "supervising_provider_npis": supervising_provider_npis,
2186
2244
  "supervising_provider_names": supervising_provider_names,
2245
+ "claim_creation_category": claim_creation_category,
2246
+ "tags": tags,
2247
+ "primary_payer_names": primary_payer_names,
2248
+ "patient_names": patient_names,
2187
2249
  "exclude_charges_linked_to_claims": exclude_charges_linked_to_claims,
2188
2250
  "patient_external_id_ranked_sort": patient_external_id_ranked_sort,
2189
2251
  "status_ranked_sort": status_ranked_sort,
@@ -2201,7 +2263,12 @@ module CandidApiClient
2201
2263
  "rendering_provider_npis_ranked_sort": rendering_provider_npis_ranked_sort,
2202
2264
  "rendering_provider_names_ranked_sort": rendering_provider_names_ranked_sort,
2203
2265
  "supervising_provider_npis_ranked_sort": supervising_provider_npis_ranked_sort,
2204
- "supervising_provider_names_ranked_sort": supervising_provider_names_ranked_sort
2266
+ "supervising_provider_names_ranked_sort": supervising_provider_names_ranked_sort,
2267
+ "claim_status": claim_status,
2268
+ "claim_creation_category_ranked_sort": claim_creation_category_ranked_sort,
2269
+ "tags_ranked_sort": tags_ranked_sort,
2270
+ "primary_payer_names_ranked_sort": primary_payer_names_ranked_sort,
2271
+ "patient_names_ranked_sort": patient_names_ranked_sort
2205
2272
  }.compact
2206
2273
  req.url "#{@request_client.get_url(environment: CandidApi,
2207
2274
  request_options: request_options)}/api/charge_captures/v1"