candidhealth 0.43.1 → 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 +479 -559
- data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +200 -190
- data/lib/candidhealth/charge_capture_bundles/v_1/client.rb +2 -44
- data/lib/candidhealth/commons/types/street_address_optional_base.rb +99 -0
- data/lib/candidhealth/commons/types/street_address_short_zip_optional.rb +107 -0
- 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/encounter_providers/v_2/types/billing_provider_update_with_optional_address.rb +160 -0
- data/lib/candidhealth/encounter_providers/v_2/types/initial_referring_provider_update_with_optional_address.rb +134 -0
- data/lib/candidhealth/encounter_providers/v_2/types/referring_provider_update_with_optional_address.rb +125 -0
- data/lib/candidhealth/encounter_providers/v_2/types/rendering_provider_update_with_optional_address.rb +125 -0
- data/lib/candidhealth/encounter_providers/v_2/types/supervising_provider_update_with_optional_address.rb +125 -0
- data/lib/candidhealth/encounters/v_4/client.rb +259 -293
- data/lib/candidhealth/encounters/v_4/types/encounter.rb +23 -13
- 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 +26 -184
- 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/individual/types/patient_update_with_optional_address.rb +179 -0
- 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_facility/types/encounter_service_facility_update_with_optional_address.rb +113 -0
- 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 +11 -1
- metadata +13 -3
- data/lib/candidhealth/billing_notes/v_2/types/billing_note_optional.rb +0 -112
@@ -37,15 +37,15 @@ require_relative "../../custom_schemas/v_1/types/schema_instance"
|
|
37
37
|
require_relative "types/epsdt_referral"
|
38
38
|
require_relative "types/claim_supplemental_information"
|
39
39
|
require_relative "types/encounter_create_from_pre_encounter"
|
40
|
-
require_relative "../../individual/types/patient_update"
|
41
40
|
require_relative "types/vitals_update"
|
41
|
+
require_relative "../../guarantor/v_1/types/guarantor_update"
|
42
|
+
require_relative "../../encounter_providers/v_2/types/initial_referring_provider_update"
|
43
|
+
require_relative "../../encounter_providers/v_2/types/referring_provider_update"
|
44
|
+
require_relative "../../individual/types/patient_update"
|
42
45
|
require_relative "../../encounter_providers/v_2/types/rendering_provider_update"
|
43
46
|
require_relative "../../service_facility/types/encounter_service_facility_update"
|
44
|
-
require_relative "../../guarantor/v_1/types/guarantor_update"
|
45
|
-
require_relative "../../encounter_providers/v_2/types/billing_provider_update"
|
46
47
|
require_relative "../../encounter_providers/v_2/types/supervising_provider_update"
|
47
|
-
require_relative "../../encounter_providers/v_2/types/
|
48
|
-
require_relative "../../encounter_providers/v_2/types/initial_referring_provider_update"
|
48
|
+
require_relative "../../encounter_providers/v_2/types/billing_provider_update"
|
49
49
|
require "async"
|
50
50
|
|
51
51
|
module CandidApiClient
|
@@ -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
|
@@ -576,39 +576,22 @@ module CandidApiClient
|
|
576
576
|
# * :attachment_report_type_code (CandidApiClient::Encounters::V4::Types::ReportTypeCode)
|
577
577
|
# * :attachment_transmission_code (CandidApiClient::Encounters::V4::Types::ReportTransmissionCode)
|
578
578
|
# * :attachment_control_number (String)
|
579
|
+
# @param secondary_payer_carrier_code [String] When Medicaid is billed as the secondary payer the Carrier Code is used to
|
580
|
+
# identify the primary payer. This is required for certain states.
|
579
581
|
# @param request_options [CandidApiClient::RequestOptions]
|
580
582
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
581
583
|
# @example
|
582
584
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
583
585
|
# api.encounters.v_4.create(
|
584
|
-
# patient: {
|
585
|
-
# billing_provider: { address: { address_1: "
|
586
|
-
# rendering_provider: { npi: "
|
587
|
-
# 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" },
|
588
|
-
# 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" },
|
589
|
-
# 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" },
|
590
|
-
# 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" },
|
591
|
-
# 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 },
|
592
|
-
# 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 },
|
593
|
-
# 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 },
|
594
|
-
# 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" },
|
595
589
|
# responsible_party: INSURANCE_PAY,
|
596
|
-
# diagnoses: [{
|
597
|
-
#
|
598
|
-
# billing_notes: [{ text: "string" }],
|
599
|
-
# place_of_service_code: PHARMACY,
|
600
|
-
# 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" }] }] }] }],
|
601
|
-
# service_lines: [{ procedure_code: "string", quantity: "string", units: MJ, diagnosis_pointers: }],
|
602
|
-
# 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" } },
|
603
|
-
# 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 }] },
|
604
|
-
# tag_ids: ["string"],
|
605
|
-
# schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
|
606
|
-
# referral_number: "string",
|
607
|
-
# epsdt_referral: { condition_indicator_1: AV, condition_indicator_2: AV, condition_indicator_3: AV },
|
608
|
-
# claim_supplemental_information: [{ attachment_report_type_code: C_03, attachment_transmission_code: CBM }]
|
590
|
+
# diagnoses: [{ code_type: ABF, code: "code" }, { code_type: ABF, code: "code" }],
|
591
|
+
# place_of_service_code: PHARMACY
|
609
592
|
# )
|
610
593
|
def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
|
611
|
-
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, request_options: nil)
|
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)
|
612
595
|
response = @request_client.conn.post do |req|
|
613
596
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
614
597
|
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
@@ -665,7 +648,8 @@ module CandidApiClient
|
|
665
648
|
schema_instances: schema_instances,
|
666
649
|
referral_number: referral_number,
|
667
650
|
epsdt_referral: epsdt_referral,
|
668
|
-
claim_supplemental_information: claim_supplemental_information
|
651
|
+
claim_supplemental_information: claim_supplemental_information,
|
652
|
+
secondary_payer_carrier_code: secondary_payer_carrier_code
|
669
653
|
}.compact
|
670
654
|
req.url "#{@request_client.get_url(environment: CandidApi,
|
671
655
|
request_options: request_options)}/api/encounters/v4"
|
@@ -811,7 +795,7 @@ module CandidApiClient
|
|
811
795
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
812
796
|
# @example
|
813
797
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
814
|
-
# 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 })
|
815
799
|
def create_from_pre_encounter_patient(request:, request_options: nil)
|
816
800
|
response = @request_client.conn.post do |req|
|
817
801
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -844,19 +828,12 @@ module CandidApiClient
|
|
844
828
|
# date_of_service will fail. If all service line date_of_service values are the
|
845
829
|
# same, updating the encounter's date_of_service will update all service line
|
846
830
|
# date_of_service values.
|
847
|
-
# @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
|
848
832
|
# be overridden with this list.
|
849
833
|
# @param clinical_notes [Array<Hash>] Holds a collection of clinical observations made by healthcare providers during
|
850
834
|
# patient encounters.Request of type Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>, as a Hash
|
851
835
|
# * :category (CandidApiClient::Encounters::V4::Types::NoteCategory)
|
852
836
|
# * :notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNote>)
|
853
|
-
# @param pay_to_address [Hash] Specifies the address to which payments for the claim should be sent.Request of type CandidApiClient::Commons::Types::StreetAddressLongZip, as a Hash
|
854
|
-
# * :zip_plus_four_code (String)
|
855
|
-
# * :address_1 (String)
|
856
|
-
# * :address_2 (String)
|
857
|
-
# * :city (String)
|
858
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
859
|
-
# * :zip_code (String)
|
860
837
|
# @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
|
861
838
|
# Examples for when this should be set to NOT_BILLABLE include if the Encounter
|
862
839
|
# has not occurred yet or if there is no intention of ever billing the
|
@@ -966,51 +943,31 @@ module CandidApiClient
|
|
966
943
|
# * :gender (CandidApiClient::Individual::Types::Gender)
|
967
944
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
968
945
|
# Box 19 on the CMS-1500 claim form.
|
969
|
-
# @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
|
970
947
|
# Required when mandated by government law or regulation to obtain authorization
|
971
948
|
# for specific service(s) but, for the
|
972
949
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
973
950
|
# the service was performed without
|
974
951
|
# obtaining the authorization.
|
975
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
952
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
976
953
|
# Required on all ambulance claims when the patient was known to be admitted to
|
977
954
|
# the hospital.
|
978
955
|
# OR
|
979
956
|
# Required on all claims involving inpatient medical visits.
|
980
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
957
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
981
958
|
# Required for inpatient claims when the patient was discharged from the facility
|
982
959
|
# and the discharge date is known.
|
983
|
-
# @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
|
984
961
|
# Required for the initial medical service or visit performed in response to a
|
985
962
|
# medical emergency when the date is available and is different than the date of
|
986
963
|
# service.
|
987
964
|
# OR
|
988
965
|
# This date is the onset of acute symptoms for the current illness or condition.
|
989
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
966
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
990
967
|
# Required when, in the judgment of the provider, the services on this claim are
|
991
968
|
# related to the patient's pregnancy.de
|
992
969
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|
993
970
|
# Code indicating the reason why a request was delayed
|
994
|
-
# @param patient [Hash] Contains the identification information of the individual receiving medical
|
995
|
-
# services.Request of type CandidApiClient::Individual::Types::PatientUpdate, as a Hash
|
996
|
-
# * :first_name (String)
|
997
|
-
# * :last_name (String)
|
998
|
-
# * :gender (CandidApiClient::Individual::Types::Gender)
|
999
|
-
# * :external_id (String)
|
1000
|
-
# * :date_of_birth (Date)
|
1001
|
-
# * :address (Hash)
|
1002
|
-
# * :zip_plus_four_code (String)
|
1003
|
-
# * :address_1 (String)
|
1004
|
-
# * :address_2 (String)
|
1005
|
-
# * :city (String)
|
1006
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
1007
|
-
# * :zip_code (String)
|
1008
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
1009
|
-
# * :phone_consent (Boolean)
|
1010
|
-
# * :email (String)
|
1011
|
-
# * :email_consent (Boolean)
|
1012
|
-
# * :non_insurance_payers (Array<String>)
|
1013
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreate>)
|
1014
971
|
# @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
|
1015
972
|
# for billing purpose.
|
1016
973
|
# Box 12 on the CMS-1500 claim form.
|
@@ -1042,11 +999,54 @@ module CandidApiClient
|
|
1042
999
|
# * :dosage_form (String)
|
1043
1000
|
# * :frequency (String)
|
1044
1001
|
# * :as_needed (Boolean)
|
1045
|
-
# @param
|
1046
|
-
#
|
1047
|
-
#
|
1048
|
-
#
|
1049
|
-
#
|
1002
|
+
# @param guarantor [Hash] Personal and contact info for the guarantor of the patient responsibility.Request of type CandidApiClient::Guarantor::V1::Types::GuarantorUpdate, as a Hash
|
1003
|
+
# * :first_name (String)
|
1004
|
+
# * :last_name (String)
|
1005
|
+
# * :external_id (String)
|
1006
|
+
# * :date_of_birth (Date)
|
1007
|
+
# * :address (Hash)
|
1008
|
+
# * :zip_plus_four_code (String)
|
1009
|
+
# * :address_1 (String)
|
1010
|
+
# * :address_2 (String)
|
1011
|
+
# * :city (String)
|
1012
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
1013
|
+
# * :zip_code (String)
|
1014
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
1015
|
+
# * :phone_consent (Boolean)
|
1016
|
+
# * :email (String)
|
1017
|
+
# * :email_consent (Boolean)
|
1018
|
+
# @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
|
1019
|
+
# @param epsdt_referral [Hash] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
|
1020
|
+
# 837P formRequest of type CandidApiClient::Encounters::V4::Types::EpsdtReferral, as a Hash
|
1021
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1022
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1023
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1024
|
+
# @param claim_supplemental_information [Array<Hash>] Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are
|
1025
|
+
# permitted.Request of type Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>, as a Hash
|
1026
|
+
# * :attachment_report_type_code (CandidApiClient::Encounters::V4::Types::ReportTypeCode)
|
1027
|
+
# * :attachment_transmission_code (CandidApiClient::Encounters::V4::Types::ReportTransmissionCode)
|
1028
|
+
# * :attachment_control_number (String)
|
1029
|
+
# @param secondary_payer_carrier_code [String] When Medicaid is billed as the secondary payer the Carrier Code is used to
|
1030
|
+
# identify the primary payer. This is required for certain states.
|
1031
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
1032
|
+
# @param _field_set [Object]
|
1033
|
+
# @param pay_to_address [Hash] Specifies the address to which payments for the claim should be sent.Request of type CandidApiClient::Commons::Types::StreetAddressLongZip, as a Hash
|
1034
|
+
# * :zip_plus_four_code (String)
|
1035
|
+
# * :address_1 (String)
|
1036
|
+
# * :address_2 (String)
|
1037
|
+
# * :city (String)
|
1038
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
1039
|
+
# * :zip_code (String)
|
1040
|
+
# @param diagnosis_ids [Array<String>] Ideally, this field should contain no more than 12 diagnoses. However, more
|
1041
|
+
# diagnoses
|
1042
|
+
# may be submitted at this time, and coders will later prioritize the 12 that will
|
1043
|
+
# be
|
1044
|
+
# submitted to the payor.
|
1045
|
+
# @param initial_referring_provider [Hash] The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in
|
1046
|
+
# this loop to
|
1047
|
+
# indicate the initial referral from the primary care provider or whatever
|
1048
|
+
# provider wrote the initial referral for this patient's episode of care being
|
1049
|
+
# billed/reported in this transaction.Request of type CandidApiClient::EncounterProviders::V2::Types::InitialReferringProviderUpdate, as a Hash
|
1050
1050
|
# * :npi (String)
|
1051
1051
|
# * :taxonomy_code (String)
|
1052
1052
|
# * :address (Hash)
|
@@ -1056,20 +1056,15 @@ module CandidApiClient
|
|
1056
1056
|
# * :city (String)
|
1057
1057
|
# * :state (CandidApiClient::Commons::Types::State)
|
1058
1058
|
# * :zip_code (String)
|
1059
|
+
# * :qualifier (CandidApiClient::Commons::Types::QualifierCode)
|
1059
1060
|
# * :first_name (String)
|
1060
1061
|
# * :last_name (String)
|
1061
1062
|
# * :organization_name (String)
|
1062
|
-
# @param
|
1063
|
-
#
|
1064
|
-
#
|
1065
|
-
# (e.g., home), or the location where an in-person visit would have taken place,
|
1066
|
-
# whichever is easier to identify. If the provider is in-network, service facility
|
1067
|
-
# may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that
|
1068
|
-
# for an in-network claim to be successfully adjudicated, the service facility
|
1069
|
-
# address listed on claims must match what was provided to the payer during the
|
1070
|
-
# credentialing process.Request of type CandidApiClient::ServiceFacility::Types::EncounterServiceFacilityUpdate, as a Hash
|
1071
|
-
# * :organization_name (String)
|
1063
|
+
# @param referring_provider [Hash] The final provider who referred the services that were rendered.
|
1064
|
+
# All physicians who order services or refer Medicare beneficiaries must
|
1065
|
+
# report this data.Request of type CandidApiClient::EncounterProviders::V2::Types::ReferringProviderUpdate, as a Hash
|
1072
1066
|
# * :npi (String)
|
1067
|
+
# * :taxonomy_code (String)
|
1073
1068
|
# * :address (Hash)
|
1074
1069
|
# * :zip_plus_four_code (String)
|
1075
1070
|
# * :address_1 (String)
|
@@ -1077,10 +1072,14 @@ module CandidApiClient
|
|
1077
1072
|
# * :city (String)
|
1078
1073
|
# * :state (CandidApiClient::Commons::Types::State)
|
1079
1074
|
# * :zip_code (String)
|
1080
|
-
# * :secondary_identification (String)
|
1081
|
-
# @param guarantor [Hash] Personal and contact info for the guarantor of the patient responsibility.Request of type CandidApiClient::Guarantor::V1::Types::GuarantorUpdate, as a Hash
|
1082
1075
|
# * :first_name (String)
|
1083
1076
|
# * :last_name (String)
|
1077
|
+
# * :organization_name (String)
|
1078
|
+
# @param patient [Hash] Contains the identification information of the individual receiving medical
|
1079
|
+
# services.Request of type CandidApiClient::Individual::Types::PatientUpdate, as a Hash
|
1080
|
+
# * :first_name (String)
|
1081
|
+
# * :last_name (String)
|
1082
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
1084
1083
|
# * :external_id (String)
|
1085
1084
|
# * :date_of_birth (Date)
|
1086
1085
|
# * :address (Hash)
|
@@ -1094,15 +1093,15 @@ module CandidApiClient
|
|
1094
1093
|
# * :phone_consent (Boolean)
|
1095
1094
|
# * :email (String)
|
1096
1095
|
# * :email_consent (Boolean)
|
1097
|
-
#
|
1098
|
-
#
|
1099
|
-
#
|
1100
|
-
#
|
1101
|
-
#
|
1102
|
-
#
|
1103
|
-
#
|
1104
|
-
#
|
1105
|
-
#
|
1096
|
+
# * :non_insurance_payers (Array<String>)
|
1097
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreate>)
|
1098
|
+
# @param rendering_provider [Hash] The rendering provider is the practitioner -- physician, nurse practitioner,
|
1099
|
+
# etc. -- performing the service.
|
1100
|
+
# For telehealth services, the rendering provider performs the visit, asynchronous
|
1101
|
+
# communication, or other service. The rendering provider address should generally
|
1102
|
+
# be the same as the service facility address.Request of type CandidApiClient::EncounterProviders::V2::Types::RenderingProviderUpdate, as a Hash
|
1103
|
+
# * :npi (String)
|
1104
|
+
# * :taxonomy_code (String)
|
1106
1105
|
# * :address (Hash)
|
1107
1106
|
# * :zip_plus_four_code (String)
|
1108
1107
|
# * :address_1 (String)
|
@@ -1110,17 +1109,20 @@ module CandidApiClient
|
|
1110
1109
|
# * :city (String)
|
1111
1110
|
# * :state (CandidApiClient::Commons::Types::State)
|
1112
1111
|
# * :zip_code (String)
|
1113
|
-
# * :tax_id (String)
|
1114
|
-
# * :npi (String)
|
1115
|
-
# * :taxonomy_code (String)
|
1116
|
-
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
1117
1112
|
# * :first_name (String)
|
1118
1113
|
# * :last_name (String)
|
1119
1114
|
# * :organization_name (String)
|
1120
|
-
# @param
|
1121
|
-
#
|
1115
|
+
# @param service_facility [Hash] Encounter Service facility is typically the location a medical service was
|
1116
|
+
# rendered, such as a provider office or hospital. For telehealth, service
|
1117
|
+
# facility can represent the provider's location when the service was delivered
|
1118
|
+
# (e.g., home), or the location where an in-person visit would have taken place,
|
1119
|
+
# whichever is easier to identify. If the provider is in-network, service facility
|
1120
|
+
# may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that
|
1121
|
+
# for an in-network claim to be successfully adjudicated, the service facility
|
1122
|
+
# address listed on claims must match what was provided to the payer during the
|
1123
|
+
# credentialing process.Request of type CandidApiClient::ServiceFacility::Types::EncounterServiceFacilityUpdate, as a Hash
|
1124
|
+
# * :organization_name (String)
|
1122
1125
|
# * :npi (String)
|
1123
|
-
# * :taxonomy_code (String)
|
1124
1126
|
# * :address (Hash)
|
1125
1127
|
# * :zip_plus_four_code (String)
|
1126
1128
|
# * :address_1 (String)
|
@@ -1128,12 +1130,9 @@ module CandidApiClient
|
|
1128
1130
|
# * :city (String)
|
1129
1131
|
# * :state (CandidApiClient::Commons::Types::State)
|
1130
1132
|
# * :zip_code (String)
|
1131
|
-
# * :
|
1132
|
-
#
|
1133
|
-
#
|
1134
|
-
# @param referring_provider [Hash] The final provider who referred the services that were rendered.
|
1135
|
-
# All physicians who order services or refer Medicare beneficiaries must
|
1136
|
-
# report this data.Request of type CandidApiClient::EncounterProviders::V2::Types::ReferringProviderUpdate, as a Hash
|
1133
|
+
# * :secondary_identification (String)
|
1134
|
+
# @param supervising_provider [Hash] Required when the rendering provider is supervised by a physician. If not
|
1135
|
+
# required by this implementation guide, do not send.Request of type CandidApiClient::EncounterProviders::V2::Types::SupervisingProviderUpdate, as a Hash
|
1137
1136
|
# * :npi (String)
|
1138
1137
|
# * :taxonomy_code (String)
|
1139
1138
|
# * :address (Hash)
|
@@ -1146,13 +1145,15 @@ module CandidApiClient
|
|
1146
1145
|
# * :first_name (String)
|
1147
1146
|
# * :last_name (String)
|
1148
1147
|
# * :organization_name (String)
|
1149
|
-
# @param
|
1150
|
-
#
|
1151
|
-
#
|
1152
|
-
#
|
1153
|
-
#
|
1154
|
-
#
|
1155
|
-
#
|
1148
|
+
# @param billing_provider [Hash] The billing provider is the provider or business entity submitting the claim.
|
1149
|
+
# Billing provider may be, but is not necessarily, the same person/NPI as the
|
1150
|
+
# rendering provider. From a payer's perspective, this represents the person or
|
1151
|
+
# entity being reimbursed. When a contract exists with the target payer, the
|
1152
|
+
# billing provider should be the entity contracted with the payer. In some
|
1153
|
+
# circumstances, this will be an individual provider. In that case, submit that
|
1154
|
+
# provider's NPI and the tax ID (TIN) that the provider gave to the payer during
|
1155
|
+
# contracting. In other cases, the billing entity will be a medical group. If so,
|
1156
|
+
# submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form.Request of type CandidApiClient::EncounterProviders::V2::Types::BillingProviderUpdate, as a Hash
|
1156
1157
|
# * :address (Hash)
|
1157
1158
|
# * :zip_plus_four_code (String)
|
1158
1159
|
# * :address_1 (String)
|
@@ -1160,28 +1161,13 @@ module CandidApiClient
|
|
1160
1161
|
# * :city (String)
|
1161
1162
|
# * :state (CandidApiClient::Commons::Types::State)
|
1162
1163
|
# * :zip_code (String)
|
1163
|
-
# * :
|
1164
|
+
# * :tax_id (String)
|
1165
|
+
# * :npi (String)
|
1166
|
+
# * :taxonomy_code (String)
|
1167
|
+
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
1164
1168
|
# * :first_name (String)
|
1165
1169
|
# * :last_name (String)
|
1166
1170
|
# * :organization_name (String)
|
1167
|
-
# @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
|
1168
|
-
# @param epsdt_referral [Hash] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
|
1169
|
-
# 837P formRequest of type CandidApiClient::Encounters::V4::Types::EpsdtReferral, as a Hash
|
1170
|
-
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1171
|
-
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1172
|
-
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1173
|
-
# @param claim_supplemental_information [Array<Hash>] Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are
|
1174
|
-
# permitted.Request of type Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>, as a Hash
|
1175
|
-
# * :attachment_report_type_code (CandidApiClient::Encounters::V4::Types::ReportTypeCode)
|
1176
|
-
# * :attachment_transmission_code (CandidApiClient::Encounters::V4::Types::ReportTransmissionCode)
|
1177
|
-
# * :attachment_control_number (String)
|
1178
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
1179
|
-
# @param _field_set [Object]
|
1180
|
-
# @param diagnosis_ids [Array<String>] Ideally, this field should contain no more than 12 diagnoses. However, more
|
1181
|
-
# diagnoses
|
1182
|
-
# may be submitted at this time, and coders will later prioritize the 12 that will
|
1183
|
-
# be
|
1184
|
-
# submitted to the payor.
|
1185
1171
|
# @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
|
1186
1172
|
# telemedicine, 11 for in-person. Full list
|
1187
1173
|
# //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
|
@@ -1189,13 +1175,9 @@ module CandidApiClient
|
|
1189
1175
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
1190
1176
|
# @example
|
1191
1177
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
1192
|
-
# api.encounters.v_4.update(
|
1193
|
-
# encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
|
1194
|
-
# diagnosis_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
|
1195
|
-
# place_of_service_code_as_submitted: PHARMACY
|
1196
|
-
# )
|
1178
|
+
# api.encounters.v_4.update(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
1197
1179
|
def update(encounter_id:, benefits_assigned_to_provider: nil, prior_authorization_number: nil,
|
1198
|
-
external_id: nil, date_of_service: nil, tag_ids: nil, clinical_notes: nil,
|
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)
|
1199
1181
|
response = @request_client.conn.patch do |req|
|
1200
1182
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
1201
1183
|
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
@@ -1212,7 +1194,6 @@ module CandidApiClient
|
|
1212
1194
|
date_of_service: date_of_service,
|
1213
1195
|
tag_ids: tag_ids,
|
1214
1196
|
clinical_notes: clinical_notes,
|
1215
|
-
pay_to_address: pay_to_address,
|
1216
1197
|
billable_status: billable_status,
|
1217
1198
|
responsible_party: responsible_party,
|
1218
1199
|
provider_accepts_assignment: provider_accepts_assignment,
|
@@ -1230,24 +1211,26 @@ module CandidApiClient
|
|
1230
1211
|
onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
|
1231
1212
|
last_menstrual_period_date: last_menstrual_period_date,
|
1232
1213
|
delay_reason_code: delay_reason_code,
|
1233
|
-
patient: patient,
|
1234
1214
|
patient_authorized_release: patient_authorized_release,
|
1235
1215
|
schema_instances: schema_instances,
|
1236
1216
|
vitals: vitals,
|
1237
1217
|
existing_medications: existing_medications,
|
1238
|
-
rendering_provider: rendering_provider,
|
1239
|
-
service_facility: service_facility,
|
1240
1218
|
guarantor: guarantor,
|
1241
|
-
billing_provider: billing_provider,
|
1242
|
-
supervising_provider: supervising_provider,
|
1243
|
-
referring_provider: referring_provider,
|
1244
|
-
initial_referring_provider: initial_referring_provider,
|
1245
1219
|
referral_number: referral_number,
|
1246
1220
|
epsdt_referral: epsdt_referral,
|
1247
1221
|
claim_supplemental_information: claim_supplemental_information,
|
1222
|
+
secondary_payer_carrier_code: secondary_payer_carrier_code,
|
1248
1223
|
additional_properties: additional_properties,
|
1249
1224
|
_field_set: _field_set,
|
1225
|
+
pay_to_address: pay_to_address,
|
1250
1226
|
diagnosis_ids: diagnosis_ids,
|
1227
|
+
initial_referring_provider: initial_referring_provider,
|
1228
|
+
referring_provider: referring_provider,
|
1229
|
+
patient: patient,
|
1230
|
+
rendering_provider: rendering_provider,
|
1231
|
+
service_facility: service_facility,
|
1232
|
+
supervising_provider: supervising_provider,
|
1233
|
+
billing_provider: billing_provider,
|
1251
1234
|
place_of_service_code_as_submitted: place_of_service_code_as_submitted
|
1252
1235
|
}.compact
|
1253
1236
|
req.url "#{@request_client.get_url(environment: CandidApi,
|
@@ -1445,27 +1428,27 @@ module CandidApiClient
|
|
1445
1428
|
# billing the responsible_party.
|
1446
1429
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
1447
1430
|
# Box 19 on the CMS-1500 claim form.
|
1448
|
-
# @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
|
1449
1432
|
# Required when mandated by government law or regulation to obtain authorization
|
1450
1433
|
# for specific service(s) but, for the
|
1451
1434
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
1452
1435
|
# the service was performed without
|
1453
1436
|
# obtaining the authorization.
|
1454
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
1437
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
1455
1438
|
# Required on all ambulance claims when the patient was known to be admitted to
|
1456
1439
|
# the hospital.
|
1457
1440
|
# OR
|
1458
1441
|
# Required on all claims involving inpatient medical visits.
|
1459
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
1442
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
1460
1443
|
# Required for inpatient claims when the patient was discharged from the facility
|
1461
1444
|
# and the discharge date is known.
|
1462
|
-
# @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
|
1463
1446
|
# Required for the initial medical service or visit performed in response to a
|
1464
1447
|
# medical emergency when the date is available and is different than the date of
|
1465
1448
|
# service.
|
1466
1449
|
# OR
|
1467
1450
|
# This date is the onset of acute symptoms for the current illness or condition.
|
1468
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
1451
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
1469
1452
|
# Required when, in the judgment of the provider, the services on this claim are
|
1470
1453
|
# related to the patient's pregnancy.
|
1471
1454
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|
@@ -1786,39 +1769,22 @@ module CandidApiClient
|
|
1786
1769
|
# * :attachment_report_type_code (CandidApiClient::Encounters::V4::Types::ReportTypeCode)
|
1787
1770
|
# * :attachment_transmission_code (CandidApiClient::Encounters::V4::Types::ReportTransmissionCode)
|
1788
1771
|
# * :attachment_control_number (String)
|
1772
|
+
# @param secondary_payer_carrier_code [String] When Medicaid is billed as the secondary payer the Carrier Code is used to
|
1773
|
+
# identify the primary payer. This is required for certain states.
|
1789
1774
|
# @param request_options [CandidApiClient::RequestOptions]
|
1790
1775
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
1791
1776
|
# @example
|
1792
1777
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
1793
1778
|
# api.encounters.v_4.create(
|
1794
|
-
# patient: {
|
1795
|
-
# billing_provider: { address: { address_1: "
|
1796
|
-
# rendering_provider: { npi: "
|
1797
|
-
# 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" },
|
1798
|
-
# 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" },
|
1799
|
-
# 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" },
|
1800
|
-
# 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" },
|
1801
|
-
# 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 },
|
1802
|
-
# 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 },
|
1803
|
-
# 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 },
|
1804
|
-
# 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" },
|
1805
1782
|
# responsible_party: INSURANCE_PAY,
|
1806
|
-
# diagnoses: [{
|
1807
|
-
#
|
1808
|
-
# billing_notes: [{ text: "string" }],
|
1809
|
-
# place_of_service_code: PHARMACY,
|
1810
|
-
# 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" }] }] }] }],
|
1811
|
-
# service_lines: [{ procedure_code: "string", quantity: "string", units: MJ, diagnosis_pointers: }],
|
1812
|
-
# 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" } },
|
1813
|
-
# 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 }] },
|
1814
|
-
# tag_ids: ["string"],
|
1815
|
-
# schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
|
1816
|
-
# referral_number: "string",
|
1817
|
-
# epsdt_referral: { condition_indicator_1: AV, condition_indicator_2: AV, condition_indicator_3: AV },
|
1818
|
-
# claim_supplemental_information: [{ attachment_report_type_code: C_03, attachment_transmission_code: CBM }]
|
1783
|
+
# diagnoses: [{ code_type: ABF, code: "code" }, { code_type: ABF, code: "code" }],
|
1784
|
+
# place_of_service_code: PHARMACY
|
1819
1785
|
# )
|
1820
1786
|
def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
|
1821
|
-
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, request_options: nil)
|
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)
|
1822
1788
|
Async do
|
1823
1789
|
response = @request_client.conn.post do |req|
|
1824
1790
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -1876,7 +1842,8 @@ module CandidApiClient
|
|
1876
1842
|
schema_instances: schema_instances,
|
1877
1843
|
referral_number: referral_number,
|
1878
1844
|
epsdt_referral: epsdt_referral,
|
1879
|
-
claim_supplemental_information: claim_supplemental_information
|
1845
|
+
claim_supplemental_information: claim_supplemental_information,
|
1846
|
+
secondary_payer_carrier_code: secondary_payer_carrier_code
|
1880
1847
|
}.compact
|
1881
1848
|
req.url "#{@request_client.get_url(environment: CandidApi,
|
1882
1849
|
request_options: request_options)}/api/encounters/v4"
|
@@ -2023,7 +1990,7 @@ module CandidApiClient
|
|
2023
1990
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
2024
1991
|
# @example
|
2025
1992
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
2026
|
-
# 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 })
|
2027
1994
|
def create_from_pre_encounter_patient(request:, request_options: nil)
|
2028
1995
|
Async do
|
2029
1996
|
response = @request_client.conn.post do |req|
|
@@ -2058,19 +2025,12 @@ module CandidApiClient
|
|
2058
2025
|
# date_of_service will fail. If all service line date_of_service values are the
|
2059
2026
|
# same, updating the encounter's date_of_service will update all service line
|
2060
2027
|
# date_of_service values.
|
2061
|
-
# @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
|
2062
2029
|
# be overridden with this list.
|
2063
2030
|
# @param clinical_notes [Array<Hash>] Holds a collection of clinical observations made by healthcare providers during
|
2064
2031
|
# patient encounters.Request of type Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>, as a Hash
|
2065
2032
|
# * :category (CandidApiClient::Encounters::V4::Types::NoteCategory)
|
2066
2033
|
# * :notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNote>)
|
2067
|
-
# @param pay_to_address [Hash] Specifies the address to which payments for the claim should be sent.Request of type CandidApiClient::Commons::Types::StreetAddressLongZip, as a Hash
|
2068
|
-
# * :zip_plus_four_code (String)
|
2069
|
-
# * :address_1 (String)
|
2070
|
-
# * :address_2 (String)
|
2071
|
-
# * :city (String)
|
2072
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
2073
|
-
# * :zip_code (String)
|
2074
2034
|
# @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
|
2075
2035
|
# Examples for when this should be set to NOT_BILLABLE include if the Encounter
|
2076
2036
|
# has not occurred yet or if there is no intention of ever billing the
|
@@ -2180,51 +2140,31 @@ module CandidApiClient
|
|
2180
2140
|
# * :gender (CandidApiClient::Individual::Types::Gender)
|
2181
2141
|
# @param additional_information [String] Defines additional information on the claim needed by the payer.
|
2182
2142
|
# Box 19 on the CMS-1500 claim form.
|
2183
|
-
# @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
|
2184
2144
|
# Required when mandated by government law or regulation to obtain authorization
|
2185
2145
|
# for specific service(s) but, for the
|
2186
2146
|
# reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
|
2187
2147
|
# the service was performed without
|
2188
2148
|
# obtaining the authorization.
|
2189
|
-
# @param admission_date [Date] 837p Loop2300 DTP
|
2149
|
+
# @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
|
2190
2150
|
# Required on all ambulance claims when the patient was known to be admitted to
|
2191
2151
|
# the hospital.
|
2192
2152
|
# OR
|
2193
2153
|
# Required on all claims involving inpatient medical visits.
|
2194
|
-
# @param discharge_date [Date] 837p Loop2300 DTP
|
2154
|
+
# @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
|
2195
2155
|
# Required for inpatient claims when the patient was discharged from the facility
|
2196
2156
|
# and the discharge date is known.
|
2197
|
-
# @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
|
2198
2158
|
# Required for the initial medical service or visit performed in response to a
|
2199
2159
|
# medical emergency when the date is available and is different than the date of
|
2200
2160
|
# service.
|
2201
2161
|
# OR
|
2202
2162
|
# This date is the onset of acute symptoms for the current illness or condition.
|
2203
|
-
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP
|
2163
|
+
# @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
|
2204
2164
|
# Required when, in the judgment of the provider, the services on this claim are
|
2205
2165
|
# related to the patient's pregnancy.de
|
2206
2166
|
# @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
|
2207
2167
|
# Code indicating the reason why a request was delayed
|
2208
|
-
# @param patient [Hash] Contains the identification information of the individual receiving medical
|
2209
|
-
# services.Request of type CandidApiClient::Individual::Types::PatientUpdate, as a Hash
|
2210
|
-
# * :first_name (String)
|
2211
|
-
# * :last_name (String)
|
2212
|
-
# * :gender (CandidApiClient::Individual::Types::Gender)
|
2213
|
-
# * :external_id (String)
|
2214
|
-
# * :date_of_birth (Date)
|
2215
|
-
# * :address (Hash)
|
2216
|
-
# * :zip_plus_four_code (String)
|
2217
|
-
# * :address_1 (String)
|
2218
|
-
# * :address_2 (String)
|
2219
|
-
# * :city (String)
|
2220
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
2221
|
-
# * :zip_code (String)
|
2222
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
2223
|
-
# * :phone_consent (Boolean)
|
2224
|
-
# * :email (String)
|
2225
|
-
# * :email_consent (Boolean)
|
2226
|
-
# * :non_insurance_payers (Array<String>)
|
2227
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreate>)
|
2228
2168
|
# @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
|
2229
2169
|
# for billing purpose.
|
2230
2170
|
# Box 12 on the CMS-1500 claim form.
|
@@ -2256,11 +2196,54 @@ module CandidApiClient
|
|
2256
2196
|
# * :dosage_form (String)
|
2257
2197
|
# * :frequency (String)
|
2258
2198
|
# * :as_needed (Boolean)
|
2259
|
-
# @param
|
2260
|
-
#
|
2261
|
-
#
|
2262
|
-
#
|
2263
|
-
#
|
2199
|
+
# @param guarantor [Hash] Personal and contact info for the guarantor of the patient responsibility.Request of type CandidApiClient::Guarantor::V1::Types::GuarantorUpdate, as a Hash
|
2200
|
+
# * :first_name (String)
|
2201
|
+
# * :last_name (String)
|
2202
|
+
# * :external_id (String)
|
2203
|
+
# * :date_of_birth (Date)
|
2204
|
+
# * :address (Hash)
|
2205
|
+
# * :zip_plus_four_code (String)
|
2206
|
+
# * :address_1 (String)
|
2207
|
+
# * :address_2 (String)
|
2208
|
+
# * :city (String)
|
2209
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
2210
|
+
# * :zip_code (String)
|
2211
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
2212
|
+
# * :phone_consent (Boolean)
|
2213
|
+
# * :email (String)
|
2214
|
+
# * :email_consent (Boolean)
|
2215
|
+
# @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
|
2216
|
+
# @param epsdt_referral [Hash] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
|
2217
|
+
# 837P formRequest of type CandidApiClient::Encounters::V4::Types::EpsdtReferral, as a Hash
|
2218
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
2219
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
2220
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
2221
|
+
# @param claim_supplemental_information [Array<Hash>] Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are
|
2222
|
+
# permitted.Request of type Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>, as a Hash
|
2223
|
+
# * :attachment_report_type_code (CandidApiClient::Encounters::V4::Types::ReportTypeCode)
|
2224
|
+
# * :attachment_transmission_code (CandidApiClient::Encounters::V4::Types::ReportTransmissionCode)
|
2225
|
+
# * :attachment_control_number (String)
|
2226
|
+
# @param secondary_payer_carrier_code [String] When Medicaid is billed as the secondary payer the Carrier Code is used to
|
2227
|
+
# identify the primary payer. This is required for certain states.
|
2228
|
+
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
2229
|
+
# @param _field_set [Object]
|
2230
|
+
# @param pay_to_address [Hash] Specifies the address to which payments for the claim should be sent.Request of type CandidApiClient::Commons::Types::StreetAddressLongZip, as a Hash
|
2231
|
+
# * :zip_plus_four_code (String)
|
2232
|
+
# * :address_1 (String)
|
2233
|
+
# * :address_2 (String)
|
2234
|
+
# * :city (String)
|
2235
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
2236
|
+
# * :zip_code (String)
|
2237
|
+
# @param diagnosis_ids [Array<String>] Ideally, this field should contain no more than 12 diagnoses. However, more
|
2238
|
+
# diagnoses
|
2239
|
+
# may be submitted at this time, and coders will later prioritize the 12 that will
|
2240
|
+
# be
|
2241
|
+
# submitted to the payor.
|
2242
|
+
# @param initial_referring_provider [Hash] The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in
|
2243
|
+
# this loop to
|
2244
|
+
# indicate the initial referral from the primary care provider or whatever
|
2245
|
+
# provider wrote the initial referral for this patient's episode of care being
|
2246
|
+
# billed/reported in this transaction.Request of type CandidApiClient::EncounterProviders::V2::Types::InitialReferringProviderUpdate, as a Hash
|
2264
2247
|
# * :npi (String)
|
2265
2248
|
# * :taxonomy_code (String)
|
2266
2249
|
# * :address (Hash)
|
@@ -2270,20 +2253,15 @@ module CandidApiClient
|
|
2270
2253
|
# * :city (String)
|
2271
2254
|
# * :state (CandidApiClient::Commons::Types::State)
|
2272
2255
|
# * :zip_code (String)
|
2256
|
+
# * :qualifier (CandidApiClient::Commons::Types::QualifierCode)
|
2273
2257
|
# * :first_name (String)
|
2274
2258
|
# * :last_name (String)
|
2275
2259
|
# * :organization_name (String)
|
2276
|
-
# @param
|
2277
|
-
#
|
2278
|
-
#
|
2279
|
-
# (e.g., home), or the location where an in-person visit would have taken place,
|
2280
|
-
# whichever is easier to identify. If the provider is in-network, service facility
|
2281
|
-
# may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that
|
2282
|
-
# for an in-network claim to be successfully adjudicated, the service facility
|
2283
|
-
# address listed on claims must match what was provided to the payer during the
|
2284
|
-
# credentialing process.Request of type CandidApiClient::ServiceFacility::Types::EncounterServiceFacilityUpdate, as a Hash
|
2285
|
-
# * :organization_name (String)
|
2260
|
+
# @param referring_provider [Hash] The final provider who referred the services that were rendered.
|
2261
|
+
# All physicians who order services or refer Medicare beneficiaries must
|
2262
|
+
# report this data.Request of type CandidApiClient::EncounterProviders::V2::Types::ReferringProviderUpdate, as a Hash
|
2286
2263
|
# * :npi (String)
|
2264
|
+
# * :taxonomy_code (String)
|
2287
2265
|
# * :address (Hash)
|
2288
2266
|
# * :zip_plus_four_code (String)
|
2289
2267
|
# * :address_1 (String)
|
@@ -2291,10 +2269,14 @@ module CandidApiClient
|
|
2291
2269
|
# * :city (String)
|
2292
2270
|
# * :state (CandidApiClient::Commons::Types::State)
|
2293
2271
|
# * :zip_code (String)
|
2294
|
-
# * :secondary_identification (String)
|
2295
|
-
# @param guarantor [Hash] Personal and contact info for the guarantor of the patient responsibility.Request of type CandidApiClient::Guarantor::V1::Types::GuarantorUpdate, as a Hash
|
2296
2272
|
# * :first_name (String)
|
2297
2273
|
# * :last_name (String)
|
2274
|
+
# * :organization_name (String)
|
2275
|
+
# @param patient [Hash] Contains the identification information of the individual receiving medical
|
2276
|
+
# services.Request of type CandidApiClient::Individual::Types::PatientUpdate, as a Hash
|
2277
|
+
# * :first_name (String)
|
2278
|
+
# * :last_name (String)
|
2279
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
2298
2280
|
# * :external_id (String)
|
2299
2281
|
# * :date_of_birth (Date)
|
2300
2282
|
# * :address (Hash)
|
@@ -2308,15 +2290,15 @@ module CandidApiClient
|
|
2308
2290
|
# * :phone_consent (Boolean)
|
2309
2291
|
# * :email (String)
|
2310
2292
|
# * :email_consent (Boolean)
|
2311
|
-
#
|
2312
|
-
#
|
2313
|
-
#
|
2314
|
-
#
|
2315
|
-
#
|
2316
|
-
#
|
2317
|
-
#
|
2318
|
-
#
|
2319
|
-
#
|
2293
|
+
# * :non_insurance_payers (Array<String>)
|
2294
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreate>)
|
2295
|
+
# @param rendering_provider [Hash] The rendering provider is the practitioner -- physician, nurse practitioner,
|
2296
|
+
# etc. -- performing the service.
|
2297
|
+
# For telehealth services, the rendering provider performs the visit, asynchronous
|
2298
|
+
# communication, or other service. The rendering provider address should generally
|
2299
|
+
# be the same as the service facility address.Request of type CandidApiClient::EncounterProviders::V2::Types::RenderingProviderUpdate, as a Hash
|
2300
|
+
# * :npi (String)
|
2301
|
+
# * :taxonomy_code (String)
|
2320
2302
|
# * :address (Hash)
|
2321
2303
|
# * :zip_plus_four_code (String)
|
2322
2304
|
# * :address_1 (String)
|
@@ -2324,17 +2306,20 @@ module CandidApiClient
|
|
2324
2306
|
# * :city (String)
|
2325
2307
|
# * :state (CandidApiClient::Commons::Types::State)
|
2326
2308
|
# * :zip_code (String)
|
2327
|
-
# * :tax_id (String)
|
2328
|
-
# * :npi (String)
|
2329
|
-
# * :taxonomy_code (String)
|
2330
|
-
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
2331
2309
|
# * :first_name (String)
|
2332
2310
|
# * :last_name (String)
|
2333
2311
|
# * :organization_name (String)
|
2334
|
-
# @param
|
2335
|
-
#
|
2312
|
+
# @param service_facility [Hash] Encounter Service facility is typically the location a medical service was
|
2313
|
+
# rendered, such as a provider office or hospital. For telehealth, service
|
2314
|
+
# facility can represent the provider's location when the service was delivered
|
2315
|
+
# (e.g., home), or the location where an in-person visit would have taken place,
|
2316
|
+
# whichever is easier to identify. If the provider is in-network, service facility
|
2317
|
+
# may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that
|
2318
|
+
# for an in-network claim to be successfully adjudicated, the service facility
|
2319
|
+
# address listed on claims must match what was provided to the payer during the
|
2320
|
+
# credentialing process.Request of type CandidApiClient::ServiceFacility::Types::EncounterServiceFacilityUpdate, as a Hash
|
2321
|
+
# * :organization_name (String)
|
2336
2322
|
# * :npi (String)
|
2337
|
-
# * :taxonomy_code (String)
|
2338
2323
|
# * :address (Hash)
|
2339
2324
|
# * :zip_plus_four_code (String)
|
2340
2325
|
# * :address_1 (String)
|
@@ -2342,12 +2327,9 @@ module CandidApiClient
|
|
2342
2327
|
# * :city (String)
|
2343
2328
|
# * :state (CandidApiClient::Commons::Types::State)
|
2344
2329
|
# * :zip_code (String)
|
2345
|
-
# * :
|
2346
|
-
#
|
2347
|
-
#
|
2348
|
-
# @param referring_provider [Hash] The final provider who referred the services that were rendered.
|
2349
|
-
# All physicians who order services or refer Medicare beneficiaries must
|
2350
|
-
# report this data.Request of type CandidApiClient::EncounterProviders::V2::Types::ReferringProviderUpdate, as a Hash
|
2330
|
+
# * :secondary_identification (String)
|
2331
|
+
# @param supervising_provider [Hash] Required when the rendering provider is supervised by a physician. If not
|
2332
|
+
# required by this implementation guide, do not send.Request of type CandidApiClient::EncounterProviders::V2::Types::SupervisingProviderUpdate, as a Hash
|
2351
2333
|
# * :npi (String)
|
2352
2334
|
# * :taxonomy_code (String)
|
2353
2335
|
# * :address (Hash)
|
@@ -2360,13 +2342,15 @@ module CandidApiClient
|
|
2360
2342
|
# * :first_name (String)
|
2361
2343
|
# * :last_name (String)
|
2362
2344
|
# * :organization_name (String)
|
2363
|
-
# @param
|
2364
|
-
#
|
2365
|
-
#
|
2366
|
-
#
|
2367
|
-
#
|
2368
|
-
#
|
2369
|
-
#
|
2345
|
+
# @param billing_provider [Hash] The billing provider is the provider or business entity submitting the claim.
|
2346
|
+
# Billing provider may be, but is not necessarily, the same person/NPI as the
|
2347
|
+
# rendering provider. From a payer's perspective, this represents the person or
|
2348
|
+
# entity being reimbursed. When a contract exists with the target payer, the
|
2349
|
+
# billing provider should be the entity contracted with the payer. In some
|
2350
|
+
# circumstances, this will be an individual provider. In that case, submit that
|
2351
|
+
# provider's NPI and the tax ID (TIN) that the provider gave to the payer during
|
2352
|
+
# contracting. In other cases, the billing entity will be a medical group. If so,
|
2353
|
+
# submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form.Request of type CandidApiClient::EncounterProviders::V2::Types::BillingProviderUpdate, as a Hash
|
2370
2354
|
# * :address (Hash)
|
2371
2355
|
# * :zip_plus_four_code (String)
|
2372
2356
|
# * :address_1 (String)
|
@@ -2374,28 +2358,13 @@ module CandidApiClient
|
|
2374
2358
|
# * :city (String)
|
2375
2359
|
# * :state (CandidApiClient::Commons::Types::State)
|
2376
2360
|
# * :zip_code (String)
|
2377
|
-
# * :
|
2361
|
+
# * :tax_id (String)
|
2362
|
+
# * :npi (String)
|
2363
|
+
# * :taxonomy_code (String)
|
2364
|
+
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
2378
2365
|
# * :first_name (String)
|
2379
2366
|
# * :last_name (String)
|
2380
2367
|
# * :organization_name (String)
|
2381
|
-
# @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
|
2382
|
-
# @param epsdt_referral [Hash] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
|
2383
|
-
# 837P formRequest of type CandidApiClient::Encounters::V4::Types::EpsdtReferral, as a Hash
|
2384
|
-
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
2385
|
-
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
2386
|
-
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
2387
|
-
# @param claim_supplemental_information [Array<Hash>] Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are
|
2388
|
-
# permitted.Request of type Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>, as a Hash
|
2389
|
-
# * :attachment_report_type_code (CandidApiClient::Encounters::V4::Types::ReportTypeCode)
|
2390
|
-
# * :attachment_transmission_code (CandidApiClient::Encounters::V4::Types::ReportTransmissionCode)
|
2391
|
-
# * :attachment_control_number (String)
|
2392
|
-
# @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
|
2393
|
-
# @param _field_set [Object]
|
2394
|
-
# @param diagnosis_ids [Array<String>] Ideally, this field should contain no more than 12 diagnoses. However, more
|
2395
|
-
# diagnoses
|
2396
|
-
# may be submitted at this time, and coders will later prioritize the 12 that will
|
2397
|
-
# be
|
2398
|
-
# submitted to the payor.
|
2399
2368
|
# @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
|
2400
2369
|
# telemedicine, 11 for in-person. Full list
|
2401
2370
|
# //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
|
@@ -2403,13 +2372,9 @@ module CandidApiClient
|
|
2403
2372
|
# @return [CandidApiClient::Encounters::V4::Types::Encounter]
|
2404
2373
|
# @example
|
2405
2374
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
2406
|
-
# api.encounters.v_4.update(
|
2407
|
-
# encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
|
2408
|
-
# diagnosis_ids: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"],
|
2409
|
-
# place_of_service_code_as_submitted: PHARMACY
|
2410
|
-
# )
|
2375
|
+
# api.encounters.v_4.update(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
2411
2376
|
def update(encounter_id:, benefits_assigned_to_provider: nil, prior_authorization_number: nil,
|
2412
|
-
external_id: nil, date_of_service: nil, tag_ids: nil, clinical_notes: nil,
|
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)
|
2413
2378
|
Async do
|
2414
2379
|
response = @request_client.conn.patch do |req|
|
2415
2380
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -2427,7 +2392,6 @@ module CandidApiClient
|
|
2427
2392
|
date_of_service: date_of_service,
|
2428
2393
|
tag_ids: tag_ids,
|
2429
2394
|
clinical_notes: clinical_notes,
|
2430
|
-
pay_to_address: pay_to_address,
|
2431
2395
|
billable_status: billable_status,
|
2432
2396
|
responsible_party: responsible_party,
|
2433
2397
|
provider_accepts_assignment: provider_accepts_assignment,
|
@@ -2445,24 +2409,26 @@ module CandidApiClient
|
|
2445
2409
|
onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
|
2446
2410
|
last_menstrual_period_date: last_menstrual_period_date,
|
2447
2411
|
delay_reason_code: delay_reason_code,
|
2448
|
-
patient: patient,
|
2449
2412
|
patient_authorized_release: patient_authorized_release,
|
2450
2413
|
schema_instances: schema_instances,
|
2451
2414
|
vitals: vitals,
|
2452
2415
|
existing_medications: existing_medications,
|
2453
|
-
rendering_provider: rendering_provider,
|
2454
|
-
service_facility: service_facility,
|
2455
2416
|
guarantor: guarantor,
|
2456
|
-
billing_provider: billing_provider,
|
2457
|
-
supervising_provider: supervising_provider,
|
2458
|
-
referring_provider: referring_provider,
|
2459
|
-
initial_referring_provider: initial_referring_provider,
|
2460
2417
|
referral_number: referral_number,
|
2461
2418
|
epsdt_referral: epsdt_referral,
|
2462
2419
|
claim_supplemental_information: claim_supplemental_information,
|
2420
|
+
secondary_payer_carrier_code: secondary_payer_carrier_code,
|
2463
2421
|
additional_properties: additional_properties,
|
2464
2422
|
_field_set: _field_set,
|
2423
|
+
pay_to_address: pay_to_address,
|
2465
2424
|
diagnosis_ids: diagnosis_ids,
|
2425
|
+
initial_referring_provider: initial_referring_provider,
|
2426
|
+
referring_provider: referring_provider,
|
2427
|
+
patient: patient,
|
2428
|
+
rendering_provider: rendering_provider,
|
2429
|
+
service_facility: service_facility,
|
2430
|
+
supervising_provider: supervising_provider,
|
2431
|
+
billing_provider: billing_provider,
|
2466
2432
|
place_of_service_code_as_submitted: place_of_service_code_as_submitted
|
2467
2433
|
}.compact
|
2468
2434
|
req.url "#{@request_client.get_url(environment: CandidApi,
|