candidhealth 1.0.0 → 1.3.1
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 +532 -484
- 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/next_responsible_party.rb +16 -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/contracts/v_2/client.rb +4 -4
- 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 +216 -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 +27 -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/organization_providers/v_2/types/license_type.rb +1 -0
- data/lib/candidhealth/pre_encounter/patients/v_1/types/authorization.rb +13 -1
- data/lib/candidhealth/service_lines/v_2/client.rb +4 -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.rb +10 -2
- data/lib/candidhealth/service_lines/v_2/types/service_line_create.rb +10 -2
- data/lib/candidhealth/service_lines/v_2/types/service_line_create_optional.rb +247 -0
- data/lib/candidhealth/service_lines/v_2/types/service_line_create_standalone.rb +10 -2
- data/lib/candidhealth/service_lines/v_2/types/service_line_update.rb +10 -2
- 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 +33 -3
- metadata +35 -5
|
@@ -7,6 +7,8 @@ require_relative "types/charge_capture"
|
|
|
7
7
|
require_relative "types/charge_capture_sort_field"
|
|
8
8
|
require_relative "../../commons/types/sort_direction"
|
|
9
9
|
require "date"
|
|
10
|
+
require_relative "../../encounters/v_4/types/billable_status_type"
|
|
11
|
+
require_relative "../../encounters/v_4/types/responsible_party_type"
|
|
10
12
|
require_relative "types/charge_capture_page"
|
|
11
13
|
require_relative "types/charge_capture_post_billed_change"
|
|
12
14
|
require "json"
|
|
@@ -28,15 +30,120 @@ module CandidApiClient
|
|
|
28
30
|
# @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
|
|
29
31
|
# listed as optional. Candid will use this data when attempting to bundle multiple
|
|
30
32
|
# Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
|
31
|
-
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::
|
|
32
|
-
# * :
|
|
33
|
+
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
|
|
34
|
+
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
|
|
35
|
+
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
|
|
36
|
+
# * :epsdt_referral (Hash)
|
|
37
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
38
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
39
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
40
|
+
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
|
|
41
|
+
# * :guarantor (Hash)
|
|
42
|
+
# * :first_name (String)
|
|
43
|
+
# * :last_name (String)
|
|
44
|
+
# * :external_id (String)
|
|
45
|
+
# * :date_of_birth (Date)
|
|
46
|
+
# * :address (Hash)
|
|
47
|
+
# * :zip_plus_four_code (String)
|
|
48
|
+
# * :address_1 (String)
|
|
49
|
+
# * :address_2 (String)
|
|
50
|
+
# * :city (String)
|
|
51
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
52
|
+
# * :zip_code (String)
|
|
53
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
54
|
+
# * :phone_consent (Boolean)
|
|
55
|
+
# * :email (String)
|
|
56
|
+
# * :email_consent (Boolean)
|
|
57
|
+
# * :subscriber_primary (Hash)
|
|
58
|
+
# * :insurance_card (Hash)
|
|
59
|
+
# * :member_id (String)
|
|
60
|
+
# * :payer_name (String)
|
|
61
|
+
# * :payer_id (String)
|
|
62
|
+
# * :rx_bin (String)
|
|
63
|
+
# * :rx_pcn (String)
|
|
64
|
+
# * :image_url_front (String)
|
|
65
|
+
# * :image_url_back (String)
|
|
66
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
67
|
+
# * :group_number (String)
|
|
68
|
+
# * :plan_name (String)
|
|
69
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
70
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
71
|
+
# * :payer_plan_group_id (String)
|
|
72
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
73
|
+
# * :date_of_birth (Date)
|
|
74
|
+
# * :address (Hash)
|
|
75
|
+
# * :zip_plus_four_code (String)
|
|
76
|
+
# * :address_1 (String)
|
|
77
|
+
# * :address_2 (String)
|
|
78
|
+
# * :city (String)
|
|
79
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
80
|
+
# * :zip_code (String)
|
|
81
|
+
# * :first_name (String)
|
|
82
|
+
# * :last_name (String)
|
|
83
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
84
|
+
# * :subscriber_secondary (Hash)
|
|
85
|
+
# * :insurance_card (Hash)
|
|
86
|
+
# * :member_id (String)
|
|
87
|
+
# * :payer_name (String)
|
|
88
|
+
# * :payer_id (String)
|
|
89
|
+
# * :rx_bin (String)
|
|
90
|
+
# * :rx_pcn (String)
|
|
91
|
+
# * :image_url_front (String)
|
|
92
|
+
# * :image_url_back (String)
|
|
93
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
94
|
+
# * :group_number (String)
|
|
95
|
+
# * :plan_name (String)
|
|
96
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
97
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
98
|
+
# * :payer_plan_group_id (String)
|
|
99
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
100
|
+
# * :date_of_birth (Date)
|
|
101
|
+
# * :address (Hash)
|
|
102
|
+
# * :zip_plus_four_code (String)
|
|
103
|
+
# * :address_1 (String)
|
|
104
|
+
# * :address_2 (String)
|
|
105
|
+
# * :city (String)
|
|
106
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
107
|
+
# * :zip_code (String)
|
|
108
|
+
# * :first_name (String)
|
|
109
|
+
# * :last_name (String)
|
|
110
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
111
|
+
# * :subscriber_tertiary (Hash)
|
|
112
|
+
# * :insurance_card (Hash)
|
|
113
|
+
# * :member_id (String)
|
|
114
|
+
# * :payer_name (String)
|
|
115
|
+
# * :payer_id (String)
|
|
116
|
+
# * :rx_bin (String)
|
|
117
|
+
# * :rx_pcn (String)
|
|
118
|
+
# * :image_url_front (String)
|
|
119
|
+
# * :image_url_back (String)
|
|
120
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
121
|
+
# * :group_number (String)
|
|
122
|
+
# * :plan_name (String)
|
|
123
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
124
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
125
|
+
# * :payer_plan_group_id (String)
|
|
126
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
127
|
+
# * :date_of_birth (Date)
|
|
128
|
+
# * :address (Hash)
|
|
129
|
+
# * :zip_plus_four_code (String)
|
|
130
|
+
# * :address_1 (String)
|
|
131
|
+
# * :address_2 (String)
|
|
132
|
+
# * :city (String)
|
|
133
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
134
|
+
# * :zip_code (String)
|
|
135
|
+
# * :first_name (String)
|
|
136
|
+
# * :last_name (String)
|
|
137
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
138
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
|
139
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
|
33
140
|
# * :external_claim_submission (Hash)
|
|
34
141
|
# * :claim_created_at (DateTime)
|
|
35
142
|
# * :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::
|
|
143
|
+
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
|
|
144
|
+
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
|
|
145
|
+
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
|
|
146
|
+
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
|
|
40
147
|
# * :patient (Hash)
|
|
41
148
|
# * :first_name (String)
|
|
42
149
|
# * :last_name (String)
|
|
@@ -50,12 +157,12 @@ module CandidApiClient
|
|
|
50
157
|
# * :city (String)
|
|
51
158
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
52
159
|
# * :zip_code (String)
|
|
53
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
|
160
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
54
161
|
# * :phone_consent (Boolean)
|
|
55
162
|
# * :email (String)
|
|
56
163
|
# * :email_consent (Boolean)
|
|
57
164
|
# * :non_insurance_payers (Array<String>)
|
|
58
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
|
165
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
|
59
166
|
# * :service_facility (Hash)
|
|
60
167
|
# * :organization_name (String)
|
|
61
168
|
# * :npi (String)
|
|
@@ -147,7 +254,6 @@ module CandidApiClient
|
|
|
147
254
|
# * :external_id (String)
|
|
148
255
|
# * :date_of_service (Date)
|
|
149
256
|
# * :tag_ids (Array<String>)
|
|
150
|
-
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>)
|
|
151
257
|
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
|
152
258
|
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
|
153
259
|
# * :provider_accepts_assignment (Boolean)
|
|
@@ -155,6 +261,97 @@ module CandidApiClient
|
|
|
155
261
|
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
|
156
262
|
# * :appointment_type (String)
|
|
157
263
|
# * :end_date_of_service (Date)
|
|
264
|
+
# * :additional_information (String)
|
|
265
|
+
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
|
266
|
+
# * :admission_date (Date)
|
|
267
|
+
# * :discharge_date (Date)
|
|
268
|
+
# * :onset_of_current_illness_or_symptom_date (Date)
|
|
269
|
+
# * :last_menstrual_period_date (Date)
|
|
270
|
+
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
|
271
|
+
# * :patient_authorized_release (Boolean)
|
|
272
|
+
# * :vitals (Hash)
|
|
273
|
+
# * :height_in (Integer)
|
|
274
|
+
# * :weight_lbs (Integer)
|
|
275
|
+
# * :blood_pressure_systolic_mmhg (Integer)
|
|
276
|
+
# * :blood_pressure_diastolic_mmhg (Integer)
|
|
277
|
+
# * :body_temperature_f (Float)
|
|
278
|
+
# * :hemoglobin_gdl (Float)
|
|
279
|
+
# * :hematocrit_pct (Float)
|
|
280
|
+
# * :referral_number (String)
|
|
281
|
+
# * :secondary_payer_carrier_code (String)
|
|
282
|
+
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
|
|
283
|
+
# internal encounter ID or a Dr. Chrono encounter ID. This field should not
|
|
284
|
+
# contain PHI.
|
|
285
|
+
# @param originating_system [String] An optional string field denoting the originating system of the charge.
|
|
286
|
+
# @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
|
|
287
|
+
# creation.
|
|
288
|
+
# @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
|
|
289
|
+
# system (e.g. the EHR visit page). Send full URL format for the external link
|
|
290
|
+
# (e.g. https://emr_charge_capture_url.com/123).
|
|
291
|
+
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
|
292
|
+
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
|
293
|
+
# @param request_options [CandidApiClient::RequestOptions]
|
|
294
|
+
# @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
|
|
295
|
+
# @example
|
|
296
|
+
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
297
|
+
# api.charge_capture.v_1.create(
|
|
298
|
+
# data: { },
|
|
299
|
+
# charge_external_id: "charge_external_id",
|
|
300
|
+
# patient_external_id: "patient_external_id",
|
|
301
|
+
# status: PLANNED
|
|
302
|
+
# )
|
|
303
|
+
def create(data:, charge_external_id:, patient_external_id:, status:, originating_system: nil, claim_creation_category: nil,
|
|
304
|
+
ehr_source_url: nil, request_options: nil)
|
|
305
|
+
response = @request_client.conn.post do |req|
|
|
306
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
307
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
|
308
|
+
req.headers = {
|
|
309
|
+
**(req.headers || {}),
|
|
310
|
+
**@request_client.get_headers,
|
|
311
|
+
**(request_options&.additional_headers || {})
|
|
312
|
+
}.compact
|
|
313
|
+
req.body = {
|
|
314
|
+
**(request_options&.additional_body_parameters || {}),
|
|
315
|
+
data: data,
|
|
316
|
+
charge_external_id: charge_external_id,
|
|
317
|
+
originating_system: originating_system,
|
|
318
|
+
claim_creation_category: claim_creation_category,
|
|
319
|
+
ehr_source_url: ehr_source_url,
|
|
320
|
+
patient_external_id: patient_external_id,
|
|
321
|
+
status: status
|
|
322
|
+
}.compact
|
|
323
|
+
req.url "#{@request_client.get_url(environment: CandidApi,
|
|
324
|
+
request_options: request_options)}/api/charge_captures/v1"
|
|
325
|
+
end
|
|
326
|
+
CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
|
|
327
|
+
end
|
|
328
|
+
|
|
329
|
+
# @param charge_capture_id [String]
|
|
330
|
+
# @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
|
331
|
+
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
|
|
332
|
+
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
|
|
333
|
+
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
|
|
334
|
+
# * :epsdt_referral (Hash)
|
|
335
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
336
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
337
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
338
|
+
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
|
|
339
|
+
# * :guarantor (Hash)
|
|
340
|
+
# * :first_name (String)
|
|
341
|
+
# * :last_name (String)
|
|
342
|
+
# * :external_id (String)
|
|
343
|
+
# * :date_of_birth (Date)
|
|
344
|
+
# * :address (Hash)
|
|
345
|
+
# * :zip_plus_four_code (String)
|
|
346
|
+
# * :address_1 (String)
|
|
347
|
+
# * :address_2 (String)
|
|
348
|
+
# * :city (String)
|
|
349
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
350
|
+
# * :zip_code (String)
|
|
351
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
352
|
+
# * :phone_consent (Boolean)
|
|
353
|
+
# * :email (String)
|
|
354
|
+
# * :email_consent (Boolean)
|
|
158
355
|
# * :subscriber_primary (Hash)
|
|
159
356
|
# * :insurance_card (Hash)
|
|
160
357
|
# * :member_id (String)
|
|
@@ -236,99 +433,15 @@ module CandidApiClient
|
|
|
236
433
|
# * :first_name (String)
|
|
237
434
|
# * :last_name (String)
|
|
238
435
|
# * :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>)
|
|
436
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
|
437
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
|
325
438
|
# * :external_claim_submission (Hash)
|
|
326
439
|
# * :claim_created_at (DateTime)
|
|
327
440
|
# * :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::
|
|
441
|
+
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
|
|
442
|
+
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
|
|
443
|
+
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
|
|
444
|
+
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
|
|
332
445
|
# * :patient (Hash)
|
|
333
446
|
# * :first_name (String)
|
|
334
447
|
# * :last_name (String)
|
|
@@ -342,12 +455,12 @@ module CandidApiClient
|
|
|
342
455
|
# * :city (String)
|
|
343
456
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
344
457
|
# * :zip_code (String)
|
|
345
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
|
458
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
346
459
|
# * :phone_consent (Boolean)
|
|
347
460
|
# * :email (String)
|
|
348
461
|
# * :email_consent (Boolean)
|
|
349
462
|
# * :non_insurance_payers (Array<String>)
|
|
350
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
|
463
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
|
351
464
|
# * :service_facility (Hash)
|
|
352
465
|
# * :organization_name (String)
|
|
353
466
|
# * :npi (String)
|
|
@@ -381,89 +494,14 @@ module CandidApiClient
|
|
|
381
494
|
# * :address_2 (String)
|
|
382
495
|
# * :city (String)
|
|
383
496
|
# * :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)
|
|
497
|
+
# * :zip_code (String)
|
|
498
|
+
# * :qualifier (CandidApiClient::Commons::Types::QualifierCode)
|
|
499
|
+
# * :first_name (String)
|
|
500
|
+
# * :last_name (String)
|
|
501
|
+
# * :organization_name (String)
|
|
502
|
+
# * :referring_provider (Hash)
|
|
503
|
+
# * :npi (String)
|
|
504
|
+
# * :taxonomy_code (String)
|
|
467
505
|
# * :address (Hash)
|
|
468
506
|
# * :zip_plus_four_code (String)
|
|
469
507
|
# * :address_1 (String)
|
|
@@ -473,24 +511,10 @@ module CandidApiClient
|
|
|
473
511
|
# * :zip_code (String)
|
|
474
512
|
# * :first_name (String)
|
|
475
513
|
# * :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)
|
|
514
|
+
# * :organization_name (String)
|
|
515
|
+
# * :supervising_provider (Hash)
|
|
516
|
+
# * :npi (String)
|
|
517
|
+
# * :taxonomy_code (String)
|
|
494
518
|
# * :address (Hash)
|
|
495
519
|
# * :zip_plus_four_code (String)
|
|
496
520
|
# * :address_1 (String)
|
|
@@ -500,24 +524,8 @@ module CandidApiClient
|
|
|
500
524
|
# * :zip_code (String)
|
|
501
525
|
# * :first_name (String)
|
|
502
526
|
# * :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)
|
|
527
|
+
# * :organization_name (String)
|
|
528
|
+
# * :billing_provider (Hash)
|
|
521
529
|
# * :address (Hash)
|
|
522
530
|
# * :zip_plus_four_code (String)
|
|
523
531
|
# * :address_1 (String)
|
|
@@ -525,9 +533,32 @@ module CandidApiClient
|
|
|
525
533
|
# * :city (String)
|
|
526
534
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
527
535
|
# * :zip_code (String)
|
|
536
|
+
# * :tax_id (String)
|
|
537
|
+
# * :npi (String)
|
|
538
|
+
# * :taxonomy_code (String)
|
|
539
|
+
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
|
528
540
|
# * :first_name (String)
|
|
529
541
|
# * :last_name (String)
|
|
530
|
-
# * :
|
|
542
|
+
# * :organization_name (String)
|
|
543
|
+
# * :pay_to_address (Hash)
|
|
544
|
+
# * :zip_plus_four_code (String)
|
|
545
|
+
# * :address_1 (String)
|
|
546
|
+
# * :address_2 (String)
|
|
547
|
+
# * :city (String)
|
|
548
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
549
|
+
# * :zip_code (String)
|
|
550
|
+
# * :benefits_assigned_to_provider (Boolean)
|
|
551
|
+
# * :prior_authorization_number (String)
|
|
552
|
+
# * :external_id (String)
|
|
553
|
+
# * :date_of_service (Date)
|
|
554
|
+
# * :tag_ids (Array<String>)
|
|
555
|
+
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
|
556
|
+
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
|
557
|
+
# * :provider_accepts_assignment (Boolean)
|
|
558
|
+
# * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
|
|
559
|
+
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
|
560
|
+
# * :appointment_type (String)
|
|
561
|
+
# * :end_date_of_service (Date)
|
|
531
562
|
# * :additional_information (String)
|
|
532
563
|
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
|
533
564
|
# * :admission_date (Date)
|
|
@@ -536,7 +567,6 @@ module CandidApiClient
|
|
|
536
567
|
# * :last_menstrual_period_date (Date)
|
|
537
568
|
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
|
538
569
|
# * :patient_authorized_release (Boolean)
|
|
539
|
-
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>)
|
|
540
570
|
# * :vitals (Hash)
|
|
541
571
|
# * :height_in (Integer)
|
|
542
572
|
# * :weight_lbs (Integer)
|
|
@@ -545,29 +575,7 @@ module CandidApiClient
|
|
|
545
575
|
# * :body_temperature_f (Float)
|
|
546
576
|
# * :hemoglobin_gdl (Float)
|
|
547
577
|
# * :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
578
|
# * :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
579
|
# * :secondary_payer_carrier_code (String)
|
|
572
580
|
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
|
|
573
581
|
# for example, your internal encounter ID or a Dr. Chrono encounter ID.
|
|
@@ -576,6 +584,9 @@ module CandidApiClient
|
|
|
576
584
|
# system (e.g. the EHR visit page).
|
|
577
585
|
# Send full URL format for the external link (e.g.
|
|
578
586
|
# https://emr_charge_capture_url.com/123).
|
|
587
|
+
# @param originating_system [String] An optional string field denoting the originating system of the charge.
|
|
588
|
+
# @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
|
|
589
|
+
# creation.
|
|
579
590
|
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
|
580
591
|
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
|
581
592
|
# @param request_options [CandidApiClient::RequestOptions]
|
|
@@ -584,7 +595,7 @@ module CandidApiClient
|
|
|
584
595
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
585
596
|
# api.charge_capture.v_1.update(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
586
597
|
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)
|
|
598
|
+
originating_system: nil, claim_creation_category: nil, patient_external_id: nil, status: nil, request_options: nil)
|
|
588
599
|
response = @request_client.conn.patch do |req|
|
|
589
600
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
590
601
|
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
|
@@ -598,6 +609,8 @@ module CandidApiClient
|
|
|
598
609
|
data: data,
|
|
599
610
|
charge_external_id: charge_external_id,
|
|
600
611
|
ehr_source_url: ehr_source_url,
|
|
612
|
+
originating_system: originating_system,
|
|
613
|
+
claim_creation_category: claim_creation_category,
|
|
601
614
|
patient_external_id: patient_external_id,
|
|
602
615
|
status: status
|
|
603
616
|
}.compact
|
|
@@ -668,6 +681,15 @@ module CandidApiClient
|
|
|
668
681
|
# This date must be the local date in the timezone where the service occurred.
|
|
669
682
|
# @param date_of_service_max_ranked_sort [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
|
|
670
683
|
# This date must be the local date in the timezone where the service occurred.
|
|
684
|
+
# @param search_term [String] Filter by any of the following fields: charge_id, claim_id, patient external_id,
|
|
685
|
+
# patient date of birth, patient first name, patient last name,
|
|
686
|
+
# or charge external id.
|
|
687
|
+
# @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
|
|
688
|
+
# Examples for when this should be set to NOT_BILLABLE include if the Encounter
|
|
689
|
+
# has not occurred yet or if there is no intention of ever billing the
|
|
690
|
+
# responsible_party.
|
|
691
|
+
# @param responsible_party [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim. Use
|
|
692
|
+
# SELF_PAY if you intend to bill self pay/cash pay.
|
|
671
693
|
# @param claim_ids_ranked_sort [String] A list of claim IDs to show first. This will return all charge captures that
|
|
672
694
|
# have a resulting claim with one of the IDs in this list.
|
|
673
695
|
# @param claim_creation_ids_ranked_sort [String] A list of Claim Creation IDs to show first.
|
|
@@ -691,7 +713,7 @@ module CandidApiClient
|
|
|
691
713
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
692
714
|
# api.charge_capture.v_1.get_all
|
|
693
715
|
def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil, status: nil,
|
|
694
|
-
charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
|
|
716
|
+
charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, search_term: nil, billable_status: nil, responsible_party: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
|
|
695
717
|
response = @request_client.conn.get do |req|
|
|
696
718
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
697
719
|
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
|
@@ -726,6 +748,9 @@ module CandidApiClient
|
|
|
726
748
|
"charge_external_id_ranked_sort": charge_external_id_ranked_sort,
|
|
727
749
|
"date_of_service_min_ranked_sort": date_of_service_min_ranked_sort,
|
|
728
750
|
"date_of_service_max_ranked_sort": date_of_service_max_ranked_sort,
|
|
751
|
+
"search_term": search_term,
|
|
752
|
+
"billable_status": billable_status,
|
|
753
|
+
"responsible_party": responsible_party,
|
|
729
754
|
"claim_ids_ranked_sort": claim_ids_ranked_sort,
|
|
730
755
|
"claim_creation_ids_ranked_sort": claim_creation_ids_ranked_sort,
|
|
731
756
|
"billing_provider_npis_ranked_sort": billing_provider_npis_ranked_sort,
|
|
@@ -790,15 +815,120 @@ module CandidApiClient
|
|
|
790
815
|
# @param data [Hash] Charge Capture data contains all the fields needed to create an encounter, but
|
|
791
816
|
# listed as optional. Candid will use this data when attempting to bundle multiple
|
|
792
817
|
# Charge Captures into a single encounter.Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
|
793
|
-
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::
|
|
794
|
-
# * :
|
|
818
|
+
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
|
|
819
|
+
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
|
|
820
|
+
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
|
|
821
|
+
# * :epsdt_referral (Hash)
|
|
822
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
823
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
824
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
825
|
+
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
|
|
826
|
+
# * :guarantor (Hash)
|
|
827
|
+
# * :first_name (String)
|
|
828
|
+
# * :last_name (String)
|
|
829
|
+
# * :external_id (String)
|
|
830
|
+
# * :date_of_birth (Date)
|
|
831
|
+
# * :address (Hash)
|
|
832
|
+
# * :zip_plus_four_code (String)
|
|
833
|
+
# * :address_1 (String)
|
|
834
|
+
# * :address_2 (String)
|
|
835
|
+
# * :city (String)
|
|
836
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
837
|
+
# * :zip_code (String)
|
|
838
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
839
|
+
# * :phone_consent (Boolean)
|
|
840
|
+
# * :email (String)
|
|
841
|
+
# * :email_consent (Boolean)
|
|
842
|
+
# * :subscriber_primary (Hash)
|
|
843
|
+
# * :insurance_card (Hash)
|
|
844
|
+
# * :member_id (String)
|
|
845
|
+
# * :payer_name (String)
|
|
846
|
+
# * :payer_id (String)
|
|
847
|
+
# * :rx_bin (String)
|
|
848
|
+
# * :rx_pcn (String)
|
|
849
|
+
# * :image_url_front (String)
|
|
850
|
+
# * :image_url_back (String)
|
|
851
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
852
|
+
# * :group_number (String)
|
|
853
|
+
# * :plan_name (String)
|
|
854
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
855
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
856
|
+
# * :payer_plan_group_id (String)
|
|
857
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
858
|
+
# * :date_of_birth (Date)
|
|
859
|
+
# * :address (Hash)
|
|
860
|
+
# * :zip_plus_four_code (String)
|
|
861
|
+
# * :address_1 (String)
|
|
862
|
+
# * :address_2 (String)
|
|
863
|
+
# * :city (String)
|
|
864
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
865
|
+
# * :zip_code (String)
|
|
866
|
+
# * :first_name (String)
|
|
867
|
+
# * :last_name (String)
|
|
868
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
869
|
+
# * :subscriber_secondary (Hash)
|
|
870
|
+
# * :insurance_card (Hash)
|
|
871
|
+
# * :member_id (String)
|
|
872
|
+
# * :payer_name (String)
|
|
873
|
+
# * :payer_id (String)
|
|
874
|
+
# * :rx_bin (String)
|
|
875
|
+
# * :rx_pcn (String)
|
|
876
|
+
# * :image_url_front (String)
|
|
877
|
+
# * :image_url_back (String)
|
|
878
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
879
|
+
# * :group_number (String)
|
|
880
|
+
# * :plan_name (String)
|
|
881
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
882
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
883
|
+
# * :payer_plan_group_id (String)
|
|
884
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
885
|
+
# * :date_of_birth (Date)
|
|
886
|
+
# * :address (Hash)
|
|
887
|
+
# * :zip_plus_four_code (String)
|
|
888
|
+
# * :address_1 (String)
|
|
889
|
+
# * :address_2 (String)
|
|
890
|
+
# * :city (String)
|
|
891
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
892
|
+
# * :zip_code (String)
|
|
893
|
+
# * :first_name (String)
|
|
894
|
+
# * :last_name (String)
|
|
895
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
896
|
+
# * :subscriber_tertiary (Hash)
|
|
897
|
+
# * :insurance_card (Hash)
|
|
898
|
+
# * :member_id (String)
|
|
899
|
+
# * :payer_name (String)
|
|
900
|
+
# * :payer_id (String)
|
|
901
|
+
# * :rx_bin (String)
|
|
902
|
+
# * :rx_pcn (String)
|
|
903
|
+
# * :image_url_front (String)
|
|
904
|
+
# * :image_url_back (String)
|
|
905
|
+
# * :emr_payer_crosswalk (CandidApiClient::Commons::Types::EmrPayerCrosswalk)
|
|
906
|
+
# * :group_number (String)
|
|
907
|
+
# * :plan_name (String)
|
|
908
|
+
# * :plan_type (CandidApiClient::Commons::Types::SourceOfPaymentCode)
|
|
909
|
+
# * :insurance_type (CandidApiClient::Commons::Types::InsuranceTypeCode)
|
|
910
|
+
# * :payer_plan_group_id (String)
|
|
911
|
+
# * :patient_relationship_to_subscriber_code (CandidApiClient::Commons::Types::PatientRelationshipToInsuredCodeAll)
|
|
912
|
+
# * :date_of_birth (Date)
|
|
913
|
+
# * :address (Hash)
|
|
914
|
+
# * :zip_plus_four_code (String)
|
|
915
|
+
# * :address_1 (String)
|
|
916
|
+
# * :address_2 (String)
|
|
917
|
+
# * :city (String)
|
|
918
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
919
|
+
# * :zip_code (String)
|
|
920
|
+
# * :first_name (String)
|
|
921
|
+
# * :last_name (String)
|
|
922
|
+
# * :gender (CandidApiClient::Individual::Types::Gender)
|
|
923
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
|
924
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
|
795
925
|
# * :external_claim_submission (Hash)
|
|
796
926
|
# * :claim_created_at (DateTime)
|
|
797
927
|
# * :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::
|
|
928
|
+
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
|
|
929
|
+
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
|
|
930
|
+
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
|
|
931
|
+
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
|
|
802
932
|
# * :patient (Hash)
|
|
803
933
|
# * :first_name (String)
|
|
804
934
|
# * :last_name (String)
|
|
@@ -812,12 +942,12 @@ module CandidApiClient
|
|
|
812
942
|
# * :city (String)
|
|
813
943
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
814
944
|
# * :zip_code (String)
|
|
815
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
|
945
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
816
946
|
# * :phone_consent (Boolean)
|
|
817
947
|
# * :email (String)
|
|
818
948
|
# * :email_consent (Boolean)
|
|
819
949
|
# * :non_insurance_payers (Array<String>)
|
|
820
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
|
950
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
|
821
951
|
# * :service_facility (Hash)
|
|
822
952
|
# * :organization_name (String)
|
|
823
953
|
# * :npi (String)
|
|
@@ -881,8 +1011,123 @@ module CandidApiClient
|
|
|
881
1011
|
# * :zip_code (String)
|
|
882
1012
|
# * :first_name (String)
|
|
883
1013
|
# * :last_name (String)
|
|
884
|
-
# * :organization_name (String)
|
|
885
|
-
# * :billing_provider (Hash)
|
|
1014
|
+
# * :organization_name (String)
|
|
1015
|
+
# * :billing_provider (Hash)
|
|
1016
|
+
# * :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
|
+
# * :tax_id (String)
|
|
1024
|
+
# * :npi (String)
|
|
1025
|
+
# * :taxonomy_code (String)
|
|
1026
|
+
# * :provider_commercial_license_type (CandidApiClient::Commons::Types::BillingProviderCommercialLicenseType)
|
|
1027
|
+
# * :first_name (String)
|
|
1028
|
+
# * :last_name (String)
|
|
1029
|
+
# * :organization_name (String)
|
|
1030
|
+
# * :pay_to_address (Hash)
|
|
1031
|
+
# * :zip_plus_four_code (String)
|
|
1032
|
+
# * :address_1 (String)
|
|
1033
|
+
# * :address_2 (String)
|
|
1034
|
+
# * :city (String)
|
|
1035
|
+
# * :state (CandidApiClient::Commons::Types::State)
|
|
1036
|
+
# * :zip_code (String)
|
|
1037
|
+
# * :benefits_assigned_to_provider (Boolean)
|
|
1038
|
+
# * :prior_authorization_number (String)
|
|
1039
|
+
# * :external_id (String)
|
|
1040
|
+
# * :date_of_service (Date)
|
|
1041
|
+
# * :tag_ids (Array<String>)
|
|
1042
|
+
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
|
1043
|
+
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
|
1044
|
+
# * :provider_accepts_assignment (Boolean)
|
|
1045
|
+
# * :synchronicity (CandidApiClient::Encounters::V4::Types::SynchronicityType)
|
|
1046
|
+
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
|
1047
|
+
# * :appointment_type (String)
|
|
1048
|
+
# * :end_date_of_service (Date)
|
|
1049
|
+
# * :additional_information (String)
|
|
1050
|
+
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
|
1051
|
+
# * :admission_date (Date)
|
|
1052
|
+
# * :discharge_date (Date)
|
|
1053
|
+
# * :onset_of_current_illness_or_symptom_date (Date)
|
|
1054
|
+
# * :last_menstrual_period_date (Date)
|
|
1055
|
+
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
|
1056
|
+
# * :patient_authorized_release (Boolean)
|
|
1057
|
+
# * :vitals (Hash)
|
|
1058
|
+
# * :height_in (Integer)
|
|
1059
|
+
# * :weight_lbs (Integer)
|
|
1060
|
+
# * :blood_pressure_systolic_mmhg (Integer)
|
|
1061
|
+
# * :blood_pressure_diastolic_mmhg (Integer)
|
|
1062
|
+
# * :body_temperature_f (Float)
|
|
1063
|
+
# * :hemoglobin_gdl (Float)
|
|
1064
|
+
# * :hematocrit_pct (Float)
|
|
1065
|
+
# * :referral_number (String)
|
|
1066
|
+
# * :secondary_payer_carrier_code (String)
|
|
1067
|
+
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter; for example, your
|
|
1068
|
+
# internal encounter ID or a Dr. Chrono encounter ID. This field should not
|
|
1069
|
+
# contain PHI.
|
|
1070
|
+
# @param originating_system [String] An optional string field denoting the originating system of the charge.
|
|
1071
|
+
# @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
|
|
1072
|
+
# creation.
|
|
1073
|
+
# @param ehr_source_url [String] External URL reference that links to Charge Capture details within the external
|
|
1074
|
+
# system (e.g. the EHR visit page). Send full URL format for the external link
|
|
1075
|
+
# (e.g. https://emr_charge_capture_url.com/123).
|
|
1076
|
+
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
|
1077
|
+
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
|
1078
|
+
# @param request_options [CandidApiClient::RequestOptions]
|
|
1079
|
+
# @return [CandidApiClient::ChargeCapture::V1::Types::ChargeCapture]
|
|
1080
|
+
# @example
|
|
1081
|
+
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1082
|
+
# api.charge_capture.v_1.create(
|
|
1083
|
+
# data: { },
|
|
1084
|
+
# charge_external_id: "charge_external_id",
|
|
1085
|
+
# patient_external_id: "patient_external_id",
|
|
1086
|
+
# status: PLANNED
|
|
1087
|
+
# )
|
|
1088
|
+
def create(data:, charge_external_id:, patient_external_id:, status:, originating_system: nil, claim_creation_category: nil,
|
|
1089
|
+
ehr_source_url: nil, request_options: nil)
|
|
1090
|
+
Async do
|
|
1091
|
+
response = @request_client.conn.post do |req|
|
|
1092
|
+
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
1093
|
+
req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
|
|
1094
|
+
req.headers = {
|
|
1095
|
+
**(req.headers || {}),
|
|
1096
|
+
**@request_client.get_headers,
|
|
1097
|
+
**(request_options&.additional_headers || {})
|
|
1098
|
+
}.compact
|
|
1099
|
+
req.body = {
|
|
1100
|
+
**(request_options&.additional_body_parameters || {}),
|
|
1101
|
+
data: data,
|
|
1102
|
+
charge_external_id: charge_external_id,
|
|
1103
|
+
originating_system: originating_system,
|
|
1104
|
+
claim_creation_category: claim_creation_category,
|
|
1105
|
+
ehr_source_url: ehr_source_url,
|
|
1106
|
+
patient_external_id: patient_external_id,
|
|
1107
|
+
status: status
|
|
1108
|
+
}.compact
|
|
1109
|
+
req.url "#{@request_client.get_url(environment: CandidApi,
|
|
1110
|
+
request_options: request_options)}/api/charge_captures/v1"
|
|
1111
|
+
end
|
|
1112
|
+
CandidApiClient::ChargeCapture::V1::Types::ChargeCapture.from_json(json_object: response.body)
|
|
1113
|
+
end
|
|
1114
|
+
end
|
|
1115
|
+
|
|
1116
|
+
# @param charge_capture_id [String]
|
|
1117
|
+
# @param data [Hash] Request of type CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureData, as a Hash
|
|
1118
|
+
# * :diagnoses (Array<CandidApiClient::Diagnoses::Types::DiagnosisCreateOptional>)
|
|
1119
|
+
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreateOptional>)
|
|
1120
|
+
# * :claim_supplemental_information (Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional>)
|
|
1121
|
+
# * :epsdt_referral (Hash)
|
|
1122
|
+
# * :condition_indicator_1 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
1123
|
+
# * :condition_indicator_2 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
1124
|
+
# * :condition_indicator_3 (CandidApiClient::Commons::Types::EpsdtReferralConditionIndicatorCode)
|
|
1125
|
+
# * :existing_medications (Array<CandidApiClient::Encounters::V4::Types::MedicationOptional>)
|
|
1126
|
+
# * :guarantor (Hash)
|
|
1127
|
+
# * :first_name (String)
|
|
1128
|
+
# * :last_name (String)
|
|
1129
|
+
# * :external_id (String)
|
|
1130
|
+
# * :date_of_birth (Date)
|
|
886
1131
|
# * :address (Hash)
|
|
887
1132
|
# * :zip_plus_four_code (String)
|
|
888
1133
|
# * :address_1 (String)
|
|
@@ -890,33 +1135,10 @@ module CandidApiClient
|
|
|
890
1135
|
# * :city (String)
|
|
891
1136
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
892
1137
|
# * :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)
|
|
1138
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
1139
|
+
# * :phone_consent (Boolean)
|
|
1140
|
+
# * :email (String)
|
|
1141
|
+
# * :email_consent (Boolean)
|
|
920
1142
|
# * :subscriber_primary (Hash)
|
|
921
1143
|
# * :insurance_card (Hash)
|
|
922
1144
|
# * :member_id (String)
|
|
@@ -998,101 +1220,15 @@ module CandidApiClient
|
|
|
998
1220
|
# * :first_name (String)
|
|
999
1221
|
# * :last_name (String)
|
|
1000
1222
|
# * :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>)
|
|
1223
|
+
# * :interventions (Array<CandidApiClient::Encounters::V4::Types::InterventionOptional>)
|
|
1224
|
+
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstanceOptional>)
|
|
1089
1225
|
# * :external_claim_submission (Hash)
|
|
1090
1226
|
# * :claim_created_at (DateTime)
|
|
1091
1227
|
# * :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::
|
|
1228
|
+
# * :submission_records (Array<CandidApiClient::ClaimSubmission::V1::Types::ClaimSubmissionRecordCreateOptional>)
|
|
1229
|
+
# * :service_lines (Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional>)
|
|
1230
|
+
# * :patient_histories (Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategoryOptional>)
|
|
1231
|
+
# * :billing_notes (Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBaseOptional>)
|
|
1096
1232
|
# * :patient (Hash)
|
|
1097
1233
|
# * :first_name (String)
|
|
1098
1234
|
# * :last_name (String)
|
|
@@ -1106,12 +1242,12 @@ module CandidApiClient
|
|
|
1106
1242
|
# * :city (String)
|
|
1107
1243
|
# * :state (CandidApiClient::Commons::Types::State)
|
|
1108
1244
|
# * :zip_code (String)
|
|
1109
|
-
# * :phone_numbers (Array<CandidApiClient::Commons::Types::
|
|
1245
|
+
# * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumberOptional>)
|
|
1110
1246
|
# * :phone_consent (Boolean)
|
|
1111
1247
|
# * :email (String)
|
|
1112
1248
|
# * :email_consent (Boolean)
|
|
1113
1249
|
# * :non_insurance_payers (Array<String>)
|
|
1114
|
-
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::
|
|
1250
|
+
# * :non_insurance_payers_info (Array<CandidApiClient::Individual::Types::PatientNonInsurancePayerInfoCreateOptional>)
|
|
1115
1251
|
# * :service_facility (Hash)
|
|
1116
1252
|
# * :organization_name (String)
|
|
1117
1253
|
# * :npi (String)
|
|
@@ -1203,7 +1339,6 @@ module CandidApiClient
|
|
|
1203
1339
|
# * :external_id (String)
|
|
1204
1340
|
# * :date_of_service (Date)
|
|
1205
1341
|
# * :tag_ids (Array<String>)
|
|
1206
|
-
# * :clinical_notes (Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>)
|
|
1207
1342
|
# * :billable_status (CandidApiClient::Encounters::V4::Types::BillableStatusType)
|
|
1208
1343
|
# * :responsible_party (CandidApiClient::Encounters::V4::Types::ResponsiblePartyType)
|
|
1209
1344
|
# * :provider_accepts_assignment (Boolean)
|
|
@@ -1211,87 +1346,6 @@ module CandidApiClient
|
|
|
1211
1346
|
# * :place_of_service_code (CandidApiClient::Commons::Types::FacilityTypeCode)
|
|
1212
1347
|
# * :appointment_type (String)
|
|
1213
1348
|
# * :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
1349
|
# * :additional_information (String)
|
|
1296
1350
|
# * :service_authorization_exception_code (CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode)
|
|
1297
1351
|
# * :admission_date (Date)
|
|
@@ -1300,7 +1354,6 @@ module CandidApiClient
|
|
|
1300
1354
|
# * :last_menstrual_period_date (Date)
|
|
1301
1355
|
# * :delay_reason_code (CandidApiClient::Commons::Types::DelayReasonCode)
|
|
1302
1356
|
# * :patient_authorized_release (Boolean)
|
|
1303
|
-
# * :schema_instances (Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>)
|
|
1304
1357
|
# * :vitals (Hash)
|
|
1305
1358
|
# * :height_in (Integer)
|
|
1306
1359
|
# * :weight_lbs (Integer)
|
|
@@ -1309,29 +1362,7 @@ module CandidApiClient
|
|
|
1309
1362
|
# * :body_temperature_f (Float)
|
|
1310
1363
|
# * :hemoglobin_gdl (Float)
|
|
1311
1364
|
# * :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
1365
|
# * :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
1366
|
# * :secondary_payer_carrier_code (String)
|
|
1336
1367
|
# @param charge_external_id [String] A client-specified unique ID to associate with this encounter;
|
|
1337
1368
|
# for example, your internal encounter ID or a Dr. Chrono encounter ID.
|
|
@@ -1340,6 +1371,9 @@ module CandidApiClient
|
|
|
1340
1371
|
# system (e.g. the EHR visit page).
|
|
1341
1372
|
# Send full URL format for the external link (e.g.
|
|
1342
1373
|
# https://emr_charge_capture_url.com/123).
|
|
1374
|
+
# @param originating_system [String] An optional string field denoting the originating system of the charge.
|
|
1375
|
+
# @param claim_creation_category [String] An optional string field denoting the user defined category of the claim
|
|
1376
|
+
# creation.
|
|
1343
1377
|
# @param patient_external_id [String] The patient ID from the external EMR platform for the patient
|
|
1344
1378
|
# @param status [CandidApiClient::ChargeCapture::V1::Types::ChargeCaptureStatus] the status of the charge capture
|
|
1345
1379
|
# @param request_options [CandidApiClient::RequestOptions]
|
|
@@ -1348,7 +1382,7 @@ module CandidApiClient
|
|
|
1348
1382
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1349
1383
|
# api.charge_capture.v_1.update(charge_capture_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
|
|
1350
1384
|
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)
|
|
1385
|
+
originating_system: nil, claim_creation_category: nil, patient_external_id: nil, status: nil, request_options: nil)
|
|
1352
1386
|
Async do
|
|
1353
1387
|
response = @request_client.conn.patch do |req|
|
|
1354
1388
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -1363,6 +1397,8 @@ module CandidApiClient
|
|
|
1363
1397
|
data: data,
|
|
1364
1398
|
charge_external_id: charge_external_id,
|
|
1365
1399
|
ehr_source_url: ehr_source_url,
|
|
1400
|
+
originating_system: originating_system,
|
|
1401
|
+
claim_creation_category: claim_creation_category,
|
|
1366
1402
|
patient_external_id: patient_external_id,
|
|
1367
1403
|
status: status
|
|
1368
1404
|
}.compact
|
|
@@ -1436,6 +1472,15 @@ module CandidApiClient
|
|
|
1436
1472
|
# This date must be the local date in the timezone where the service occurred.
|
|
1437
1473
|
# @param date_of_service_max_ranked_sort [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
|
|
1438
1474
|
# This date must be the local date in the timezone where the service occurred.
|
|
1475
|
+
# @param search_term [String] Filter by any of the following fields: charge_id, claim_id, patient external_id,
|
|
1476
|
+
# patient date of birth, patient first name, patient last name,
|
|
1477
|
+
# or charge external id.
|
|
1478
|
+
# @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
|
|
1479
|
+
# Examples for when this should be set to NOT_BILLABLE include if the Encounter
|
|
1480
|
+
# has not occurred yet or if there is no intention of ever billing the
|
|
1481
|
+
# responsible_party.
|
|
1482
|
+
# @param responsible_party [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim. Use
|
|
1483
|
+
# SELF_PAY if you intend to bill self pay/cash pay.
|
|
1439
1484
|
# @param claim_ids_ranked_sort [String] A list of claim IDs to show first. This will return all charge captures that
|
|
1440
1485
|
# have a resulting claim with one of the IDs in this list.
|
|
1441
1486
|
# @param claim_creation_ids_ranked_sort [String] A list of Claim Creation IDs to show first.
|
|
@@ -1459,7 +1504,7 @@ module CandidApiClient
|
|
|
1459
1504
|
# api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
|
|
1460
1505
|
# api.charge_capture.v_1.get_all
|
|
1461
1506
|
def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil, status: nil,
|
|
1462
|
-
charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
|
|
1507
|
+
charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, search_term: nil, billable_status: nil, responsible_party: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
|
|
1463
1508
|
Async do
|
|
1464
1509
|
response = @request_client.conn.get do |req|
|
|
1465
1510
|
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
|
|
@@ -1495,6 +1540,9 @@ module CandidApiClient
|
|
|
1495
1540
|
"charge_external_id_ranked_sort": charge_external_id_ranked_sort,
|
|
1496
1541
|
"date_of_service_min_ranked_sort": date_of_service_min_ranked_sort,
|
|
1497
1542
|
"date_of_service_max_ranked_sort": date_of_service_max_ranked_sort,
|
|
1543
|
+
"search_term": search_term,
|
|
1544
|
+
"billable_status": billable_status,
|
|
1545
|
+
"responsible_party": responsible_party,
|
|
1498
1546
|
"claim_ids_ranked_sort": claim_ids_ranked_sort,
|
|
1499
1547
|
"claim_creation_ids_ranked_sort": claim_creation_ids_ranked_sort,
|
|
1500
1548
|
"billing_provider_npis_ranked_sort": billing_provider_npis_ranked_sort,
|