candidhealth 1.0.0 → 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 -482
- 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/patients/v_1/types/authorization.rb +13 -1
- 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 +32 -3
- metadata +34 -5
|
@@ -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,99 +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 data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
|
323
|
-
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreate>)
|
|
324
|
-
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::Intervention>)
|
|
434
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
|
435
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
|
325
436
|
# * :external_claim_submission (Hash)
|
|
326
437
|
# * :claim_created_at (DateTime)
|
|
327
438
|
# * :patient_control_number (String)
|
|
328
|
-
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::
|
|
329
|
-
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::
|
|
330
|
-
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::
|
|
331
|
-
# * :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>)
|
|
332
443
|
# * :patient (Hash)
|
|
333
444
|
# * :first_name (String)
|
|
334
445
|
# * :last_name (String)
|
|
@@ -342,12 +453,12 @@ module CandidApiClient
|
|
|
342
453
|
# * :city (String)
|
|
343
454
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
344
455
|
# * :zip_code (String)
|
|
345
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
|
456
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
346
457
|
# * :phone_consent (Boolean)
|
|
347
458
|
# * :email (String)
|
|
348
459
|
# * :email_consent (Boolean)
|
|
349
460
|
# * :non_insurance_payers (Array<String>)
|
|
350
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
|
461
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
|
351
462
|
# * :service_facility (Hash)
|
|
352
463
|
# * :organization_name (String)
|
|
353
464
|
# * :npi (String)
|
|
@@ -381,89 +492,14 @@ module CandidApiClient
|
|
|
381
492
|
# * :address_2 (String)
|
|
382
493
|
# * :city (String)
|
|
383
494
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
384
|
-
# * :zip_code (String)
|
|
385
|
-
# * :qualifier (CandidApiClient::Commons::Types::QualifierCode)
|
|
386
|
-
# * :first_name (String)
|
|
387
|
-
# * :last_name (String)
|
|
388
|
-
# * :organization_name (String)
|
|
389
|
-
# * :referring_provider (Hash)
|
|
390
|
-
# * :npi (String)
|
|
391
|
-
# * :taxonomy_code (String)
|
|
392
|
-
# * :address (Hash)
|
|
393
|
-
# * :zip_plus_four_code (String)
|
|
394
|
-
# * :address_1 (String)
|
|
395
|
-
# * :address_2 (String)
|
|
396
|
-
# * :city (String)
|
|
397
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
398
|
-
# * :zip_code (String)
|
|
399
|
-
# * :first_name (String)
|
|
400
|
-
# * :last_name (String)
|
|
401
|
-
# * :organization_name (String)
|
|
402
|
-
# * :supervising_provider (Hash)
|
|
403
|
-
# * :npi (String)
|
|
404
|
-
# * :taxonomy_code (String)
|
|
405
|
-
# * :address (Hash)
|
|
406
|
-
# * :zip_plus_four_code (String)
|
|
407
|
-
# * :address_1 (String)
|
|
408
|
-
# * :address_2 (String)
|
|
409
|
-
# * :city (String)
|
|
410
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
411
|
-
# * :zip_code (String)
|
|
412
|
-
# * :first_name (String)
|
|
413
|
-
# * :last_name (String)
|
|
414
|
-
# * :organization_name (String)
|
|
415
|
-
# * :billing_provider (Hash)
|
|
416
|
-
# * :address (Hash)
|
|
417
|
-
# * :zip_plus_four_code (String)
|
|
418
|
-
# * :address_1 (String)
|
|
419
|
-
# * :address_2 (String)
|
|
420
|
-
# * :city (String)
|
|
421
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
422
|
-
# * :zip_code (String)
|
|
423
|
-
# * :tax_id (String)
|
|
424
|
-
# * :npi (String)
|
|
425
|
-
# * :taxonomy_code (String)
|
|
426
|
-
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
|
427
|
-
# * :first_name (String)
|
|
428
|
-
# * :last_name (String)
|
|
429
|
-
# * :organization_name (String)
|
|
430
|
-
# * :pay_to_address (Hash)
|
|
431
|
-
# * :zip_plus_four_code (String)
|
|
432
|
-
# * :address_1 (String)
|
|
433
|
-
# * :address_2 (String)
|
|
434
|
-
# * :city (String)
|
|
435
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
436
|
-
# * :zip_code (String)
|
|
437
|
-
# * :benefits_assigned_to_provider (Boolean)
|
|
438
|
-
# * :prior_authorization_number (String)
|
|
439
|
-
# * :external_id (String)
|
|
440
|
-
# * :date_of_service (Date)
|
|
441
|
-
# * :tag_ids (Array<String>)
|
|
442
|
-
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>)
|
|
443
|
-
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
|
444
|
-
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
|
445
|
-
# * :provider_accepts_assignment (Boolean)
|
|
446
|
-
# * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
|
|
447
|
-
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
|
448
|
-
# * :appointment_type (String)
|
|
449
|
-
# * :end_date_of_service (Date)
|
|
450
|
-
# * :subscriber_primary (Hash)
|
|
451
|
-
# * :insurance_card (Hash)
|
|
452
|
-
# * :member_id (String)
|
|
453
|
-
# * :payer_name (String)
|
|
454
|
-
# * :payer_id (String)
|
|
455
|
-
# * :rx_bin (String)
|
|
456
|
-
# * :rx_pcn (String)
|
|
457
|
-
# * :image_url_front (String)
|
|
458
|
-
# * :image_url_back (String)
|
|
459
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
460
|
-
# * :group_number (String)
|
|
461
|
-
# * :plan_name (String)
|
|
462
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
463
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
464
|
-
# * :payer_plan_group_id (String)
|
|
465
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
466
|
-
# * :date_of_birth (Date)
|
|
495
|
+
# * :zip_code (String)
|
|
496
|
+
# * :qualifier (CandidApiClient::Commons::Types::QualifierCode)
|
|
497
|
+
# * :first_name (String)
|
|
498
|
+
# * :last_name (String)
|
|
499
|
+
# * :organization_name (String)
|
|
500
|
+
# * :referring_provider (Hash)
|
|
501
|
+
# * :npi (String)
|
|
502
|
+
# * :taxonomy_code (String)
|
|
467
503
|
# * :address (Hash)
|
|
468
504
|
# * :zip_plus_four_code (String)
|
|
469
505
|
# * :address_1 (String)
|
|
@@ -473,24 +509,10 @@ module CandidApiClient
|
|
|
473
509
|
# * :zip_code (String)
|
|
474
510
|
# * :first_name (String)
|
|
475
511
|
# * :last_name (String)
|
|
476
|
-
# * :
|
|
477
|
-
# * :
|
|
478
|
-
# * :
|
|
479
|
-
#
|
|
480
|
-
# * :payer_name (String)
|
|
481
|
-
# * :payer_id (String)
|
|
482
|
-
# * :rx_bin (String)
|
|
483
|
-
# * :rx_pcn (String)
|
|
484
|
-
# * :image_url_front (String)
|
|
485
|
-
# * :image_url_back (String)
|
|
486
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
487
|
-
# * :group_number (String)
|
|
488
|
-
# * :plan_name (String)
|
|
489
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
490
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
491
|
-
# * :payer_plan_group_id (String)
|
|
492
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
493
|
-
# * :date_of_birth (Date)
|
|
512
|
+
# * :organization_name (String)
|
|
513
|
+
# * :supervising_provider (Hash)
|
|
514
|
+
# * :npi (String)
|
|
515
|
+
# * :taxonomy_code (String)
|
|
494
516
|
# * :address (Hash)
|
|
495
517
|
# * :zip_plus_four_code (String)
|
|
496
518
|
# * :address_1 (String)
|
|
@@ -500,24 +522,8 @@ module CandidApiClient
|
|
|
500
522
|
# * :zip_code (String)
|
|
501
523
|
# * :first_name (String)
|
|
502
524
|
# * :last_name (String)
|
|
503
|
-
# * :
|
|
504
|
-
# * :
|
|
505
|
-
# * :insurance_card (Hash)
|
|
506
|
-
# * :member_id (String)
|
|
507
|
-
# * :payer_name (String)
|
|
508
|
-
# * :payer_id (String)
|
|
509
|
-
# * :rx_bin (String)
|
|
510
|
-
# * :rx_pcn (String)
|
|
511
|
-
# * :image_url_front (String)
|
|
512
|
-
# * :image_url_back (String)
|
|
513
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
514
|
-
# * :group_number (String)
|
|
515
|
-
# * :plan_name (String)
|
|
516
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
517
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
518
|
-
# * :payer_plan_group_id (String)
|
|
519
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
520
|
-
# * :date_of_birth (Date)
|
|
525
|
+
# * :organization_name (String)
|
|
526
|
+
# * :billing_provider (Hash)
|
|
521
527
|
# * :address (Hash)
|
|
522
528
|
# * :zip_plus_four_code (String)
|
|
523
529
|
# * :address_1 (String)
|
|
@@ -525,9 +531,32 @@ module CandidApiClient
|
|
|
525
531
|
# * :city (String)
|
|
526
532
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
527
533
|
# * :zip_code (String)
|
|
534
|
+
# * :tax_id (String)
|
|
535
|
+
# * :npi (String)
|
|
536
|
+
# * :taxonomy_code (String)
|
|
537
|
+
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
|
528
538
|
# * :first_name (String)
|
|
529
539
|
# * :last_name (String)
|
|
530
|
-
# * :
|
|
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)
|
|
531
560
|
# * :additional_information (String)
|
|
532
561
|
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
|
533
562
|
# * :admission_date (Date)
|
|
@@ -536,7 +565,6 @@ module CandidApiClient
|
|
|
536
565
|
# * :last_menstrual_period_date (Date)
|
|
537
566
|
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
|
538
567
|
# * :patient_authorized_release (Boolean)
|
|
539
|
-
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>)
|
|
540
568
|
# * :vitals (Hash)
|
|
541
569
|
# * :height_in (Integer)
|
|
542
570
|
# * :weight_lbs (Integer)
|
|
@@ -545,29 +573,7 @@ module CandidApiClient
|
|
|
545
573
|
# * :body_temperature_f (Float)
|
|
546
574
|
# * :hemoglobin_gdl (Float)
|
|
547
575
|
# * :hematocrit_pct (Float)
|
|
548
|
-
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::Medication>)
|
|
549
|
-
# * :guarantor (Hash)
|
|
550
|
-
# * :first_name (String)
|
|
551
|
-
# * :last_name (String)
|
|
552
|
-
# * :external_id (String)
|
|
553
|
-
# * :date_of_birth (Date)
|
|
554
|
-
# * :address (Hash)
|
|
555
|
-
# * :zip_plus_four_code (String)
|
|
556
|
-
# * :address_1 (String)
|
|
557
|
-
# * :address_2 (String)
|
|
558
|
-
# * :city (String)
|
|
559
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
560
|
-
# * :zip_code (String)
|
|
561
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
|
562
|
-
# * :phone_consent (Boolean)
|
|
563
|
-
# * :email (String)
|
|
564
|
-
# * :email_consent (Boolean)
|
|
565
576
|
# * :referral_number (String)
|
|
566
|
-
# * :epsdt_referral (Hash)
|
|
567
|
-
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
568
|
-
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
569
|
-
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
570
|
-
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>)
|
|
571
577
|
# * :secondary_payer_carrier_code (String)
|
|
572
578
|
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
|
|
573
579
|
# for example, your internal encounter ID or a Dr. Chrono encounter ID.
|
|
@@ -576,6 +582,9 @@ module CandidApiClient
|
|
|
576
582
|
# system (e.g. the EHR visit page).
|
|
577
583
|
# Send full URL format for the external link (e.g.
|
|
578
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.
|
|
579
588
|
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
|
580
589
|
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
|
581
590
|
# @param request_options [CandidApiClient::RequestOptions]
|
|
@@ -584,7 +593,7 @@ module CandidApiClient
|
|
|
584
593
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
585
594
|
# api.charge_capture.v_1.update(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
586
595
|
def update(charge_capture_id:, data: nil, charge_external_id: nil, ehr_source_url: nil,
|
|
587
|
-
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)
|
|
588
597
|
response = @request_client.conn.patch do |req|
|
|
589
598
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
590
599
|
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
|
@@ -598,6 +607,8 @@ module CandidApiClient
|
|
|
598
607
|
data: data,
|
|
599
608
|
charge_external_id: charge_external_id,
|
|
600
609
|
ehr_source_url: ehr_source_url,
|
|
610
|
+
originating_system: originating_system,
|
|
611
|
+
claim_creation_category: claim_creation_category,
|
|
601
612
|
patient_external_id: patient_external_id,
|
|
602
613
|
status: status
|
|
603
614
|
}.compact
|
|
@@ -790,15 +801,120 @@ module CandidApiClient
|
|
|
790
801
|
# @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
|
|
791
802
|
# listed as optional. Candid will use this data when attempting to bundle multiple
|
|
792
803
|
# Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
|
793
|
-
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::
|
|
794
|
-
# * :
|
|
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>)
|
|
795
911
|
# * :external_claim_submission (Hash)
|
|
796
912
|
# * :claim_created_at (DateTime)
|
|
797
913
|
# * :patient_control_number (String)
|
|
798
|
-
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::
|
|
799
|
-
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::
|
|
800
|
-
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::
|
|
801
|
-
# * :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>)
|
|
802
918
|
# * :patient (Hash)
|
|
803
919
|
# * :first_name (String)
|
|
804
920
|
# * :last_name (String)
|
|
@@ -812,12 +928,12 @@ module CandidApiClient
|
|
|
812
928
|
# * :city (String)
|
|
813
929
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
814
930
|
# * :zip_code (String)
|
|
815
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
|
931
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
816
932
|
# * :phone_consent (Boolean)
|
|
817
933
|
# * :email (String)
|
|
818
934
|
# * :email_consent (Boolean)
|
|
819
935
|
# * :non_insurance_payers (Array<String>)
|
|
820
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
|
936
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
|
821
937
|
# * :service_facility (Hash)
|
|
822
938
|
# * :organization_name (String)
|
|
823
939
|
# * :npi (String)
|
|
@@ -881,8 +997,123 @@ module CandidApiClient
|
|
|
881
997
|
# * :zip_code (String)
|
|
882
998
|
# * :first_name (String)
|
|
883
999
|
# * :last_name (String)
|
|
884
|
-
# * :organization_name (String)
|
|
885
|
-
# * :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)
|
|
886
1117
|
# * :address (Hash)
|
|
887
1118
|
# * :zip_plus_four_code (String)
|
|
888
1119
|
# * :address_1 (String)
|
|
@@ -890,33 +1121,10 @@ module CandidApiClient
|
|
|
890
1121
|
# * :city (String)
|
|
891
1122
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
892
1123
|
# * :zip_code (String)
|
|
893
|
-
# * :
|
|
894
|
-
# * :
|
|
895
|
-
# * :
|
|
896
|
-
# * :
|
|
897
|
-
# * :first_name (String)
|
|
898
|
-
# * :last_name (String)
|
|
899
|
-
# * :organization_name (String)
|
|
900
|
-
# * :pay_to_address (Hash)
|
|
901
|
-
# * :zip_plus_four_code (String)
|
|
902
|
-
# * :address_1 (String)
|
|
903
|
-
# * :address_2 (String)
|
|
904
|
-
# * :city (String)
|
|
905
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
906
|
-
# * :zip_code (String)
|
|
907
|
-
# * :benefits_assigned_to_provider (Boolean)
|
|
908
|
-
# * :prior_authorization_number (String)
|
|
909
|
-
# * :external_id (String)
|
|
910
|
-
# * :date_of_service (Date)
|
|
911
|
-
# * :tag_ids (Array<String>)
|
|
912
|
-
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>)
|
|
913
|
-
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
|
914
|
-
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
|
915
|
-
# * :provider_accepts_assignment (Boolean)
|
|
916
|
-
# * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
|
|
917
|
-
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
|
918
|
-
# * :appointment_type (String)
|
|
919
|
-
# * :end_date_of_service (Date)
|
|
1124
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
1125
|
+
# * :phone_consent (Boolean)
|
|
1126
|
+
# * :email (String)
|
|
1127
|
+
# * :email_consent (Boolean)
|
|
920
1128
|
# * :subscriber_primary (Hash)
|
|
921
1129
|
# * :insurance_card (Hash)
|
|
922
1130
|
# * :member_id (String)
|
|
@@ -998,101 +1206,15 @@ module CandidApiClient
|
|
|
998
1206
|
# * :first_name (String)
|
|
999
1207
|
# * :last_name (String)
|
|
1000
1208
|
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
1001
|
-
# * :
|
|
1002
|
-
# * :
|
|
1003
|
-
# * :admission_date (Date)
|
|
1004
|
-
# * :discharge_date (Date)
|
|
1005
|
-
# * :onset_of_current_illness_or_symptom_date (Date)
|
|
1006
|
-
# * :last_menstrual_period_date (Date)
|
|
1007
|
-
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
|
1008
|
-
# * :patient_authorized_release (Boolean)
|
|
1009
|
-
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>)
|
|
1010
|
-
# * :vitals (Hash)
|
|
1011
|
-
# * :height_in (Integer)
|
|
1012
|
-
# * :weight_lbs (Integer)
|
|
1013
|
-
# * :blood_pressure_systolic_mmhg (Integer)
|
|
1014
|
-
# * :blood_pressure_diastolic_mmhg (Integer)
|
|
1015
|
-
# * :body_temperature_f (Float)
|
|
1016
|
-
# * :hemoglobin_gdl (Float)
|
|
1017
|
-
# * :hematocrit_pct (Float)
|
|
1018
|
-
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::Medication>)
|
|
1019
|
-
# * :guarantor (Hash)
|
|
1020
|
-
# * :first_name (String)
|
|
1021
|
-
# * :last_name (String)
|
|
1022
|
-
# * :external_id (String)
|
|
1023
|
-
# * :date_of_birth (Date)
|
|
1024
|
-
# * :address (Hash)
|
|
1025
|
-
# * :zip_plus_four_code (String)
|
|
1026
|
-
# * :address_1 (String)
|
|
1027
|
-
# * :address_2 (String)
|
|
1028
|
-
# * :city (String)
|
|
1029
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
1030
|
-
# * :zip_code (String)
|
|
1031
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
|
1032
|
-
# * :phone_consent (Boolean)
|
|
1033
|
-
# * :email (String)
|
|
1034
|
-
# * :email_consent (Boolean)
|
|
1035
|
-
# * :referral_number (String)
|
|
1036
|
-
# * :epsdt_referral (Hash)
|
|
1037
|
-
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
1038
|
-
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
1039
|
-
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
1040
|
-
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>)
|
|
1041
|
-
# * :secondary_payer_carrier_code (String)
|
|
1042
|
-
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
|
|
1043
|
-
# internal encounter ID or a Dr. Chrono encounter ID. This field should not
|
|
1044
|
-
# contain PHI.
|
|
1045
|
-
# @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
|
|
1046
|
-
# system (e.g. the EHR visit page). Send full URL format for the external link
|
|
1047
|
-
# (e.g. https://emr_charge_capture_url.com/123).
|
|
1048
|
-
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
|
1049
|
-
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
|
1050
|
-
# @param request_options [CandidApiClient::RequestOptions]
|
|
1051
|
-
# @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
|
|
1052
|
-
# @example
|
|
1053
|
-
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1054
|
-
# api.charge_capture.v_1.create(
|
|
1055
|
-
# data: { },
|
|
1056
|
-
# charge_external_id: "charge_external_id",
|
|
1057
|
-
# patient_external_id: "patient_external_id",
|
|
1058
|
-
# status: PLANNED
|
|
1059
|
-
# )
|
|
1060
|
-
def create(data:, charge_external_id:, patient_external_id:, status:, ehr_source_url: nil, request_options: nil)
|
|
1061
|
-
Async do
|
|
1062
|
-
response = @request_client.conn.post do |req|
|
|
1063
|
-
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
1064
|
-
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
|
1065
|
-
req.headers = {
|
|
1066
|
-
**(req.headers || {}),
|
|
1067
|
-
**@request_client.get_headers,
|
|
1068
|
-
**(request_options&.additional_headers || {})
|
|
1069
|
-
}.compact
|
|
1070
|
-
req.body = {
|
|
1071
|
-
**(request_options&.additional_body_parameters || {}),
|
|
1072
|
-
data: data,
|
|
1073
|
-
charge_external_id: charge_external_id,
|
|
1074
|
-
ehr_source_url: ehr_source_url,
|
|
1075
|
-
patient_external_id: patient_external_id,
|
|
1076
|
-
status: status
|
|
1077
|
-
}.compact
|
|
1078
|
-
req.url "#{@request_client.get_url(environment: CandidApi,
|
|
1079
|
-
request_options: request_options)}/api/charge_captures/v1"
|
|
1080
|
-
end
|
|
1081
|
-
CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
|
|
1082
|
-
end
|
|
1083
|
-
end
|
|
1084
|
-
|
|
1085
|
-
# @param charge_capture_id [String]
|
|
1086
|
-
# @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
|
1087
|
-
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreate>)
|
|
1088
|
-
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::Intervention>)
|
|
1209
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
|
1210
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
|
1089
1211
|
# * :external_claim_submission (Hash)
|
|
1090
1212
|
# * :claim_created_at (DateTime)
|
|
1091
1213
|
# * :patient_control_number (String)
|
|
1092
|
-
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::
|
|
1093
|
-
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::
|
|
1094
|
-
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::
|
|
1095
|
-
# * :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>)
|
|
1096
1218
|
# * :patient (Hash)
|
|
1097
1219
|
# * :first_name (String)
|
|
1098
1220
|
# * :last_name (String)
|
|
@@ -1106,12 +1228,12 @@ module CandidApiClient
|
|
|
1106
1228
|
# * :city (String)
|
|
1107
1229
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
1108
1230
|
# * :zip_code (String)
|
|
1109
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
|
1231
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
1110
1232
|
# * :phone_consent (Boolean)
|
|
1111
1233
|
# * :email (String)
|
|
1112
1234
|
# * :email_consent (Boolean)
|
|
1113
1235
|
# * :non_insurance_payers (Array<String>)
|
|
1114
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
|
1236
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
|
1115
1237
|
# * :service_facility (Hash)
|
|
1116
1238
|
# * :organization_name (String)
|
|
1117
1239
|
# * :npi (String)
|
|
@@ -1203,7 +1325,6 @@ module CandidApiClient
|
|
|
1203
1325
|
# * :external_id (String)
|
|
1204
1326
|
# * :date_of_service (Date)
|
|
1205
1327
|
# * :tag_ids (Array<String>)
|
|
1206
|
-
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>)
|
|
1207
1328
|
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
|
1208
1329
|
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
|
1209
1330
|
# * :provider_accepts_assignment (Boolean)
|
|
@@ -1211,87 +1332,6 @@ module CandidApiClient
|
|
|
1211
1332
|
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
|
1212
1333
|
# * :appointment_type (String)
|
|
1213
1334
|
# * :end_date_of_service (Date)
|
|
1214
|
-
# * :subscriber_primary (Hash)
|
|
1215
|
-
# * :insurance_card (Hash)
|
|
1216
|
-
# * :member_id (String)
|
|
1217
|
-
# * :payer_name (String)
|
|
1218
|
-
# * :payer_id (String)
|
|
1219
|
-
# * :rx_bin (String)
|
|
1220
|
-
# * :rx_pcn (String)
|
|
1221
|
-
# * :image_url_front (String)
|
|
1222
|
-
# * :image_url_back (String)
|
|
1223
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
1224
|
-
# * :group_number (String)
|
|
1225
|
-
# * :plan_name (String)
|
|
1226
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
1227
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
1228
|
-
# * :payer_plan_group_id (String)
|
|
1229
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
1230
|
-
# * :date_of_birth (Date)
|
|
1231
|
-
# * :address (Hash)
|
|
1232
|
-
# * :zip_plus_four_code (String)
|
|
1233
|
-
# * :address_1 (String)
|
|
1234
|
-
# * :address_2 (String)
|
|
1235
|
-
# * :city (String)
|
|
1236
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
1237
|
-
# * :zip_code (String)
|
|
1238
|
-
# * :first_name (String)
|
|
1239
|
-
# * :last_name (String)
|
|
1240
|
-
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
1241
|
-
# * :subscriber_secondary (Hash)
|
|
1242
|
-
# * :insurance_card (Hash)
|
|
1243
|
-
# * :member_id (String)
|
|
1244
|
-
# * :payer_name (String)
|
|
1245
|
-
# * :payer_id (String)
|
|
1246
|
-
# * :rx_bin (String)
|
|
1247
|
-
# * :rx_pcn (String)
|
|
1248
|
-
# * :image_url_front (String)
|
|
1249
|
-
# * :image_url_back (String)
|
|
1250
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
1251
|
-
# * :group_number (String)
|
|
1252
|
-
# * :plan_name (String)
|
|
1253
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
1254
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
1255
|
-
# * :payer_plan_group_id (String)
|
|
1256
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
1257
|
-
# * :date_of_birth (Date)
|
|
1258
|
-
# * :address (Hash)
|
|
1259
|
-
# * :zip_plus_four_code (String)
|
|
1260
|
-
# * :address_1 (String)
|
|
1261
|
-
# * :address_2 (String)
|
|
1262
|
-
# * :city (String)
|
|
1263
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
1264
|
-
# * :zip_code (String)
|
|
1265
|
-
# * :first_name (String)
|
|
1266
|
-
# * :last_name (String)
|
|
1267
|
-
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
1268
|
-
# * :subscriber_tertiary (Hash)
|
|
1269
|
-
# * :insurance_card (Hash)
|
|
1270
|
-
# * :member_id (String)
|
|
1271
|
-
# * :payer_name (String)
|
|
1272
|
-
# * :payer_id (String)
|
|
1273
|
-
# * :rx_bin (String)
|
|
1274
|
-
# * :rx_pcn (String)
|
|
1275
|
-
# * :image_url_front (String)
|
|
1276
|
-
# * :image_url_back (String)
|
|
1277
|
-
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
1278
|
-
# * :group_number (String)
|
|
1279
|
-
# * :plan_name (String)
|
|
1280
|
-
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
1281
|
-
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
1282
|
-
# * :payer_plan_group_id (String)
|
|
1283
|
-
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
1284
|
-
# * :date_of_birth (Date)
|
|
1285
|
-
# * :address (Hash)
|
|
1286
|
-
# * :zip_plus_four_code (String)
|
|
1287
|
-
# * :address_1 (String)
|
|
1288
|
-
# * :address_2 (String)
|
|
1289
|
-
# * :city (String)
|
|
1290
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
1291
|
-
# * :zip_code (String)
|
|
1292
|
-
# * :first_name (String)
|
|
1293
|
-
# * :last_name (String)
|
|
1294
|
-
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
1295
1335
|
# * :additional_information (String)
|
|
1296
1336
|
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
|
1297
1337
|
# * :admission_date (Date)
|
|
@@ -1300,7 +1340,6 @@ module CandidApiClient
|
|
|
1300
1340
|
# * :last_menstrual_period_date (Date)
|
|
1301
1341
|
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
|
1302
1342
|
# * :patient_authorized_release (Boolean)
|
|
1303
|
-
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>)
|
|
1304
1343
|
# * :vitals (Hash)
|
|
1305
1344
|
# * :height_in (Integer)
|
|
1306
1345
|
# * :weight_lbs (Integer)
|
|
@@ -1309,29 +1348,7 @@ module CandidApiClient
|
|
|
1309
1348
|
# * :body_temperature_f (Float)
|
|
1310
1349
|
# * :hemoglobin_gdl (Float)
|
|
1311
1350
|
# * :hematocrit_pct (Float)
|
|
1312
|
-
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::Medication>)
|
|
1313
|
-
# * :guarantor (Hash)
|
|
1314
|
-
# * :first_name (String)
|
|
1315
|
-
# * :last_name (String)
|
|
1316
|
-
# * :external_id (String)
|
|
1317
|
-
# * :date_of_birth (Date)
|
|
1318
|
-
# * :address (Hash)
|
|
1319
|
-
# * :zip_plus_four_code (String)
|
|
1320
|
-
# * :address_1 (String)
|
|
1321
|
-
# * :address_2 (String)
|
|
1322
|
-
# * :city (String)
|
|
1323
|
-
# * :state (CandidApiClient::Commons::Types::State)
|
|
1324
|
-
# * :zip_code (String)
|
|
1325
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
|
|
1326
|
-
# * :phone_consent (Boolean)
|
|
1327
|
-
# * :email (String)
|
|
1328
|
-
# * :email_consent (Boolean)
|
|
1329
1351
|
# * :referral_number (String)
|
|
1330
|
-
# * :epsdt_referral (Hash)
|
|
1331
|
-
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
1332
|
-
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
1333
|
-
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
1334
|
-
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>)
|
|
1335
1352
|
# * :secondary_payer_carrier_code (String)
|
|
1336
1353
|
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
|
|
1337
1354
|
# for example, your internal encounter ID or a Dr. Chrono encounter ID.
|
|
@@ -1340,6 +1357,9 @@ module CandidApiClient
|
|
|
1340
1357
|
# system (e.g. the EHR visit page).
|
|
1341
1358
|
# Send full URL format for the external link (e.g.
|
|
1342
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.
|
|
1343
1363
|
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
|
1344
1364
|
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
|
1345
1365
|
# @param request_options [CandidApiClient::RequestOptions]
|
|
@@ -1348,7 +1368,7 @@ module CandidApiClient
|
|
|
1348
1368
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1349
1369
|
# api.charge_capture.v_1.update(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
1350
1370
|
def update(charge_capture_id:, data: nil, charge_external_id: nil, ehr_source_url: nil,
|
|
1351
|
-
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)
|
|
1352
1372
|
Async do
|
|
1353
1373
|
response = @request_client.conn.patch do |req|
|
|
1354
1374
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -1363,6 +1383,8 @@ module CandidApiClient
|
|
|
1363
1383
|
data: data,
|
|
1364
1384
|
charge_external_id: charge_external_id,
|
|
1365
1385
|
ehr_source_url: ehr_source_url,
|
|
1386
|
+
originating_system: originating_system,
|
|
1387
|
+
claim_creation_category: claim_creation_category,
|
|
1366
1388
|
patient_external_id: patient_external_id,
|
|
1367
1389
|
status: status
|
|
1368
1390
|
}.compact
|