Get Charge Capture Bundle

Beta

GET

/api/charge_capture_bundle/v1/:charge_capture_bundle_id

GET

/api/charge_capture_bundle/v1/:charge_capture_bundle_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_bundles.v_1.get(
10     charge_capture_bundle_id=uuid.UUID(
11         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12     ),
13 )

Try it

200Retrieved

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

Path parameters

charge_capture_bundle_idUUIDRequired

Response

This endpoint returns an object.

idUUID

statusenum

Status of the Bundle, Successful means that the Bundle created a corresponding Claim

charge_captureslist of objects

All the underlying ChargeCaptures that are present in a ChargeCaptureBundle.

errorslist of objects

All errors that were found when the bundle was attempted to be created. Errors can correspond to the Bundle as a whole or specific underlying Charge Captures.

created_encounter_idUUIDOptional

Path parameters

Headers

Response