candidhealth 0.45.0 → 0.46.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.
- checksums.yaml +4 -4
- data/lib/candidhealth/billing_notes/v_2/client.rb +2 -2
- data/lib/candidhealth/charge_capture/v_1/client.rb +10 -94
- data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +16 -16
- data/lib/candidhealth/charge_capture_bundles/v_1/client.rb +2 -44
- data/lib/candidhealth/contracts/v_2/client.rb +18 -34
- data/lib/candidhealth/contracts/v_2/types/contract_sort_field.rb +18 -0
- data/lib/candidhealth/credentialing/v_2/client.rb +6 -44
- data/lib/candidhealth/diagnoses/client.rb +4 -14
- data/lib/candidhealth/eligibility/v_2/client.rb +4 -4
- data/lib/candidhealth/encounter_attachments/v_1/client.rb +0 -6
- data/lib/candidhealth/encounter_providers/v_2/client.rb +16 -16
- data/lib/candidhealth/encounters/v_4/client.rb +38 -102
- data/lib/candidhealth/encounters/v_4/types/encounter.rb +12 -12
- data/lib/candidhealth/encounters/v_4/types/encounter_base.rb +10 -10
- data/lib/candidhealth/encounters/v_4/types/encounter_create_from_pre_encounter.rb +10 -10
- data/lib/candidhealth/encounters/v_4/types/encounter_optional.rb +14 -14
- data/lib/candidhealth/expected_network_status/v_1/client.rb +12 -18
- data/lib/candidhealth/expected_network_status/v_2/client.rb +4 -4
- data/lib/candidhealth/expected_network_status/v_2/types/empty_object.rb +53 -0
- data/lib/candidhealth/expected_network_status/v_2/types/insurance_type_codes.rb +13 -10
- data/lib/candidhealth/external_payment_account_config/v_1/client.rb +2 -2
- data/lib/candidhealth/fee_schedules/v_3/client.rb +12 -68
- data/lib/candidhealth/fee_schedules/v_3/types/payer_threshold.rb +3 -3
- data/lib/candidhealth/fee_schedules/v_3/types/rate_entry.rb +2 -2
- data/lib/candidhealth/guarantor/v_1/client.rb +4 -4
- data/lib/candidhealth/import_invoice/v_1/client.rb +6 -28
- data/lib/candidhealth/insurance_adjudications/v_1/client.rb +2 -2
- data/lib/candidhealth/insurance_payments/v_1/client.rb +2 -20
- data/lib/candidhealth/insurance_refunds/v_1/client.rb +6 -24
- data/lib/candidhealth/medication_dispense/v_1/client.rb +2 -2
- data/lib/candidhealth/non_insurance_payer_payments/v_1/client.rb +6 -22
- data/lib/candidhealth/non_insurance_payer_refunds/v_1/client.rb +6 -22
- data/lib/candidhealth/non_insurance_payers/v_1/client.rb +6 -22
- data/lib/candidhealth/organization_providers/v_3/client.rb +4 -4
- data/lib/candidhealth/organization_service_facilities/v_2/client.rb +2 -2
- data/lib/candidhealth/patient_payments/v_4/client.rb +8 -38
- data/lib/candidhealth/patient_refunds/v_1/client.rb +8 -40
- data/lib/candidhealth/payer_plan_groups/v_1/client.rb +6 -30
- data/lib/candidhealth/pre_encounter/appointments/v_1/client.rb +32 -44
- data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb +4 -4
- data/lib/candidhealth/pre_encounter/common/types/base_model.rb +4 -4
- data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +24 -34
- data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb +4 -4
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb +2 -2
- data/lib/candidhealth/pre_encounter/images/v_1/client.rb +20 -20
- data/lib/candidhealth/pre_encounter/images/v_1/types/image.rb +6 -6
- data/lib/candidhealth/pre_encounter/lists/v_1/client.rb +4 -28
- data/lib/candidhealth/pre_encounter/notes/v_1/client.rb +14 -14
- data/lib/candidhealth/pre_encounter/notes/v_1/types/note.rb +4 -4
- data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +56 -68
- data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb +8 -8
- data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb +8 -8
- data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb +16 -16
- data/lib/candidhealth/pre_encounter/tags/v_1/client.rb +16 -16
- data/lib/candidhealth/pre_encounter/tags/v_1/types/tag.rb +4 -4
- data/lib/candidhealth/service_facility/client.rb +2 -2
- data/lib/candidhealth/service_lines/v_2/client.rb +4 -4
- data/lib/candidhealth/superbills/v_1/client.rb +4 -6
- data/lib/candidhealth/tasks/v_3/client.rb +6 -34
- data/lib/candidhealth/write_offs/v_1/client.rb +2 -24
- data/lib/environment.rb +4 -0
- data/lib/requests.rb +2 -2
- data/lib/types_export.rb +2 -0
- metadata +4 -2
|
@@ -235,27 +235,27 @@ module CandidApiClient
|
|
|
235
235
|
# billing the responsible_party.
|
|
236
236
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
|
237
237
|
# Box 19 on the CMS-1500 claim form.
|
|
238
|
-
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
238
|
+
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
239
239
|
# Required when mandated by government law or regulation to obtain authorization
|
|
240
240
|
# for specific service(s) but, for the
|
|
241
241
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
242
242
|
# the service was performed without
|
|
243
243
|
# obtaining the authorization.
|
|
244
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
|
244
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
245
245
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
246
246
|
# the hospital.
|
|
247
247
|
# OR
|
|
248
248
|
# Required on all claims involving inpatient medical visits.
|
|
249
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
|
249
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
250
250
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
251
251
|
# and the discharge date is known.
|
|
252
|
-
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP
|
|
252
|
+
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
253
253
|
# Required for the initial medical service or visit performed in response to a
|
|
254
254
|
# medical emergency when the date is available and is different than the date of
|
|
255
255
|
# service.
|
|
256
256
|
# OR
|
|
257
257
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
258
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
|
258
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
259
259
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
260
260
|
# related to the patient's pregnancy.
|
|
261
261
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|
|
@@ -583,32 +583,12 @@ module CandidApiClient
|
|
|
583
583
|
# @example
|
|
584
584
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
585
585
|
# api.encounters.v_4.create(
|
|
586
|
-
# patient: {
|
|
587
|
-
# billing_provider: { address: { address_1: "
|
|
588
|
-
# rendering_provider: { npi: "
|
|
589
|
-
# 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" },
|
|
590
|
-
# 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" },
|
|
591
|
-
# 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" },
|
|
592
|
-
# 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" }, secondary_identification: "string" },
|
|
593
|
-
# 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, payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, 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 },
|
|
594
|
-
# 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, payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, 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 },
|
|
595
|
-
# subscriber_tertiary: { 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, payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, 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 },
|
|
596
|
-
# prior_authorization_number: "string",
|
|
586
|
+
# patient: { first_name: "first_name", last_name: "last_name", gender: MALE, external_id: "external_id", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "address1", city: "city", state: AA, zip_code: "zip_code" } },
|
|
587
|
+
# billing_provider: { address: { address_1: "address1", city: "city", state: AA, zip_code: "zip_code", zip_plus_four_code: "zip_plus_four_code" }, tax_id: "tax_id", npi: "npi" },
|
|
588
|
+
# rendering_provider: { npi: "npi" },
|
|
597
589
|
# responsible_party: INSURANCE_PAY,
|
|
598
|
-
# diagnoses: [{
|
|
599
|
-
#
|
|
600
|
-
# billing_notes: [{ text: "string" }],
|
|
601
|
-
# place_of_service_code: PHARMACY,
|
|
602
|
-
# 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" }] }] }] }],
|
|
603
|
-
# service_lines: [{ procedure_code: "string", quantity: "string", units: MJ, diagnosis_pointers: }],
|
|
604
|
-
# 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" } },
|
|
605
|
-
# 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 }] },
|
|
606
|
-
# tag_ids: ["string"],
|
|
607
|
-
# schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
|
|
608
|
-
# referral_number: "string",
|
|
609
|
-
# epsdt_referral: { condition_indicator_1: AV, condition_indicator_2: AV, condition_indicator_3: AV },
|
|
610
|
-
# claim_supplemental_information: [{ attachment_report_type_code: C_03, attachment_transmission_code: CBM }],
|
|
611
|
-
# secondary_payer_carrier_code: "string"
|
|
590
|
+
# diagnoses: [{ code_type: ABF, code: "code" }, { code_type: ABF, code: "code" }],
|
|
591
|
+
# place_of_service_code: PHARMACY
|
|
612
592
|
# )
|
|
613
593
|
def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
|
|
614
594
|
provider_accepts_assignment:, billable_status:, patient:, billing_provider:, rendering_provider:, responsible_party:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: 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, additional_properties: nil, _field_set: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, subscriber_tertiary: nil, prior_authorization_number: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, referral_number: nil, epsdt_referral: nil, claim_supplemental_information: nil, secondary_payer_carrier_code: nil, request_options: nil)
|
|
@@ -815,7 +795,7 @@ module CandidApiClient
|
|
|
815
795
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
|
816
796
|
# @example
|
|
817
797
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
818
|
-
# api.encounters.v_4.create_from_pre_encounter_patient(request: {
|
|
798
|
+
# api.encounters.v_4.create_from_pre_encounter_patient(request: { external_id: "external_id", patient_authorized_release: true, benefits_assigned_to_provider: true, provider_accepts_assignment: true, billable_status: BILLABLE, pre_encounter_patient_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", pre_encounter_appointment_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], billing_provider: { address: { address_1: "address1", city: "city", state: AA, zip_code: "zip_code", zip_plus_four_code: "zip_plus_four_code" }, tax_id: "tax_id", npi: "npi" }, rendering_provider: { npi: "npi" }, diagnoses: [{ code_type: ABF, code: "code" }, { code_type: ABF, code: "code" }], place_of_service_code: PHARMACY })
|
|
819
799
|
def create_from_pre_encounter_patient(request:, request_options: nil)
|
|
820
800
|
response = @request_client.conn.post do |req|
|
|
821
801
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -848,7 +828,7 @@ module CandidApiClient
|
|
|
848
828
|
# date_of_service will fail. If all service line date_of_service values are the
|
|
849
829
|
# same, updating the encounter's date_of_service will update all service line
|
|
850
830
|
# date_of_service values.
|
|
851
|
-
# @param tag_ids [Array<String>] Names of tags that should be on the encounter.
|
|
831
|
+
# @param tag_ids [Array<String>] Names of tags that should be on the encounter. Note all tags on encounter will
|
|
852
832
|
# be overridden with this list.
|
|
853
833
|
# @param clinical_notes [Array<Hash>] Holds a collection of clinical observations made by healthcare providers during
|
|
854
834
|
# patient encounters.Request of type Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>, as a Hash
|
|
@@ -963,27 +943,27 @@ module CandidApiClient
|
|
|
963
943
|
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
964
944
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
|
965
945
|
# Box 19 on the CMS-1500 claim form.
|
|
966
|
-
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
946
|
+
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
967
947
|
# Required when mandated by government law or regulation to obtain authorization
|
|
968
948
|
# for specific service(s) but, for the
|
|
969
949
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
970
950
|
# the service was performed without
|
|
971
951
|
# obtaining the authorization.
|
|
972
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
|
952
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
973
953
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
974
954
|
# the hospital.
|
|
975
955
|
# OR
|
|
976
956
|
# Required on all claims involving inpatient medical visits.
|
|
977
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
|
957
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
978
958
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
979
959
|
# and the discharge date is known.
|
|
980
|
-
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP
|
|
960
|
+
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
981
961
|
# Required for the initial medical service or visit performed in response to a
|
|
982
962
|
# medical emergency when the date is available and is different than the date of
|
|
983
963
|
# service.
|
|
984
964
|
# OR
|
|
985
965
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
986
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
|
966
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
987
967
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
988
968
|
# related to the patient's pregnancy.de
|
|
989
969
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|
|
@@ -1035,7 +1015,7 @@ module CandidApiClient
|
|
|
1035
1015
|
# * :phone_consent (Boolean)
|
|
1036
1016
|
# * :email (String)
|
|
1037
1017
|
# * :email_consent (Boolean)
|
|
1038
|
-
# @param referral_number [String] Refers to REF
|
|
1018
|
+
# @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
|
|
1039
1019
|
# @param epsdt_referral [Hash] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
|
|
1040
1020
|
# 837P formRequest of type CandidApiClient::Encounters::V4::Types::EpsdtReferral, as a Hash
|
|
1041
1021
|
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
@@ -1195,19 +1175,7 @@ module CandidApiClient
|
|
|
1195
1175
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
|
1196
1176
|
# @example
|
|
1197
1177
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1198
|
-
# api.encounters.v_4.update(
|
|
1199
|
-
# encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
|
|
1200
|
-
# 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" },
|
|
1201
|
-
# diagnosis_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
|
|
1202
|
-
# 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" },
|
|
1203
|
-
# 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" },
|
|
1204
|
-
# 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", clinical_trial_info: [{ clinical_trial_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }] }] },
|
|
1205
|
-
# 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" },
|
|
1206
|
-
# 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" } },
|
|
1207
|
-
# 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" },
|
|
1208
|
-
# 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, first_name: "string", last_name: "string", organization_name: "string" },
|
|
1209
|
-
# place_of_service_code_as_submitted: PHARMACY
|
|
1210
|
-
# )
|
|
1178
|
+
# api.encounters.v_4.update(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
1211
1179
|
def update(encounter_id:, benefits_assigned_to_provider: nil, prior_authorization_number: nil,
|
|
1212
1180
|
external_id: nil, date_of_service: nil, tag_ids: nil, clinical_notes: 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, subscriber_tertiary: 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_authorized_release: nil, schema_instances: nil, vitals: nil, existing_medications: nil, guarantor: nil, referral_number: nil, epsdt_referral: nil, claim_supplemental_information: nil, secondary_payer_carrier_code: nil, additional_properties: nil, _field_set: nil, pay_to_address: nil, diagnosis_ids: nil, initial_referring_provider: nil, referring_provider: nil, patient: nil, rendering_provider: nil, service_facility: nil, supervising_provider: nil, billing_provider: nil, place_of_service_code_as_submitted: nil, request_options: nil)
|
|
1213
1181
|
response = @request_client.conn.patch do |req|
|
|
@@ -1460,27 +1428,27 @@ module CandidApiClient
|
|
|
1460
1428
|
# billing the responsible_party.
|
|
1461
1429
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
|
1462
1430
|
# Box 19 on the CMS-1500 claim form.
|
|
1463
|
-
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
1431
|
+
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
1464
1432
|
# Required when mandated by government law or regulation to obtain authorization
|
|
1465
1433
|
# for specific service(s) but, for the
|
|
1466
1434
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
1467
1435
|
# the service was performed without
|
|
1468
1436
|
# obtaining the authorization.
|
|
1469
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
|
1437
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
1470
1438
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
1471
1439
|
# the hospital.
|
|
1472
1440
|
# OR
|
|
1473
1441
|
# Required on all claims involving inpatient medical visits.
|
|
1474
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
|
1442
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
1475
1443
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
1476
1444
|
# and the discharge date is known.
|
|
1477
|
-
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP
|
|
1445
|
+
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
1478
1446
|
# Required for the initial medical service or visit performed in response to a
|
|
1479
1447
|
# medical emergency when the date is available and is different than the date of
|
|
1480
1448
|
# service.
|
|
1481
1449
|
# OR
|
|
1482
1450
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
1483
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
|
1451
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
1484
1452
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
1485
1453
|
# related to the patient's pregnancy.
|
|
1486
1454
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|
|
@@ -1808,32 +1776,12 @@ module CandidApiClient
|
|
|
1808
1776
|
# @example
|
|
1809
1777
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1810
1778
|
# api.encounters.v_4.create(
|
|
1811
|
-
# patient: {
|
|
1812
|
-
# billing_provider: { address: { address_1: "
|
|
1813
|
-
# rendering_provider: { npi: "
|
|
1814
|
-
# 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" },
|
|
1815
|
-
# 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" },
|
|
1816
|
-
# 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" },
|
|
1817
|
-
# 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" }, secondary_identification: "string" },
|
|
1818
|
-
# 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, payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, 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 },
|
|
1819
|
-
# 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, payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, 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 },
|
|
1820
|
-
# subscriber_tertiary: { 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, payer_plan_group_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }, 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 },
|
|
1821
|
-
# prior_authorization_number: "string",
|
|
1779
|
+
# patient: { first_name: "first_name", last_name: "last_name", gender: MALE, external_id: "external_id", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "address1", city: "city", state: AA, zip_code: "zip_code" } },
|
|
1780
|
+
# billing_provider: { address: { address_1: "address1", city: "city", state: AA, zip_code: "zip_code", zip_plus_four_code: "zip_plus_four_code" }, tax_id: "tax_id", npi: "npi" },
|
|
1781
|
+
# rendering_provider: { npi: "npi" },
|
|
1822
1782
|
# responsible_party: INSURANCE_PAY,
|
|
1823
|
-
# diagnoses: [{
|
|
1824
|
-
#
|
|
1825
|
-
# billing_notes: [{ text: "string" }],
|
|
1826
|
-
# place_of_service_code: PHARMACY,
|
|
1827
|
-
# 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" }] }] }] }],
|
|
1828
|
-
# service_lines: [{ procedure_code: "string", quantity: "string", units: MJ, diagnosis_pointers: }],
|
|
1829
|
-
# 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" } },
|
|
1830
|
-
# 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 }] },
|
|
1831
|
-
# tag_ids: ["string"],
|
|
1832
|
-
# schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
|
|
1833
|
-
# referral_number: "string",
|
|
1834
|
-
# epsdt_referral: { condition_indicator_1: AV, condition_indicator_2: AV, condition_indicator_3: AV },
|
|
1835
|
-
# claim_supplemental_information: [{ attachment_report_type_code: C_03, attachment_transmission_code: CBM }],
|
|
1836
|
-
# secondary_payer_carrier_code: "string"
|
|
1783
|
+
# diagnoses: [{ code_type: ABF, code: "code" }, { code_type: ABF, code: "code" }],
|
|
1784
|
+
# place_of_service_code: PHARMACY
|
|
1837
1785
|
# )
|
|
1838
1786
|
def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
|
|
1839
1787
|
provider_accepts_assignment:, billable_status:, patient:, billing_provider:, rendering_provider:, responsible_party:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: 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, additional_properties: nil, _field_set: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, subscriber_tertiary: nil, prior_authorization_number: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, referral_number: nil, epsdt_referral: nil, claim_supplemental_information: nil, secondary_payer_carrier_code: nil, request_options: nil)
|
|
@@ -2042,7 +1990,7 @@ module CandidApiClient
|
|
|
2042
1990
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
|
2043
1991
|
# @example
|
|
2044
1992
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
2045
|
-
# api.encounters.v_4.create_from_pre_encounter_patient(request: {
|
|
1993
|
+
# api.encounters.v_4.create_from_pre_encounter_patient(request: { external_id: "external_id", patient_authorized_release: true, benefits_assigned_to_provider: true, provider_accepts_assignment: true, billable_status: BILLABLE, pre_encounter_patient_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", pre_encounter_appointment_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"], billing_provider: { address: { address_1: "address1", city: "city", state: AA, zip_code: "zip_code", zip_plus_four_code: "zip_plus_four_code" }, tax_id: "tax_id", npi: "npi" }, rendering_provider: { npi: "npi" }, diagnoses: [{ code_type: ABF, code: "code" }, { code_type: ABF, code: "code" }], place_of_service_code: PHARMACY })
|
|
2046
1994
|
def create_from_pre_encounter_patient(request:, request_options: nil)
|
|
2047
1995
|
Async do
|
|
2048
1996
|
response = @request_client.conn.post do |req|
|
|
@@ -2077,7 +2025,7 @@ module CandidApiClient
|
|
|
2077
2025
|
# date_of_service will fail. If all service line date_of_service values are the
|
|
2078
2026
|
# same, updating the encounter's date_of_service will update all service line
|
|
2079
2027
|
# date_of_service values.
|
|
2080
|
-
# @param tag_ids [Array<String>] Names of tags that should be on the encounter.
|
|
2028
|
+
# @param tag_ids [Array<String>] Names of tags that should be on the encounter. Note all tags on encounter will
|
|
2081
2029
|
# be overridden with this list.
|
|
2082
2030
|
# @param clinical_notes [Array<Hash>] Holds a collection of clinical observations made by healthcare providers during
|
|
2083
2031
|
# patient encounters.Request of type Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>, as a Hash
|
|
@@ -2192,27 +2140,27 @@ module CandidApiClient
|
|
|
2192
2140
|
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
2193
2141
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
|
2194
2142
|
# Box 19 on the CMS-1500 claim form.
|
|
2195
|
-
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
2143
|
+
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
2196
2144
|
# Required when mandated by government law or regulation to obtain authorization
|
|
2197
2145
|
# for specific service(s) but, for the
|
|
2198
2146
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
2199
2147
|
# the service was performed without
|
|
2200
2148
|
# obtaining the authorization.
|
|
2201
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
|
2149
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
2202
2150
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
2203
2151
|
# the hospital.
|
|
2204
2152
|
# OR
|
|
2205
2153
|
# Required on all claims involving inpatient medical visits.
|
|
2206
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
|
2154
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
2207
2155
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
2208
2156
|
# and the discharge date is known.
|
|
2209
|
-
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP
|
|
2157
|
+
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
2210
2158
|
# Required for the initial medical service or visit performed in response to a
|
|
2211
2159
|
# medical emergency when the date is available and is different than the date of
|
|
2212
2160
|
# service.
|
|
2213
2161
|
# OR
|
|
2214
2162
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
2215
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
|
2163
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
2216
2164
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
2217
2165
|
# related to the patient's pregnancy.de
|
|
2218
2166
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|
|
@@ -2264,7 +2212,7 @@ module CandidApiClient
|
|
|
2264
2212
|
# * :phone_consent (Boolean)
|
|
2265
2213
|
# * :email (String)
|
|
2266
2214
|
# * :email_consent (Boolean)
|
|
2267
|
-
# @param referral_number [String] Refers to REF
|
|
2215
|
+
# @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
|
|
2268
2216
|
# @param epsdt_referral [Hash] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
|
|
2269
2217
|
# 837P formRequest of type CandidApiClient::Encounters::V4::Types::EpsdtReferral, as a Hash
|
|
2270
2218
|
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
@@ -2424,19 +2372,7 @@ module CandidApiClient
|
|
|
2424
2372
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
|
2425
2373
|
# @example
|
|
2426
2374
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
2427
|
-
# api.encounters.v_4.update(
|
|
2428
|
-
# encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
|
|
2429
|
-
# 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" },
|
|
2430
|
-
# diagnosis_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
|
|
2431
|
-
# 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" },
|
|
2432
|
-
# 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" },
|
|
2433
|
-
# 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", clinical_trial_info: [{ clinical_trial_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }] }] },
|
|
2434
|
-
# 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" },
|
|
2435
|
-
# 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" } },
|
|
2436
|
-
# 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" },
|
|
2437
|
-
# 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, first_name: "string", last_name: "string", organization_name: "string" },
|
|
2438
|
-
# place_of_service_code_as_submitted: PHARMACY
|
|
2439
|
-
# )
|
|
2375
|
+
# api.encounters.v_4.update(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
2440
2376
|
def update(encounter_id:, benefits_assigned_to_provider: nil, prior_authorization_number: nil,
|
|
2441
2377
|
external_id: nil, date_of_service: nil, tag_ids: nil, clinical_notes: 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, subscriber_tertiary: 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_authorized_release: nil, schema_instances: nil, vitals: nil, existing_medications: nil, guarantor: nil, referral_number: nil, epsdt_referral: nil, claim_supplemental_information: nil, secondary_payer_carrier_code: nil, additional_properties: nil, _field_set: nil, pay_to_address: nil, diagnosis_ids: nil, initial_referring_provider: nil, referring_provider: nil, patient: nil, rendering_provider: nil, service_facility: nil, supervising_provider: nil, billing_provider: nil, place_of_service_code_as_submitted: nil, request_options: nil)
|
|
2442
2378
|
Async do
|
|
@@ -145,7 +145,7 @@ module CandidApiClient
|
|
|
145
145
|
# Multiple schema
|
|
146
146
|
# instances cannot be created for the same schema on an encounter.
|
|
147
147
|
attr_reader :schema_instances
|
|
148
|
-
# @return [String] Refers to REF
|
|
148
|
+
# @return [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
|
|
149
149
|
attr_reader :referral_number
|
|
150
150
|
# @return [CandidApiClient::Encounters::V4::Types::EpsdtReferral] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
|
|
151
151
|
# 837P form
|
|
@@ -221,31 +221,31 @@ module CandidApiClient
|
|
|
221
221
|
# @return [String] Defines additional information on the claim needed by the payer.
|
|
222
222
|
# Box 19 on the CMS-1500 claim form.
|
|
223
223
|
attr_reader :additional_information
|
|
224
|
-
# @return [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
224
|
+
# @return [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
225
225
|
# Required when mandated by government law or regulation to obtain authorization
|
|
226
226
|
# for specific service(s) but, for the
|
|
227
227
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
228
228
|
# the service was performed without
|
|
229
229
|
# obtaining the authorization.
|
|
230
230
|
attr_reader :service_authorization_exception_code
|
|
231
|
-
# @return [Date] 837p Loop2300 DTP
|
|
231
|
+
# @return [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
232
232
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
233
233
|
# the hospital.
|
|
234
234
|
# OR
|
|
235
235
|
# Required on all claims involving inpatient medical visits.
|
|
236
236
|
attr_reader :admission_date
|
|
237
|
-
# @return [Date] 837p Loop2300 DTP
|
|
237
|
+
# @return [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
238
238
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
239
239
|
# and the discharge date is known.
|
|
240
240
|
attr_reader :discharge_date
|
|
241
|
-
# @return [Date] 837p Loop2300 DTP
|
|
241
|
+
# @return [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
242
242
|
# Required for the initial medical service or visit performed in response to a
|
|
243
243
|
# medical emergency when the date is available and is different than the date of
|
|
244
244
|
# service.
|
|
245
245
|
# OR
|
|
246
246
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
247
247
|
attr_reader :onset_of_current_illness_or_symptom_date
|
|
248
|
-
# @return [Date] 837p Loop2300 DTP
|
|
248
|
+
# @return [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
249
249
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
250
250
|
# related to the patient's pregnancy.
|
|
251
251
|
attr_reader :last_menstrual_period_date
|
|
@@ -337,7 +337,7 @@ module CandidApiClient
|
|
|
337
337
|
# @param schema_instances [Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>] Key-value pairs that must adhere to a schema created via the Custom Schema API.
|
|
338
338
|
# Multiple schema
|
|
339
339
|
# instances cannot be created for the same schema on an encounter.
|
|
340
|
-
# @param referral_number [String] Refers to REF
|
|
340
|
+
# @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
|
|
341
341
|
# @param epsdt_referral [CandidApiClient::Encounters::V4::Types::EpsdtReferral] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
|
|
342
342
|
# 837P form
|
|
343
343
|
# @param claim_supplemental_information [Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>] Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are
|
|
@@ -393,27 +393,27 @@ module CandidApiClient
|
|
|
393
393
|
# billing the responsible_party.
|
|
394
394
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
|
395
395
|
# Box 19 on the CMS-1500 claim form.
|
|
396
|
-
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
396
|
+
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
397
397
|
# Required when mandated by government law or regulation to obtain authorization
|
|
398
398
|
# for specific service(s) but, for the
|
|
399
399
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
400
400
|
# the service was performed without
|
|
401
401
|
# obtaining the authorization.
|
|
402
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
|
402
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
403
403
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
404
404
|
# the hospital.
|
|
405
405
|
# OR
|
|
406
406
|
# Required on all claims involving inpatient medical visits.
|
|
407
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
|
407
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
408
408
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
409
409
|
# and the discharge date is known.
|
|
410
|
-
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP
|
|
410
|
+
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
411
411
|
# Required for the initial medical service or visit performed in response to a
|
|
412
412
|
# medical emergency when the date is available and is different than the date of
|
|
413
413
|
# service.
|
|
414
414
|
# OR
|
|
415
415
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
416
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
|
416
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
417
417
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
418
418
|
# related to the patient's pregnancy.
|
|
419
419
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|
|
@@ -78,31 +78,31 @@ module CandidApiClient
|
|
|
78
78
|
# @return [String] Defines additional information on the claim needed by the payer.
|
|
79
79
|
# Box 19 on the CMS-1500 claim form.
|
|
80
80
|
attr_reader :additional_information
|
|
81
|
-
# @return [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
81
|
+
# @return [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
82
82
|
# Required when mandated by government law or regulation to obtain authorization
|
|
83
83
|
# for specific service(s) but, for the
|
|
84
84
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
85
85
|
# the service was performed without
|
|
86
86
|
# obtaining the authorization.
|
|
87
87
|
attr_reader :service_authorization_exception_code
|
|
88
|
-
# @return [Date] 837p Loop2300 DTP
|
|
88
|
+
# @return [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
89
89
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
90
90
|
# the hospital.
|
|
91
91
|
# OR
|
|
92
92
|
# Required on all claims involving inpatient medical visits.
|
|
93
93
|
attr_reader :admission_date
|
|
94
|
-
# @return [Date] 837p Loop2300 DTP
|
|
94
|
+
# @return [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
95
95
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
96
96
|
# and the discharge date is known.
|
|
97
97
|
attr_reader :discharge_date
|
|
98
|
-
# @return [Date] 837p Loop2300 DTP
|
|
98
|
+
# @return [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
99
99
|
# Required for the initial medical service or visit performed in response to a
|
|
100
100
|
# medical emergency when the date is available and is different than the date of
|
|
101
101
|
# service.
|
|
102
102
|
# OR
|
|
103
103
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
104
104
|
attr_reader :onset_of_current_illness_or_symptom_date
|
|
105
|
-
# @return [Date] 837p Loop2300 DTP
|
|
105
|
+
# @return [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
106
106
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
107
107
|
# related to the patient's pregnancy.
|
|
108
108
|
attr_reader :last_menstrual_period_date
|
|
@@ -164,27 +164,27 @@ module CandidApiClient
|
|
|
164
164
|
# billing the responsible_party.
|
|
165
165
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
|
166
166
|
# Box 19 on the CMS-1500 claim form.
|
|
167
|
-
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
167
|
+
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
168
168
|
# Required when mandated by government law or regulation to obtain authorization
|
|
169
169
|
# for specific service(s) but, for the
|
|
170
170
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
171
171
|
# the service was performed without
|
|
172
172
|
# obtaining the authorization.
|
|
173
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
|
173
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
174
174
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
175
175
|
# the hospital.
|
|
176
176
|
# OR
|
|
177
177
|
# Required on all claims involving inpatient medical visits.
|
|
178
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
|
178
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
179
179
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
180
180
|
# and the discharge date is known.
|
|
181
|
-
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP
|
|
181
|
+
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
182
182
|
# Required for the initial medical service or visit performed in response to a
|
|
183
183
|
# medical emergency when the date is available and is different than the date of
|
|
184
184
|
# service.
|
|
185
185
|
# OR
|
|
186
186
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
187
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
|
187
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
188
188
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
189
189
|
# related to the patient's pregnancy.
|
|
190
190
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|
|
@@ -162,31 +162,31 @@ module CandidApiClient
|
|
|
162
162
|
# @return [String] Defines additional information on the claim needed by the payer.
|
|
163
163
|
# Box 19 on the CMS-1500 claim form.
|
|
164
164
|
attr_reader :additional_information
|
|
165
|
-
# @return [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
165
|
+
# @return [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
166
166
|
# Required when mandated by government law or regulation to obtain authorization
|
|
167
167
|
# for specific service(s) but, for the
|
|
168
168
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
169
169
|
# the service was performed without
|
|
170
170
|
# obtaining the authorization.
|
|
171
171
|
attr_reader :service_authorization_exception_code
|
|
172
|
-
# @return [Date] 837p Loop2300 DTP
|
|
172
|
+
# @return [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
173
173
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
174
174
|
# the hospital.
|
|
175
175
|
# OR
|
|
176
176
|
# Required on all claims involving inpatient medical visits.
|
|
177
177
|
attr_reader :admission_date
|
|
178
|
-
# @return [Date] 837p Loop2300 DTP
|
|
178
|
+
# @return [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
179
179
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
180
180
|
# and the discharge date is known.
|
|
181
181
|
attr_reader :discharge_date
|
|
182
|
-
# @return [Date] 837p Loop2300 DTP
|
|
182
|
+
# @return [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
183
183
|
# Required for the initial medical service or visit performed in response to a
|
|
184
184
|
# medical emergency when the date is available and is different than the date of
|
|
185
185
|
# service.
|
|
186
186
|
# OR
|
|
187
187
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
188
188
|
attr_reader :onset_of_current_illness_or_symptom_date
|
|
189
|
-
# @return [Date] 837p Loop2300 DTP
|
|
189
|
+
# @return [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
190
190
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
191
191
|
# related to the patient's pregnancy.
|
|
192
192
|
attr_reader :last_menstrual_period_date
|
|
@@ -303,27 +303,27 @@ module CandidApiClient
|
|
|
303
303
|
# billing the responsible_party.
|
|
304
304
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
|
305
305
|
# Box 19 on the CMS-1500 claim form.
|
|
306
|
-
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF
|
|
306
|
+
# @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
|
|
307
307
|
# Required when mandated by government law or regulation to obtain authorization
|
|
308
308
|
# for specific service(s) but, for the
|
|
309
309
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
|
310
310
|
# the service was performed without
|
|
311
311
|
# obtaining the authorization.
|
|
312
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
|
312
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
|
313
313
|
# Required on all ambulance claims when the patient was known to be admitted to
|
|
314
314
|
# the hospital.
|
|
315
315
|
# OR
|
|
316
316
|
# Required on all claims involving inpatient medical visits.
|
|
317
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
|
317
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
|
318
318
|
# Required for inpatient claims when the patient was discharged from the facility
|
|
319
319
|
# and the discharge date is known.
|
|
320
|
-
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP
|
|
320
|
+
# @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
|
|
321
321
|
# Required for the initial medical service or visit performed in response to a
|
|
322
322
|
# medical emergency when the date is available and is different than the date of
|
|
323
323
|
# service.
|
|
324
324
|
# OR
|
|
325
325
|
# This date is the onset of acute symptoms for the current illness or condition.
|
|
326
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
|
326
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
|
327
327
|
# Required when, in the judgment of the provider, the services on this claim are
|
|
328
328
|
# related to the patient's pregnancy.
|
|
329
329
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|