candidhealth 1.3.1 → 1.5.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 (56) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candidhealth/charge_capture/v_1/client.rb +885 -235
  3. data/lib/candidhealth/claim_submission/v_1/types/claim_submission_record_create.rb +4 -4
  4. data/lib/candidhealth/claim_submission/v_1/types/claim_submission_record_create_optional.rb +4 -4
  5. data/lib/candidhealth/contracts/v_2/client.rb +4 -4
  6. data/lib/candidhealth/diagnoses/types/disallow_multiple_primary_diagnosis_error.rb +80 -0
  7. data/lib/candidhealth/diagnoses/types/service_lines_must_have_at_least_one_diagnosis_error.rb +77 -0
  8. data/lib/candidhealth/encounters/v_4/types/encounter.rb +151 -2
  9. data/lib/candidhealth/encounters/v_4/types/encounter_submission_expectation.rb +23 -0
  10. data/lib/candidhealth/exports/v_3/client.rb +16 -10
  11. data/lib/candidhealth/fee_schedules/v_3/client.rb +82 -0
  12. data/lib/candidhealth/individual/types/subscriber_create.rb +6 -2
  13. data/lib/candidhealth/individual/types/subscriber_create_optional.rb +6 -2
  14. data/lib/candidhealth/non_insurance_payers/v_1/client.rb +95 -6
  15. data/lib/candidhealth/non_insurance_payers/v_1/types/non_insurance_payer_categories_page.rb +83 -0
  16. data/lib/candidhealth/organization_providers/v_3/client.rb +8 -4
  17. data/lib/candidhealth/organization_service_facilities/v_2/client.rb +8 -2
  18. data/lib/candidhealth/pre_encounter/appointments/v_1/client.rb +12 -4
  19. data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb +11 -3
  20. data/lib/candidhealth/pre_encounter/appointments/v_1/types/mutable_appointment.rb +9 -1
  21. data/lib/candidhealth/pre_encounter/appointments/v_1/types/visit.rb +24 -2
  22. data/lib/candidhealth/pre_encounter/common/types/base_model.rb +2 -2
  23. data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +8 -4
  24. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb +6 -4
  25. data/lib/candidhealth/pre_encounter/coverages/v_1/types/mutable_coverage.rb +4 -2
  26. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb +205 -16
  27. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/coordination_of_benefits_recommendation.rb +63 -0
  28. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_recommendation.rb +144 -0
  29. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_recommendation_patient_info.rb +124 -0
  30. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_recommendation_payload.rb +102 -0
  31. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/medicare_advantage_recommendation.rb +70 -0
  32. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/medicare_advantage_recommendation_payload.rb +96 -0
  33. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/payer_search_response.rb +107 -0
  34. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/post_eligibility_recommendation_request.rb +96 -0
  35. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/stedi_payer.rb +144 -0
  36. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/stedi_payer_item.rb +79 -0
  37. data/lib/candidhealth/pre_encounter/images/v_1/types/image.rb +2 -2
  38. data/lib/candidhealth/pre_encounter/lists/v_1/types/patient_list_item.rb +28 -1
  39. data/lib/candidhealth/pre_encounter/notes/v_1/types/note.rb +2 -2
  40. data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +8 -4
  41. data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb +2 -2
  42. data/lib/candidhealth/pre_encounter/tags/v_1/client.rb +8 -0
  43. data/lib/candidhealth/pre_encounter/tags/v_1/types/mutable_tag.rb +22 -3
  44. data/lib/candidhealth/pre_encounter/tags/v_1/types/tag.rb +23 -5
  45. data/lib/candidhealth/service_lines/v_2/types/service_line.rb +9 -1
  46. data/lib/candidhealth/x_12/v_1/types/patient_discharge_status_code.rb +52 -0
  47. data/lib/candidhealth/x_12/v_1/types/point_of_origin_for_admission_or_visit_code.rb +23 -0
  48. data/lib/candidhealth/x_12/v_1/types/type_of_admission_or_visit_code.rb +18 -0
  49. data/lib/candidhealth/x_12/v_1/types/type_of_bill_composite.rb +98 -0
  50. data/lib/candidhealth/x_12/v_1/types/type_of_bill_frequency_code.rb +39 -0
  51. data/lib/candidhealth/x_12/v_1/types/type_of_care_code.rb +21 -0
  52. data/lib/candidhealth/x_12/v_1/types/type_of_facility_code.rb +19 -0
  53. data/lib/requests.rb +2 -2
  54. data/lib/types_export.rb +21 -1
  55. metadata +23 -3
  56. data/lib/candidhealth/claim_submission/v_1/types/claim_frequency_type_code.rb +0 -15
@@ -326,8 +326,31 @@ module CandidApiClient
326
326
  CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
327
327
  end
328
328
 
329
- # @param charge_capture_id [String]
330
- # @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
329
+ # Create a Charge Capture from a pre-encounter patient and appointment. This
330
+ # endpoint is intended to be used by consumers who are managing
331
+ # patients and appointments in the pre-encounter service and is currently under
332
+ # development. Consumers who are not taking advantage
333
+ # of the pre-encounter service should use the standard create endpoint.
334
+ # At encounter creation time, information from the provided patient and
335
+ # appointment objects will be populated
336
+ # where applicable. In particular, the following fields are populated from the
337
+ # patient and appointment objects:
338
+ # - Patient
339
+ # - Referring Provider
340
+ # - Subscriber Primary
341
+ # - Subscriber Secondary
342
+ # - Referral Number
343
+ # - Responsible Party
344
+ # - Guarantor
345
+ # Note that these fields should not be populated in the ChargeCaptureData property
346
+ # of this endpoint, as they will be overwritten at encounter creation time.
347
+ # Utilizing this endpoint opts you into automatic updating of the encounter when
348
+ # the patient or appointment is updated, assuming the
349
+ # encounter has not already been submitted or adjudicated.
350
+ #
351
+ # @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
352
+ # listed as optional. Candid will use this data when attempting to bundle multiple
353
+ # Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
331
354
  # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
332
355
  # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
333
356
  # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
@@ -577,26 +600,32 @@ module CandidApiClient
577
600
  # * :hematocrit_pct (Float)
578
601
  # * :referral_number (String)
579
602
  # * :secondary_payer_carrier_code (String)
580
- # @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
581
- # for example, your internal encounter ID or a Dr. Chrono encounter ID.
582
- # This field should not contain PHI.
583
- # @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
584
- # system (e.g. the EHR visit page).
585
- # Send full URL format for the external link (e.g.
586
- # https://emr_charge_capture_url.com/123).
603
+ # @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
604
+ # internal encounter ID or a Dr. Chrono encounter ID. This field should not
605
+ # contain PHI.
606
+ # @param pre_encounter_patient_id [String]
607
+ # @param pre_encounter_appointment_ids [Array<String>]
587
608
  # @param originating_system [String] An optional string field denoting the originating system of the charge.
588
609
  # @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
589
610
  # creation.
590
- # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
611
+ # @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
612
+ # system (e.g. the EHR visit page). Send full URL format for the external link
613
+ # (e.g. https://emr_charge_capture_url.com/123).
591
614
  # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
592
615
  # @param request_options [CandidApiClient::RequestOptions]
593
616
  # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
594
617
  # @example
595
618
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
596
- # api.charge_capture.v_1.update(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
597
- def update(charge_capture_id:, data: nil, charge_external_id: nil, ehr_source_url: nil,
598
- originating_system: nil, claim_creation_category: nil, patient_external_id: nil, status: nil, request_options: nil)
599
- response = @request_client.conn.patch do |req|
619
+ # api.charge_capture.v_1.create_from_pre_encounter_patient(
620
+ # data: { },
621
+ # charge_external_id: "charge_external_id",
622
+ # pre_encounter_patient_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
623
+ # pre_encounter_appointment_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
624
+ # status: PLANNED
625
+ # )
626
+ def create_from_pre_encounter_patient(data:, charge_external_id:, pre_encounter_patient_id:,
627
+ pre_encounter_appointment_ids:, status:, originating_system: nil, claim_creation_category: nil, ehr_source_url: nil, request_options: nil)
628
+ response = @request_client.conn.post do |req|
600
629
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
601
630
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
602
631
  req.headers = {
@@ -608,213 +637,21 @@ module CandidApiClient
608
637
  **(request_options&.additional_body_parameters || {}),
609
638
  data: data,
610
639
  charge_external_id: charge_external_id,
611
- ehr_source_url: ehr_source_url,
640
+ pre_encounter_patient_id: pre_encounter_patient_id,
641
+ pre_encounter_appointment_ids: pre_encounter_appointment_ids,
612
642
  originating_system: originating_system,
613
643
  claim_creation_category: claim_creation_category,
614
- patient_external_id: patient_external_id,
644
+ ehr_source_url: ehr_source_url,
615
645
  status: status
616
646
  }.compact
617
647
  req.url "#{@request_client.get_url(environment: CandidApi,
618
- request_options: request_options)}/api/charge_captures/v1/#{charge_capture_id}"
648
+ request_options: request_options)}/api/charge_captures/v1/create-from-pre-encounter"
619
649
  end
620
650
  CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
621
651
  end
622
652
 
623
653
  # @param charge_capture_id [String]
624
- # @param request_options [CandidApiClient::RequestOptions]
625
- # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
626
- # @example
627
- # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
628
- # api.charge_capture.v_1.get(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
629
- def get(charge_capture_id:, request_options: nil)
630
- response = @request_client.conn.get do |req|
631
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
632
- req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
633
- req.headers = {
634
- **(req.headers || {}),
635
- **@request_client.get_headers,
636
- **(request_options&.additional_headers || {})
637
- }.compact
638
- req.url "#{@request_client.get_url(environment: CandidApi,
639
- request_options: request_options)}/api/charge_captures/v1/#{charge_capture_id}"
640
- end
641
- CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
642
- end
643
-
644
- # @param limit [Integer] Maximum number of entities per page, defaults to 100.
645
- # @param sort [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureSortField] Defaults to created_at
646
- # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
647
- # @param page_token [String]
648
- # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
649
- # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge captures
650
- # @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
651
- # for example, your internal encounter ID or a Dr. Chrono encounter ID.
652
- # This field should not contain PHI.
653
- # @param date_of_service_min [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
654
- # This date must be the local date in the timezone where the service occurred.
655
- # @param date_of_service_max [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
656
- # This date must be the local date in the timezone where the service occurred.
657
- # @param claim_ids [String] A list of claim IDs to filter by. This will return all charge captures that have
658
- # a resulting claim with one of the IDs in this list.
659
- # @param claim_creation_ids [String] A list of Claim Creation IDs to filter by.
660
- # @param billing_provider_npis [String] A list of billing provider NPIs to filter by. This will return all charge
661
- # captures with one of the NPIs in this list.
662
- # @param service_facility_name [String] A string to filter by. This will return all charge captures with this service
663
- # facility name.
664
- # @param primary_payer_ids [String] A list of primary payer IDs to filter by. This will return all charge captures
665
- # with one of the primary payer IDs in this list.
666
- # @param rendering_provider_npis [String] A list of rendering provider NPIs to filter by. This will return all charge
667
- # captures with one of the NPIs in this list.
668
- # @param rendering_provider_names [String] A list of rendering provider names to filter by. This will return all charge
669
- # captures with one of the names in this list.
670
- # @param supervising_provider_npis [String] A list of supervising provider NPIs to filter by. This will return all charge
671
- # captures with one of the NPIs in this list.
672
- # @param supervising_provider_names [String] A list of supervising provider names to filter by. This will return all charge
673
- # captures with one of the names in this list.
674
- # @param exclude_charges_linked_to_claims [Boolean] Whether to exclude charge captures which are part of a claim creation.
675
- # @param patient_external_id_ranked_sort [String] The patient ID from the external EMR platform for the patient
676
- # @param status_ranked_sort [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] The charge capture status to show first
677
- # @param charge_external_id_ranked_sort [String] A client-specified unique ID to associate with this encounter;
678
- # for example, your internal encounter ID or a Dr. Chrono encounter ID.
679
- # This field should not contain PHI.
680
- # @param date_of_service_min_ranked_sort [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
681
- # This date must be the local date in the timezone where the service occurred.
682
- # @param date_of_service_max_ranked_sort [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
683
- # This date must be the local date in the timezone where the service occurred.
684
- # @param search_term [String] Filter by any of the following fields: charge_id, claim_id, patient external_id,
685
- # patient date of birth, patient first name, patient last name,
686
- # or charge external id.
687
- # @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
688
- # Examples for when this should be set to NOT_BILLABLE include if the Encounter
689
- # has not occurred yet or if there is no intention of ever billing the
690
- # responsible_party.
691
- # @param responsible_party [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim. Use
692
- # SELF_PAY if you intend to bill self pay/cash pay.
693
- # @param claim_ids_ranked_sort [String] A list of claim IDs to show first. This will return all charge captures that
694
- # have a resulting claim with one of the IDs in this list.
695
- # @param claim_creation_ids_ranked_sort [String] A list of Claim Creation IDs to show first.
696
- # @param billing_provider_npis_ranked_sort [String] A list of billing provider NPIs to show first. This will return all charge
697
- # captures with one of the NPIs in this list.
698
- # @param service_facility_name_ranked_sort [String] A string to show first. This will return all charge captures with this service
699
- # facility name.
700
- # @param primary_payer_ids_ranked_sort [String] A list of primary payer IDs to show first. This will return all charge captures
701
- # with one of the primary payer IDs in this list.
702
- # @param rendering_provider_npis_ranked_sort [String] A list of rendering provider NPIs to show first. This will return all charge
703
- # captures with one of the NPIs in this list.
704
- # @param rendering_provider_names_ranked_sort [String] A list of rendering provider names to show first. This will return all charge
705
- # captures with one of the names in this list.
706
- # @param supervising_provider_npis_ranked_sort [String] A list of supervising provider NPIs to show first. This will return all charge
707
- # captures with one of the NPIs in this list.
708
- # @param supervising_provider_names_ranked_sort [String] A list of supervising provider names to show first. This will return all charge
709
- # captures with one of the names in this list.
710
- # @param request_options [CandidApiClient::RequestOptions]
711
- # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePage]
712
- # @example
713
- # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
714
- # api.charge_capture.v_1.get_all
715
- def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil, status: nil,
716
- 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)
717
- response = @request_client.conn.get do |req|
718
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
719
- req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
720
- req.headers = {
721
- **(req.headers || {}),
722
- **@request_client.get_headers,
723
- **(request_options&.additional_headers || {})
724
- }.compact
725
- req.params = {
726
- **(request_options&.additional_query_parameters || {}),
727
- "limit": limit,
728
- "sort": sort,
729
- "sort_direction": sort_direction,
730
- "page_token": page_token,
731
- "patient_external_id": patient_external_id,
732
- "status": status,
733
- "charge_external_id": charge_external_id,
734
- "date_of_service_min": date_of_service_min,
735
- "date_of_service_max": date_of_service_max,
736
- "claim_ids": claim_ids,
737
- "claim_creation_ids": claim_creation_ids,
738
- "billing_provider_npis": billing_provider_npis,
739
- "service_facility_name": service_facility_name,
740
- "primary_payer_ids": primary_payer_ids,
741
- "rendering_provider_npis": rendering_provider_npis,
742
- "rendering_provider_names": rendering_provider_names,
743
- "supervising_provider_npis": supervising_provider_npis,
744
- "supervising_provider_names": supervising_provider_names,
745
- "exclude_charges_linked_to_claims": exclude_charges_linked_to_claims,
746
- "patient_external_id_ranked_sort": patient_external_id_ranked_sort,
747
- "status_ranked_sort": status_ranked_sort,
748
- "charge_external_id_ranked_sort": charge_external_id_ranked_sort,
749
- "date_of_service_min_ranked_sort": date_of_service_min_ranked_sort,
750
- "date_of_service_max_ranked_sort": date_of_service_max_ranked_sort,
751
- "search_term": search_term,
752
- "billable_status": billable_status,
753
- "responsible_party": responsible_party,
754
- "claim_ids_ranked_sort": claim_ids_ranked_sort,
755
- "claim_creation_ids_ranked_sort": claim_creation_ids_ranked_sort,
756
- "billing_provider_npis_ranked_sort": billing_provider_npis_ranked_sort,
757
- "service_facility_name_ranked_sort": service_facility_name_ranked_sort,
758
- "primary_payer_ids_ranked_sort": primary_payer_ids_ranked_sort,
759
- "rendering_provider_npis_ranked_sort": rendering_provider_npis_ranked_sort,
760
- "rendering_provider_names_ranked_sort": rendering_provider_names_ranked_sort,
761
- "supervising_provider_npis_ranked_sort": supervising_provider_npis_ranked_sort,
762
- "supervising_provider_names_ranked_sort": supervising_provider_names_ranked_sort
763
- }.compact
764
- req.url "#{@request_client.get_url(environment: CandidApi,
765
- request_options: request_options)}/api/charge_captures/v1"
766
- end
767
- CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePage.from_json(json_object: response.body)
768
- end
769
-
770
- # @param charge_capture_change_ids [Array<String>] A list of UUIDs corresponding to ChargeCapturePostBilledChanges.
771
- # All of the charges sent will be marked as resolved
772
- # @param resolved [Boolean] Whether the change has been resolved. If true, the change will be marked as
773
- # resolved.
774
- # If false, the change will be marked as unresolved.
775
- # @param request_options [CandidApiClient::RequestOptions]
776
- # @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePostBilledChange>]
777
- # @example
778
- # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
779
- # api.charge_capture.v_1.update_post_billed_changes(charge_capture_change_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], resolved: true)
780
- def update_post_billed_changes(charge_capture_change_ids:, resolved:, request_options: nil)
781
- response = @request_client.conn.patch do |req|
782
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
783
- req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
784
- req.headers = {
785
- **(req.headers || {}),
786
- **@request_client.get_headers,
787
- **(request_options&.additional_headers || {})
788
- }.compact
789
- req.body = {
790
- **(request_options&.additional_body_parameters || {}),
791
- charge_capture_change_ids: charge_capture_change_ids,
792
- resolved: resolved
793
- }.compact
794
- req.url "#{@request_client.get_url(environment: CandidApi,
795
- request_options: request_options)}/api/charge_captures/v1/changes"
796
- end
797
- parsed_json = JSON.parse(response.body)
798
- parsed_json&.map do |item|
799
- item = item.to_json
800
- CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePostBilledChange.from_json(json_object: item)
801
- end
802
- end
803
- end
804
-
805
- class AsyncV1Client
806
- # @return [CandidApiClient::AsyncRequestClient]
807
- attr_reader :request_client
808
-
809
- # @param request_client [CandidApiClient::AsyncRequestClient]
810
- # @return [CandidApiClient::ChargeCapture::V1::AsyncV1Client]
811
- def initialize(request_client:)
812
- @request_client = request_client
813
- end
814
-
815
- # @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
816
- # listed as optional. Candid will use this data when attempting to bundle multiple
817
- # Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
654
+ # @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
818
655
  # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
819
656
  # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
820
657
  # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
@@ -1064,50 +901,863 @@ module CandidApiClient
1064
901
  # * :hematocrit_pct (Float)
1065
902
  # * :referral_number (String)
1066
903
  # * :secondary_payer_carrier_code (String)
1067
- # @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
1068
- # internal encounter ID or a Dr. Chrono encounter ID. This field should not
1069
- # contain PHI.
904
+ # @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
905
+ # for example, your internal encounter ID or a Dr. Chrono encounter ID.
906
+ # This field should not contain PHI.
907
+ # @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
908
+ # system (e.g. the EHR visit page).
909
+ # Send full URL format for the external link (e.g.
910
+ # https://emr_charge_capture_url.com/123).
1070
911
  # @param originating_system [String] An optional string field denoting the originating system of the charge.
1071
912
  # @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
1072
913
  # creation.
1073
- # @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
1074
- # system (e.g. the EHR visit page). Send full URL format for the external link
1075
- # (e.g. https://emr_charge_capture_url.com/123).
1076
914
  # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
1077
915
  # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
1078
916
  # @param request_options [CandidApiClient::RequestOptions]
1079
917
  # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
1080
918
  # @example
1081
919
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1082
- # api.charge_capture.v_1.create(
1083
- # data: { },
1084
- # charge_external_id: "charge_external_id",
1085
- # patient_external_id: "patient_external_id",
1086
- # status: PLANNED
1087
- # )
1088
- def create(data:, charge_external_id:, patient_external_id:, status:, originating_system: nil, claim_creation_category: nil,
1089
- ehr_source_url: nil, request_options: nil)
1090
- Async do
1091
- response = @request_client.conn.post do |req|
1092
- req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
1093
- req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
1094
- req.headers = {
1095
- **(req.headers || {}),
1096
- **@request_client.get_headers,
1097
- **(request_options&.additional_headers || {})
920
+ # api.charge_capture.v_1.update(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
921
+ def update(charge_capture_id:, data: nil, charge_external_id: nil, ehr_source_url: nil,
922
+ originating_system: nil, claim_creation_category: nil, patient_external_id: nil, status: nil, request_options: nil)
923
+ response = @request_client.conn.patch do |req|
924
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
925
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
926
+ req.headers = {
927
+ **(req.headers || {}),
928
+ **@request_client.get_headers,
929
+ **(request_options&.additional_headers || {})
930
+ }.compact
931
+ req.body = {
932
+ **(request_options&.additional_body_parameters || {}),
933
+ data: data,
934
+ charge_external_id: charge_external_id,
935
+ ehr_source_url: ehr_source_url,
936
+ originating_system: originating_system,
937
+ claim_creation_category: claim_creation_category,
938
+ patient_external_id: patient_external_id,
939
+ status: status
940
+ }.compact
941
+ req.url "#{@request_client.get_url(environment: CandidApi,
942
+ request_options: request_options)}/api/charge_captures/v1/#{charge_capture_id}"
943
+ end
944
+ CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
945
+ end
946
+
947
+ # @param charge_capture_id [String]
948
+ # @param request_options [CandidApiClient::RequestOptions]
949
+ # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
950
+ # @example
951
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
952
+ # api.charge_capture.v_1.get(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
953
+ def get(charge_capture_id:, request_options: nil)
954
+ response = @request_client.conn.get do |req|
955
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
956
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
957
+ req.headers = {
958
+ **(req.headers || {}),
959
+ **@request_client.get_headers,
960
+ **(request_options&.additional_headers || {})
961
+ }.compact
962
+ req.url "#{@request_client.get_url(environment: CandidApi,
963
+ request_options: request_options)}/api/charge_captures/v1/#{charge_capture_id}"
964
+ end
965
+ CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
966
+ end
967
+
968
+ # @param limit [Integer] Maximum number of entities per page, defaults to 100.
969
+ # @param sort [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureSortField] Defaults to created_at
970
+ # @param sort_direction [CandidApiClient::Commons::Types::SortDirection] Sort direction. Defaults to descending order if not provided.
971
+ # @param page_token [String]
972
+ # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
973
+ # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge captures
974
+ # @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
975
+ # for example, your internal encounter ID or a Dr. Chrono encounter ID.
976
+ # This field should not contain PHI.
977
+ # @param date_of_service_min [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
978
+ # This date must be the local date in the timezone where the service occurred.
979
+ # @param date_of_service_max [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
980
+ # This date must be the local date in the timezone where the service occurred.
981
+ # @param claim_ids [String] A list of claim IDs to filter by. This will return all charge captures that have
982
+ # a resulting claim with one of the IDs in this list.
983
+ # @param claim_creation_ids [String] A list of Claim Creation IDs to filter by.
984
+ # @param billing_provider_npis [String] A list of billing provider NPIs to filter by. This will return all charge
985
+ # captures with one of the NPIs in this list.
986
+ # @param service_facility_name [String] A string to filter by. This will return all charge captures with this service
987
+ # facility name.
988
+ # @param primary_payer_ids [String] A list of primary payer IDs to filter by. This will return all charge captures
989
+ # with one of the primary payer IDs in this list.
990
+ # @param rendering_provider_npis [String] A list of rendering provider NPIs to filter by. This will return all charge
991
+ # captures with one of the NPIs in this list.
992
+ # @param rendering_provider_names [String] A list of rendering provider names to filter by. This will return all charge
993
+ # captures with one of the names in this list.
994
+ # @param supervising_provider_npis [String] A list of supervising provider NPIs to filter by. This will return all charge
995
+ # captures with one of the NPIs in this list.
996
+ # @param supervising_provider_names [String] A list of supervising provider names to filter by. This will return all charge
997
+ # captures with one of the names in this list.
998
+ # @param exclude_charges_linked_to_claims [Boolean] Whether to exclude charge captures which are part of a claim creation.
999
+ # @param patient_external_id_ranked_sort [String] The patient ID from the external EMR platform for the patient
1000
+ # @param status_ranked_sort [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] The charge capture status to show first
1001
+ # @param charge_external_id_ranked_sort [String] A client-specified unique ID to associate with this encounter;
1002
+ # for example, your internal encounter ID or a Dr. Chrono encounter ID.
1003
+ # This field should not contain PHI.
1004
+ # @param date_of_service_min_ranked_sort [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
1005
+ # This date must be the local date in the timezone where the service occurred.
1006
+ # @param date_of_service_max_ranked_sort [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
1007
+ # This date must be the local date in the timezone where the service occurred.
1008
+ # @param search_term [String] Filter by any of the following fields: charge_id, claim_id, patient external_id,
1009
+ # patient date of birth, patient first name, patient last name,
1010
+ # or charge external id.
1011
+ # @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
1012
+ # Examples for when this should be set to NOT_BILLABLE include if the Encounter
1013
+ # has not occurred yet or if there is no intention of ever billing the
1014
+ # responsible_party.
1015
+ # @param responsible_party [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim. Use
1016
+ # SELF_PAY if you intend to bill self pay/cash pay.
1017
+ # @param claim_ids_ranked_sort [String] A list of claim IDs to show first. This will return all charge captures that
1018
+ # have a resulting claim with one of the IDs in this list.
1019
+ # @param claim_creation_ids_ranked_sort [String] A list of Claim Creation IDs to show first.
1020
+ # @param billing_provider_npis_ranked_sort [String] A list of billing provider NPIs to show first. This will return all charge
1021
+ # captures with one of the NPIs in this list.
1022
+ # @param service_facility_name_ranked_sort [String] A string to show first. This will return all charge captures with this service
1023
+ # facility name.
1024
+ # @param primary_payer_ids_ranked_sort [String] A list of primary payer IDs to show first. This will return all charge captures
1025
+ # with one of the primary payer IDs in this list.
1026
+ # @param rendering_provider_npis_ranked_sort [String] A list of rendering provider NPIs to show first. This will return all charge
1027
+ # captures with one of the NPIs in this list.
1028
+ # @param rendering_provider_names_ranked_sort [String] A list of rendering provider names to show first. This will return all charge
1029
+ # captures with one of the names in this list.
1030
+ # @param supervising_provider_npis_ranked_sort [String] A list of supervising provider NPIs to show first. This will return all charge
1031
+ # captures with one of the NPIs in this list.
1032
+ # @param supervising_provider_names_ranked_sort [String] A list of supervising provider names to show first. This will return all charge
1033
+ # captures with one of the names in this list.
1034
+ # @param request_options [CandidApiClient::RequestOptions]
1035
+ # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePage]
1036
+ # @example
1037
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1038
+ # api.charge_capture.v_1.get_all
1039
+ 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)
1041
+ response = @request_client.conn.get do |req|
1042
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
1043
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
1044
+ req.headers = {
1045
+ **(req.headers || {}),
1046
+ **@request_client.get_headers,
1047
+ **(request_options&.additional_headers || {})
1048
+ }.compact
1049
+ req.params = {
1050
+ **(request_options&.additional_query_parameters || {}),
1051
+ "limit": limit,
1052
+ "sort": sort,
1053
+ "sort_direction": sort_direction,
1054
+ "page_token": page_token,
1055
+ "patient_external_id": patient_external_id,
1056
+ "status": status,
1057
+ "charge_external_id": charge_external_id,
1058
+ "date_of_service_min": date_of_service_min,
1059
+ "date_of_service_max": date_of_service_max,
1060
+ "claim_ids": claim_ids,
1061
+ "claim_creation_ids": claim_creation_ids,
1062
+ "billing_provider_npis": billing_provider_npis,
1063
+ "service_facility_name": service_facility_name,
1064
+ "primary_payer_ids": primary_payer_ids,
1065
+ "rendering_provider_npis": rendering_provider_npis,
1066
+ "rendering_provider_names": rendering_provider_names,
1067
+ "supervising_provider_npis": supervising_provider_npis,
1068
+ "supervising_provider_names": supervising_provider_names,
1069
+ "exclude_charges_linked_to_claims": exclude_charges_linked_to_claims,
1070
+ "patient_external_id_ranked_sort": patient_external_id_ranked_sort,
1071
+ "status_ranked_sort": status_ranked_sort,
1072
+ "charge_external_id_ranked_sort": charge_external_id_ranked_sort,
1073
+ "date_of_service_min_ranked_sort": date_of_service_min_ranked_sort,
1074
+ "date_of_service_max_ranked_sort": date_of_service_max_ranked_sort,
1075
+ "search_term": search_term,
1076
+ "billable_status": billable_status,
1077
+ "responsible_party": responsible_party,
1078
+ "claim_ids_ranked_sort": claim_ids_ranked_sort,
1079
+ "claim_creation_ids_ranked_sort": claim_creation_ids_ranked_sort,
1080
+ "billing_provider_npis_ranked_sort": billing_provider_npis_ranked_sort,
1081
+ "service_facility_name_ranked_sort": service_facility_name_ranked_sort,
1082
+ "primary_payer_ids_ranked_sort": primary_payer_ids_ranked_sort,
1083
+ "rendering_provider_npis_ranked_sort": rendering_provider_npis_ranked_sort,
1084
+ "rendering_provider_names_ranked_sort": rendering_provider_names_ranked_sort,
1085
+ "supervising_provider_npis_ranked_sort": supervising_provider_npis_ranked_sort,
1086
+ "supervising_provider_names_ranked_sort": supervising_provider_names_ranked_sort
1087
+ }.compact
1088
+ req.url "#{@request_client.get_url(environment: CandidApi,
1089
+ request_options: request_options)}/api/charge_captures/v1"
1090
+ end
1091
+ CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePage.from_json(json_object: response.body)
1092
+ end
1093
+
1094
+ # @param charge_capture_change_ids [Array<String>] A list of UUIDs corresponding to ChargeCapturePostBilledChanges.
1095
+ # All of the charges sent will be marked as resolved
1096
+ # @param resolved [Boolean] Whether the change has been resolved. If true, the change will be marked as
1097
+ # resolved.
1098
+ # If false, the change will be marked as unresolved.
1099
+ # @param request_options [CandidApiClient::RequestOptions]
1100
+ # @return [Array<CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePostBilledChange>]
1101
+ # @example
1102
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1103
+ # api.charge_capture.v_1.update_post_billed_changes(charge_capture_change_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], resolved: true)
1104
+ def update_post_billed_changes(charge_capture_change_ids:, resolved:, request_options: nil)
1105
+ response = @request_client.conn.patch do |req|
1106
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
1107
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
1108
+ req.headers = {
1109
+ **(req.headers || {}),
1110
+ **@request_client.get_headers,
1111
+ **(request_options&.additional_headers || {})
1112
+ }.compact
1113
+ req.body = {
1114
+ **(request_options&.additional_body_parameters || {}),
1115
+ charge_capture_change_ids: charge_capture_change_ids,
1116
+ resolved: resolved
1117
+ }.compact
1118
+ req.url "#{@request_client.get_url(environment: CandidApi,
1119
+ request_options: request_options)}/api/charge_captures/v1/changes"
1120
+ end
1121
+ parsed_json = JSON.parse(response.body)
1122
+ parsed_json&.map do |item|
1123
+ item = item.to_json
1124
+ CandidApiClient::ChargeCapture::V1::Types::ChargeCapturePostBilledChange.from_json(json_object: item)
1125
+ end
1126
+ end
1127
+ end
1128
+
1129
+ class AsyncV1Client
1130
+ # @return [CandidApiClient::AsyncRequestClient]
1131
+ attr_reader :request_client
1132
+
1133
+ # @param request_client [CandidApiClient::AsyncRequestClient]
1134
+ # @return [CandidApiClient::ChargeCapture::V1::AsyncV1Client]
1135
+ def initialize(request_client:)
1136
+ @request_client = request_client
1137
+ end
1138
+
1139
+ # @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
1140
+ # listed as optional. Candid will use this data when attempting to bundle multiple
1141
+ # Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
1142
+ # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
1143
+ # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
1144
+ # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
1145
+ # * :epsdt_referral (Hash)
1146
+ # * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
1147
+ # * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
1148
+ # * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
1149
+ # * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
1150
+ # * :guarantor (Hash)
1151
+ # * :first_name (String)
1152
+ # * :last_name (String)
1153
+ # * :external_id (String)
1154
+ # * :date_of_birth (Date)
1155
+ # * :address (Hash)
1156
+ # * :zip_plus_four_code (String)
1157
+ # * :address_1 (String)
1158
+ # * :address_2 (String)
1159
+ # * :city (String)
1160
+ # * :state (CandidApiClient::Commons::Types::State)
1161
+ # * :zip_code (String)
1162
+ # * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
1163
+ # * :phone_consent (Boolean)
1164
+ # * :email (String)
1165
+ # * :email_consent (Boolean)
1166
+ # * :subscriber_primary (Hash)
1167
+ # * :insurance_card (Hash)
1168
+ # * :member_id (String)
1169
+ # * :payer_name (String)
1170
+ # * :payer_id (String)
1171
+ # * :rx_bin (String)
1172
+ # * :rx_pcn (String)
1173
+ # * :image_url_front (String)
1174
+ # * :image_url_back (String)
1175
+ # * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
1176
+ # * :group_number (String)
1177
+ # * :plan_name (String)
1178
+ # * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
1179
+ # * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
1180
+ # * :payer_plan_group_id (String)
1181
+ # * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
1182
+ # * :date_of_birth (Date)
1183
+ # * :address (Hash)
1184
+ # * :zip_plus_four_code (String)
1185
+ # * :address_1 (String)
1186
+ # * :address_2 (String)
1187
+ # * :city (String)
1188
+ # * :state (CandidApiClient::Commons::Types::State)
1189
+ # * :zip_code (String)
1190
+ # * :first_name (String)
1191
+ # * :last_name (String)
1192
+ # * :gender (CandidApiClient::Individual::Types::Gender)
1193
+ # * :subscriber_secondary (Hash)
1194
+ # * :insurance_card (Hash)
1195
+ # * :member_id (String)
1196
+ # * :payer_name (String)
1197
+ # * :payer_id (String)
1198
+ # * :rx_bin (String)
1199
+ # * :rx_pcn (String)
1200
+ # * :image_url_front (String)
1201
+ # * :image_url_back (String)
1202
+ # * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
1203
+ # * :group_number (String)
1204
+ # * :plan_name (String)
1205
+ # * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
1206
+ # * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
1207
+ # * :payer_plan_group_id (String)
1208
+ # * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
1209
+ # * :date_of_birth (Date)
1210
+ # * :address (Hash)
1211
+ # * :zip_plus_four_code (String)
1212
+ # * :address_1 (String)
1213
+ # * :address_2 (String)
1214
+ # * :city (String)
1215
+ # * :state (CandidApiClient::Commons::Types::State)
1216
+ # * :zip_code (String)
1217
+ # * :first_name (String)
1218
+ # * :last_name (String)
1219
+ # * :gender (CandidApiClient::Individual::Types::Gender)
1220
+ # * :subscriber_tertiary (Hash)
1221
+ # * :insurance_card (Hash)
1222
+ # * :member_id (String)
1223
+ # * :payer_name (String)
1224
+ # * :payer_id (String)
1225
+ # * :rx_bin (String)
1226
+ # * :rx_pcn (String)
1227
+ # * :image_url_front (String)
1228
+ # * :image_url_back (String)
1229
+ # * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
1230
+ # * :group_number (String)
1231
+ # * :plan_name (String)
1232
+ # * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
1233
+ # * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
1234
+ # * :payer_plan_group_id (String)
1235
+ # * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
1236
+ # * :date_of_birth (Date)
1237
+ # * :address (Hash)
1238
+ # * :zip_plus_four_code (String)
1239
+ # * :address_1 (String)
1240
+ # * :address_2 (String)
1241
+ # * :city (String)
1242
+ # * :state (CandidApiClient::Commons::Types::State)
1243
+ # * :zip_code (String)
1244
+ # * :first_name (String)
1245
+ # * :last_name (String)
1246
+ # * :gender (CandidApiClient::Individual::Types::Gender)
1247
+ # * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
1248
+ # * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
1249
+ # * :external_claim_submission (Hash)
1250
+ # * :claim_created_at (DateTime)
1251
+ # * :patient_control_number (String)
1252
+ # * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
1253
+ # * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
1254
+ # * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
1255
+ # * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
1256
+ # * :patient (Hash)
1257
+ # * :first_name (String)
1258
+ # * :last_name (String)
1259
+ # * :gender (CandidApiClient::Individual::Types::Gender)
1260
+ # * :external_id (String)
1261
+ # * :date_of_birth (Date)
1262
+ # * :address (Hash)
1263
+ # * :zip_plus_four_code (String)
1264
+ # * :address_1 (String)
1265
+ # * :address_2 (String)
1266
+ # * :city (String)
1267
+ # * :state (CandidApiClient::Commons::Types::State)
1268
+ # * :zip_code (String)
1269
+ # * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
1270
+ # * :phone_consent (Boolean)
1271
+ # * :email (String)
1272
+ # * :email_consent (Boolean)
1273
+ # * :non_insurance_payers (Array<String>)
1274
+ # * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
1275
+ # * :service_facility (Hash)
1276
+ # * :organization_name (String)
1277
+ # * :npi (String)
1278
+ # * :address (Hash)
1279
+ # * :zip_plus_four_code (String)
1280
+ # * :address_1 (String)
1281
+ # * :address_2 (String)
1282
+ # * :city (String)
1283
+ # * :state (CandidApiClient::Commons::Types::State)
1284
+ # * :zip_code (String)
1285
+ # * :secondary_identification (String)
1286
+ # * :rendering_provider (Hash)
1287
+ # * :npi (String)
1288
+ # * :taxonomy_code (String)
1289
+ # * :address (Hash)
1290
+ # * :zip_plus_four_code (String)
1291
+ # * :address_1 (String)
1292
+ # * :address_2 (String)
1293
+ # * :city (String)
1294
+ # * :state (CandidApiClient::Commons::Types::State)
1295
+ # * :zip_code (String)
1296
+ # * :first_name (String)
1297
+ # * :last_name (String)
1298
+ # * :organization_name (String)
1299
+ # * :initial_referring_provider (Hash)
1300
+ # * :npi (String)
1301
+ # * :taxonomy_code (String)
1302
+ # * :address (Hash)
1303
+ # * :zip_plus_four_code (String)
1304
+ # * :address_1 (String)
1305
+ # * :address_2 (String)
1306
+ # * :city (String)
1307
+ # * :state (CandidApiClient::Commons::Types::State)
1308
+ # * :zip_code (String)
1309
+ # * :qualifier (CandidApiClient::Commons::Types::QualifierCode)
1310
+ # * :first_name (String)
1311
+ # * :last_name (String)
1312
+ # * :organization_name (String)
1313
+ # * :referring_provider (Hash)
1314
+ # * :npi (String)
1315
+ # * :taxonomy_code (String)
1316
+ # * :address (Hash)
1317
+ # * :zip_plus_four_code (String)
1318
+ # * :address_1 (String)
1319
+ # * :address_2 (String)
1320
+ # * :city (String)
1321
+ # * :state (CandidApiClient::Commons::Types::State)
1322
+ # * :zip_code (String)
1323
+ # * :first_name (String)
1324
+ # * :last_name (String)
1325
+ # * :organization_name (String)
1326
+ # * :supervising_provider (Hash)
1327
+ # * :npi (String)
1328
+ # * :taxonomy_code (String)
1329
+ # * :address (Hash)
1330
+ # * :zip_plus_four_code (String)
1331
+ # * :address_1 (String)
1332
+ # * :address_2 (String)
1333
+ # * :city (String)
1334
+ # * :state (CandidApiClient::Commons::Types::State)
1335
+ # * :zip_code (String)
1336
+ # * :first_name (String)
1337
+ # * :last_name (String)
1338
+ # * :organization_name (String)
1339
+ # * :billing_provider (Hash)
1340
+ # * :address (Hash)
1341
+ # * :zip_plus_four_code (String)
1342
+ # * :address_1 (String)
1343
+ # * :address_2 (String)
1344
+ # * :city (String)
1345
+ # * :state (CandidApiClient::Commons::Types::State)
1346
+ # * :zip_code (String)
1347
+ # * :tax_id (String)
1348
+ # * :npi (String)
1349
+ # * :taxonomy_code (String)
1350
+ # * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
1351
+ # * :first_name (String)
1352
+ # * :last_name (String)
1353
+ # * :organization_name (String)
1354
+ # * :pay_to_address (Hash)
1355
+ # * :zip_plus_four_code (String)
1356
+ # * :address_1 (String)
1357
+ # * :address_2 (String)
1358
+ # * :city (String)
1359
+ # * :state (CandidApiClient::Commons::Types::State)
1360
+ # * :zip_code (String)
1361
+ # * :benefits_assigned_to_provider (Boolean)
1362
+ # * :prior_authorization_number (String)
1363
+ # * :external_id (String)
1364
+ # * :date_of_service (Date)
1365
+ # * :tag_ids (Array<String>)
1366
+ # * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
1367
+ # * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
1368
+ # * :provider_accepts_assignment (Boolean)
1369
+ # * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
1370
+ # * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
1371
+ # * :appointment_type (String)
1372
+ # * :end_date_of_service (Date)
1373
+ # * :additional_information (String)
1374
+ # * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
1375
+ # * :admission_date (Date)
1376
+ # * :discharge_date (Date)
1377
+ # * :onset_of_current_illness_or_symptom_date (Date)
1378
+ # * :last_menstrual_period_date (Date)
1379
+ # * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
1380
+ # * :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
+ # * :referral_number (String)
1390
+ # * :secondary_payer_carrier_code (String)
1391
+ # @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
1392
+ # internal encounter ID or a Dr. Chrono encounter ID. This field should not
1393
+ # contain PHI.
1394
+ # @param originating_system [String] An optional string field denoting the originating system of the charge.
1395
+ # @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
1396
+ # creation.
1397
+ # @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
1398
+ # system (e.g. the EHR visit page). Send full URL format for the external link
1399
+ # (e.g. https://emr_charge_capture_url.com/123).
1400
+ # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
1401
+ # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
1402
+ # @param request_options [CandidApiClient::RequestOptions]
1403
+ # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
1404
+ # @example
1405
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1406
+ # api.charge_capture.v_1.create(
1407
+ # data: { },
1408
+ # charge_external_id: "charge_external_id",
1409
+ # patient_external_id: "patient_external_id",
1410
+ # status: PLANNED
1411
+ # )
1412
+ def create(data:, charge_external_id:, patient_external_id:, status:, originating_system: nil, claim_creation_category: nil,
1413
+ ehr_source_url: nil, request_options: nil)
1414
+ Async do
1415
+ response = @request_client.conn.post do |req|
1416
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
1417
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
1418
+ req.headers = {
1419
+ **(req.headers || {}),
1420
+ **@request_client.get_headers,
1421
+ **(request_options&.additional_headers || {})
1422
+ }.compact
1423
+ req.body = {
1424
+ **(request_options&.additional_body_parameters || {}),
1425
+ data: data,
1426
+ charge_external_id: charge_external_id,
1427
+ originating_system: originating_system,
1428
+ claim_creation_category: claim_creation_category,
1429
+ ehr_source_url: ehr_source_url,
1430
+ patient_external_id: patient_external_id,
1431
+ status: status
1432
+ }.compact
1433
+ req.url "#{@request_client.get_url(environment: CandidApi,
1434
+ request_options: request_options)}/api/charge_captures/v1"
1435
+ end
1436
+ CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
1437
+ end
1438
+ end
1439
+
1440
+ # Create a Charge Capture from a pre-encounter patient and appointment. This
1441
+ # endpoint is intended to be used by consumers who are managing
1442
+ # patients and appointments in the pre-encounter service and is currently under
1443
+ # development. Consumers who are not taking advantage
1444
+ # of the pre-encounter service should use the standard create endpoint.
1445
+ # At encounter creation time, information from the provided patient and
1446
+ # appointment objects will be populated
1447
+ # where applicable. In particular, the following fields are populated from the
1448
+ # patient and appointment objects:
1449
+ # - Patient
1450
+ # - Referring Provider
1451
+ # - Subscriber Primary
1452
+ # - Subscriber Secondary
1453
+ # - Referral Number
1454
+ # - Responsible Party
1455
+ # - Guarantor
1456
+ # Note that these fields should not be populated in the ChargeCaptureData property
1457
+ # of this endpoint, as they will be overwritten at encounter creation time.
1458
+ # Utilizing this endpoint opts you into automatic updating of the encounter when
1459
+ # the patient or appointment is updated, assuming the
1460
+ # encounter has not already been submitted or adjudicated.
1461
+ #
1462
+ # @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
1463
+ # listed as optional. Candid will use this data when attempting to bundle multiple
1464
+ # Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
1465
+ # * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
1466
+ # * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
1467
+ # * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
1468
+ # * :epsdt_referral (Hash)
1469
+ # * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
1470
+ # * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
1471
+ # * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
1472
+ # * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
1473
+ # * :guarantor (Hash)
1474
+ # * :first_name (String)
1475
+ # * :last_name (String)
1476
+ # * :external_id (String)
1477
+ # * :date_of_birth (Date)
1478
+ # * :address (Hash)
1479
+ # * :zip_plus_four_code (String)
1480
+ # * :address_1 (String)
1481
+ # * :address_2 (String)
1482
+ # * :city (String)
1483
+ # * :state (CandidApiClient::Commons::Types::State)
1484
+ # * :zip_code (String)
1485
+ # * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
1486
+ # * :phone_consent (Boolean)
1487
+ # * :email (String)
1488
+ # * :email_consent (Boolean)
1489
+ # * :subscriber_primary (Hash)
1490
+ # * :insurance_card (Hash)
1491
+ # * :member_id (String)
1492
+ # * :payer_name (String)
1493
+ # * :payer_id (String)
1494
+ # * :rx_bin (String)
1495
+ # * :rx_pcn (String)
1496
+ # * :image_url_front (String)
1497
+ # * :image_url_back (String)
1498
+ # * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
1499
+ # * :group_number (String)
1500
+ # * :plan_name (String)
1501
+ # * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
1502
+ # * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
1503
+ # * :payer_plan_group_id (String)
1504
+ # * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
1505
+ # * :date_of_birth (Date)
1506
+ # * :address (Hash)
1507
+ # * :zip_plus_four_code (String)
1508
+ # * :address_1 (String)
1509
+ # * :address_2 (String)
1510
+ # * :city (String)
1511
+ # * :state (CandidApiClient::Commons::Types::State)
1512
+ # * :zip_code (String)
1513
+ # * :first_name (String)
1514
+ # * :last_name (String)
1515
+ # * :gender (CandidApiClient::Individual::Types::Gender)
1516
+ # * :subscriber_secondary (Hash)
1517
+ # * :insurance_card (Hash)
1518
+ # * :member_id (String)
1519
+ # * :payer_name (String)
1520
+ # * :payer_id (String)
1521
+ # * :rx_bin (String)
1522
+ # * :rx_pcn (String)
1523
+ # * :image_url_front (String)
1524
+ # * :image_url_back (String)
1525
+ # * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
1526
+ # * :group_number (String)
1527
+ # * :plan_name (String)
1528
+ # * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
1529
+ # * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
1530
+ # * :payer_plan_group_id (String)
1531
+ # * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
1532
+ # * :date_of_birth (Date)
1533
+ # * :address (Hash)
1534
+ # * :zip_plus_four_code (String)
1535
+ # * :address_1 (String)
1536
+ # * :address_2 (String)
1537
+ # * :city (String)
1538
+ # * :state (CandidApiClient::Commons::Types::State)
1539
+ # * :zip_code (String)
1540
+ # * :first_name (String)
1541
+ # * :last_name (String)
1542
+ # * :gender (CandidApiClient::Individual::Types::Gender)
1543
+ # * :subscriber_tertiary (Hash)
1544
+ # * :insurance_card (Hash)
1545
+ # * :member_id (String)
1546
+ # * :payer_name (String)
1547
+ # * :payer_id (String)
1548
+ # * :rx_bin (String)
1549
+ # * :rx_pcn (String)
1550
+ # * :image_url_front (String)
1551
+ # * :image_url_back (String)
1552
+ # * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
1553
+ # * :group_number (String)
1554
+ # * :plan_name (String)
1555
+ # * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
1556
+ # * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
1557
+ # * :payer_plan_group_id (String)
1558
+ # * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
1559
+ # * :date_of_birth (Date)
1560
+ # * :address (Hash)
1561
+ # * :zip_plus_four_code (String)
1562
+ # * :address_1 (String)
1563
+ # * :address_2 (String)
1564
+ # * :city (String)
1565
+ # * :state (CandidApiClient::Commons::Types::State)
1566
+ # * :zip_code (String)
1567
+ # * :first_name (String)
1568
+ # * :last_name (String)
1569
+ # * :gender (CandidApiClient::Individual::Types::Gender)
1570
+ # * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
1571
+ # * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
1572
+ # * :external_claim_submission (Hash)
1573
+ # * :claim_created_at (DateTime)
1574
+ # * :patient_control_number (String)
1575
+ # * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
1576
+ # * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
1577
+ # * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
1578
+ # * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
1579
+ # * :patient (Hash)
1580
+ # * :first_name (String)
1581
+ # * :last_name (String)
1582
+ # * :gender (CandidApiClient::Individual::Types::Gender)
1583
+ # * :external_id (String)
1584
+ # * :date_of_birth (Date)
1585
+ # * :address (Hash)
1586
+ # * :zip_plus_four_code (String)
1587
+ # * :address_1 (String)
1588
+ # * :address_2 (String)
1589
+ # * :city (String)
1590
+ # * :state (CandidApiClient::Commons::Types::State)
1591
+ # * :zip_code (String)
1592
+ # * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
1593
+ # * :phone_consent (Boolean)
1594
+ # * :email (String)
1595
+ # * :email_consent (Boolean)
1596
+ # * :non_insurance_payers (Array<String>)
1597
+ # * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
1598
+ # * :service_facility (Hash)
1599
+ # * :organization_name (String)
1600
+ # * :npi (String)
1601
+ # * :address (Hash)
1602
+ # * :zip_plus_four_code (String)
1603
+ # * :address_1 (String)
1604
+ # * :address_2 (String)
1605
+ # * :city (String)
1606
+ # * :state (CandidApiClient::Commons::Types::State)
1607
+ # * :zip_code (String)
1608
+ # * :secondary_identification (String)
1609
+ # * :rendering_provider (Hash)
1610
+ # * :npi (String)
1611
+ # * :taxonomy_code (String)
1612
+ # * :address (Hash)
1613
+ # * :zip_plus_four_code (String)
1614
+ # * :address_1 (String)
1615
+ # * :address_2 (String)
1616
+ # * :city (String)
1617
+ # * :state (CandidApiClient::Commons::Types::State)
1618
+ # * :zip_code (String)
1619
+ # * :first_name (String)
1620
+ # * :last_name (String)
1621
+ # * :organization_name (String)
1622
+ # * :initial_referring_provider (Hash)
1623
+ # * :npi (String)
1624
+ # * :taxonomy_code (String)
1625
+ # * :address (Hash)
1626
+ # * :zip_plus_four_code (String)
1627
+ # * :address_1 (String)
1628
+ # * :address_2 (String)
1629
+ # * :city (String)
1630
+ # * :state (CandidApiClient::Commons::Types::State)
1631
+ # * :zip_code (String)
1632
+ # * :qualifier (CandidApiClient::Commons::Types::QualifierCode)
1633
+ # * :first_name (String)
1634
+ # * :last_name (String)
1635
+ # * :organization_name (String)
1636
+ # * :referring_provider (Hash)
1637
+ # * :npi (String)
1638
+ # * :taxonomy_code (String)
1639
+ # * :address (Hash)
1640
+ # * :zip_plus_four_code (String)
1641
+ # * :address_1 (String)
1642
+ # * :address_2 (String)
1643
+ # * :city (String)
1644
+ # * :state (CandidApiClient::Commons::Types::State)
1645
+ # * :zip_code (String)
1646
+ # * :first_name (String)
1647
+ # * :last_name (String)
1648
+ # * :organization_name (String)
1649
+ # * :supervising_provider (Hash)
1650
+ # * :npi (String)
1651
+ # * :taxonomy_code (String)
1652
+ # * :address (Hash)
1653
+ # * :zip_plus_four_code (String)
1654
+ # * :address_1 (String)
1655
+ # * :address_2 (String)
1656
+ # * :city (String)
1657
+ # * :state (CandidApiClient::Commons::Types::State)
1658
+ # * :zip_code (String)
1659
+ # * :first_name (String)
1660
+ # * :last_name (String)
1661
+ # * :organization_name (String)
1662
+ # * :billing_provider (Hash)
1663
+ # * :address (Hash)
1664
+ # * :zip_plus_four_code (String)
1665
+ # * :address_1 (String)
1666
+ # * :address_2 (String)
1667
+ # * :city (String)
1668
+ # * :state (CandidApiClient::Commons::Types::State)
1669
+ # * :zip_code (String)
1670
+ # * :tax_id (String)
1671
+ # * :npi (String)
1672
+ # * :taxonomy_code (String)
1673
+ # * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
1674
+ # * :first_name (String)
1675
+ # * :last_name (String)
1676
+ # * :organization_name (String)
1677
+ # * :pay_to_address (Hash)
1678
+ # * :zip_plus_four_code (String)
1679
+ # * :address_1 (String)
1680
+ # * :address_2 (String)
1681
+ # * :city (String)
1682
+ # * :state (CandidApiClient::Commons::Types::State)
1683
+ # * :zip_code (String)
1684
+ # * :benefits_assigned_to_provider (Boolean)
1685
+ # * :prior_authorization_number (String)
1686
+ # * :external_id (String)
1687
+ # * :date_of_service (Date)
1688
+ # * :tag_ids (Array<String>)
1689
+ # * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
1690
+ # * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
1691
+ # * :provider_accepts_assignment (Boolean)
1692
+ # * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
1693
+ # * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
1694
+ # * :appointment_type (String)
1695
+ # * :end_date_of_service (Date)
1696
+ # * :additional_information (String)
1697
+ # * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
1698
+ # * :admission_date (Date)
1699
+ # * :discharge_date (Date)
1700
+ # * :onset_of_current_illness_or_symptom_date (Date)
1701
+ # * :last_menstrual_period_date (Date)
1702
+ # * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
1703
+ # * :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
+ # * :referral_number (String)
1713
+ # * :secondary_payer_carrier_code (String)
1714
+ # @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
1715
+ # internal encounter ID or a Dr. Chrono encounter ID. This field should not
1716
+ # contain PHI.
1717
+ # @param pre_encounter_patient_id [String]
1718
+ # @param pre_encounter_appointment_ids [Array<String>]
1719
+ # @param originating_system [String] An optional string field denoting the originating system of the charge.
1720
+ # @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
1721
+ # creation.
1722
+ # @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
1723
+ # system (e.g. the EHR visit page). Send full URL format for the external link
1724
+ # (e.g. https://emr_charge_capture_url.com/123).
1725
+ # @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
1726
+ # @param request_options [CandidApiClient::RequestOptions]
1727
+ # @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
1728
+ # @example
1729
+ # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1730
+ # api.charge_capture.v_1.create_from_pre_encounter_patient(
1731
+ # data: { },
1732
+ # charge_external_id: "charge_external_id",
1733
+ # pre_encounter_patient_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1734
+ # pre_encounter_appointment_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
1735
+ # status: PLANNED
1736
+ # )
1737
+ def create_from_pre_encounter_patient(data:, charge_external_id:, pre_encounter_patient_id:,
1738
+ pre_encounter_appointment_ids:, status:, originating_system: nil, claim_creation_category: nil, ehr_source_url: nil, request_options: nil)
1739
+ Async do
1740
+ response = @request_client.conn.post do |req|
1741
+ req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
1742
+ req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
1743
+ req.headers = {
1744
+ **(req.headers || {}),
1745
+ **@request_client.get_headers,
1746
+ **(request_options&.additional_headers || {})
1098
1747
  }.compact
1099
1748
  req.body = {
1100
1749
  **(request_options&.additional_body_parameters || {}),
1101
1750
  data: data,
1102
1751
  charge_external_id: charge_external_id,
1752
+ pre_encounter_patient_id: pre_encounter_patient_id,
1753
+ pre_encounter_appointment_ids: pre_encounter_appointment_ids,
1103
1754
  originating_system: originating_system,
1104
1755
  claim_creation_category: claim_creation_category,
1105
1756
  ehr_source_url: ehr_source_url,
1106
- patient_external_id: patient_external_id,
1107
1757
  status: status
1108
1758
  }.compact
1109
1759
  req.url "#{@request_client.get_url(environment: CandidApi,
1110
- request_options: request_options)}/api/charge_captures/v1"
1760
+ request_options: request_options)}/api/charge_captures/v1/create-from-pre-encounter"
1111
1761
  end
1112
1762
  CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
1113
1763
  end