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               "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
258             },
259             {
260               "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
261             }
262           ]
263         },
264         {
265           "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
266           "member_id": "member_id",
267           "clinical_trial_info": [
268             {
269               "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
270             },
271             {
272               "clinical_trial_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
273             }
274           ]
275         }
276       ],
277       "non_insurance_payers": [
278         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
279         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
280       ]
281     },
282     "patient_histories": [
283       {
284         "category": "present_illness",
285         "questions": [
286           {
287             "id": "id",
288             "text": "text",
289             "responses": [
290               {},
291               {}
292             ]
293           },
294           {
295             "id": "id",
296             "text": "text",
297             "responses": [
298               {},
299               {}
300             ]
301           }
302         ]
303       },
304       {
305         "category": "present_illness",
306         "questions": [
307           {
308             "id": "id",
309             "text": "text",
310             "responses": [
311               {},
312               {}
313             ]
314           },
315           {
316             "id": "id",
317             "text": "text",
318             "responses": [
319               {},
320               {}
321             ]
322           }
323         ]
324       }
325     ],
326     "pay_to_address": {
327       "address1": "address1",
328       "address2": "address2",
329       "city": "city",
330       "state": "AA",
331       "zip_code": "zip_code",
332       "zip_plus_four_code": "zip_plus_four_code"
333     },
334     "place_of_service_code": "01",
335     "prior_authorization_number": "prior_authorization_number",
336     "provider_accepts_assignment": true,
337     "referral_number": "referral_number",
338     "referring_provider": {
339       "address": {
340         "address1": "address1",
341         "address2": "address2",
342         "city": "city",
343         "state": "AA",
344         "zip_code": "zip_code",
345         "zip_plus_four_code": "zip_plus_four_code"
346       },
347       "first_name": "first_name",
348       "last_name": "last_name",
349       "npi": "npi",
350       "organization_name": "organization_name",
351       "taxonomy_code": "taxonomy_code"
352     },
353     "rendering_provider": {
354       "address": {
355         "address1": "address1",
356         "address2": "address2",
357         "city": "city",
358         "state": "AA",
359         "zip_code": "zip_code",
360         "zip_plus_four_code": "zip_plus_four_code"
361       },
362       "first_name": "first_name",
363       "last_name": "last_name",
364       "npi": "npi",
365       "organization_name": "organization_name",
366       "taxonomy_code": "taxonomy_code"
367     },
368     "responsible_party": "INSURANCE_PAY",
369     "schema_instances": [
370       {
371         "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
372         "content": {
373           "content": {
374             "key": "value"
375           }
376         }
377       },
378       {
379         "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
380         "content": {
381           "content": {
382             "key": "value"
383           }
384         }
385       }
386     ],
387     "secondary_payer_carrier_code": "secondary_payer_carrier_code",
388     "service_authorization_exception_code": "1",
389     "service_facility": {
390       "organization_name": "organization_name",
391       "npi": "npi",
392       "address": {
393         "address1": "address1",
394         "address2": "address2",
395         "city": "city",
396         "state": "AA",
397         "zip_code": "zip_code",
398         "zip_plus_four_code": "zip_plus_four_code"
399       },
400       "secondary_identification": "secondary_identification",
401       "mammography_certification_number": "mammography_certification_number"
402     },
403     "service_lines": [
404       {
405         "modifiers": [
406           "AV",
407           "AV"
408         ],
409         "has_epsdt_indicator": true,
410         "has_family_planning_indicator": true,
411         "procedure_code": "procedure_code",
412         "quantity": "quantity",
413         "units": "MJ",
414         "charge_amount_cents": 1,
415         "diagnosis_pointers": [
416           1,
417           1
418         ],
419         "drug_identification": {
420           "service_id_qualifier": "EN",
421           "national_drug_code": "national_drug_code",
422           "national_drug_unit_count": "national_drug_unit_count",
423           "measurement_unit_code": "ML",
424           "link_sequence_number": "link_sequence_number",
425           "pharmacy_prescription_number": "pharmacy_prescription_number",
426           "conversion_formula": "conversion_formula",
427           "drug_description": "drug_description"
428         },
429         "place_of_service_code": "01",
430         "description": "description",
431         "date_of_service": "2023-01-15",
432         "end_date_of_service": "2023-01-15",
433         "ordering_provider": {
434           "address": {
435             "address1": "address1",
436             "address2": "address2",
437             "city": "city",
438             "state": "AA",
439             "zip_code": "zip_code",
440             "zip_plus_four_code": "zip_plus_four_code"
441           },
442           "first_name": "first_name",
443           "last_name": "last_name",
444           "npi": "npi",
445           "organization_name": "organization_name",
446           "taxonomy_code": "taxonomy_code"
447         },
448         "test_results": [
449           {
450             "value": 1.1,
451             "result_type": "HEMATOCRIT"
452           },
453           {
454             "value": 1.1,
455             "result_type": "HEMATOCRIT"
456           }
457         ],
458         "note": "note",
459         "revenue_code": "revenue_code",
460         "prior_authorization_number": "prior_authorization_number"
461       },
462       {
463         "modifiers": [
464           "AV",
465           "AV"
466         ],
467         "has_epsdt_indicator": true,
468         "has_family_planning_indicator": true,
469         "procedure_code": "procedure_code",
470         "quantity": "quantity",
471         "units": "MJ",
472         "charge_amount_cents": 1,
473         "diagnosis_pointers": [
474           1,
475           1
476         ],
477         "drug_identification": {
478           "service_id_qualifier": "EN",
479           "national_drug_code": "national_drug_code",
480           "national_drug_unit_count": "national_drug_unit_count",
481           "measurement_unit_code": "ML",
482           "link_sequence_number": "link_sequence_number",
483           "pharmacy_prescription_number": "pharmacy_prescription_number",
484           "conversion_formula": "conversion_formula",
485           "drug_description": "drug_description"
486         },
487         "place_of_service_code": "01",
488         "description": "description",
489         "date_of_service": "2023-01-15",
490         "end_date_of_service": "2023-01-15",
491         "ordering_provider": {
492           "address": {
493             "address1": "address1",
494             "address2": "address2",
495             "city": "city",
496             "state": "AA",
497             "zip_code": "zip_code",
498             "zip_plus_four_code": "zip_plus_four_code"
499           },
500           "first_name": "first_name",
501           "last_name": "last_name",
502           "npi": "npi",
503           "organization_name": "organization_name",
504           "taxonomy_code": "taxonomy_code"
505         },
506         "test_results": [
507           {
508             "value": 1.1,
509             "result_type": "HEMATOCRIT"
510           },
511           {
512             "value": 1.1,
513             "result_type": "HEMATOCRIT"
514           }
515         ],
516         "note": "note",
517         "revenue_code": "revenue_code",
518         "prior_authorization_number": "prior_authorization_number"
519       }
520     ],
521     "subscriber_primary": {
522       "address": {
523         "address1": "address1",
524         "address2": "address2",
525         "city": "city",
526         "state": "AA",
527         "zip_code": "zip_code",
528         "zip_plus_four_code": "zip_plus_four_code"
529       },
530       "date_of_birth": "2023-01-15",
531       "first_name": "first_name",
532       "gender": "male",
533       "insurance_card": {
534         "emr_payer_crosswalk": "HEALTHIE",
535         "group_number": "group_number",
536         "image_url_back": "image_url_back",
537         "image_url_front": "image_url_front",
538         "insurance_type": "01",
539         "member_id": "member_id",
540         "payer_id": "payer_id",
541         "payer_name": "payer_name",
542         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
543         "plan_name": "plan_name",
544         "plan_type": "09",
545         "rx_bin": "rx_bin",
546         "rx_pcn": "rx_pcn"
547       },
548       "last_name": "last_name",
549       "patient_relationship_to_subscriber_code": "01"
550     },
551     "subscriber_secondary": {
552       "address": {
553         "address1": "address1",
554         "address2": "address2",
555         "city": "city",
556         "state": "AA",
557         "zip_code": "zip_code",
558         "zip_plus_four_code": "zip_plus_four_code"
559       },
560       "date_of_birth": "2023-01-15",
561       "first_name": "first_name",
562       "gender": "male",
563       "insurance_card": {
564         "emr_payer_crosswalk": "HEALTHIE",
565         "group_number": "group_number",
566         "image_url_back": "image_url_back",
567         "image_url_front": "image_url_front",
568         "insurance_type": "01",
569         "member_id": "member_id",
570         "payer_id": "payer_id",
571         "payer_name": "payer_name",
572         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
573         "plan_name": "plan_name",
574         "plan_type": "09",
575         "rx_bin": "rx_bin",
576         "rx_pcn": "rx_pcn"
577       },
578       "last_name": "last_name",
579       "patient_relationship_to_subscriber_code": "01"
580     },
581     "subscriber_tertiary": {
582       "address": {
583         "address1": "address1",
584         "address2": "address2",
585         "city": "city",
586         "state": "AA",
587         "zip_code": "zip_code",
588         "zip_plus_four_code": "zip_plus_four_code"
589       },
590       "date_of_birth": "2023-01-15",
591       "first_name": "first_name",
592       "gender": "male",
593       "insurance_card": {
594         "emr_payer_crosswalk": "HEALTHIE",
595         "group_number": "group_number",
596         "image_url_back": "image_url_back",
597         "image_url_front": "image_url_front",
598         "insurance_type": "01",
599         "member_id": "member_id",
600         "payer_id": "payer_id",
601         "payer_name": "payer_name",
602         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
603         "plan_name": "plan_name",
604         "plan_type": "09",
605         "rx_bin": "rx_bin",
606         "rx_pcn": "rx_pcn"
607       },
608       "last_name": "last_name",
609       "patient_relationship_to_subscriber_code": "01"
610     },
611     "supervising_provider": {
612       "address": {
613         "address1": "address1",
614         "address2": "address2",
615         "city": "city",
616         "state": "AA",
617         "zip_code": "zip_code",
618         "zip_plus_four_code": "zip_plus_four_code"
619       },
620       "first_name": "first_name",
621       "last_name": "last_name",
622       "npi": "npi",
623       "organization_name": "organization_name",
624       "taxonomy_code": "taxonomy_code"
625     },
626     "synchronicity": "Synchronous",
627     "tag_ids": [
628       "tag_ids",
629       "tag_ids"
630     ],
631     "vitals": {
632       "height_in": 1,
633       "weight_lbs": 1,
634       "blood_pressure_systolic_mmhg": 1,
635       "blood_pressure_diastolic_mmhg": 1,
636       "body_temperature_f": 1.1,
637       "hemoglobin_gdl": 1.1,
638       "hematocrit_pct": 1.1
639     },
640     "external_claim_submission": {
641       "submission_records": [
642         {
643           "submitted_at": "2024-01-15T09:30:00Z",
644           "claim_frequency_code": "0",
645           "payer_responsibility": "primary",
646           "intended_submission_medium": "paper"
647         },
648         {
649           "submitted_at": "2024-01-15T09:30:00Z",
650           "claim_frequency_code": "0",
651           "payer_responsibility": "primary",
652           "intended_submission_medium": "paper"
653         }
654       ],
655       "claim_created_at": "2024-01-15T09:30:00Z",
656       "patient_control_number": "patient_control_number"
657     },
658     "patient_authorized_release": true
659   },
660   "patient_external_id": "patient_external_id",
661   "charge_external_id": "charge_external_id",
662   "updates": [
663     {
664       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
665       "message": "message",
666       "resolved": true
667     },
668     {
669       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
670       "message": "message",
671       "resolved": true
672     }
673   ],
674   "date_of_service": "2023-01-15",
675   "ehr_source_url": "ehr_source_url",
676   "originating_system": "originating_system",
677   "claim_creation_category": "claim_creation_category",
678   "error": {
679     "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
680     "message": "message",
681     "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
682     "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
683     "resolved": true,
684     "resolved_by": "resolved_by",
685     "resolution_reason": "resolution_reason",
686     "field_in_error": "field_in_error"
687   },
688   "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
689 }

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

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

This list of updates will always return at most 1 update that is not resolved. The singular update will contain the difference between the updated charge and the created encounter.

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