Beta

Get Charge Capture Bundle

GET

/api/charge_capture_bundle/v1/:charge_capture_bundle_id

GET

1 curl https://api.joincandidhealth.com/api/charge_capture_bundle/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
2      -H "Authorization: Bearer <token>"

Play

200Retrieved

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

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

Allowed values:

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

Errors