Update Charge Capture

Beta

PATCH

/api/charge_captures/v1/:charge_capture_id

PATCH

/api/charge_captures/v1/:charge_capture_id

1 import { CandidApiClient, CandidApi } from "candidhealth";
2 
3 const client = new CandidApiClient({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" });
4 await client.chargeCapture.v1.update(CandidApi.ChargeCaptureId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
5     data: {},
6     chargeExternalId: "string",
7     ehrSourceUrl: "string",
8     patientExternalId: "string",
9     status: "planned"
10 });

Try it

1 {
2   "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "status": "planned",
4   "charge_capture_data": {
5     "additional_information": "string",
6     "admission_date": "2023-01-01",
7     "appointment_type": "string",
8     "benefits_assigned_to_provider": true,
9     "billable_status": "BILLABLE",
10     "billing_notes": [
11       {
12         "text": "string"
13       }
14     ],
15     "billing_provider": {
16       "address": {
17         "address1": "string",
18         "address2": "string",
19         "city": "string",
20         "state": "AA",
21         "zip_code": "string",
22         "zip_plus_four_code": "string"
23       },
24       "first_name": "string",
25       "last_name": "string",
26       "npi": "string",
27       "organization_name": "string",
28       "provider_commercial_license_type": "0",
29       "tax_id": "string",
30       "taxonomy_code": "string"
31     },
32     "claim_supplemental_information": [
33       {
34         "attachment_report_type_code": "03",
35         "attachment_transmission_code": "BM",
36         "attachment_control_number": "string"
37       }
38     ],
39     "clinical_notes": [
40       {
41         "category": "clinical",
42         "notes": [
43           {
44             "text": "string",
45             "author_name": "string",
46             "timestamp": "2023-01-01T00:00:00Z",
47             "author_npi": "string"
48           }
49         ]
50       }
51     ],
52     "date_of_service": "2023-01-01",
53     "delay_reason_code": "1",
54     "diagnoses": [
55       {
56         "code_type": "ABF",
57         "code": "string",
58         "name": "string"
59       }
60     ],
61     "discharge_date": "2023-01-01",
62     "end_date_of_service": "2023-01-01",
63     "epsdt_referral": {
64       "condition_indicator1": "AV",
65       "condition_indicator2": "AV",
66       "condition_indicator3": "AV"
67     },
68     "existing_medications": [
69       {
70         "name": "string",
71         "rx_cui": "string",
72         "dosage": "string",
73         "dosage_form": "string",
74         "frequency": "string",
75         "as_needed": true
76       }
77     ],
78     "external_id": "string",
79     "guarantor": {
80       "first_name": "string",
81       "last_name": "string",
82       "external_id": "string",
83       "date_of_birth": "2023-01-01",
84       "address": {
85         "address1": "string",
86         "city": "string",
87         "state": "AA",
88         "zip_code": "string",
89         "address2": "string",
90         "zip_plus_four_code": "string"
91       },
92       "phone_numbers": [
93         {
94           "number": "string",
95           "type": "Home"
96         }
97       ],
98       "phone_consent": true,
99       "email": "string",
100       "email_consent": true
101     },
102     "initial_referring_provider": {
103       "address": {
104         "address1": "string",
105         "address2": "string",
106         "city": "string",
107         "state": "AA",
108         "zip_code": "string",
109         "zip_plus_four_code": "string"
110       },
111       "first_name": "string",
112       "last_name": "string",
113       "npi": "string",
114       "organization_name": "string",
115       "qualifier": "DQ",
116       "taxonomy_code": "string"
117     },
118     "interventions": [
119       {
120         "name": "string",
121         "category": "allopathic",
122         "description": "string",
123         "medication": {
124           "name": "string",
125           "rx_cui": "string",
126           "dosage": "string",
127           "dosage_form": "string",
128           "frequency": "string",
129           "as_needed": true
130         },
131         "labs": [
132           {
133             "name": "string",
134             "code": "string",
135             "code_type": "quest"
136           }
137         ]
138       }
139     ],
140     "last_menstrual_period_date": "2023-01-01",
141     "onset_of_current_illness_or_symptom_date": "2023-01-01",
142     "patient": {
143       "first_name": "string",
144       "last_name": "string",
145       "gender": "male",
146       "external_id": "string",
147       "date_of_birth": "2023-01-01",
148       "address": {
149         "address1": "string",
150         "address2": "string",
151         "city": "string",
152         "state": "AA",
153         "zip_code": "string",
154         "zip_plus_four_code": "string"
155       },
156       "phone_numbers": [
157         {
158           "number": "string",
159           "type": "Home"
160         }
161       ],
162       "phone_consent": true,
163       "email": "string",
164       "email_consent": true,
165       "non_insurance_payers_info": [
166         {
167           "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
168           "member_id": "string",
169           "clinical_trial_info": [
170             {
171               "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
172               "clinical_trial_arm": "string"
173             }
174           ]
175         }
176       ],
177       "non_insurance_payers": [
178         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
179       ]
180     },
181     "patient_authorized_release": true,
182     "patient_histories": [
183       {
184         "category": "present_illness",
185         "questions": [
186           {
187             "id": "string",
188             "text": "string",
189             "responses": [
190               {
191                 "response": "string",
192                 "follow_ups": [
193                   {
194                     "id": "string",
195                     "text": "string",
196                     "response": "string"
197                   }
198                 ]
199               }
200             ]
201           }
202         ]
203       }
204     ],
205     "pay_to_address": {
206       "address1": "string",
207       "address2": "string",
208       "city": "string",
209       "state": "AA",
210       "zip_code": "string",
211       "zip_plus_four_code": "string"
212     },
213     "place_of_service_code": "01",
214     "prior_authorization_number": "string",
215     "provider_accepts_assignment": true,
216     "referral_number": "string",
217     "referring_provider": {
218       "address": {
219         "address1": "string",
220         "address2": "string",
221         "city": "string",
222         "state": "AA",
223         "zip_code": "string",
224         "zip_plus_four_code": "string"
225       },
226       "first_name": "string",
227       "last_name": "string",
228       "npi": "string",
229       "organization_name": "string",
230       "taxonomy_code": "string"
231     },
232     "rendering_provider": {
233       "address": {
234         "address1": "string",
235         "address2": "string",
236         "city": "string",
237         "state": "AA",
238         "zip_code": "string",
239         "zip_plus_four_code": "string"
240       },
241       "first_name": "string",
242       "last_name": "string",
243       "npi": "string",
244       "organization_name": "string",
245       "taxonomy_code": "string"
246     },
247     "responsible_party": "INSURANCE_PAY",
248     "secondary_payer_carrier_code": "string",
249     "service_authorization_exception_code": "1",
250     "service_facility": {
251       "organization_name": "string",
252       "npi": "string",
253       "address": {
254         "address1": "string",
255         "address2": "string",
256         "city": "string",
257         "state": "AA",
258         "zip_code": "string",
259         "zip_plus_four_code": "string"
260       },
261       "secondary_identification": "string"
262     },
263     "service_lines": [
264       {
265         "procedure_code": "string",
266         "quantity": "string",
267         "units": "MJ",
268         "diagnosis_pointers": [
269           0
270         ],
271         "modifiers": [
272           "AV"
273         ],
274         "has_epsdt_indicator": true,
275         "has_family_planning_indicator": true,
276         "charge_amount_cents": 0,
277         "drug_identification": {
278           "service_id_qualifier": "EN",
279           "national_drug_code": "string",
280           "national_drug_unit_count": "string",
281           "measurement_unit_code": "ML",
282           "link_sequence_number": "string",
283           "pharmacy_prescription_number": "string",
284           "conversion_formula": "string",
285           "drug_description": "string"
286         },
287         "place_of_service_code": "01",
288         "description": "string",
289         "date_of_service": "2023-01-01",
290         "end_date_of_service": "2023-01-01",
291         "ordering_provider": {
292           "npi": "string",
293           "address": {
294             "address1": "string",
295             "city": "string",
296             "state": "AA",
297             "zip_code": "string",
298             "zip_plus_four_code": "string",
299             "address2": "string"
300           },
301           "first_name": "string",
302           "last_name": "string",
303           "organization_name": "string",
304           "taxonomy_code": "string"
305         },
306         "test_results": [
307           {
308             "value": 1,
309             "result_type": "HEMATOCRIT"
310           }
311         ]
312       }
313     ],
314     "subscriber_primary": {
315       "first_name": "string",
316       "gender": "male",
317       "insurance_card": {
318         "member_id": "string",
319         "payer_id": "string",
320         "payer_name": "string",
321         "emr_payer_crosswalk": "HEALTHIE",
322         "group_number": "string",
323         "image_url_back": "string",
324         "image_url_front": "string",
325         "insurance_type": "01",
326         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
327         "plan_name": "string",
328         "plan_type": "09",
329         "rx_bin": "string",
330         "rx_pcn": "string"
331       },
332       "last_name": "string",
333       "patient_relationship_to_subscriber_code": "01",
334       "address": {
335         "address1": "string",
336         "city": "string",
337         "state": "AA",
338         "zip_code": "string",
339         "address2": "string",
340         "zip_plus_four_code": "string"
341       },
342       "date_of_birth": "2023-01-01"
343     },
344     "subscriber_secondary": {
345       "first_name": "string",
346       "gender": "male",
347       "insurance_card": {
348         "member_id": "string",
349         "payer_id": "string",
350         "payer_name": "string",
351         "emr_payer_crosswalk": "HEALTHIE",
352         "group_number": "string",
353         "image_url_back": "string",
354         "image_url_front": "string",
355         "insurance_type": "01",
356         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
357         "plan_name": "string",
358         "plan_type": "09",
359         "rx_bin": "string",
360         "rx_pcn": "string"
361       },
362       "last_name": "string",
363       "patient_relationship_to_subscriber_code": "01",
364       "address": {
365         "address1": "string",
366         "city": "string",
367         "state": "AA",
368         "zip_code": "string",
369         "address2": "string",
370         "zip_plus_four_code": "string"
371       },
372       "date_of_birth": "2023-01-01"
373     },
374     "subscriber_tertiary": {
375       "first_name": "string",
376       "gender": "male",
377       "insurance_card": {
378         "member_id": "string",
379         "payer_id": "string",
380         "payer_name": "string",
381         "emr_payer_crosswalk": "HEALTHIE",
382         "group_number": "string",
383         "image_url_back": "string",
384         "image_url_front": "string",
385         "insurance_type": "01",
386         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
387         "plan_name": "string",
388         "plan_type": "09",
389         "rx_bin": "string",
390         "rx_pcn": "string"
391       },
392       "last_name": "string",
393       "patient_relationship_to_subscriber_code": "01",
394       "address": {
395         "address1": "string",
396         "city": "string",
397         "state": "AA",
398         "zip_code": "string",
399         "address2": "string",
400         "zip_plus_four_code": "string"
401       },
402       "date_of_birth": "2023-01-01"
403     },
404     "supervising_provider": {
405       "address": {
406         "address1": "string",
407         "address2": "string",
408         "city": "string",
409         "state": "AA",
410         "zip_code": "string",
411         "zip_plus_four_code": "string"
412       },
413       "first_name": "string",
414       "last_name": "string",
415       "npi": "string",
416       "organization_name": "string",
417       "taxonomy_code": "string"
418     },
419     "synchronicity": "Synchronous",
420     "tag_ids": [
421       "string"
422     ],
423     "vitals": {
424       "height_in": 0,
425       "weight_lbs": 0,
426       "blood_pressure_systolic_mmhg": 0,
427       "blood_pressure_diastolic_mmhg": 0,
428       "body_temperature_f": 1,
429       "hemoglobin_gdl": 1,
430       "hematocrit_pct": 1
431     },
432     "external_claim_submission": {
433       "claim_created_at": "2023-01-01T00:00:00Z",
434       "patient_control_number": "string",
435       "submission_records": [
436         {
437           "submitted_at": "2023-01-01T00:00:00Z",
438           "claim_frequency_code": "1",
439           "payer_responsibility": "primary",
440           "intended_submission_medium": "paper"
441         }
442       ]
443     },
444     "schema_instances": [
445       {
446         "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
447         "content": {
448           "string": {}
449         }
450       }
451     ]
452   },
453   "patient_external_id": "string",
454   "charge_external_id": "string",
455   "updates": [
456     {
457       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
458       "message": "string",
459       "resolved": true
460     }
461   ],
462   "date_of_service": "2023-01-01",
463   "ehr_source_url": "string",
464   "error": {
465     "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
466     "message": "string",
467     "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
468     "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
469     "field_in_error": "string"
470   },
471   "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
472 }

Path parameters

charge_capture_idUUIDRequired

Request

This endpoint expects an object.

dataobjectOptional

charge_external_idstringOptional

A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.

ehr_source_urlstringOptional

External URL reference that links to Charge Capture details within the external system (e.g. the EHR visit page). Send full URL format for the external link (e.g. https://emr_charge_capture_url.com/123).

patient_external_idstringOptional

The patient ID from the external EMR platform for the patient

statusenumOptional

the status of the charge capture

Allowed values:

Response

This endpoint returns an object.

idUUID

statusenum

Allowed values:

charge_capture_dataobject

patient_external_idstring

charge_external_idstring

updateslist of objects

date_of_servicedateOptional

ehr_source_urlstringOptional

errorobjectOptional

claim_creation_idUUIDOptional

Update Charge Capture

Path parameters

Headers

Request

Response

Errors