candidhealth 0.36.0 → 0.37.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 (23) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candidhealth/charge_capture/client.rb +30 -0
  3. data/lib/candidhealth/charge_capture/v_1/client.rb +1250 -0
  4. data/lib/candidhealth/charge_capture/v_1/types/charge_capture.rb +116 -0
  5. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +727 -0
  6. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_page.rb +88 -0
  7. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_status.rb +19 -0
  8. data/lib/candidhealth/commons/types/billing_provider_commercial_license_type.rb +20 -0
  9. data/lib/candidhealth/commons/types/not_implemented_error_message.rb +60 -0
  10. data/lib/candidhealth/commons/types/procedure_modifier.rb +1 -0
  11. data/lib/candidhealth/contracts/v_2/types/contract_invalid_expiration_date_error.rb +60 -0
  12. data/lib/candidhealth/encounter_providers/v_2/client.rb +16 -16
  13. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider.rb +15 -2
  14. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider_update.rb +15 -2
  15. data/lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb +14 -1
  16. data/lib/candidhealth/encounters/v_4/client.rb +92 -150
  17. data/lib/candidhealth/encounters/v_4/types/encounter_optional.rb +633 -0
  18. data/lib/candidhealth/guarantor/v_1/client.rb +2 -2
  19. data/lib/candidhealth/service_lines/v_2/client.rb +2 -2
  20. data/lib/candidhealth.rb +7 -0
  21. data/lib/requests.rb +2 -2
  22. data/lib/types_export.rb +8 -0
  23. metadata +15 -5
data/lib/candidhealth/encounters/v_4/client.rb CHANGED
@@ -298,6 +298,7 @@ module CandidApiClient
298
298
  # * :tax_id (String)
299
299
  # * :npi (String)
300
300
  # * :taxonomy_code (String)
301
+ # * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
301
302
  # * :first_name (String)
302
303
  # * :last_name (String)
303
304
  # * :organization_name (String)
@@ -537,14 +538,14 @@ module CandidApiClient
537
538
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
538
539
  # api.encounters.v_4.create(
539
540
  # patient: { phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", non_insurance_payers: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], non_insurance_payers_info: [{ non_insurance_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", member_id: "string" }], email_consent: true, external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
540
- # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", first_name: "string", last_name: "string", organization_name: "string" },
541
- # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
542
- # referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
543
- # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ, first_name: "string", last_name: "string", organization_name: "string" },
544
- # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
541
+ # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", provider_commercial_license_type: LICENSED_CLINICAL_SOCIAL_WORKER },
542
+ # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
543
+ # referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
544
+ # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ },
545
+ # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
545
546
  # service_facility: { organization_name: "string", npi: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
546
- # subscriber_primary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string", rx_bin: "string", rx_pcn: "string", image_url_front: "string", image_url_back: "string", emr_payer_crosswalk: HEALTHIE, group_number: "string", plan_name: "string", plan_type: SELF_PAY, insurance_type: C_01 }, patient_relationship_to_subscriber_code: SPOUSE, date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
547
- # subscriber_secondary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string", rx_bin: "string", rx_pcn: "string", image_url_front: "string", image_url_back: "string", emr_payer_crosswalk: HEALTHIE, group_number: "string", plan_name: "string", plan_type: SELF_PAY, insurance_type: C_01 }, patient_relationship_to_subscriber_code: SPOUSE, date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
547
+ # subscriber_primary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string" }, patient_relationship_to_subscriber_code: SPOUSE, first_name: "string", last_name: "string", gender: MALE },
548
+ # subscriber_secondary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string" }, patient_relationship_to_subscriber_code: SPOUSE, first_name: "string", last_name: "string", gender: MALE },
548
549
  # prior_authorization_number: "string",
549
550
  # responsible_party: INSURANCE_PAY,
550
551
  # diagnoses: [{ name: "string", code_type: ABF, code: "string" }],
@@ -552,7 +553,7 @@ module CandidApiClient
552
553
  # billing_notes: [{ text: "string" }],
553
554
  # place_of_service_code: PHARMACY,
554
555
  # patient_histories: [{ category: PRESENT_ILLNESS, questions: [{ id: "6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176", text: "Do you have any allergies?", responses: [{ response: "No allergies", follow_ups: [{ id: "4F3D57F9-AC94-49D6-87E4-E804B709917A", text: "Do you have any allergies?", response: "No allergies" }] }] }] }],
555
- # service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: { service_id_qualifier: EAN_UCC_13, national_drug_code: "string", national_drug_unit_count: "string", measurement_unit_code: MILLILITERS, link_sequence_number: "string", pharmacy_prescription_number: "string", conversion_formula: "string", drug_description: "string" }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" }, test_results: [{ value: 1.1, result_type: HEMATOCRIT }] }],
556
+ # service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: { service_id_qualifier: EAN_UCC_13, national_drug_code: "string", national_drug_unit_count: "string", measurement_unit_code: MILLILITERS, link_sequence_number: "string", pharmacy_prescription_number: "string", conversion_formula: "string", drug_description: "string" }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } }, test_results: [{ value: 1.1, result_type: HEMATOCRIT }] }],
556
557
  # guarantor: { phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
557
558
  # external_claim_submission: { claim_created_at: DateTime.parse(2023-01-01T12:00:00.000Z), patient_control_number: "PATIENT_CONTROL_NUMBER", submission_records: [{ submitted_at: DateTime.parse(2023-01-01T13:00:00.000Z), claim_frequency_code: ORIGINAL, payer_responsibility: PRIMARY, intended_submission_medium: ELECTRONIC }, { submitted_at: DateTime.parse(2023-01-04T12:00:00.000Z), claim_frequency_code: REPLACEMENT, payer_responsibility: PRIMARY, intended_submission_medium: PAPER }] },
558
559
  # tag_ids: ["string"],
@@ -767,6 +768,7 @@ module CandidApiClient
767
768
  # * :tax_id (String)
768
769
  # * :npi (String)
769
770
  # * :taxonomy_code (String)
771
+ # * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
770
772
  # * :first_name (String)
771
773
  # * :last_name (String)
772
774
  # * :organization_name (String)
@@ -914,17 +916,17 @@ module CandidApiClient
914
916
  # api.encounters.v_4.create_from_pre_encounter_patient(
915
917
  # pre_encounter_patient_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
916
918
  # pre_encounter_appointment_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
917
- # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", first_name: "string", last_name: "string", organization_name: "string" },
918
- # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
919
- # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ, first_name: "string", last_name: "string", organization_name: "string" },
920
- # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
919
+ # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", provider_commercial_license_type: LICENSED_CLINICAL_SOCIAL_WORKER },
920
+ # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
921
+ # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ },
922
+ # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
921
923
  # service_facility: { organization_name: "string", npi: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
922
924
  # diagnoses: [{ name: "string", code_type: ABF, code: "string" }],
923
925
  # clinical_notes: [{ category: CLINICAL, notes: [{ text: "string", author_name: "string", author_npi: "string", timestamp: DateTime.parse(2024-01-15T09:30:00.000Z) }] }],
924
926
  # billing_notes: [{ text: "string" }],
925
927
  # place_of_service_code: PHARMACY,
926
928
  # patient_histories: [{ category: PRESENT_ILLNESS, questions: [{ id: "6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176", text: "Do you have any allergies?", responses: [{ response: "No allergies", follow_ups: [{ id: "4F3D57F9-AC94-49D6-87E4-E804B709917A", text: "Do you have any allergies?", response: "No allergies" }] }] }] }],
927
- # service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: { service_id_qualifier: EAN_UCC_13, national_drug_code: "string", national_drug_unit_count: "string", measurement_unit_code: MILLILITERS, link_sequence_number: "string", pharmacy_prescription_number: "string", conversion_formula: "string", drug_description: "string" }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" }, test_results: [{ value: 1.1, result_type: HEMATOCRIT }] }],
929
+ # service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: { service_id_qualifier: EAN_UCC_13, national_drug_code: "string", national_drug_unit_count: "string", measurement_unit_code: MILLILITERS, link_sequence_number: "string", pharmacy_prescription_number: "string", conversion_formula: "string", drug_description: "string" }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } }, test_results: [{ value: 1.1, result_type: HEMATOCRIT }] }],
928
930
  # external_claim_submission: { claim_created_at: DateTime.parse(2023-01-01T12:00:00.000Z), patient_control_number: "PATIENT_CONTROL_NUMBER", submission_records: [{ submitted_at: DateTime.parse(2023-01-01T13:00:00.000Z), claim_frequency_code: ORIGINAL, payer_responsibility: PRIMARY, intended_submission_medium: ELECTRONIC }, { submitted_at: DateTime.parse(2023-01-04T12:00:00.000Z), claim_frequency_code: REPLACEMENT, payer_responsibility: PRIMARY, intended_submission_medium: PAPER }] },
929
931
  # tag_ids: ["string"],
930
932
  # schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
@@ -987,6 +989,9 @@ module CandidApiClient
987
989
  end
988
990
 
989
991
  # @param encounter_id [String]
992
+ # @param benefits_assigned_to_provider [Boolean] Whether this patient has authorized insurance payments to be made to you, not
993
+ # them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim
994
+ # form.
990
995
  # @param prior_authorization_number [String] Box 23 on the CMS-1500 claim form.
991
996
  # @param external_id [String] A client-specified unique ID to associate with this encounter;
992
997
  # for example, your internal encounter ID or a Dr. Chrono encounter ID.
@@ -999,12 +1004,7 @@ module CandidApiClient
999
1004
  # date_of_service will fail. If all service line date_of_service values are the
1000
1005
  # same, updating the encounter's date_of_service will update all service line
1001
1006
  # date_of_service values.
1002
- # @param diagnosis_ids [Array<String>] Ideally, this field should contain no more than 12 diagnoses. However, more
1003
- # diagnoses
1004
- # may be submitted at this time, and coders will later prioritize the 12 that will
1005
- # be
1006
- # submitted to the payor.
1007
- # @param tag_ids [Array<String>] Names of tags that should be on the encounter. Note all tags on encounter will
1007
+ # @param tag_ids [Array<String>] Names of tags that should be on the encounter. Note all tags on encounter will
1008
1008
  # be overridden with this list.
1009
1009
  # @param clinical_notes [Array<Hash>] Holds a collection of clinical observations made by healthcare providers during
1010
1010
  # patient encounters.Request of type Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>, as a Hash
@@ -1025,9 +1025,6 @@ module CandidApiClient
1025
1025
  # SELF_PAY if you intend to bill self pay/cash pay.
1026
1026
  # @param provider_accepts_assignment [Boolean] Whether you have accepted the patient's authorization for insurance payments to
1027
1027
  # be made to you, not them. Box 27 on the CMS-1500 claim form.
1028
- # @param benefits_assigned_to_provider [Boolean] Whether this patient has authorized insurance payments to be made to you, not
1029
- # them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim
1030
- # form.
1031
1028
  # @param synchronicity [CandidApiClient::Encounters::V4::Types::SynchronicityType] Whether or not this was a synchronous or asynchronous encounter. Asynchronous
1032
1029
  # encounters occur when providers and patients communicate online using forms,
1033
1030
  # instant messaging, or other pre-recorded digital mediums. Synchronous encounters
@@ -1036,9 +1033,6 @@ module CandidApiClient
1036
1033
  # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
1037
1034
  # telemedicine, 11 for in-person. Full list
1038
1035
  # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
1039
- # @param place_of_service_code_as_submitted [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
1040
- # telemedicine, 11 for in-person. Full list
1041
- # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
1042
1036
  # @param appointment_type [String] Human-readable description of the appointment type (ex: "Acupuncture -
1043
1037
  # Headaches").
1044
1038
  # @param end_date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
@@ -1103,29 +1097,29 @@ module CandidApiClient
1103
1097
  # * :gender (CandidApiClient::Individual::Types::Gender)
1104
1098
  # @param additional_information [String] Defines additional information on the claim needed by the payer.
1105
1099
  # Box 19 on the CMS-1500 claim form.
1106
- # @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
1100
+ # @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF\*4N
1107
1101
  # Required when mandated by government law or regulation to obtain authorization
1108
1102
  # for specific service(s) but, for the
1109
1103
  # reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
1110
1104
  # the service was performed without
1111
1105
  # obtaining the authorization.
1112
- # @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
1106
+ # @param admission_date [Date] 837p Loop2300 DTP\*435, CMS-1500 Box 18
1113
1107
  # Required on all ambulance claims when the patient was known to be admitted to
1114
1108
  # the hospital.
1115
1109
  # OR
1116
1110
  # Required on all claims involving inpatient medical visits.
1117
- # @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
1111
+ # @param discharge_date [Date] 837p Loop2300 DTP\*096, CMS-1500 Box 18
1118
1112
  # Required for inpatient claims when the patient was discharged from the facility
1119
1113
  # and the discharge date is known.
1120
- # @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
1114
+ # @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP\*431, CMS-1500 Box 14
1121
1115
  # Required for the initial medical service or visit performed in response to a
1122
1116
  # medical emergency when the date is available and is different than the date of
1123
1117
  # service.
1124
1118
  # OR
1125
1119
  # This date is the onset of acute symptoms for the current illness or condition.
1126
- # @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
1120
+ # @param last_menstrual_period_date [Date] 837p Loop2300 DTP\*484, CMS-1500 Box 14
1127
1121
  # Required when, in the judgment of the provider, the services on this claim are
1128
- # related to the patient's pregnancy.
1122
+ # related to the patient's pregnancy.de
1129
1123
  # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
1130
1124
  # Code indicating the reason why a request was delayed
1131
1125
  # @param patient [Hash] Contains the identification information of the individual receiving medical
@@ -1249,6 +1243,7 @@ module CandidApiClient
1249
1243
  # * :tax_id (String)
1250
1244
  # * :npi (String)
1251
1245
  # * :taxonomy_code (String)
1246
+ # * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
1252
1247
  # * :first_name (String)
1253
1248
  # * :last_name (String)
1254
1249
  # * :organization_name (String)
@@ -1299,54 +1294,28 @@ module CandidApiClient
1299
1294
  # * :first_name (String)
1300
1295
  # * :last_name (String)
1301
1296
  # * :organization_name (String)
1302
- # @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
1297
+ # @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
1298
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
1299
+ # @param _field_set [Object]
1300
+ # @param diagnosis_ids [Array<String>] Ideally, this field should contain no more than 12 diagnoses. However, more
1301
+ # diagnoses
1302
+ # may be submitted at this time, and coders will later prioritize the 12 that will
1303
+ # be
1304
+ # submitted to the payor.
1305
+ # @param place_of_service_code_as_submitted [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
1306
+ # telemedicine, 11 for in-person. Full list
1307
+ # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
1303
1308
  # @param request_options [CandidApiClient::RequestOptions]
1304
1309
  # @return [CandidApiClient::Encounters::V4::Types::Encounter]
1305
1310
  # @example
1306
1311
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1307
1312
  # api.encounters.v_4.update(
1308
1313
  # encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1309
- # prior_authorization_number: "string",
1310
- # external_id: "string",
1311
- # date_of_service: DateTime.parse(2023-01-15),
1312
1314
  # diagnosis_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
1313
- # tag_ids: ["string"],
1314
- # clinical_notes: [{ category: CLINICAL, notes: [{ text: "string", author_name: "string", author_npi: "string", timestamp: DateTime.parse(2024-01-15T09:30:00.000Z) }] }],
1315
- # pay_to_address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" },
1316
- # billable_status: BILLABLE,
1317
- # responsible_party: INSURANCE_PAY,
1318
- # provider_accepts_assignment: true,
1319
- # benefits_assigned_to_provider: true,
1320
- # synchronicity: SYNCHRONOUS,
1321
- # place_of_service_code: PHARMACY,
1322
- # place_of_service_code_as_submitted: PHARMACY,
1323
- # appointment_type: "string",
1324
- # end_date_of_service: DateTime.parse(2023-01-15),
1325
- # subscriber_primary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string", rx_bin: "string", rx_pcn: "string", image_url_front: "string", image_url_back: "string", emr_payer_crosswalk: HEALTHIE, group_number: "string", plan_name: "string", plan_type: SELF_PAY, insurance_type: C_01 }, patient_relationship_to_subscriber_code: SPOUSE, date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
1326
- # subscriber_secondary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string", rx_bin: "string", rx_pcn: "string", image_url_front: "string", image_url_back: "string", emr_payer_crosswalk: HEALTHIE, group_number: "string", plan_name: "string", plan_type: SELF_PAY, insurance_type: C_01 }, patient_relationship_to_subscriber_code: SPOUSE, date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
1327
- # additional_information: "string",
1328
- # service_authorization_exception_code: C_1,
1329
- # admission_date: DateTime.parse(2023-01-15),
1330
- # discharge_date: DateTime.parse(2023-01-15),
1331
- # onset_of_current_illness_or_symptom_date: DateTime.parse(2023-01-15),
1332
- # last_menstrual_period_date: DateTime.parse(2023-01-15),
1333
- # delay_reason_code: C_1,
1334
- # patient: { first_name: "string", last_name: "string", gender: MALE, external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, non_insurance_payers: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], non_insurance_payers_info: [{ non_insurance_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", member_id: "string" }] },
1335
- # patient_authorized_release: true,
1336
- # schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
1337
- # vitals: { height_in: 70, weight_lbs: 165, blood_pressure_systolic_mmhg: 115, blood_pressure_diastolic_mmhg: 85, body_temperature_f: 98, hemoglobin_gdl: 15.1, hematocrit_pct: 51.2 },
1338
- # existing_medications: [{ name: "Lisinopril", rx_cui: "860975", dosage: "10mg", dosage_form: "Tablet", frequency: "Once Daily", as_needed: true }],
1339
- # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
1340
- # service_facility: { organization_name: "Test Organization", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
1341
- # guarantor: { first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true },
1342
- # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", first_name: "string", last_name: "string", organization_name: "string" },
1343
- # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
1344
- # referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
1345
- # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ, first_name: "string", last_name: "string", organization_name: "string" },
1346
- # referral_number: "string"
1315
+ # place_of_service_code_as_submitted: PHARMACY
1347
1316
  # )
1348
- def update(encounter_id:, prior_authorization_number: nil, external_id: nil, date_of_service: nil,
1349
- diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, place_of_service_code_as_submitted: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, patient: nil, patient_authorized_release: nil, schema_instances: nil, vitals: nil, existing_medications: nil, rendering_provider: nil, service_facility: nil, guarantor: nil, billing_provider: nil, supervising_provider: nil, referring_provider: nil, initial_referring_provider: nil, referral_number: nil, request_options: nil)
1317
+ def update(encounter_id:, benefits_assigned_to_provider: nil, prior_authorization_number: nil,
1318
+ external_id: nil, date_of_service: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, synchronicity: nil, place_of_service_code: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, patient: nil, patient_authorized_release: nil, schema_instances: nil, vitals: nil, existing_medications: nil, rendering_provider: nil, service_facility: nil, guarantor: nil, billing_provider: nil, supervising_provider: nil, referring_provider: nil, initial_referring_provider: nil, referral_number: nil, additional_properties: nil, _field_set: nil, diagnosis_ids: nil, place_of_service_code_as_submitted: nil, request_options: nil)
1350
1319
  response = @request_client.conn.patch do |req|
1351
1320
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
1352
1321
  req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -1357,20 +1326,18 @@ module CandidApiClient
1357
1326
  }.compact
1358
1327
  req.body = {
1359
1328
  **(request_options&.additional_body_parameters || {}),
1329
+ benefits_assigned_to_provider: benefits_assigned_to_provider,
1360
1330
  prior_authorization_number: prior_authorization_number,
1361
1331
  external_id: external_id,
1362
1332
  date_of_service: date_of_service,
1363
- diagnosis_ids: diagnosis_ids,
1364
1333
  tag_ids: tag_ids,
1365
1334
  clinical_notes: clinical_notes,
1366
1335
  pay_to_address: pay_to_address,
1367
1336
  billable_status: billable_status,
1368
1337
  responsible_party: responsible_party,
1369
1338
  provider_accepts_assignment: provider_accepts_assignment,
1370
- benefits_assigned_to_provider: benefits_assigned_to_provider,
1371
1339
  synchronicity: synchronicity,
1372
1340
  place_of_service_code: place_of_service_code,
1373
- place_of_service_code_as_submitted: place_of_service_code_as_submitted,
1374
1341
  appointment_type: appointment_type,
1375
1342
  end_date_of_service: end_date_of_service,
1376
1343
  subscriber_primary: subscriber_primary,
@@ -1394,7 +1361,11 @@ module CandidApiClient
1394
1361
  supervising_provider: supervising_provider,
1395
1362
  referring_provider: referring_provider,
1396
1363
  initial_referring_provider: initial_referring_provider,
1397
- referral_number: referral_number
1364
+ referral_number: referral_number,
1365
+ additional_properties: additional_properties,
1366
+ _field_set: _field_set,
1367
+ diagnosis_ids: diagnosis_ids,
1368
+ place_of_service_code_as_submitted: place_of_service_code_as_submitted
1398
1369
  }.compact
1399
1370
  req.url "#{@request_client.get_url(environment: CandidApi,
1400
1371
  request_options: request_options)}/api/encounters/v4/#{encounter_id}"
@@ -1657,6 +1628,7 @@ module CandidApiClient
1657
1628
  # * :tax_id (String)
1658
1629
  # * :npi (String)
1659
1630
  # * :taxonomy_code (String)
1631
+ # * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
1660
1632
  # * :first_name (String)
1661
1633
  # * :last_name (String)
1662
1634
  # * :organization_name (String)
@@ -1896,14 +1868,14 @@ module CandidApiClient
1896
1868
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
1897
1869
  # api.encounters.v_4.create(
1898
1870
  # patient: { phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", non_insurance_payers: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], non_insurance_payers_info: [{ non_insurance_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", member_id: "string" }], email_consent: true, external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
1899
- # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", first_name: "string", last_name: "string", organization_name: "string" },
1900
- # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
1901
- # referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
1902
- # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ, first_name: "string", last_name: "string", organization_name: "string" },
1903
- # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
1871
+ # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", provider_commercial_license_type: LICENSED_CLINICAL_SOCIAL_WORKER },
1872
+ # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
1873
+ # referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
1874
+ # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ },
1875
+ # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
1904
1876
  # service_facility: { organization_name: "string", npi: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
1905
- # subscriber_primary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string", rx_bin: "string", rx_pcn: "string", image_url_front: "string", image_url_back: "string", emr_payer_crosswalk: HEALTHIE, group_number: "string", plan_name: "string", plan_type: SELF_PAY, insurance_type: C_01 }, patient_relationship_to_subscriber_code: SPOUSE, date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
1906
- # subscriber_secondary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string", rx_bin: "string", rx_pcn: "string", image_url_front: "string", image_url_back: "string", emr_payer_crosswalk: HEALTHIE, group_number: "string", plan_name: "string", plan_type: SELF_PAY, insurance_type: C_01 }, patient_relationship_to_subscriber_code: SPOUSE, date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
1877
+ # subscriber_primary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string" }, patient_relationship_to_subscriber_code: SPOUSE, first_name: "string", last_name: "string", gender: MALE },
1878
+ # subscriber_secondary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string" }, patient_relationship_to_subscriber_code: SPOUSE, first_name: "string", last_name: "string", gender: MALE },
1907
1879
  # prior_authorization_number: "string",
1908
1880
  # responsible_party: INSURANCE_PAY,
1909
1881
  # diagnoses: [{ name: "string", code_type: ABF, code: "string" }],
@@ -1911,7 +1883,7 @@ module CandidApiClient
1911
1883
  # billing_notes: [{ text: "string" }],
1912
1884
  # place_of_service_code: PHARMACY,
1913
1885
  # patient_histories: [{ category: PRESENT_ILLNESS, questions: [{ id: "6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176", text: "Do you have any allergies?", responses: [{ response: "No allergies", follow_ups: [{ id: "4F3D57F9-AC94-49D6-87E4-E804B709917A", text: "Do you have any allergies?", response: "No allergies" }] }] }] }],
1914
- # service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: { service_id_qualifier: EAN_UCC_13, national_drug_code: "string", national_drug_unit_count: "string", measurement_unit_code: MILLILITERS, link_sequence_number: "string", pharmacy_prescription_number: "string", conversion_formula: "string", drug_description: "string" }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" }, test_results: [{ value: 1.1, result_type: HEMATOCRIT }] }],
1886
+ # service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: { service_id_qualifier: EAN_UCC_13, national_drug_code: "string", national_drug_unit_count: "string", measurement_unit_code: MILLILITERS, link_sequence_number: "string", pharmacy_prescription_number: "string", conversion_formula: "string", drug_description: "string" }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } }, test_results: [{ value: 1.1, result_type: HEMATOCRIT }] }],
1915
1887
  # guarantor: { phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
1916
1888
  # external_claim_submission: { claim_created_at: DateTime.parse(2023-01-01T12:00:00.000Z), patient_control_number: "PATIENT_CONTROL_NUMBER", submission_records: [{ submitted_at: DateTime.parse(2023-01-01T13:00:00.000Z), claim_frequency_code: ORIGINAL, payer_responsibility: PRIMARY, intended_submission_medium: ELECTRONIC }, { submitted_at: DateTime.parse(2023-01-04T12:00:00.000Z), claim_frequency_code: REPLACEMENT, payer_responsibility: PRIMARY, intended_submission_medium: PAPER }] },
1917
1889
  # tag_ids: ["string"],
@@ -2128,6 +2100,7 @@ module CandidApiClient
2128
2100
  # * :tax_id (String)
2129
2101
  # * :npi (String)
2130
2102
  # * :taxonomy_code (String)
2103
+ # * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
2131
2104
  # * :first_name (String)
2132
2105
  # * :last_name (String)
2133
2106
  # * :organization_name (String)
@@ -2275,17 +2248,17 @@ module CandidApiClient
2275
2248
  # api.encounters.v_4.create_from_pre_encounter_patient(
2276
2249
  # pre_encounter_patient_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
2277
2250
  # pre_encounter_appointment_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
2278
- # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", first_name: "string", last_name: "string", organization_name: "string" },
2279
- # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
2280
- # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ, first_name: "string", last_name: "string", organization_name: "string" },
2281
- # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
2251
+ # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", provider_commercial_license_type: LICENSED_CLINICAL_SOCIAL_WORKER },
2252
+ # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
2253
+ # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ },
2254
+ # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
2282
2255
  # service_facility: { organization_name: "string", npi: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
2283
2256
  # diagnoses: [{ name: "string", code_type: ABF, code: "string" }],
2284
2257
  # clinical_notes: [{ category: CLINICAL, notes: [{ text: "string", author_name: "string", author_npi: "string", timestamp: DateTime.parse(2024-01-15T09:30:00.000Z) }] }],
2285
2258
  # billing_notes: [{ text: "string" }],
2286
2259
  # place_of_service_code: PHARMACY,
2287
2260
  # patient_histories: [{ category: PRESENT_ILLNESS, questions: [{ id: "6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176", text: "Do you have any allergies?", responses: [{ response: "No allergies", follow_ups: [{ id: "4F3D57F9-AC94-49D6-87E4-E804B709917A", text: "Do you have any allergies?", response: "No allergies" }] }] }] }],
2288
- # service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: { service_id_qualifier: EAN_UCC_13, national_drug_code: "string", national_drug_unit_count: "string", measurement_unit_code: MILLILITERS, link_sequence_number: "string", pharmacy_prescription_number: "string", conversion_formula: "string", drug_description: "string" }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" }, test_results: [{ value: 1.1, result_type: HEMATOCRIT }] }],
2261
+ # service_lines: [{ modifiers: [TWENTY_TWO], procedure_code: "string", quantity: "string", units: MJ, charge_amount_cents: 1, diagnosis_pointers: [1], drug_identification: { service_id_qualifier: EAN_UCC_13, national_drug_code: "string", national_drug_unit_count: "string", measurement_unit_code: MILLILITERS, link_sequence_number: "string", pharmacy_prescription_number: "string", conversion_formula: "string", drug_description: "string" }, place_of_service_code: PHARMACY, description: "string", date_of_service: DateTime.parse(2023-01-15), end_date_of_service: DateTime.parse(2023-01-15), ordering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } }, test_results: [{ value: 1.1, result_type: HEMATOCRIT }] }],
2289
2262
  # external_claim_submission: { claim_created_at: DateTime.parse(2023-01-01T12:00:00.000Z), patient_control_number: "PATIENT_CONTROL_NUMBER", submission_records: [{ submitted_at: DateTime.parse(2023-01-01T13:00:00.000Z), claim_frequency_code: ORIGINAL, payer_responsibility: PRIMARY, intended_submission_medium: ELECTRONIC }, { submitted_at: DateTime.parse(2023-01-04T12:00:00.000Z), claim_frequency_code: REPLACEMENT, payer_responsibility: PRIMARY, intended_submission_medium: PAPER }] },
2290
2263
  # tag_ids: ["string"],
2291
2264
  # schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
@@ -2350,6 +2323,9 @@ module CandidApiClient
2350
2323
  end
2351
2324
 
2352
2325
  # @param encounter_id [String]
2326
+ # @param benefits_assigned_to_provider [Boolean] Whether this patient has authorized insurance payments to be made to you, not
2327
+ # them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim
2328
+ # form.
2353
2329
  # @param prior_authorization_number [String] Box 23 on the CMS-1500 claim form.
2354
2330
  # @param external_id [String] A client-specified unique ID to associate with this encounter;
2355
2331
  # for example, your internal encounter ID or a Dr. Chrono encounter ID.
@@ -2362,12 +2338,7 @@ module CandidApiClient
2362
2338
  # date_of_service will fail. If all service line date_of_service values are the
2363
2339
  # same, updating the encounter's date_of_service will update all service line
2364
2340
  # date_of_service values.
2365
- # @param diagnosis_ids [Array<String>] Ideally, this field should contain no more than 12 diagnoses. However, more
2366
- # diagnoses
2367
- # may be submitted at this time, and coders will later prioritize the 12 that will
2368
- # be
2369
- # submitted to the payor.
2370
- # @param tag_ids [Array<String>] Names of tags that should be on the encounter. Note all tags on encounter will
2341
+ # @param tag_ids [Array<String>] Names of tags that should be on the encounter. Note all tags on encounter will
2371
2342
  # be overridden with this list.
2372
2343
  # @param clinical_notes [Array<Hash>] Holds a collection of clinical observations made by healthcare providers during
2373
2344
  # patient encounters.Request of type Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>, as a Hash
@@ -2388,9 +2359,6 @@ module CandidApiClient
2388
2359
  # SELF_PAY if you intend to bill self pay/cash pay.
2389
2360
  # @param provider_accepts_assignment [Boolean] Whether you have accepted the patient's authorization for insurance payments to
2390
2361
  # be made to you, not them. Box 27 on the CMS-1500 claim form.
2391
- # @param benefits_assigned_to_provider [Boolean] Whether this patient has authorized insurance payments to be made to you, not
2392
- # them. If false, patient may receive reimbursement. Box 13 on the CMS-1500 claim
2393
- # form.
2394
2362
  # @param synchronicity [CandidApiClient::Encounters::V4::Types::SynchronicityType] Whether or not this was a synchronous or asynchronous encounter. Asynchronous
2395
2363
  # encounters occur when providers and patients communicate online using forms,
2396
2364
  # instant messaging, or other pre-recorded digital mediums. Synchronous encounters
@@ -2399,9 +2367,6 @@ module CandidApiClient
2399
2367
  # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
2400
2368
  # telemedicine, 11 for in-person. Full list
2401
2369
  # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
2402
- # @param place_of_service_code_as_submitted [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
2403
- # telemedicine, 11 for in-person. Full list
2404
- # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
2405
2370
  # @param appointment_type [String] Human-readable description of the appointment type (ex: "Acupuncture -
2406
2371
  # Headaches").
2407
2372
  # @param end_date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
@@ -2466,29 +2431,29 @@ module CandidApiClient
2466
2431
  # * :gender (CandidApiClient::Individual::Types::Gender)
2467
2432
  # @param additional_information [String] Defines additional information on the claim needed by the payer.
2468
2433
  # Box 19 on the CMS-1500 claim form.
2469
- # @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
2434
+ # @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF\*4N
2470
2435
  # Required when mandated by government law or regulation to obtain authorization
2471
2436
  # for specific service(s) but, for the
2472
2437
  # reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
2473
2438
  # the service was performed without
2474
2439
  # obtaining the authorization.
2475
- # @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
2440
+ # @param admission_date [Date] 837p Loop2300 DTP\*435, CMS-1500 Box 18
2476
2441
  # Required on all ambulance claims when the patient was known to be admitted to
2477
2442
  # the hospital.
2478
2443
  # OR
2479
2444
  # Required on all claims involving inpatient medical visits.
2480
- # @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
2445
+ # @param discharge_date [Date] 837p Loop2300 DTP\*096, CMS-1500 Box 18
2481
2446
  # Required for inpatient claims when the patient was discharged from the facility
2482
2447
  # and the discharge date is known.
2483
- # @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
2448
+ # @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP\*431, CMS-1500 Box 14
2484
2449
  # Required for the initial medical service or visit performed in response to a
2485
2450
  # medical emergency when the date is available and is different than the date of
2486
2451
  # service.
2487
2452
  # OR
2488
2453
  # This date is the onset of acute symptoms for the current illness or condition.
2489
- # @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
2454
+ # @param last_menstrual_period_date [Date] 837p Loop2300 DTP\*484, CMS-1500 Box 14
2490
2455
  # Required when, in the judgment of the provider, the services on this claim are
2491
- # related to the patient's pregnancy.
2456
+ # related to the patient's pregnancy.de
2492
2457
  # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
2493
2458
  # Code indicating the reason why a request was delayed
2494
2459
  # @param patient [Hash] Contains the identification information of the individual receiving medical
@@ -2612,6 +2577,7 @@ module CandidApiClient
2612
2577
  # * :tax_id (String)
2613
2578
  # * :npi (String)
2614
2579
  # * :taxonomy_code (String)
2580
+ # * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
2615
2581
  # * :first_name (String)
2616
2582
  # * :last_name (String)
2617
2583
  # * :organization_name (String)
@@ -2662,54 +2628,28 @@ module CandidApiClient
2662
2628
  # * :first_name (String)
2663
2629
  # * :last_name (String)
2664
2630
  # * :organization_name (String)
2665
- # @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
2631
+ # @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
2632
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
2633
+ # @param _field_set [Object]
2634
+ # @param diagnosis_ids [Array<String>] Ideally, this field should contain no more than 12 diagnoses. However, more
2635
+ # diagnoses
2636
+ # may be submitted at this time, and coders will later prioritize the 12 that will
2637
+ # be
2638
+ # submitted to the payor.
2639
+ # @param place_of_service_code_as_submitted [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
2640
+ # telemedicine, 11 for in-person. Full list
2641
+ # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
2666
2642
  # @param request_options [CandidApiClient::RequestOptions]
2667
2643
  # @return [CandidApiClient::Encounters::V4::Types::Encounter]
2668
2644
  # @example
2669
2645
  # api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
2670
2646
  # api.encounters.v_4.update(
2671
2647
  # encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
2672
- # prior_authorization_number: "string",
2673
- # external_id: "string",
2674
- # date_of_service: DateTime.parse(2023-01-15),
2675
2648
  # diagnosis_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
2676
- # tag_ids: ["string"],
2677
- # clinical_notes: [{ category: CLINICAL, notes: [{ text: "string", author_name: "string", author_npi: "string", timestamp: DateTime.parse(2024-01-15T09:30:00.000Z) }] }],
2678
- # pay_to_address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" },
2679
- # billable_status: BILLABLE,
2680
- # responsible_party: INSURANCE_PAY,
2681
- # provider_accepts_assignment: true,
2682
- # benefits_assigned_to_provider: true,
2683
- # synchronicity: SYNCHRONOUS,
2684
- # place_of_service_code: PHARMACY,
2685
- # place_of_service_code_as_submitted: PHARMACY,
2686
- # appointment_type: "string",
2687
- # end_date_of_service: DateTime.parse(2023-01-15),
2688
- # subscriber_primary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string", rx_bin: "string", rx_pcn: "string", image_url_front: "string", image_url_back: "string", emr_payer_crosswalk: HEALTHIE, group_number: "string", plan_name: "string", plan_type: SELF_PAY, insurance_type: C_01 }, patient_relationship_to_subscriber_code: SPOUSE, date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
2689
- # subscriber_secondary: { insurance_card: { member_id: "string", payer_name: "string", payer_id: "string", rx_bin: "string", rx_pcn: "string", image_url_front: "string", image_url_back: "string", emr_payer_crosswalk: HEALTHIE, group_number: "string", plan_name: "string", plan_type: SELF_PAY, insurance_type: C_01 }, patient_relationship_to_subscriber_code: SPOUSE, date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", gender: MALE },
2690
- # additional_information: "string",
2691
- # service_authorization_exception_code: C_1,
2692
- # admission_date: DateTime.parse(2023-01-15),
2693
- # discharge_date: DateTime.parse(2023-01-15),
2694
- # onset_of_current_illness_or_symptom_date: DateTime.parse(2023-01-15),
2695
- # last_menstrual_period_date: DateTime.parse(2023-01-15),
2696
- # delay_reason_code: C_1,
2697
- # patient: { first_name: "string", last_name: "string", gender: MALE, external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, non_insurance_payers: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], non_insurance_payers_info: [{ non_insurance_payer_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", member_id: "string" }] },
2698
- # patient_authorized_release: true,
2699
- # schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
2700
- # vitals: { height_in: 70, weight_lbs: 165, blood_pressure_systolic_mmhg: 115, blood_pressure_diastolic_mmhg: 85, body_temperature_f: 98, hemoglobin_gdl: 15.1, hematocrit_pct: 51.2 },
2701
- # existing_medications: [{ name: "Lisinopril", rx_cui: "860975", dosage: "10mg", dosage_form: "Tablet", frequency: "Once Daily", as_needed: true }],
2702
- # rendering_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
2703
- # service_facility: { organization_name: "Test Organization", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
2704
- # guarantor: { first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true },
2705
- # billing_provider: { address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, tax_id: "string", npi: "string", taxonomy_code: "string", first_name: "string", last_name: "string", organization_name: "string" },
2706
- # supervising_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
2707
- # referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, first_name: "string", last_name: "string", organization_name: "string" },
2708
- # initial_referring_provider: { npi: "string", taxonomy_code: "string", address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, qualifier: DQ, first_name: "string", last_name: "string", organization_name: "string" },
2709
- # referral_number: "string"
2649
+ # place_of_service_code_as_submitted: PHARMACY
2710
2650
  # )
2711
- def update(encounter_id:, prior_authorization_number: nil, external_id: nil, date_of_service: nil,
2712
- diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, place_of_service_code_as_submitted: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, patient: nil, patient_authorized_release: nil, schema_instances: nil, vitals: nil, existing_medications: nil, rendering_provider: nil, service_facility: nil, guarantor: nil, billing_provider: nil, supervising_provider: nil, referring_provider: nil, initial_referring_provider: nil, referral_number: nil, request_options: nil)
2651
+ def update(encounter_id:, benefits_assigned_to_provider: nil, prior_authorization_number: nil,
2652
+ external_id: nil, date_of_service: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, synchronicity: nil, place_of_service_code: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, patient: nil, patient_authorized_release: nil, schema_instances: nil, vitals: nil, existing_medications: nil, rendering_provider: nil, service_facility: nil, guarantor: nil, billing_provider: nil, supervising_provider: nil, referring_provider: nil, initial_referring_provider: nil, referral_number: nil, additional_properties: nil, _field_set: nil, diagnosis_ids: nil, place_of_service_code_as_submitted: nil, request_options: nil)
2713
2653
  Async do
2714
2654
  response = @request_client.conn.patch do |req|
2715
2655
  req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -2721,20 +2661,18 @@ module CandidApiClient
2721
2661
  }.compact
2722
2662
  req.body = {
2723
2663
  **(request_options&.additional_body_parameters || {}),
2664
+ benefits_assigned_to_provider: benefits_assigned_to_provider,
2724
2665
  prior_authorization_number: prior_authorization_number,
2725
2666
  external_id: external_id,
2726
2667
  date_of_service: date_of_service,
2727
- diagnosis_ids: diagnosis_ids,
2728
2668
  tag_ids: tag_ids,
2729
2669
  clinical_notes: clinical_notes,
2730
2670
  pay_to_address: pay_to_address,
2731
2671
  billable_status: billable_status,
2732
2672
  responsible_party: responsible_party,
2733
2673
  provider_accepts_assignment: provider_accepts_assignment,
2734
- benefits_assigned_to_provider: benefits_assigned_to_provider,
2735
2674
  synchronicity: synchronicity,
2736
2675
  place_of_service_code: place_of_service_code,
2737
- place_of_service_code_as_submitted: place_of_service_code_as_submitted,
2738
2676
  appointment_type: appointment_type,
2739
2677
  end_date_of_service: end_date_of_service,
2740
2678
  subscriber_primary: subscriber_primary,
@@ -2758,7 +2696,11 @@ module CandidApiClient
2758
2696
  supervising_provider: supervising_provider,
2759
2697
  referring_provider: referring_provider,
2760
2698
  initial_referring_provider: initial_referring_provider,
2761
- referral_number: referral_number
2699
+ referral_number: referral_number,
2700
+ additional_properties: additional_properties,
2701
+ _field_set: _field_set,
2702
+ diagnosis_ids: diagnosis_ids,
2703
+ place_of_service_code_as_submitted: place_of_service_code_as_submitted
2762
2704
  }.compact
2763
2705
  req.url "#{@request_client.get_url(environment: CandidApi,
2764
2706
  request_options: request_options)}/api/encounters/v4/#{encounter_id}"