candidhealth 1.14.3 → 1.16.0

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 (38) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candid/client.rb +11 -1
  3. data/lib/candid/commons/types/bad_request_error_message.rb +11 -0
  4. data/lib/candid/commons/types/claim_adjustment_group_codes.rb +22 -0
  5. data/lib/candid/commons/types/internal_error_message.rb +11 -0
  6. data/lib/candid/commons/types/procedure_modifier.rb +1 -0
  7. data/lib/candid/events/client.rb +17 -0
  8. data/lib/candid/events/v_1/client.rb +64 -0
  9. data/lib/candid/events/v_1/types/event.rb +18 -0
  10. data/lib/candid/events/v_1/types/event_scan_page.rb +16 -0
  11. data/lib/candid/events/v_1/types/get_event_scan_request.rb +17 -0
  12. data/lib/candid/insurance_adjudications/client.rb +17 -0
  13. data/lib/candid/insurance_adjudications/v_1/client.rb +37 -0
  14. data/lib/candid/insurance_adjudications/v_1/types/claim_adjudication.rb +23 -0
  15. data/lib/candid/insurance_adjudications/v_1/types/insurance_adjudication.rb +21 -0
  16. data/lib/candid/insurance_adjudications/v_1/types/service_line_adjudication.rb +27 -0
  17. data/lib/candid/patient_ar/v_1/client.rb +0 -4
  18. data/lib/candid/patient_payments/v_4/types/card_payment_method.rb +11 -0
  19. data/lib/candid/patient_payments/v_4/types/cash_payment_method.rb +11 -0
  20. data/lib/candid/patient_payments/v_4/types/check_payment_method.rb +13 -0
  21. data/lib/candid/patient_payments/v_4/types/patient_payment.rb +3 -0
  22. data/lib/candid/patient_payments/v_4/types/payment_method.rb +19 -0
  23. data/lib/candid/patient_payments/v_4/types/payment_method_detail.rb +18 -0
  24. data/lib/candid/pre_encounter/eligibility_checks/v_1/types/eligibility_request.rb +2 -0
  25. data/lib/candid/service_lines/v_2/types/service_line.rb +1 -0
  26. data/lib/candid/service_lines/v_2/types/service_line_create_base_base.rb +1 -0
  27. data/lib/candid/service_lines/v_2/types/service_line_create_optional.rb +1 -0
  28. data/lib/candid/service_lines/v_2/types/service_line_create_standalone.rb +1 -0
  29. data/lib/candid/service_lines/v_2/types/service_line_update_base.rb +1 -0
  30. data/lib/candid/service_lines/v_2/types/universal_service_line_create_standalone.rb +1 -0
  31. data/lib/candid/version.rb +1 -1
  32. data/lib/candid/x_12/v_1/types/carc.rb +418 -0
  33. data/lib/candid/x_12/v_1/types/claim_adjustment_reason_code.rb +15 -0
  34. data/lib/candid/x_12/v_1/types/rarc.rb +1201 -0
  35. data/lib/candid/x_12/v_1/types/remittance_advice_remark_code.rb +13 -0
  36. data/lib/candid.rb +22 -0
  37. data/reference.md +182 -4
  38. metadata +23 -1
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Candid
4
+ module X12
5
+ module V1
6
+ module Types
7
+ class RemittanceAdviceRemarkCode < Internal::Types::Model
8
+ field :reason_code, -> { Candid::X12::V1::Types::Rarc }, optional: false, nullable: false
9
+ end
10
+ end
11
+ end
12
+ end
13
+ end
data/lib/candid.rb CHANGED
@@ -381,6 +381,8 @@ require_relative "candid/encounters/v_4/types/schema_instance_validation_error"
381
381
  require_relative "candid/encounters/v_4/types/schema_instance_validation_failure"
382
382
  require_relative "candid/encounters/v_4/types/payer_plan_group_payer_does_not_match_insurance_card_error"
383
383
  require_relative "candid/encounters/v_4/types/encounter_rendering_or_attending_provider_required_error"
384
+ require_relative "candid/events/v_1/types/event"
385
+ require_relative "candid/events/v_1/types/event_scan_page"
384
386
  require_relative "candid/expected_network_status/v_1/types/expected_network_status"
385
387
  require_relative "candid/expected_network_status/v_1/types/expected_network_status_response"
386
388
  require_relative "candid/expected_network_status/v_2/types/line_of_business"
@@ -447,6 +449,14 @@ require_relative "candid/import_invoice/v_1/types/invoice_item_update_type"
447
449
  require_relative "candid/import_invoice/v_1/types/import_invoices_page"
448
450
  require_relative "candid/import_invoice/v_1/types/invoice_item_info_update"
449
451
  require_relative "candid/import_invoice/v_1/types/import_invoice_update_request"
452
+ require_relative "candid/x_12/v_1/types/carc"
453
+ require_relative "candid/commons/types/claim_adjustment_group_codes"
454
+ require_relative "candid/x_12/v_1/types/claim_adjustment_reason_code"
455
+ require_relative "candid/x_12/v_1/types/rarc"
456
+ require_relative "candid/x_12/v_1/types/remittance_advice_remark_code"
457
+ require_relative "candid/insurance_adjudications/v_1/types/service_line_adjudication"
458
+ require_relative "candid/insurance_adjudications/v_1/types/claim_adjudication"
459
+ require_relative "candid/insurance_adjudications/v_1/types/insurance_adjudication"
450
460
  require_relative "candid/financials/types/service_line_allocation_target"
451
461
  require_relative "candid/financials/types/claim_allocation_target"
452
462
  require_relative "candid/financials/types/billing_provider_allocation_target"
@@ -509,6 +519,11 @@ require_relative "candid/patient_ar/v_1/types/patient_ar_status"
509
519
  require_relative "candid/patient_ar/v_1/types/inventory_record"
510
520
  require_relative "candid/patient_ar/v_1/types/list_inventory_paged_response"
511
521
  require_relative "candid/patient_ar/v_1/types/invalid_filters_error_type"
522
+ require_relative "candid/patient_payments/v_4/types/cash_payment_method"
523
+ require_relative "candid/patient_payments/v_4/types/check_payment_method"
524
+ require_relative "candid/patient_payments/v_4/types/card_payment_method"
525
+ require_relative "candid/patient_payments/v_4/types/payment_method"
526
+ require_relative "candid/patient_payments/v_4/types/payment_method_detail"
512
527
  require_relative "candid/financials/types/patient_transaction_source"
513
528
  require_relative "candid/patient_payments/v_4/types/patient_payment"
514
529
  require_relative "candid/patient_payments/v_4/types/patient_payments_page"
@@ -693,6 +708,8 @@ require_relative "candid/commons/types/http_service_unavailable_error_message"
693
708
  require_relative "candid/commons/types/request_validation_error"
694
709
  require_relative "candid/commons/types/updates_disabled_due_to_external_system_integration_error_message"
695
710
  require_relative "candid/commons/types/organization_not_authorized_error_message"
711
+ require_relative "candid/commons/types/bad_request_error_message"
712
+ require_relative "candid/commons/types/internal_error_message"
696
713
  require_relative "candid/diagnoses/types/diagnosis_not_found_error"
697
714
  require_relative "candid/diagnoses/types/service_lines_must_have_at_least_one_diagnosis_error"
698
715
  require_relative "candid/diagnoses/types/disallow_multiple_primary_diagnosis_error"
@@ -753,6 +770,9 @@ require_relative "candid/encounter_supplemental_information/v_1/client"
753
770
  require_relative "candid/encounters/client"
754
771
  require_relative "candid/encounters/v_4/client"
755
772
  require_relative "candid/encounters/v_4/types/get_all_encounters_request"
773
+ require_relative "candid/events/client"
774
+ require_relative "candid/events/v_1/client"
775
+ require_relative "candid/events/v_1/types/get_event_scan_request"
756
776
  require_relative "candid/expected_network_status/client"
757
777
  require_relative "candid/expected_network_status/v_1/client"
758
778
  require_relative "candid/expected_network_status/v_1/types/expected_network_status_request"
@@ -777,6 +797,8 @@ require_relative "candid/health_care_code_information/v_1/client"
777
797
  require_relative "candid/import_invoice/client"
778
798
  require_relative "candid/import_invoice/v_1/client"
779
799
  require_relative "candid/import_invoice/v_1/types/search_imported_invoices_request"
800
+ require_relative "candid/insurance_adjudications/client"
801
+ require_relative "candid/insurance_adjudications/v_1/client"
780
802
  require_relative "candid/insurance_payments/client"
781
803
  require_relative "candid/insurance_payments/v_1/client"
782
804
  require_relative "candid/insurance_payments/v_1/types/get_multi_insurance_payment_request"
data/reference.md CHANGED
@@ -4477,6 +4477,133 @@ client.encounters.v_4.update({});
4477
4477
  </dl>
4478
4478
 
4479
4479
 
4480
+ </dd>
4481
+ </dl>
4482
+ </details>
4483
+
4484
+ ## Events V1
4485
+ <details><summary><code>client.events.v_1.scan() -> Candid::Events::V1::Types::EventScanPage</code></summary>
4486
+ <dl>
4487
+ <dd>
4488
+
4489
+ #### 📝 Description
4490
+
4491
+ <dl>
4492
+ <dd>
4493
+
4494
+ <dl>
4495
+ <dd>
4496
+
4497
+ Scans the last 30 days of events. All results are sorted by created date, descending.
4498
+ </dd>
4499
+ </dl>
4500
+ </dd>
4501
+ </dl>
4502
+
4503
+ #### 🔌 Usage
4504
+
4505
+ <dl>
4506
+ <dd>
4507
+
4508
+ <dl>
4509
+ <dd>
4510
+
4511
+ ```ruby
4512
+ client.events.v_1.scan();
4513
+ ```
4514
+ </dd>
4515
+ </dl>
4516
+ </dd>
4517
+ </dl>
4518
+
4519
+ #### ⚙️ Parameters
4520
+
4521
+ <dl>
4522
+ <dd>
4523
+
4524
+ <dl>
4525
+ <dd>
4526
+
4527
+ **page_token:** `String`
4528
+
4529
+ </dd>
4530
+ </dl>
4531
+
4532
+ <dl>
4533
+ <dd>
4534
+
4535
+ **limit:** `Integer` — Number of events to return. Minimum value is 1, maximum is 100. Defaults to 10.
4536
+
4537
+ </dd>
4538
+ </dl>
4539
+
4540
+ <dl>
4541
+ <dd>
4542
+
4543
+ **event_types:** `String` — Event types to filter on. Defaults to showing all event types.
4544
+
4545
+ </dd>
4546
+ </dl>
4547
+
4548
+ <dl>
4549
+ <dd>
4550
+
4551
+ **created_before:** `String` — Filters for only events created before this time (inclusive).
4552
+
4553
+ </dd>
4554
+ </dl>
4555
+
4556
+ <dl>
4557
+ <dd>
4558
+
4559
+ **created_after:** `String` — Filters for only events created after this time (inclusive).
4560
+
4561
+ </dd>
4562
+ </dl>
4563
+ </dd>
4564
+ </dl>
4565
+
4566
+
4567
+ </dd>
4568
+ </dl>
4569
+ </details>
4570
+
4571
+ <details><summary><code>client.events.v_1.get(event_id) -> Candid::Events::V1::Types::Event</code></summary>
4572
+ <dl>
4573
+ <dd>
4574
+
4575
+ #### 🔌 Usage
4576
+
4577
+ <dl>
4578
+ <dd>
4579
+
4580
+ <dl>
4581
+ <dd>
4582
+
4583
+ ```ruby
4584
+ client.events.v_1.get();
4585
+ ```
4586
+ </dd>
4587
+ </dl>
4588
+ </dd>
4589
+ </dl>
4590
+
4591
+ #### ⚙️ Parameters
4592
+
4593
+ <dl>
4594
+ <dd>
4595
+
4596
+ <dl>
4597
+ <dd>
4598
+
4599
+ **event_id:** `String`
4600
+
4601
+ </dd>
4602
+ </dl>
4603
+ </dd>
4604
+ </dl>
4605
+
4606
+
4480
4607
  </dd>
4481
4608
  </dl>
4482
4609
  </details>
@@ -6354,6 +6481,61 @@ client.import_invoice.v_1.update({});
6354
6481
  </dl>
6355
6482
 
6356
6483
 
6484
+ </dd>
6485
+ </dl>
6486
+ </details>
6487
+
6488
+ ## InsuranceAdjudications V1
6489
+ <details><summary><code>client.insurance_adjudications.v_1.get(insurance_adjudication_id) -> Candid::InsuranceAdjudications::V1::Types::InsuranceAdjudication</code></summary>
6490
+ <dl>
6491
+ <dd>
6492
+
6493
+ #### 📝 Description
6494
+
6495
+ <dl>
6496
+ <dd>
6497
+
6498
+ <dl>
6499
+ <dd>
6500
+
6501
+ Retrieves a previously created insurance adjudication by its `insurance_adjudication_id`.
6502
+ </dd>
6503
+ </dl>
6504
+ </dd>
6505
+ </dl>
6506
+
6507
+ #### 🔌 Usage
6508
+
6509
+ <dl>
6510
+ <dd>
6511
+
6512
+ <dl>
6513
+ <dd>
6514
+
6515
+ ```ruby
6516
+ client.insurance_adjudications.v_1.get();
6517
+ ```
6518
+ </dd>
6519
+ </dl>
6520
+ </dd>
6521
+ </dl>
6522
+
6523
+ #### ⚙️ Parameters
6524
+
6525
+ <dl>
6526
+ <dd>
6527
+
6528
+ <dl>
6529
+ <dd>
6530
+
6531
+ **insurance_adjudication_id:** `String`
6532
+
6533
+ </dd>
6534
+ </dl>
6535
+ </dd>
6536
+ </dl>
6537
+
6538
+
6357
6539
  </dd>
6358
6540
  </dl>
6359
6541
  </details>
@@ -8613,8 +8795,6 @@ client.organization_service_facilities.v_2.delete();
8613
8795
  <dl>
8614
8796
  <dd>
8615
8797
 
8616
- NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
8617
-
8618
8798
  Retrieve a list of inventory records based on the provided filters. Each inventory record provides the latest invoiceable status of the associated claim.
8619
8799
  The response is paginated, and the `page_token` can be used to retrieve subsequent pages. Initial requests should not include `page_token`.
8620
8800
  </dd>
@@ -8686,8 +8866,6 @@ client.patient_ar.v_1.list_inventory();
8686
8866
  <dl>
8687
8867
  <dd>
8688
8868
 
8689
- NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
8690
-
8691
8869
  Provides detailed itemization of invoice data for a specific claim.
8692
8870
  </dd>
8693
8871
  </dl>
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: candidhealth
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.14.3
4
+ version: 1.16.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Candid
@@ -68,7 +68,9 @@ files:
68
68
  - lib/candid/clinical_trials/v_1/types/clinical_trial.rb
69
69
  - lib/candid/clinical_trials/v_1/types/clinical_trial_phase.rb
70
70
  - lib/candid/clinical_trials/v_1/types/mutable_clinical_trial.rb
71
+ - lib/candid/commons/types/bad_request_error_message.rb
71
72
  - lib/candid/commons/types/billing_provider_commercial_license_type.rb
73
+ - lib/candid/commons/types/claim_adjustment_group_codes.rb
72
74
  - lib/candid/commons/types/claim_submission_payer_responsibility_type.rb
73
75
  - lib/candid/commons/types/clearinghouse.rb
74
76
  - lib/candid/commons/types/date_range_optional_end.rb
@@ -81,6 +83,7 @@ files:
81
83
  - lib/candid/commons/types/http_service_unavailable_error_message.rb
82
84
  - lib/candid/commons/types/insurance_type_code.rb
83
85
  - lib/candid/commons/types/intended_submission_medium.rb
86
+ - lib/candid/commons/types/internal_error_message.rb
84
87
  - lib/candid/commons/types/network_type.rb
85
88
  - lib/candid/commons/types/next_responsible_party.rb
86
89
  - lib/candid/commons/types/organization_not_authorized_error_message.rb
@@ -280,6 +283,11 @@ files:
280
283
  - lib/candid/errors/response_error.rb
281
284
  - lib/candid/errors/server_error.rb
282
285
  - lib/candid/errors/timeout_error.rb
286
+ - lib/candid/events/client.rb
287
+ - lib/candid/events/v_1/client.rb
288
+ - lib/candid/events/v_1/types/event.rb
289
+ - lib/candid/events/v_1/types/event_scan_page.rb
290
+ - lib/candid/events/v_1/types/get_event_scan_request.rb
283
291
  - lib/candid/expected_network_status/client.rb
284
292
  - lib/candid/expected_network_status/v_1/client.rb
285
293
  - lib/candid/expected_network_status/v_1/types/expected_network_status.rb
@@ -465,6 +473,11 @@ files:
465
473
  - lib/candid/individual/types/subscriber_base_optional.rb
466
474
  - lib/candid/individual/types/subscriber_create.rb
467
475
  - lib/candid/individual/types/subscriber_create_optional.rb
476
+ - lib/candid/insurance_adjudications/client.rb
477
+ - lib/candid/insurance_adjudications/v_1/client.rb
478
+ - lib/candid/insurance_adjudications/v_1/types/claim_adjudication.rb
479
+ - lib/candid/insurance_adjudications/v_1/types/insurance_adjudication.rb
480
+ - lib/candid/insurance_adjudications/v_1/types/service_line_adjudication.rb
468
481
  - lib/candid/insurance_cards/v_2/types/insurance_card.rb
469
482
  - lib/candid/insurance_cards/v_2/types/insurance_card_base.rb
470
483
  - lib/candid/insurance_cards/v_2/types/insurance_card_create.rb
@@ -605,12 +618,17 @@ files:
605
618
  - lib/candid/patient_payments/v_3/types/patient_payment_source.rb
606
619
  - lib/candid/patient_payments/v_3/types/patient_payment_status.rb
607
620
  - lib/candid/patient_payments/v_4/client.rb
621
+ - lib/candid/patient_payments/v_4/types/card_payment_method.rb
622
+ - lib/candid/patient_payments/v_4/types/cash_payment_method.rb
623
+ - lib/candid/patient_payments/v_4/types/check_payment_method.rb
608
624
  - lib/candid/patient_payments/v_4/types/get_multi_patient_payments_request.rb
609
625
  - lib/candid/patient_payments/v_4/types/patient_payment.rb
610
626
  - lib/candid/patient_payments/v_4/types/patient_payment_create.rb
611
627
  - lib/candid/patient_payments/v_4/types/patient_payment_sort_field.rb
612
628
  - lib/candid/patient_payments/v_4/types/patient_payment_update.rb
613
629
  - lib/candid/patient_payments/v_4/types/patient_payments_page.rb
630
+ - lib/candid/patient_payments/v_4/types/payment_method.rb
631
+ - lib/candid/patient_payments/v_4/types/payment_method_detail.rb
614
632
  - lib/candid/patient_refunds/client.rb
615
633
  - lib/candid/patient_refunds/v_1/client.rb
616
634
  - lib/candid/patient_refunds/v_1/types/get_multi_patient_refunds_request.rb
@@ -883,8 +901,12 @@ files:
883
901
  - lib/candid/write_offs/v_1/types/write_off_create.rb
884
902
  - lib/candid/write_offs/v_1/types/write_off_sort_field.rb
885
903
  - lib/candid/write_offs/v_1/types/write_offs_page.rb
904
+ - lib/candid/x_12/v_1/types/carc.rb
905
+ - lib/candid/x_12/v_1/types/claim_adjustment_reason_code.rb
886
906
  - lib/candid/x_12/v_1/types/patient_discharge_status_code.rb
887
907
  - lib/candid/x_12/v_1/types/point_of_origin_for_admission_or_visit_code.rb
908
+ - lib/candid/x_12/v_1/types/rarc.rb
909
+ - lib/candid/x_12/v_1/types/remittance_advice_remark_code.rb
888
910
  - lib/candid/x_12/v_1/types/type_of_admission_or_visit_code.rb
889
911
  - lib/candid/x_12/v_1/types/type_of_bill_composite.rb
890
912
  - lib/candid/x_12/v_1/types/type_of_bill_composite_base.rb