candidhealth 0.46.1 → 1.3.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/auth/client.rb +7 -7
- data/lib/candidhealth/auth/{v_2 → default}/client.rb +39 -13
- data/lib/candidhealth/auth/{v_2 → default}/types/auth_get_token_response.rb +3 -3
- data/lib/candidhealth/auth/default/types/invalid_content_type_error_type.rb +60 -0
- data/lib/candidhealth/auth/{v_2 → default}/types/too_many_requests_error_type.rb +3 -3
- data/lib/candidhealth/billing_notes/v_2/types/billing_note_base_optional.rb +62 -0
- data/lib/candidhealth/charge_capture/v_1/client.rb +504 -524
- data/lib/candidhealth/charge_capture/v_1/types/charge_capture.rb +17 -1
- data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +173 -173
- data/lib/candidhealth/charge_capture/v_1/types/charge_capture_error.rb +26 -2
- data/lib/candidhealth/charge_capture_bundles/v_1/client.rb +58 -0
- data/lib/candidhealth/claim_submission/v_1/types/claim_submission_record_create_optional.rb +100 -0
- data/lib/candidhealth/claim_submission/v_1/types/external_claim_submission_create_optional.rb +101 -0
- data/lib/candidhealth/commons/types/phone_number_optional.rb +71 -0
- data/lib/candidhealth/commons/types/procedure_modifier.rb +2 -0
- data/lib/candidhealth/commons/types/street_address_long_zip_optional.rb +107 -0
- data/lib/candidhealth/custom_schemas/v_1/types/schema_instance_optional.rb +78 -0
- data/lib/candidhealth/diagnoses/client.rb +23 -4
- data/lib/candidhealth/diagnoses/types/diagnosis.rb +21 -2
- data/lib/candidhealth/diagnoses/types/diagnosis_create.rb +25 -2
- data/lib/candidhealth/diagnoses/types/diagnosis_create_optional.rb +126 -0
- data/lib/candidhealth/diagnoses/types/standalone_diagnosis_create.rb +22 -2
- data/lib/candidhealth/encounter_providers/v_2/types/ordering_provider_optional.rb +123 -0
- data/lib/candidhealth/encounters/v_4/client.rb +214 -208
- data/lib/candidhealth/encounters/v_4/types/claim_supplemental_information_optional.rb +86 -0
- data/lib/candidhealth/encounters/v_4/types/clinical_note_category_create_optional.rb +78 -0
- data/lib/candidhealth/encounters/v_4/types/clinical_note_optional.rb +93 -0
- data/lib/candidhealth/encounters/v_4/types/encounter.rb +16 -4
- data/lib/candidhealth/encounters/v_4/types/encounter_create_from_pre_encounter.rb +4 -2
- data/lib/candidhealth/encounters/v_4/types/encounter_deep_optional.rb +780 -0
- data/lib/candidhealth/encounters/v_4/types/encounter_optional.rb +1 -139
- data/lib/candidhealth/encounters/v_4/types/epsdt_referral_optional.rb +85 -0
- data/lib/candidhealth/encounters/v_4/types/intake_question_optional.rb +84 -0
- data/lib/candidhealth/encounters/v_4/types/intervention_optional.rb +114 -0
- data/lib/candidhealth/encounters/v_4/types/lab_optional.rb +80 -0
- data/lib/candidhealth/encounters/v_4/types/medication_optional.rb +108 -0
- data/lib/candidhealth/encounters/v_4/types/patient_history_category_optional.rb +78 -0
- data/lib/candidhealth/guarantor/v_1/types/guarantor_optional.rb +144 -0
- data/lib/candidhealth/individual/types/individual_base_optional.rb +78 -0
- data/lib/candidhealth/individual/types/patient_non_insurance_payer_info_create_optional.rb +89 -0
- data/lib/candidhealth/individual/types/patient_update_with_optional_address.rb +8 -8
- data/lib/candidhealth/individual/types/subscriber_base_optional.rb +118 -0
- data/lib/candidhealth/individual/types/subscriber_create_optional.rb +132 -0
- data/lib/candidhealth/insurance_adjudications/v_1/client.rb +2 -0
- data/lib/candidhealth/insurance_adjudications/v_1/types/insurance_adjudication_create.rb +9 -1
- data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_create_optional.rb +167 -0
- data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +13 -13
- data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb +4 -4
- data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_eligibility_check_response.rb +10 -10
- data/lib/candidhealth/pre_encounter/coverages/v_1/types/latest_eligibility_check.rb +4 -4
- data/lib/candidhealth/pre_encounter/coverages/v_1/types/mutable_coverage.rb +4 -4
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb +140 -0
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/batch_eligibility_response.rb +75 -0
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check.rb +18 -6
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_error.rb +80 -0
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_error_details.rb +112 -0
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_error_source.rb +17 -0
- data/lib/candidhealth/pre_encounter/{coverages → eligibility_checks}/v_1/types/eligibility_check_metadata.rb +7 -7
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_page.rb +98 -0
- data/lib/candidhealth/pre_encounter/{coverages → eligibility_checks}/v_1/types/eligibility_check_status.rb +2 -2
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_request.rb +18 -2
- data/lib/candidhealth/pre_encounter/{coverages → eligibility_checks}/v_1/types/eligibility_status.rb +2 -1
- data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/parsed_response.rb +4 -4
- data/lib/candidhealth/pre_encounter/patients/v_1/types/authorization.rb +13 -1
- data/lib/candidhealth/service_lines/v_2/types/denial_reason_content.rb +1 -0
- data/lib/candidhealth/service_lines/v_2/types/drug_identification_optional.rb +126 -0
- data/lib/candidhealth/service_lines/v_2/types/service_line_create_optional.rb +239 -0
- data/lib/candidhealth/service_lines/v_2/types/test_result_optional.rb +73 -0
- data/lib/candidhealth/write_offs/v_1/types/insurance_write_off_reason.rb +1 -0
- data/lib/candidhealth/write_offs/v_1/types/patient_write_off_reason.rb +1 -0
- data/lib/candidhealth/yes_no_indicator/types/yes_no_indicator.rb +14 -0
- data/lib/core/oauth.rb +2 -2
- data/lib/requests.rb +2 -2
- data/lib/types_export.rb +41 -8
- metadata +42 -9
- data/lib/candidhealth/pre_encounter/coverages/v_1/types/eligibility_check.rb +0 -116
@@ -28,15 +28,120 @@ module CandidApiClient
|
|
28
28
|
# @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
|
29
29
|
# listed as optional. Candid will use this data when attempting to bundle multiple
|
30
30
|
# Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
31
|
-
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::
|
32
|
-
# * :
|
31
|
+
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
|
32
|
+
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
|
33
|
+
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
|
34
|
+
# * :epsdt_referral (Hash)
|
35
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
36
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
37
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
38
|
+
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
|
39
|
+
# * :guarantor (Hash)
|
40
|
+
# * :first_name (String)
|
41
|
+
# * :last_name (String)
|
42
|
+
# * :external_id (String)
|
43
|
+
# * :date_of_birth (Date)
|
44
|
+
# * :address (Hash)
|
45
|
+
# * :zip_plus_four_code (String)
|
46
|
+
# * :address_1 (String)
|
47
|
+
# * :address_2 (String)
|
48
|
+
# * :city (String)
|
49
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
50
|
+
# * :zip_code (String)
|
51
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
52
|
+
# * :phone_consent (Boolean)
|
53
|
+
# * :email (String)
|
54
|
+
# * :email_consent (Boolean)
|
55
|
+
# * :subscriber_primary (Hash)
|
56
|
+
# * :insurance_card (Hash)
|
57
|
+
# * :member_id (String)
|
58
|
+
# * :payer_name (String)
|
59
|
+
# * :payer_id (String)
|
60
|
+
# * :rx_bin (String)
|
61
|
+
# * :rx_pcn (String)
|
62
|
+
# * :image_url_front (String)
|
63
|
+
# * :image_url_back (String)
|
64
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
65
|
+
# * :group_number (String)
|
66
|
+
# * :plan_name (String)
|
67
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
68
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
69
|
+
# * :payer_plan_group_id (String)
|
70
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
71
|
+
# * :date_of_birth (Date)
|
72
|
+
# * :address (Hash)
|
73
|
+
# * :zip_plus_four_code (String)
|
74
|
+
# * :address_1 (String)
|
75
|
+
# * :address_2 (String)
|
76
|
+
# * :city (String)
|
77
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
78
|
+
# * :zip_code (String)
|
79
|
+
# * :first_name (String)
|
80
|
+
# * :last_name (String)
|
81
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
82
|
+
# * :subscriber_secondary (Hash)
|
83
|
+
# * :insurance_card (Hash)
|
84
|
+
# * :member_id (String)
|
85
|
+
# * :payer_name (String)
|
86
|
+
# * :payer_id (String)
|
87
|
+
# * :rx_bin (String)
|
88
|
+
# * :rx_pcn (String)
|
89
|
+
# * :image_url_front (String)
|
90
|
+
# * :image_url_back (String)
|
91
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
92
|
+
# * :group_number (String)
|
93
|
+
# * :plan_name (String)
|
94
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
95
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
96
|
+
# * :payer_plan_group_id (String)
|
97
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
98
|
+
# * :date_of_birth (Date)
|
99
|
+
# * :address (Hash)
|
100
|
+
# * :zip_plus_four_code (String)
|
101
|
+
# * :address_1 (String)
|
102
|
+
# * :address_2 (String)
|
103
|
+
# * :city (String)
|
104
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
105
|
+
# * :zip_code (String)
|
106
|
+
# * :first_name (String)
|
107
|
+
# * :last_name (String)
|
108
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
109
|
+
# * :subscriber_tertiary (Hash)
|
110
|
+
# * :insurance_card (Hash)
|
111
|
+
# * :member_id (String)
|
112
|
+
# * :payer_name (String)
|
113
|
+
# * :payer_id (String)
|
114
|
+
# * :rx_bin (String)
|
115
|
+
# * :rx_pcn (String)
|
116
|
+
# * :image_url_front (String)
|
117
|
+
# * :image_url_back (String)
|
118
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
119
|
+
# * :group_number (String)
|
120
|
+
# * :plan_name (String)
|
121
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
122
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
123
|
+
# * :payer_plan_group_id (String)
|
124
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
125
|
+
# * :date_of_birth (Date)
|
126
|
+
# * :address (Hash)
|
127
|
+
# * :zip_plus_four_code (String)
|
128
|
+
# * :address_1 (String)
|
129
|
+
# * :address_2 (String)
|
130
|
+
# * :city (String)
|
131
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
132
|
+
# * :zip_code (String)
|
133
|
+
# * :first_name (String)
|
134
|
+
# * :last_name (String)
|
135
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
136
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
137
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
33
138
|
# * :external_claim_submission (Hash)
|
34
139
|
# * :claim_created_at (DateTime)
|
35
140
|
# * :patient_control_number (String)
|
36
|
-
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::
|
37
|
-
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::
|
38
|
-
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::
|
39
|
-
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::
|
141
|
+
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
|
142
|
+
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
|
143
|
+
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
|
144
|
+
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
|
40
145
|
# * :patient (Hash)
|
41
146
|
# * :first_name (String)
|
42
147
|
# * :last_name (String)
|
@@ -50,12 +155,12 @@ module CandidApiClient
|
|
50
155
|
# * :city (String)
|
51
156
|
# * :state (CandidApiClient::Commons::Types::State)
|
52
157
|
# * :zip_code (String)
|
53
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
158
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
54
159
|
# * :phone_consent (Boolean)
|
55
160
|
# * :email (String)
|
56
161
|
# * :email_consent (Boolean)
|
57
162
|
# * :non_insurance_payers (Array<String>)
|
58
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
163
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
59
164
|
# * :service_facility (Hash)
|
60
165
|
# * :organization_name (String)
|
61
166
|
# * :npi (String)
|
@@ -147,7 +252,6 @@ module CandidApiClient
|
|
147
252
|
# * :external_id (String)
|
148
253
|
# * :date_of_service (Date)
|
149
254
|
# * :tag_ids (Array<String>)
|
150
|
-
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>)
|
151
255
|
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
152
256
|
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
153
257
|
# * :provider_accepts_assignment (Boolean)
|
@@ -155,6 +259,97 @@ module CandidApiClient
|
|
155
259
|
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
156
260
|
# * :appointment_type (String)
|
157
261
|
# * :end_date_of_service (Date)
|
262
|
+
# * :additional_information (String)
|
263
|
+
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
264
|
+
# * :admission_date (Date)
|
265
|
+
# * :discharge_date (Date)
|
266
|
+
# * :onset_of_current_illness_or_symptom_date (Date)
|
267
|
+
# * :last_menstrual_period_date (Date)
|
268
|
+
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
269
|
+
# * :patient_authorized_release (Boolean)
|
270
|
+
# * :vitals (Hash)
|
271
|
+
# * :height_in (Integer)
|
272
|
+
# * :weight_lbs (Integer)
|
273
|
+
# * :blood_pressure_systolic_mmhg (Integer)
|
274
|
+
# * :blood_pressure_diastolic_mmhg (Integer)
|
275
|
+
# * :body_temperature_f (Float)
|
276
|
+
# * :hemoglobin_gdl (Float)
|
277
|
+
# * :hematocrit_pct (Float)
|
278
|
+
# * :referral_number (String)
|
279
|
+
# * :secondary_payer_carrier_code (String)
|
280
|
+
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
|
281
|
+
# internal encounter ID or a Dr. Chrono encounter ID. This field should not
|
282
|
+
# contain PHI.
|
283
|
+
# @param originating_system [String] An optional string field denoting the originating system of the charge.
|
284
|
+
# @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
|
285
|
+
# creation.
|
286
|
+
# @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
|
287
|
+
# system (e.g. the EHR visit page). Send full URL format for the external link
|
288
|
+
# (e.g. https://emr_charge_capture_url.com/123).
|
289
|
+
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
290
|
+
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
291
|
+
# @param request_options [CandidApiClient::RequestOptions]
|
292
|
+
# @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
|
293
|
+
# @example
|
294
|
+
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
295
|
+
# api.charge_capture.v_1.create(
|
296
|
+
# data: { },
|
297
|
+
# charge_external_id: "charge_external_id",
|
298
|
+
# patient_external_id: "patient_external_id",
|
299
|
+
# status: PLANNED
|
300
|
+
# )
|
301
|
+
def create(data:, charge_external_id:, patient_external_id:, status:, originating_system: nil, claim_creation_category: nil,
|
302
|
+
ehr_source_url: nil, request_options: nil)
|
303
|
+
response = @request_client.conn.post do |req|
|
304
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
305
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
306
|
+
req.headers = {
|
307
|
+
**(req.headers || {}),
|
308
|
+
**@request_client.get_headers,
|
309
|
+
**(request_options&.additional_headers || {})
|
310
|
+
}.compact
|
311
|
+
req.body = {
|
312
|
+
**(request_options&.additional_body_parameters || {}),
|
313
|
+
data: data,
|
314
|
+
charge_external_id: charge_external_id,
|
315
|
+
originating_system: originating_system,
|
316
|
+
claim_creation_category: claim_creation_category,
|
317
|
+
ehr_source_url: ehr_source_url,
|
318
|
+
patient_external_id: patient_external_id,
|
319
|
+
status: status
|
320
|
+
}.compact
|
321
|
+
req.url "#{@request_client.get_url(environment: CandidApi,
|
322
|
+
request_options: request_options)}/api/charge_captures/v1"
|
323
|
+
end
|
324
|
+
CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
|
325
|
+
end
|
326
|
+
|
327
|
+
# @param charge_capture_id [String]
|
328
|
+
# @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
329
|
+
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
|
330
|
+
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
|
331
|
+
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
|
332
|
+
# * :epsdt_referral (Hash)
|
333
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
334
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
335
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
336
|
+
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
|
337
|
+
# * :guarantor (Hash)
|
338
|
+
# * :first_name (String)
|
339
|
+
# * :last_name (String)
|
340
|
+
# * :external_id (String)
|
341
|
+
# * :date_of_birth (Date)
|
342
|
+
# * :address (Hash)
|
343
|
+
# * :zip_plus_four_code (String)
|
344
|
+
# * :address_1 (String)
|
345
|
+
# * :address_2 (String)
|
346
|
+
# * :city (String)
|
347
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
348
|
+
# * :zip_code (String)
|
349
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
350
|
+
# * :phone_consent (Boolean)
|
351
|
+
# * :email (String)
|
352
|
+
# * :email_consent (Boolean)
|
158
353
|
# * :subscriber_primary (Hash)
|
159
354
|
# * :insurance_card (Hash)
|
160
355
|
# * :member_id (String)
|
@@ -236,119 +431,15 @@ module CandidApiClient
|
|
236
431
|
# * :first_name (String)
|
237
432
|
# * :last_name (String)
|
238
433
|
# * :gender (CandidApiClient::Individual::Types::Gender)
|
239
|
-
# * :
|
240
|
-
# * :
|
241
|
-
# * :admission_date (Date)
|
242
|
-
# * :discharge_date (Date)
|
243
|
-
# * :onset_of_current_illness_or_symptom_date (Date)
|
244
|
-
# * :last_menstrual_period_date (Date)
|
245
|
-
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
246
|
-
# * :patient_authorized_release (Boolean)
|
247
|
-
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>)
|
248
|
-
# * :vitals (Hash)
|
249
|
-
# * :height_in (Integer)
|
250
|
-
# * :weight_lbs (Integer)
|
251
|
-
# * :blood_pressure_systolic_mmhg (Integer)
|
252
|
-
# * :blood_pressure_diastolic_mmhg (Integer)
|
253
|
-
# * :body_temperature_f (Float)
|
254
|
-
# * :hemoglobin_gdl (Float)
|
255
|
-
# * :hematocrit_pct (Float)
|
256
|
-
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::Medication>)
|
257
|
-
# * :guarantor (Hash)
|
258
|
-
# * :first_name (String)
|
259
|
-
# * :last_name (String)
|
260
|
-
# * :external_id (String)
|
261
|
-
# * :date_of_birth (Date)
|
262
|
-
# * :address (Hash)
|
263
|
-
# * :zip_plus_four_code (String)
|
264
|
-
# * :address_1 (String)
|
265
|
-
# * :address_2 (String)
|
266
|
-
# * :city (String)
|
267
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
268
|
-
# * :zip_code (String)
|
269
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
270
|
-
# * :phone_consent (Boolean)
|
271
|
-
# * :email (String)
|
272
|
-
# * :email_consent (Boolean)
|
273
|
-
# * :referral_number (String)
|
274
|
-
# * :epsdt_referral (Hash)
|
275
|
-
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
276
|
-
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
277
|
-
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
278
|
-
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>)
|
279
|
-
# * :secondary_payer_carrier_code (String)
|
280
|
-
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
|
281
|
-
# internal encounter ID or a Dr. Chrono encounter ID. This field should not
|
282
|
-
# contain PHI.
|
283
|
-
# @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
|
284
|
-
# system (e.g. the EHR visit page). Send full URL format for the external link
|
285
|
-
# (e.g. https://emr_charge_capture_url.com/123).
|
286
|
-
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
287
|
-
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
288
|
-
# @param request_options [CandidApiClient::RequestOptions]
|
289
|
-
# @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
|
290
|
-
# @example
|
291
|
-
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
292
|
-
# api.charge_capture.v_1.create(
|
293
|
-
# data: { },
|
294
|
-
# charge_external_id: "charge_external_id",
|
295
|
-
# patient_external_id: "patient_external_id",
|
296
|
-
# status: PLANNED
|
297
|
-
# )
|
298
|
-
def create(data:, charge_external_id:, patient_external_id:, status:, ehr_source_url: nil, request_options: nil)
|
299
|
-
response = @request_client.conn.post do |req|
|
300
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
301
|
-
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
302
|
-
req.headers = {
|
303
|
-
**(req.headers || {}),
|
304
|
-
**@request_client.get_headers,
|
305
|
-
**(request_options&.additional_headers || {})
|
306
|
-
}.compact
|
307
|
-
req.body = {
|
308
|
-
**(request_options&.additional_body_parameters || {}),
|
309
|
-
data: data,
|
310
|
-
charge_external_id: charge_external_id,
|
311
|
-
ehr_source_url: ehr_source_url,
|
312
|
-
patient_external_id: patient_external_id,
|
313
|
-
status: status
|
314
|
-
}.compact
|
315
|
-
req.url "#{@request_client.get_url(environment: CandidApi,
|
316
|
-
request_options: request_options)}/api/charge_captures/v1"
|
317
|
-
end
|
318
|
-
CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
|
319
|
-
end
|
320
|
-
|
321
|
-
# @param charge_capture_id [String]
|
322
|
-
# @param request_options [CandidApiClient::RequestOptions]
|
323
|
-
# @return [Void]
|
324
|
-
# @example
|
325
|
-
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
326
|
-
# api.charge_capture.v_1.delete(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
327
|
-
def delete(charge_capture_id:, request_options: nil)
|
328
|
-
@request_client.conn.delete do |req|
|
329
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
330
|
-
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
331
|
-
req.headers = {
|
332
|
-
**(req.headers || {}),
|
333
|
-
**@request_client.get_headers,
|
334
|
-
**(request_options&.additional_headers || {})
|
335
|
-
}.compact
|
336
|
-
req.url "#{@request_client.get_url(environment: CandidApi,
|
337
|
-
request_options: request_options)}/api/charge_captures/v1/#{charge_capture_id}"
|
338
|
-
end
|
339
|
-
end
|
340
|
-
|
341
|
-
# @param charge_capture_id [String]
|
342
|
-
# @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
343
|
-
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreate>)
|
344
|
-
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::Intervention>)
|
434
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
435
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
345
436
|
# * :external_claim_submission (Hash)
|
346
437
|
# * :claim_created_at (DateTime)
|
347
438
|
# * :patient_control_number (String)
|
348
|
-
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::
|
349
|
-
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::
|
350
|
-
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::
|
351
|
-
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::
|
439
|
+
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
|
440
|
+
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
|
441
|
+
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
|
442
|
+
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
|
352
443
|
# * :patient (Hash)
|
353
444
|
# * :first_name (String)
|
354
445
|
# * :last_name (String)
|
@@ -362,12 +453,12 @@ module CandidApiClient
|
|
362
453
|
# * :city (String)
|
363
454
|
# * :state (CandidApiClient::Commons::Types::State)
|
364
455
|
# * :zip_code (String)
|
365
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
456
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
366
457
|
# * :phone_consent (Boolean)
|
367
458
|
# * :email (String)
|
368
459
|
# * :email_consent (Boolean)
|
369
460
|
# * :non_insurance_payers (Array<String>)
|
370
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
461
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
371
462
|
# * :service_facility (Hash)
|
372
463
|
# * :organization_name (String)
|
373
464
|
# * :npi (String)
|
@@ -410,107 +501,18 @@ module CandidApiClient
|
|
410
501
|
# * :npi (String)
|
411
502
|
# * :taxonomy_code (String)
|
412
503
|
# * :address (Hash)
|
413
|
-
# * :zip_plus_four_code (String)
|
414
|
-
# * :address_1 (String)
|
415
|
-
# * :address_2 (String)
|
416
|
-
# * :city (String)
|
417
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
418
|
-
# * :zip_code (String)
|
419
|
-
# * :first_name (String)
|
420
|
-
# * :last_name (String)
|
421
|
-
# * :organization_name (String)
|
422
|
-
# * :supervising_provider (Hash)
|
423
|
-
# * :npi (String)
|
424
|
-
# * :taxonomy_code (String)
|
425
|
-
# * :address (Hash)
|
426
|
-
# * :zip_plus_four_code (String)
|
427
|
-
# * :address_1 (String)
|
428
|
-
# * :address_2 (String)
|
429
|
-
# * :city (String)
|
430
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
431
|
-
# * :zip_code (String)
|
432
|
-
# * :first_name (String)
|
433
|
-
# * :last_name (String)
|
434
|
-
# * :organization_name (String)
|
435
|
-
# * :billing_provider (Hash)
|
436
|
-
# * :address (Hash)
|
437
|
-
# * :zip_plus_four_code (String)
|
438
|
-
# * :address_1 (String)
|
439
|
-
# * :address_2 (String)
|
440
|
-
# * :city (String)
|
441
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
442
|
-
# * :zip_code (String)
|
443
|
-
# * :tax_id (String)
|
444
|
-
# * :npi (String)
|
445
|
-
# * :taxonomy_code (String)
|
446
|
-
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
447
|
-
# * :first_name (String)
|
448
|
-
# * :last_name (String)
|
449
|
-
# * :organization_name (String)
|
450
|
-
# * :pay_to_address (Hash)
|
451
|
-
# * :zip_plus_four_code (String)
|
452
|
-
# * :address_1 (String)
|
453
|
-
# * :address_2 (String)
|
454
|
-
# * :city (String)
|
455
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
456
|
-
# * :zip_code (String)
|
457
|
-
# * :benefits_assigned_to_provider (Boolean)
|
458
|
-
# * :prior_authorization_number (String)
|
459
|
-
# * :external_id (String)
|
460
|
-
# * :date_of_service (Date)
|
461
|
-
# * :tag_ids (Array<String>)
|
462
|
-
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>)
|
463
|
-
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
464
|
-
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
465
|
-
# * :provider_accepts_assignment (Boolean)
|
466
|
-
# * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
|
467
|
-
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
468
|
-
# * :appointment_type (String)
|
469
|
-
# * :end_date_of_service (Date)
|
470
|
-
# * :subscriber_primary (Hash)
|
471
|
-
# * :insurance_card (Hash)
|
472
|
-
# * :member_id (String)
|
473
|
-
# * :payer_name (String)
|
474
|
-
# * :payer_id (String)
|
475
|
-
# * :rx_bin (String)
|
476
|
-
# * :rx_pcn (String)
|
477
|
-
# * :image_url_front (String)
|
478
|
-
# * :image_url_back (String)
|
479
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
480
|
-
# * :group_number (String)
|
481
|
-
# * :plan_name (String)
|
482
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
483
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
484
|
-
# * :payer_plan_group_id (String)
|
485
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
486
|
-
# * :date_of_birth (Date)
|
487
|
-
# * :address (Hash)
|
488
|
-
# * :zip_plus_four_code (String)
|
489
|
-
# * :address_1 (String)
|
490
|
-
# * :address_2 (String)
|
491
|
-
# * :city (String)
|
492
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
493
|
-
# * :zip_code (String)
|
494
|
-
# * :first_name (String)
|
495
|
-
# * :last_name (String)
|
496
|
-
# * :gender (CandidApiClient::Individual::Types::Gender)
|
497
|
-
# * :subscriber_secondary (Hash)
|
498
|
-
# * :insurance_card (Hash)
|
499
|
-
# * :member_id (String)
|
500
|
-
# * :payer_name (String)
|
501
|
-
# * :payer_id (String)
|
502
|
-
# * :rx_bin (String)
|
503
|
-
# * :rx_pcn (String)
|
504
|
-
# * :image_url_front (String)
|
505
|
-
# * :image_url_back (String)
|
506
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
507
|
-
# * :group_number (String)
|
508
|
-
# * :plan_name (String)
|
509
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
510
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
511
|
-
# * :payer_plan_group_id (String)
|
512
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
513
|
-
# * :date_of_birth (Date)
|
504
|
+
# * :zip_plus_four_code (String)
|
505
|
+
# * :address_1 (String)
|
506
|
+
# * :address_2 (String)
|
507
|
+
# * :city (String)
|
508
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
509
|
+
# * :zip_code (String)
|
510
|
+
# * :first_name (String)
|
511
|
+
# * :last_name (String)
|
512
|
+
# * :organization_name (String)
|
513
|
+
# * :supervising_provider (Hash)
|
514
|
+
# * :npi (String)
|
515
|
+
# * :taxonomy_code (String)
|
514
516
|
# * :address (Hash)
|
515
517
|
# * :zip_plus_four_code (String)
|
516
518
|
# * :address_1 (String)
|
@@ -520,24 +522,8 @@ module CandidApiClient
|
|
520
522
|
# * :zip_code (String)
|
521
523
|
# * :first_name (String)
|
522
524
|
# * :last_name (String)
|
523
|
-
# * :
|
524
|
-
# * :
|
525
|
-
# * :insurance_card (Hash)
|
526
|
-
# * :member_id (String)
|
527
|
-
# * :payer_name (String)
|
528
|
-
# * :payer_id (String)
|
529
|
-
# * :rx_bin (String)
|
530
|
-
# * :rx_pcn (String)
|
531
|
-
# * :image_url_front (String)
|
532
|
-
# * :image_url_back (String)
|
533
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
534
|
-
# * :group_number (String)
|
535
|
-
# * :plan_name (String)
|
536
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
537
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
538
|
-
# * :payer_plan_group_id (String)
|
539
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
540
|
-
# * :date_of_birth (Date)
|
525
|
+
# * :organization_name (String)
|
526
|
+
# * :billing_provider (Hash)
|
541
527
|
# * :address (Hash)
|
542
528
|
# * :zip_plus_four_code (String)
|
543
529
|
# * :address_1 (String)
|
@@ -545,9 +531,32 @@ module CandidApiClient
|
|
545
531
|
# * :city (String)
|
546
532
|
# * :state (CandidApiClient::Commons::Types::State)
|
547
533
|
# * :zip_code (String)
|
534
|
+
# * :tax_id (String)
|
535
|
+
# * :npi (String)
|
536
|
+
# * :taxonomy_code (String)
|
537
|
+
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
548
538
|
# * :first_name (String)
|
549
539
|
# * :last_name (String)
|
550
|
-
# * :
|
540
|
+
# * :organization_name (String)
|
541
|
+
# * :pay_to_address (Hash)
|
542
|
+
# * :zip_plus_four_code (String)
|
543
|
+
# * :address_1 (String)
|
544
|
+
# * :address_2 (String)
|
545
|
+
# * :city (String)
|
546
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
547
|
+
# * :zip_code (String)
|
548
|
+
# * :benefits_assigned_to_provider (Boolean)
|
549
|
+
# * :prior_authorization_number (String)
|
550
|
+
# * :external_id (String)
|
551
|
+
# * :date_of_service (Date)
|
552
|
+
# * :tag_ids (Array<String>)
|
553
|
+
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
554
|
+
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
555
|
+
# * :provider_accepts_assignment (Boolean)
|
556
|
+
# * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
|
557
|
+
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
558
|
+
# * :appointment_type (String)
|
559
|
+
# * :end_date_of_service (Date)
|
551
560
|
# * :additional_information (String)
|
552
561
|
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
553
562
|
# * :admission_date (Date)
|
@@ -556,7 +565,6 @@ module CandidApiClient
|
|
556
565
|
# * :last_menstrual_period_date (Date)
|
557
566
|
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
558
567
|
# * :patient_authorized_release (Boolean)
|
559
|
-
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>)
|
560
568
|
# * :vitals (Hash)
|
561
569
|
# * :height_in (Integer)
|
562
570
|
# * :weight_lbs (Integer)
|
@@ -565,29 +573,7 @@ module CandidApiClient
|
|
565
573
|
# * :body_temperature_f (Float)
|
566
574
|
# * :hemoglobin_gdl (Float)
|
567
575
|
# * :hematocrit_pct (Float)
|
568
|
-
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::Medication>)
|
569
|
-
# * :guarantor (Hash)
|
570
|
-
# * :first_name (String)
|
571
|
-
# * :last_name (String)
|
572
|
-
# * :external_id (String)
|
573
|
-
# * :date_of_birth (Date)
|
574
|
-
# * :address (Hash)
|
575
|
-
# * :zip_plus_four_code (String)
|
576
|
-
# * :address_1 (String)
|
577
|
-
# * :address_2 (String)
|
578
|
-
# * :city (String)
|
579
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
580
|
-
# * :zip_code (String)
|
581
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
582
|
-
# * :phone_consent (Boolean)
|
583
|
-
# * :email (String)
|
584
|
-
# * :email_consent (Boolean)
|
585
576
|
# * :referral_number (String)
|
586
|
-
# * :epsdt_referral (Hash)
|
587
|
-
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
588
|
-
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
589
|
-
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
590
|
-
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>)
|
591
577
|
# * :secondary_payer_carrier_code (String)
|
592
578
|
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
|
593
579
|
# for example, your internal encounter ID or a Dr. Chrono encounter ID.
|
@@ -596,6 +582,9 @@ module CandidApiClient
|
|
596
582
|
# system (e.g. the EHR visit page).
|
597
583
|
# Send full URL format for the external link (e.g.
|
598
584
|
# https://emr_charge_capture_url.com/123).
|
585
|
+
# @param originating_system [String] An optional string field denoting the originating system of the charge.
|
586
|
+
# @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
|
587
|
+
# creation.
|
599
588
|
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
600
589
|
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
601
590
|
# @param request_options [CandidApiClient::RequestOptions]
|
@@ -604,7 +593,7 @@ module CandidApiClient
|
|
604
593
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
605
594
|
# api.charge_capture.v_1.update(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
606
595
|
def update(charge_capture_id:, data: nil, charge_external_id: nil, ehr_source_url: nil,
|
607
|
-
patient_external_id: nil, status: nil, request_options: nil)
|
596
|
+
originating_system: nil, claim_creation_category: nil, patient_external_id: nil, status: nil, request_options: nil)
|
608
597
|
response = @request_client.conn.patch do |req|
|
609
598
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
610
599
|
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
@@ -618,6 +607,8 @@ module CandidApiClient
|
|
618
607
|
data: data,
|
619
608
|
charge_external_id: charge_external_id,
|
620
609
|
ehr_source_url: ehr_source_url,
|
610
|
+
originating_system: originating_system,
|
611
|
+
claim_creation_category: claim_creation_category,
|
621
612
|
patient_external_id: patient_external_id,
|
622
613
|
status: status
|
623
614
|
}.compact
|
@@ -810,15 +801,120 @@ module CandidApiClient
|
|
810
801
|
# @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
|
811
802
|
# listed as optional. Candid will use this data when attempting to bundle multiple
|
812
803
|
# Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
813
|
-
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::
|
814
|
-
# * :
|
804
|
+
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
|
805
|
+
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
|
806
|
+
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
|
807
|
+
# * :epsdt_referral (Hash)
|
808
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
809
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
810
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
811
|
+
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
|
812
|
+
# * :guarantor (Hash)
|
813
|
+
# * :first_name (String)
|
814
|
+
# * :last_name (String)
|
815
|
+
# * :external_id (String)
|
816
|
+
# * :date_of_birth (Date)
|
817
|
+
# * :address (Hash)
|
818
|
+
# * :zip_plus_four_code (String)
|
819
|
+
# * :address_1 (String)
|
820
|
+
# * :address_2 (String)
|
821
|
+
# * :city (String)
|
822
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
823
|
+
# * :zip_code (String)
|
824
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
825
|
+
# * :phone_consent (Boolean)
|
826
|
+
# * :email (String)
|
827
|
+
# * :email_consent (Boolean)
|
828
|
+
# * :subscriber_primary (Hash)
|
829
|
+
# * :insurance_card (Hash)
|
830
|
+
# * :member_id (String)
|
831
|
+
# * :payer_name (String)
|
832
|
+
# * :payer_id (String)
|
833
|
+
# * :rx_bin (String)
|
834
|
+
# * :rx_pcn (String)
|
835
|
+
# * :image_url_front (String)
|
836
|
+
# * :image_url_back (String)
|
837
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
838
|
+
# * :group_number (String)
|
839
|
+
# * :plan_name (String)
|
840
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
841
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
842
|
+
# * :payer_plan_group_id (String)
|
843
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
844
|
+
# * :date_of_birth (Date)
|
845
|
+
# * :address (Hash)
|
846
|
+
# * :zip_plus_four_code (String)
|
847
|
+
# * :address_1 (String)
|
848
|
+
# * :address_2 (String)
|
849
|
+
# * :city (String)
|
850
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
851
|
+
# * :zip_code (String)
|
852
|
+
# * :first_name (String)
|
853
|
+
# * :last_name (String)
|
854
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
855
|
+
# * :subscriber_secondary (Hash)
|
856
|
+
# * :insurance_card (Hash)
|
857
|
+
# * :member_id (String)
|
858
|
+
# * :payer_name (String)
|
859
|
+
# * :payer_id (String)
|
860
|
+
# * :rx_bin (String)
|
861
|
+
# * :rx_pcn (String)
|
862
|
+
# * :image_url_front (String)
|
863
|
+
# * :image_url_back (String)
|
864
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
865
|
+
# * :group_number (String)
|
866
|
+
# * :plan_name (String)
|
867
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
868
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
869
|
+
# * :payer_plan_group_id (String)
|
870
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
871
|
+
# * :date_of_birth (Date)
|
872
|
+
# * :address (Hash)
|
873
|
+
# * :zip_plus_four_code (String)
|
874
|
+
# * :address_1 (String)
|
875
|
+
# * :address_2 (String)
|
876
|
+
# * :city (String)
|
877
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
878
|
+
# * :zip_code (String)
|
879
|
+
# * :first_name (String)
|
880
|
+
# * :last_name (String)
|
881
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
882
|
+
# * :subscriber_tertiary (Hash)
|
883
|
+
# * :insurance_card (Hash)
|
884
|
+
# * :member_id (String)
|
885
|
+
# * :payer_name (String)
|
886
|
+
# * :payer_id (String)
|
887
|
+
# * :rx_bin (String)
|
888
|
+
# * :rx_pcn (String)
|
889
|
+
# * :image_url_front (String)
|
890
|
+
# * :image_url_back (String)
|
891
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
892
|
+
# * :group_number (String)
|
893
|
+
# * :plan_name (String)
|
894
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
895
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
896
|
+
# * :payer_plan_group_id (String)
|
897
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
898
|
+
# * :date_of_birth (Date)
|
899
|
+
# * :address (Hash)
|
900
|
+
# * :zip_plus_four_code (String)
|
901
|
+
# * :address_1 (String)
|
902
|
+
# * :address_2 (String)
|
903
|
+
# * :city (String)
|
904
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
905
|
+
# * :zip_code (String)
|
906
|
+
# * :first_name (String)
|
907
|
+
# * :last_name (String)
|
908
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
909
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
910
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
815
911
|
# * :external_claim_submission (Hash)
|
816
912
|
# * :claim_created_at (DateTime)
|
817
913
|
# * :patient_control_number (String)
|
818
|
-
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::
|
819
|
-
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::
|
820
|
-
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::
|
821
|
-
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::
|
914
|
+
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
|
915
|
+
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
|
916
|
+
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
|
917
|
+
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
|
822
918
|
# * :patient (Hash)
|
823
919
|
# * :first_name (String)
|
824
920
|
# * :last_name (String)
|
@@ -832,12 +928,12 @@ module CandidApiClient
|
|
832
928
|
# * :city (String)
|
833
929
|
# * :state (CandidApiClient::Commons::Types::State)
|
834
930
|
# * :zip_code (String)
|
835
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
931
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
836
932
|
# * :phone_consent (Boolean)
|
837
933
|
# * :email (String)
|
838
934
|
# * :email_consent (Boolean)
|
839
935
|
# * :non_insurance_payers (Array<String>)
|
840
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
936
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
841
937
|
# * :service_facility (Hash)
|
842
938
|
# * :organization_name (String)
|
843
939
|
# * :npi (String)
|
@@ -901,8 +997,123 @@ module CandidApiClient
|
|
901
997
|
# * :zip_code (String)
|
902
998
|
# * :first_name (String)
|
903
999
|
# * :last_name (String)
|
904
|
-
# * :organization_name (String)
|
905
|
-
# * :billing_provider (Hash)
|
1000
|
+
# * :organization_name (String)
|
1001
|
+
# * :billing_provider (Hash)
|
1002
|
+
# * :address (Hash)
|
1003
|
+
# * :zip_plus_four_code (String)
|
1004
|
+
# * :address_1 (String)
|
1005
|
+
# * :address_2 (String)
|
1006
|
+
# * :city (String)
|
1007
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
1008
|
+
# * :zip_code (String)
|
1009
|
+
# * :tax_id (String)
|
1010
|
+
# * :npi (String)
|
1011
|
+
# * :taxonomy_code (String)
|
1012
|
+
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
1013
|
+
# * :first_name (String)
|
1014
|
+
# * :last_name (String)
|
1015
|
+
# * :organization_name (String)
|
1016
|
+
# * :pay_to_address (Hash)
|
1017
|
+
# * :zip_plus_four_code (String)
|
1018
|
+
# * :address_1 (String)
|
1019
|
+
# * :address_2 (String)
|
1020
|
+
# * :city (String)
|
1021
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
1022
|
+
# * :zip_code (String)
|
1023
|
+
# * :benefits_assigned_to_provider (Boolean)
|
1024
|
+
# * :prior_authorization_number (String)
|
1025
|
+
# * :external_id (String)
|
1026
|
+
# * :date_of_service (Date)
|
1027
|
+
# * :tag_ids (Array<String>)
|
1028
|
+
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
1029
|
+
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
1030
|
+
# * :provider_accepts_assignment (Boolean)
|
1031
|
+
# * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
|
1032
|
+
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
1033
|
+
# * :appointment_type (String)
|
1034
|
+
# * :end_date_of_service (Date)
|
1035
|
+
# * :additional_information (String)
|
1036
|
+
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
1037
|
+
# * :admission_date (Date)
|
1038
|
+
# * :discharge_date (Date)
|
1039
|
+
# * :onset_of_current_illness_or_symptom_date (Date)
|
1040
|
+
# * :last_menstrual_period_date (Date)
|
1041
|
+
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
1042
|
+
# * :patient_authorized_release (Boolean)
|
1043
|
+
# * :vitals (Hash)
|
1044
|
+
# * :height_in (Integer)
|
1045
|
+
# * :weight_lbs (Integer)
|
1046
|
+
# * :blood_pressure_systolic_mmhg (Integer)
|
1047
|
+
# * :blood_pressure_diastolic_mmhg (Integer)
|
1048
|
+
# * :body_temperature_f (Float)
|
1049
|
+
# * :hemoglobin_gdl (Float)
|
1050
|
+
# * :hematocrit_pct (Float)
|
1051
|
+
# * :referral_number (String)
|
1052
|
+
# * :secondary_payer_carrier_code (String)
|
1053
|
+
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
|
1054
|
+
# internal encounter ID or a Dr. Chrono encounter ID. This field should not
|
1055
|
+
# contain PHI.
|
1056
|
+
# @param originating_system [String] An optional string field denoting the originating system of the charge.
|
1057
|
+
# @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
|
1058
|
+
# creation.
|
1059
|
+
# @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
|
1060
|
+
# system (e.g. the EHR visit page). Send full URL format for the external link
|
1061
|
+
# (e.g. https://emr_charge_capture_url.com/123).
|
1062
|
+
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
1063
|
+
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
1064
|
+
# @param request_options [CandidApiClient::RequestOptions]
|
1065
|
+
# @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
|
1066
|
+
# @example
|
1067
|
+
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
1068
|
+
# api.charge_capture.v_1.create(
|
1069
|
+
# data: { },
|
1070
|
+
# charge_external_id: "charge_external_id",
|
1071
|
+
# patient_external_id: "patient_external_id",
|
1072
|
+
# status: PLANNED
|
1073
|
+
# )
|
1074
|
+
def create(data:, charge_external_id:, patient_external_id:, status:, originating_system: nil, claim_creation_category: nil,
|
1075
|
+
ehr_source_url: nil, request_options: nil)
|
1076
|
+
Async do
|
1077
|
+
response = @request_client.conn.post do |req|
|
1078
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
1079
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
1080
|
+
req.headers = {
|
1081
|
+
**(req.headers || {}),
|
1082
|
+
**@request_client.get_headers,
|
1083
|
+
**(request_options&.additional_headers || {})
|
1084
|
+
}.compact
|
1085
|
+
req.body = {
|
1086
|
+
**(request_options&.additional_body_parameters || {}),
|
1087
|
+
data: data,
|
1088
|
+
charge_external_id: charge_external_id,
|
1089
|
+
originating_system: originating_system,
|
1090
|
+
claim_creation_category: claim_creation_category,
|
1091
|
+
ehr_source_url: ehr_source_url,
|
1092
|
+
patient_external_id: patient_external_id,
|
1093
|
+
status: status
|
1094
|
+
}.compact
|
1095
|
+
req.url "#{@request_client.get_url(environment: CandidApi,
|
1096
|
+
request_options: request_options)}/api/charge_captures/v1"
|
1097
|
+
end
|
1098
|
+
CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
|
1099
|
+
end
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
# @param charge_capture_id [String]
|
1103
|
+
# @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
1104
|
+
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
|
1105
|
+
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
|
1106
|
+
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
|
1107
|
+
# * :epsdt_referral (Hash)
|
1108
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1109
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1110
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1111
|
+
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
|
1112
|
+
# * :guarantor (Hash)
|
1113
|
+
# * :first_name (String)
|
1114
|
+
# * :last_name (String)
|
1115
|
+
# * :external_id (String)
|
1116
|
+
# * :date_of_birth (Date)
|
906
1117
|
# * :address (Hash)
|
907
1118
|
# * :zip_plus_four_code (String)
|
908
1119
|
# * :address_1 (String)
|
@@ -910,33 +1121,10 @@ module CandidApiClient
|
|
910
1121
|
# * :city (String)
|
911
1122
|
# * :state (CandidApiClient::Commons::Types::State)
|
912
1123
|
# * :zip_code (String)
|
913
|
-
# * :
|
914
|
-
# * :
|
915
|
-
# * :
|
916
|
-
# * :
|
917
|
-
# * :first_name (String)
|
918
|
-
# * :last_name (String)
|
919
|
-
# * :organization_name (String)
|
920
|
-
# * :pay_to_address (Hash)
|
921
|
-
# * :zip_plus_four_code (String)
|
922
|
-
# * :address_1 (String)
|
923
|
-
# * :address_2 (String)
|
924
|
-
# * :city (String)
|
925
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
926
|
-
# * :zip_code (String)
|
927
|
-
# * :benefits_assigned_to_provider (Boolean)
|
928
|
-
# * :prior_authorization_number (String)
|
929
|
-
# * :external_id (String)
|
930
|
-
# * :date_of_service (Date)
|
931
|
-
# * :tag_ids (Array<String>)
|
932
|
-
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>)
|
933
|
-
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
934
|
-
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
935
|
-
# * :provider_accepts_assignment (Boolean)
|
936
|
-
# * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
|
937
|
-
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
938
|
-
# * :appointment_type (String)
|
939
|
-
# * :end_date_of_service (Date)
|
1124
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
1125
|
+
# * :phone_consent (Boolean)
|
1126
|
+
# * :email (String)
|
1127
|
+
# * :email_consent (Boolean)
|
940
1128
|
# * :subscriber_primary (Hash)
|
941
1129
|
# * :insurance_card (Hash)
|
942
1130
|
# * :member_id (String)
|
@@ -1018,123 +1206,15 @@ module CandidApiClient
|
|
1018
1206
|
# * :first_name (String)
|
1019
1207
|
# * :last_name (String)
|
1020
1208
|
# * :gender (CandidApiClient::Individual::Types::Gender)
|
1021
|
-
# * :
|
1022
|
-
# * :
|
1023
|
-
# * :admission_date (Date)
|
1024
|
-
# * :discharge_date (Date)
|
1025
|
-
# * :onset_of_current_illness_or_symptom_date (Date)
|
1026
|
-
# * :last_menstrual_period_date (Date)
|
1027
|
-
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
1028
|
-
# * :patient_authorized_release (Boolean)
|
1029
|
-
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>)
|
1030
|
-
# * :vitals (Hash)
|
1031
|
-
# * :height_in (Integer)
|
1032
|
-
# * :weight_lbs (Integer)
|
1033
|
-
# * :blood_pressure_systolic_mmhg (Integer)
|
1034
|
-
# * :blood_pressure_diastolic_mmhg (Integer)
|
1035
|
-
# * :body_temperature_f (Float)
|
1036
|
-
# * :hemoglobin_gdl (Float)
|
1037
|
-
# * :hematocrit_pct (Float)
|
1038
|
-
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::Medication>)
|
1039
|
-
# * :guarantor (Hash)
|
1040
|
-
# * :first_name (String)
|
1041
|
-
# * :last_name (String)
|
1042
|
-
# * :external_id (String)
|
1043
|
-
# * :date_of_birth (Date)
|
1044
|
-
# * :address (Hash)
|
1045
|
-
# * :zip_plus_four_code (String)
|
1046
|
-
# * :address_1 (String)
|
1047
|
-
# * :address_2 (String)
|
1048
|
-
# * :city (String)
|
1049
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
1050
|
-
# * :zip_code (String)
|
1051
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
1052
|
-
# * :phone_consent (Boolean)
|
1053
|
-
# * :email (String)
|
1054
|
-
# * :email_consent (Boolean)
|
1055
|
-
# * :referral_number (String)
|
1056
|
-
# * :epsdt_referral (Hash)
|
1057
|
-
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1058
|
-
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1059
|
-
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1060
|
-
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>)
|
1061
|
-
# * :secondary_payer_carrier_code (String)
|
1062
|
-
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
|
1063
|
-
# internal encounter ID or a Dr. Chrono encounter ID. This field should not
|
1064
|
-
# contain PHI.
|
1065
|
-
# @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
|
1066
|
-
# system (e.g. the EHR visit page). Send full URL format for the external link
|
1067
|
-
# (e.g. https://emr_charge_capture_url.com/123).
|
1068
|
-
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
1069
|
-
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
1070
|
-
# @param request_options [CandidApiClient::RequestOptions]
|
1071
|
-
# @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
|
1072
|
-
# @example
|
1073
|
-
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
1074
|
-
# api.charge_capture.v_1.create(
|
1075
|
-
# data: { },
|
1076
|
-
# charge_external_id: "charge_external_id",
|
1077
|
-
# patient_external_id: "patient_external_id",
|
1078
|
-
# status: PLANNED
|
1079
|
-
# )
|
1080
|
-
def create(data:, charge_external_id:, patient_external_id:, status:, ehr_source_url: nil, request_options: nil)
|
1081
|
-
Async do
|
1082
|
-
response = @request_client.conn.post do |req|
|
1083
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
1084
|
-
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
1085
|
-
req.headers = {
|
1086
|
-
**(req.headers || {}),
|
1087
|
-
**@request_client.get_headers,
|
1088
|
-
**(request_options&.additional_headers || {})
|
1089
|
-
}.compact
|
1090
|
-
req.body = {
|
1091
|
-
**(request_options&.additional_body_parameters || {}),
|
1092
|
-
data: data,
|
1093
|
-
charge_external_id: charge_external_id,
|
1094
|
-
ehr_source_url: ehr_source_url,
|
1095
|
-
patient_external_id: patient_external_id,
|
1096
|
-
status: status
|
1097
|
-
}.compact
|
1098
|
-
req.url "#{@request_client.get_url(environment: CandidApi,
|
1099
|
-
request_options: request_options)}/api/charge_captures/v1"
|
1100
|
-
end
|
1101
|
-
CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
|
1102
|
-
end
|
1103
|
-
end
|
1104
|
-
|
1105
|
-
# @param charge_capture_id [String]
|
1106
|
-
# @param request_options [CandidApiClient::RequestOptions]
|
1107
|
-
# @return [Void]
|
1108
|
-
# @example
|
1109
|
-
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
1110
|
-
# api.charge_capture.v_1.delete(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
1111
|
-
def delete(charge_capture_id:, request_options: nil)
|
1112
|
-
Async do
|
1113
|
-
@request_client.conn.delete do |req|
|
1114
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
1115
|
-
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
1116
|
-
req.headers = {
|
1117
|
-
**(req.headers || {}),
|
1118
|
-
**@request_client.get_headers,
|
1119
|
-
**(request_options&.additional_headers || {})
|
1120
|
-
}.compact
|
1121
|
-
req.url "#{@request_client.get_url(environment: CandidApi,
|
1122
|
-
request_options: request_options)}/api/charge_captures/v1/#{charge_capture_id}"
|
1123
|
-
end
|
1124
|
-
end
|
1125
|
-
end
|
1126
|
-
|
1127
|
-
# @param charge_capture_id [String]
|
1128
|
-
# @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
1129
|
-
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreate>)
|
1130
|
-
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::Intervention>)
|
1209
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
1210
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
1131
1211
|
# * :external_claim_submission (Hash)
|
1132
1212
|
# * :claim_created_at (DateTime)
|
1133
1213
|
# * :patient_control_number (String)
|
1134
|
-
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::
|
1135
|
-
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::
|
1136
|
-
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::
|
1137
|
-
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::
|
1214
|
+
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
|
1215
|
+
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
|
1216
|
+
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
|
1217
|
+
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
|
1138
1218
|
# * :patient (Hash)
|
1139
1219
|
# * :first_name (String)
|
1140
1220
|
# * :last_name (String)
|
@@ -1148,12 +1228,12 @@ module CandidApiClient
|
|
1148
1228
|
# * :city (String)
|
1149
1229
|
# * :state (CandidApiClient::Commons::Types::State)
|
1150
1230
|
# * :zip_code (String)
|
1151
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
1231
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
1152
1232
|
# * :phone_consent (Boolean)
|
1153
1233
|
# * :email (String)
|
1154
1234
|
# * :email_consent (Boolean)
|
1155
1235
|
# * :non_insurance_payers (Array<String>)
|
1156
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
1236
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
1157
1237
|
# * :service_facility (Hash)
|
1158
1238
|
# * :organization_name (String)
|
1159
1239
|
# * :npi (String)
|
@@ -1245,7 +1325,6 @@ module CandidApiClient
|
|
1245
1325
|
# * :external_id (String)
|
1246
1326
|
# * :date_of_service (Date)
|
1247
1327
|
# * :tag_ids (Array<String>)
|
1248
|
-
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>)
|
1249
1328
|
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
1250
1329
|
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
1251
1330
|
# * :provider_accepts_assignment (Boolean)
|
@@ -1253,87 +1332,6 @@ module CandidApiClient
|
|
1253
1332
|
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
1254
1333
|
# * :appointment_type (String)
|
1255
1334
|
# * :end_date_of_service (Date)
|
1256
|
-
# * :subscriber_primary (Hash)
|
1257
|
-
# * :insurance_card (Hash)
|
1258
|
-
# * :member_id (String)
|
1259
|
-
# * :payer_name (String)
|
1260
|
-
# * :payer_id (String)
|
1261
|
-
# * :rx_bin (String)
|
1262
|
-
# * :rx_pcn (String)
|
1263
|
-
# * :image_url_front (String)
|
1264
|
-
# * :image_url_back (String)
|
1265
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
1266
|
-
# * :group_number (String)
|
1267
|
-
# * :plan_name (String)
|
1268
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
1269
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
1270
|
-
# * :payer_plan_group_id (String)
|
1271
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
1272
|
-
# * :date_of_birth (Date)
|
1273
|
-
# * :address (Hash)
|
1274
|
-
# * :zip_plus_four_code (String)
|
1275
|
-
# * :address_1 (String)
|
1276
|
-
# * :address_2 (String)
|
1277
|
-
# * :city (String)
|
1278
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
1279
|
-
# * :zip_code (String)
|
1280
|
-
# * :first_name (String)
|
1281
|
-
# * :last_name (String)
|
1282
|
-
# * :gender (CandidApiClient::Individual::Types::Gender)
|
1283
|
-
# * :subscriber_secondary (Hash)
|
1284
|
-
# * :insurance_card (Hash)
|
1285
|
-
# * :member_id (String)
|
1286
|
-
# * :payer_name (String)
|
1287
|
-
# * :payer_id (String)
|
1288
|
-
# * :rx_bin (String)
|
1289
|
-
# * :rx_pcn (String)
|
1290
|
-
# * :image_url_front (String)
|
1291
|
-
# * :image_url_back (String)
|
1292
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
1293
|
-
# * :group_number (String)
|
1294
|
-
# * :plan_name (String)
|
1295
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
1296
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
1297
|
-
# * :payer_plan_group_id (String)
|
1298
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
1299
|
-
# * :date_of_birth (Date)
|
1300
|
-
# * :address (Hash)
|
1301
|
-
# * :zip_plus_four_code (String)
|
1302
|
-
# * :address_1 (String)
|
1303
|
-
# * :address_2 (String)
|
1304
|
-
# * :city (String)
|
1305
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
1306
|
-
# * :zip_code (String)
|
1307
|
-
# * :first_name (String)
|
1308
|
-
# * :last_name (String)
|
1309
|
-
# * :gender (CandidApiClient::Individual::Types::Gender)
|
1310
|
-
# * :subscriber_tertiary (Hash)
|
1311
|
-
# * :insurance_card (Hash)
|
1312
|
-
# * :member_id (String)
|
1313
|
-
# * :payer_name (String)
|
1314
|
-
# * :payer_id (String)
|
1315
|
-
# * :rx_bin (String)
|
1316
|
-
# * :rx_pcn (String)
|
1317
|
-
# * :image_url_front (String)
|
1318
|
-
# * :image_url_back (String)
|
1319
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
1320
|
-
# * :group_number (String)
|
1321
|
-
# * :plan_name (String)
|
1322
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
1323
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
1324
|
-
# * :payer_plan_group_id (String)
|
1325
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
1326
|
-
# * :date_of_birth (Date)
|
1327
|
-
# * :address (Hash)
|
1328
|
-
# * :zip_plus_four_code (String)
|
1329
|
-
# * :address_1 (String)
|
1330
|
-
# * :address_2 (String)
|
1331
|
-
# * :city (String)
|
1332
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
1333
|
-
# * :zip_code (String)
|
1334
|
-
# * :first_name (String)
|
1335
|
-
# * :last_name (String)
|
1336
|
-
# * :gender (CandidApiClient::Individual::Types::Gender)
|
1337
1335
|
# * :additional_information (String)
|
1338
1336
|
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
1339
1337
|
# * :admission_date (Date)
|
@@ -1342,7 +1340,6 @@ module CandidApiClient
|
|
1342
1340
|
# * :last_menstrual_period_date (Date)
|
1343
1341
|
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
1344
1342
|
# * :patient_authorized_release (Boolean)
|
1345
|
-
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>)
|
1346
1343
|
# * :vitals (Hash)
|
1347
1344
|
# * :height_in (Integer)
|
1348
1345
|
# * :weight_lbs (Integer)
|
@@ -1351,29 +1348,7 @@ module CandidApiClient
|
|
1351
1348
|
# * :body_temperature_f (Float)
|
1352
1349
|
# * :hemoglobin_gdl (Float)
|
1353
1350
|
# * :hematocrit_pct (Float)
|
1354
|
-
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::Medication>)
|
1355
|
-
# * :guarantor (Hash)
|
1356
|
-
# * :first_name (String)
|
1357
|
-
# * :last_name (String)
|
1358
|
-
# * :external_id (String)
|
1359
|
-
# * :date_of_birth (Date)
|
1360
|
-
# * :address (Hash)
|
1361
|
-
# * :zip_plus_four_code (String)
|
1362
|
-
# * :address_1 (String)
|
1363
|
-
# * :address_2 (String)
|
1364
|
-
# * :city (String)
|
1365
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
1366
|
-
# * :zip_code (String)
|
1367
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
1368
|
-
# * :phone_consent (Boolean)
|
1369
|
-
# * :email (String)
|
1370
|
-
# * :email_consent (Boolean)
|
1371
1351
|
# * :referral_number (String)
|
1372
|
-
# * :epsdt_referral (Hash)
|
1373
|
-
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1374
|
-
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1375
|
-
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
1376
|
-
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>)
|
1377
1352
|
# * :secondary_payer_carrier_code (String)
|
1378
1353
|
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
|
1379
1354
|
# for example, your internal encounter ID or a Dr. Chrono encounter ID.
|
@@ -1382,6 +1357,9 @@ module CandidApiClient
|
|
1382
1357
|
# system (e.g. the EHR visit page).
|
1383
1358
|
# Send full URL format for the external link (e.g.
|
1384
1359
|
# https://emr_charge_capture_url.com/123).
|
1360
|
+
# @param originating_system [String] An optional string field denoting the originating system of the charge.
|
1361
|
+
# @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
|
1362
|
+
# creation.
|
1385
1363
|
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
1386
1364
|
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
1387
1365
|
# @param request_options [CandidApiClient::RequestOptions]
|
@@ -1390,7 +1368,7 @@ module CandidApiClient
|
|
1390
1368
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
1391
1369
|
# api.charge_capture.v_1.update(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
1392
1370
|
def update(charge_capture_id:, data: nil, charge_external_id: nil, ehr_source_url: nil,
|
1393
|
-
patient_external_id: nil, status: nil, request_options: nil)
|
1371
|
+
originating_system: nil, claim_creation_category: nil, patient_external_id: nil, status: nil, request_options: nil)
|
1394
1372
|
Async do
|
1395
1373
|
response = @request_client.conn.patch do |req|
|
1396
1374
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
@@ -1405,6 +1383,8 @@ module CandidApiClient
|
|
1405
1383
|
data: data,
|
1406
1384
|
charge_external_id: charge_external_id,
|
1407
1385
|
ehr_source_url: ehr_source_url,
|
1386
|
+
originating_system: originating_system,
|
1387
|
+
claim_creation_category: claim_creation_category,
|
1408
1388
|
patient_external_id: patient_external_id,
|
1409
1389
|
status: status
|
1410
1390
|
}.compact
|