Get Charge Capture

Beta

GET

/api/charge_captures/v1/:charge_capture_id

GET

/api/charge_captures/v1/:charge_capture_id

1 import uuid
2 
3 from candid import CandidApiClient
4 
5 client = CandidApiClient(
6     client_id="YOUR_CLIENT_ID",
7     client_secret="YOUR_CLIENT_SECRET",
8 )
9 client.charge_capture.v_1.get(
10     charge_capture_id=uuid.UUID(
11         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12     ),
13 )

Try it

200Retrieved

1 {
2   "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3   "status": "planned",
4   "charge_capture_data": {
5     "additional_information": "additional_information",
6     "admission_date": "2023-01-15",
7     "appointment_type": "appointment_type",
8     "benefits_assigned_to_provider": true,
9     "billable_status": "BILLABLE",
10     "billing_notes": [
11       {
12         "text": "text"
13       },
14       {
15         "text": "text"
16       }
17     ],
18     "billing_provider": {
19       "address": {
20         "address1": "address1",
21         "address2": "address2",
22         "city": "city",
23         "state": "AA",
24         "zip_code": "zip_code",
25         "zip_plus_four_code": "zip_plus_four_code"
26       },
27       "first_name": "first_name",
28       "last_name": "last_name",
29       "npi": "npi",
30       "organization_name": "organization_name",
31       "provider_commercial_license_type": "0",
32       "tax_id": "tax_id",
33       "taxonomy_code": "taxonomy_code"
34     },
35     "claim_supplemental_information": [
36       {
37         "attachment_report_type_code": "03",
38         "attachment_transmission_code": "BM",
39         "attachment_control_number": "attachment_control_number"
40       },
41       {
42         "attachment_report_type_code": "03",
43         "attachment_transmission_code": "BM",
44         "attachment_control_number": "attachment_control_number"
45       }
46     ],
47     "clinical_notes": [
48       {
49         "category": "clinical",
50         "notes": [
51           {
52             "text": "text",
53             "author_name": "author_name",
54             "author_npi": "author_npi",
55             "timestamp": "2024-01-15T09:30:00Z"
56           },
57           {
58             "text": "text",
59             "author_name": "author_name",
60             "author_npi": "author_npi",
61             "timestamp": "2024-01-15T09:30:00Z"
62           }
63         ]
64       },
65       {
66         "category": "clinical",
67         "notes": [
68           {
69             "text": "text",
70             "author_name": "author_name",
71             "author_npi": "author_npi",
72             "timestamp": "2024-01-15T09:30:00Z"
73           },
74           {
75             "text": "text",
76             "author_name": "author_name",
77             "author_npi": "author_npi",
78             "timestamp": "2024-01-15T09:30:00Z"
79           }
80         ]
81       }
82     ],
83     "date_of_service": "2023-01-15",
84     "delay_reason_code": "1",
85     "diagnoses": [
86       {
87         "name": "name",
88         "code_type": "ABF",
89         "code": "code",
90         "present_on_admission_indicator": "YES"
91       },
92       {
93         "name": "name",
94         "code_type": "ABF",
95         "code": "code",
96         "present_on_admission_indicator": "YES"
97       }
98     ],
99     "discharge_date": "2023-01-15",
100     "end_date_of_service": "2023-01-15",
101     "epsdt_referral": {
102       "condition_indicator1": "AV",
103       "condition_indicator2": "AV",
104       "condition_indicator3": "AV"
105     },
106     "existing_medications": [
107       {
108         "name": "name",
109         "rx_cui": "rx_cui",
110         "dosage": "dosage",
111         "dosage_form": "dosage_form",
112         "frequency": "frequency",
113         "as_needed": true
114       },
115       {
116         "name": "name",
117         "rx_cui": "rx_cui",
118         "dosage": "dosage",
119         "dosage_form": "dosage_form",
120         "frequency": "frequency",
121         "as_needed": true
122       }
123     ],
124     "external_id": "external_id",
125     "guarantor": {
126       "first_name": "first_name",
127       "last_name": "last_name",
128       "external_id": "external_id",
129       "date_of_birth": "2023-01-15",
130       "address": {
131         "address1": "address1",
132         "address2": "address2",
133         "city": "city",
134         "state": "AA",
135         "zip_code": "zip_code",
136         "zip_plus_four_code": "zip_plus_four_code"
137       },
138       "phone_numbers": [
139         {
140           "number": "number",
141           "type": "Home"
142         },
143         {
144           "number": "number",
145           "type": "Home"
146         }
147       ],
148       "phone_consent": true,
149       "email": "email",
150       "email_consent": true,
151       "auto_charge_consent": true
152     },
153     "initial_referring_provider": {
154       "address": {
155         "address1": "address1",
156         "address2": "address2",
157         "city": "city",
158         "state": "AA",
159         "zip_code": "zip_code",
160         "zip_plus_four_code": "zip_plus_four_code"
161       },
162       "first_name": "first_name",
163       "last_name": "last_name",
164       "npi": "npi",
165       "organization_name": "organization_name",
166       "qualifier": "DQ",
167       "taxonomy_code": "taxonomy_code"
168     },
169     "interventions": [
170       {
171         "name": "name",
172         "category": "allopathic",
173         "description": "description",
174         "medication": {
175           "name": "name",
176           "rx_cui": "rx_cui",
177           "dosage": "dosage",
178           "dosage_form": "dosage_form",
179           "frequency": "frequency",
180           "as_needed": true
181         },
182         "labs": [
183           {
184             "name": "name",
185             "code": "code",
186             "code_type": "quest"
187           },
188           {
189             "name": "name",
190             "code": "code",
191             "code_type": "quest"
192           }
193         ]
194       },
195       {
196         "name": "name",
197         "category": "allopathic",
198         "description": "description",
199         "medication": {
200           "name": "name",
201           "rx_cui": "rx_cui",
202           "dosage": "dosage",
203           "dosage_form": "dosage_form",
204           "frequency": "frequency",
205           "as_needed": true
206         },
207         "labs": [
208           {
209             "name": "name",
210             "code": "code",
211             "code_type": "quest"
212           },
213           {
214             "name": "name",
215             "code": "code",
216             "code_type": "quest"
217           }
218         ]
219       }
220     ],
221     "last_menstrual_period_date": "2023-01-15",
222     "onset_of_current_illness_or_symptom_date": "2023-01-15",
223     "patient": {
224       "first_name": "first_name",
225       "last_name": "last_name",
226       "gender": "male",
227       "external_id": "external_id",
228       "date_of_birth": "2023-01-15",
229       "address": {
230         "address1": "address1",
231         "address2": "address2",
232         "city": "city",
233         "state": "AA",
234         "zip_code": "zip_code",
235         "zip_plus_four_code": "zip_plus_four_code"
236       },
237       "phone_numbers": [
238         {
239           "number": "number",
240           "type": "Home"
241         },
242         {
243           "number": "number",
244           "type": "Home"
245         }
246       ],
247       "phone_consent": true,
248       "email": "email",
249       "email_consent": true,
250       "auto_charge_consent": true,
251       "non_insurance_payers_info": [
252         {
253           "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
254           "member_id": "member_id",
255           "clinical_trial_info": []
256         },
257         {
258           "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
259           "member_id": "member_id",
260           "clinical_trial_info": []
261         }
262       ],
263       "non_insurance_payers": [
264         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
265         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
266       ]
267     },
268     "patient_histories": [
269       {
270         "category": "present_illness",
271         "questions": [
272           {
273             "id": "id",
274             "text": "text",
275             "responses": []
276           },
277           {
278             "id": "id",
279             "text": "text",
280             "responses": []
281           }
282         ]
283       },
284       {
285         "category": "present_illness",
286         "questions": [
287           {
288             "id": "id",
289             "text": "text",
290             "responses": []
291           },
292           {
293             "id": "id",
294             "text": "text",
295             "responses": []
296           }
297         ]
298       }
299     ],
300     "pay_to_address": {
301       "address1": "address1",
302       "address2": "address2",
303       "city": "city",
304       "state": "AA",
305       "zip_code": "zip_code",
306       "zip_plus_four_code": "zip_plus_four_code"
307     },
308     "place_of_service_code": "01",
309     "prior_authorization_number": "prior_authorization_number",
310     "provider_accepts_assignment": true,
311     "referral_number": "referral_number",
312     "referring_provider": {
313       "address": {
314         "address1": "address1",
315         "address2": "address2",
316         "city": "city",
317         "state": "AA",
318         "zip_code": "zip_code",
319         "zip_plus_four_code": "zip_plus_four_code"
320       },
321       "first_name": "first_name",
322       "last_name": "last_name",
323       "npi": "npi",
324       "organization_name": "organization_name",
325       "taxonomy_code": "taxonomy_code"
326     },
327     "rendering_provider": {
328       "address": {
329         "address1": "address1",
330         "address2": "address2",
331         "city": "city",
332         "state": "AA",
333         "zip_code": "zip_code",
334         "zip_plus_four_code": "zip_plus_four_code"
335       },
336       "first_name": "first_name",
337       "last_name": "last_name",
338       "npi": "npi",
339       "organization_name": "organization_name",
340       "taxonomy_code": "taxonomy_code"
341     },
342     "responsible_party": "INSURANCE_PAY",
343     "schema_instances": [
344       {
345         "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
346         "content": {
347           "content": {
348             "key": "value"
349           }
350         }
351       },
352       {
353         "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
354         "content": {
355           "content": {
356             "key": "value"
357           }
358         }
359       }
360     ],
361     "secondary_payer_carrier_code": "secondary_payer_carrier_code",
362     "service_authorization_exception_code": "1",
363     "service_facility": {
364       "organization_name": "organization_name",
365       "npi": "npi",
366       "address": {
367         "address1": "address1",
368         "address2": "address2",
369         "city": "city",
370         "state": "AA",
371         "zip_code": "zip_code",
372         "zip_plus_four_code": "zip_plus_four_code"
373       },
374       "secondary_identification": "secondary_identification"
375     },
376     "service_lines": [
377       {
378         "modifiers": [
379           "AV",
380           "AV"
381         ],
382         "has_epsdt_indicator": true,
383         "has_family_planning_indicator": true,
384         "procedure_code": "procedure_code",
385         "quantity": "quantity",
386         "units": "MJ",
387         "charge_amount_cents": 1,
388         "diagnosis_pointers": [
389           1,
390           1
391         ],
392         "drug_identification": {
393           "service_id_qualifier": "EN",
394           "national_drug_code": "national_drug_code",
395           "national_drug_unit_count": "national_drug_unit_count",
396           "measurement_unit_code": "ML",
397           "link_sequence_number": "link_sequence_number",
398           "pharmacy_prescription_number": "pharmacy_prescription_number",
399           "conversion_formula": "conversion_formula",
400           "drug_description": "drug_description"
401         },
402         "place_of_service_code": "01",
403         "description": "description",
404         "date_of_service": "2023-01-15",
405         "end_date_of_service": "2023-01-15",
406         "ordering_provider": {
407           "address": {},
408           "first_name": "first_name",
409           "last_name": "last_name",
410           "npi": "npi",
411           "organization_name": "organization_name",
412           "taxonomy_code": "taxonomy_code"
413         },
414         "test_results": [
415           {
416             "value": 1.1,
417             "result_type": "HEMATOCRIT"
418           },
419           {
420             "value": 1.1,
421             "result_type": "HEMATOCRIT"
422           }
423         ],
424         "note": "note",
425         "revenue_code": "revenue_code"
426       },
427       {
428         "modifiers": [
429           "AV",
430           "AV"
431         ],
432         "has_epsdt_indicator": true,
433         "has_family_planning_indicator": true,
434         "procedure_code": "procedure_code",
435         "quantity": "quantity",
436         "units": "MJ",
437         "charge_amount_cents": 1,
438         "diagnosis_pointers": [
439           1,
440           1
441         ],
442         "drug_identification": {
443           "service_id_qualifier": "EN",
444           "national_drug_code": "national_drug_code",
445           "national_drug_unit_count": "national_drug_unit_count",
446           "measurement_unit_code": "ML",
447           "link_sequence_number": "link_sequence_number",
448           "pharmacy_prescription_number": "pharmacy_prescription_number",
449           "conversion_formula": "conversion_formula",
450           "drug_description": "drug_description"
451         },
452         "place_of_service_code": "01",
453         "description": "description",
454         "date_of_service": "2023-01-15",
455         "end_date_of_service": "2023-01-15",
456         "ordering_provider": {
457           "address": {},
458           "first_name": "first_name",
459           "last_name": "last_name",
460           "npi": "npi",
461           "organization_name": "organization_name",
462           "taxonomy_code": "taxonomy_code"
463         },
464         "test_results": [
465           {
466             "value": 1.1,
467             "result_type": "HEMATOCRIT"
468           },
469           {
470             "value": 1.1,
471             "result_type": "HEMATOCRIT"
472           }
473         ],
474         "note": "note",
475         "revenue_code": "revenue_code"
476       }
477     ],
478     "subscriber_primary": {
479       "address": {
480         "address1": "address1",
481         "address2": "address2",
482         "city": "city",
483         "state": "AA",
484         "zip_code": "zip_code",
485         "zip_plus_four_code": "zip_plus_four_code"
486       },
487       "date_of_birth": "2023-01-15",
488       "first_name": "first_name",
489       "gender": "male",
490       "insurance_card": {
491         "emr_payer_crosswalk": "HEALTHIE",
492         "group_number": "group_number",
493         "image_url_back": "image_url_back",
494         "image_url_front": "image_url_front",
495         "insurance_type": "01",
496         "member_id": "member_id",
497         "payer_id": "payer_id",
498         "payer_name": "payer_name",
499         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
500         "plan_name": "plan_name",
501         "plan_type": "09",
502         "rx_bin": "rx_bin",
503         "rx_pcn": "rx_pcn"
504       },
505       "last_name": "last_name",
506       "patient_relationship_to_subscriber_code": "01"
507     },
508     "subscriber_secondary": {
509       "address": {
510         "address1": "address1",
511         "address2": "address2",
512         "city": "city",
513         "state": "AA",
514         "zip_code": "zip_code",
515         "zip_plus_four_code": "zip_plus_four_code"
516       },
517       "date_of_birth": "2023-01-15",
518       "first_name": "first_name",
519       "gender": "male",
520       "insurance_card": {
521         "emr_payer_crosswalk": "HEALTHIE",
522         "group_number": "group_number",
523         "image_url_back": "image_url_back",
524         "image_url_front": "image_url_front",
525         "insurance_type": "01",
526         "member_id": "member_id",
527         "payer_id": "payer_id",
528         "payer_name": "payer_name",
529         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
530         "plan_name": "plan_name",
531         "plan_type": "09",
532         "rx_bin": "rx_bin",
533         "rx_pcn": "rx_pcn"
534       },
535       "last_name": "last_name",
536       "patient_relationship_to_subscriber_code": "01"
537     },
538     "subscriber_tertiary": {
539       "address": {
540         "address1": "address1",
541         "address2": "address2",
542         "city": "city",
543         "state": "AA",
544         "zip_code": "zip_code",
545         "zip_plus_four_code": "zip_plus_four_code"
546       },
547       "date_of_birth": "2023-01-15",
548       "first_name": "first_name",
549       "gender": "male",
550       "insurance_card": {
551         "emr_payer_crosswalk": "HEALTHIE",
552         "group_number": "group_number",
553         "image_url_back": "image_url_back",
554         "image_url_front": "image_url_front",
555         "insurance_type": "01",
556         "member_id": "member_id",
557         "payer_id": "payer_id",
558         "payer_name": "payer_name",
559         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
560         "plan_name": "plan_name",
561         "plan_type": "09",
562         "rx_bin": "rx_bin",
563         "rx_pcn": "rx_pcn"
564       },
565       "last_name": "last_name",
566       "patient_relationship_to_subscriber_code": "01"
567     },
568     "supervising_provider": {
569       "address": {
570         "address1": "address1",
571         "address2": "address2",
572         "city": "city",
573         "state": "AA",
574         "zip_code": "zip_code",
575         "zip_plus_four_code": "zip_plus_four_code"
576       },
577       "first_name": "first_name",
578       "last_name": "last_name",
579       "npi": "npi",
580       "organization_name": "organization_name",
581       "taxonomy_code": "taxonomy_code"
582     },
583     "synchronicity": "Synchronous",
584     "tag_ids": [
585       "tag_ids",
586       "tag_ids"
587     ],
588     "vitals": {
589       "height_in": 1,
590       "weight_lbs": 1,
591       "blood_pressure_systolic_mmhg": 1,
592       "blood_pressure_diastolic_mmhg": 1,
593       "body_temperature_f": 1.1,
594       "hemoglobin_gdl": 1.1,
595       "hematocrit_pct": 1.1
596     },
597     "external_claim_submission": {
598       "submission_records": [
599         {
600           "submitted_at": "2024-01-15T09:30:00Z",
601           "claim_frequency_code": "0",
602           "payer_responsibility": "primary",
603           "intended_submission_medium": "paper"
604         },
605         {
606           "submitted_at": "2024-01-15T09:30:00Z",
607           "claim_frequency_code": "0",
608           "payer_responsibility": "primary",
609           "intended_submission_medium": "paper"
610         }
611       ],
612       "claim_created_at": "2024-01-15T09:30:00Z",
613       "patient_control_number": "patient_control_number"
614     },
615     "patient_authorized_release": true
616   },
617   "patient_external_id": "patient_external_id",
618   "charge_external_id": "charge_external_id",
619   "updates": [
620     {
621       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
622       "message": "message",
623       "resolved": true
624     },
625     {
626       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
627       "message": "message",
628       "resolved": true
629     }
630   ],
631   "date_of_service": "2023-01-15",
632   "ehr_source_url": "ehr_source_url",
633   "originating_system": "originating_system",
634   "claim_creation_category": "claim_creation_category",
635   "error": {
636     "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
637     "message": "message",
638     "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
639     "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
640     "resolved": true,
641     "resolved_by": "resolved_by",
642     "resolution_reason": "resolution_reason",
643     "field_in_error": "field_in_error"
644   },
645   "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
646 }

Path parameters

charge_capture_idUUIDRequired

Response

This endpoint returns an object.

idUUID

statusenum

Allowed values:

charge_capture_dataobject

patient_external_idstring

charge_external_idstring

updateslist of objects

date_of_servicedate or null

ehr_source_urlstring or null

originating_systemstring or null

claim_creation_categorystring or null

errorobject or null

claim_creation_idUUID or null

Path parameters

Headers

Response