Get Charge Capture

Beta

GET

/api/charge_captures/v1/:charge_capture_id

GET

/api/charge_captures/v1/:charge_capture_id

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

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     },
152     "initial_referring_provider": {
153       "address": {
154         "address1": "address1",
155         "address2": "address2",
156         "city": "city",
157         "state": "AA",
158         "zip_code": "zip_code",
159         "zip_plus_four_code": "zip_plus_four_code"
160       },
161       "first_name": "first_name",
162       "last_name": "last_name",
163       "npi": "npi",
164       "organization_name": "organization_name",
165       "qualifier": "DQ",
166       "taxonomy_code": "taxonomy_code"
167     },
168     "interventions": [
169       {
170         "name": "name",
171         "category": "allopathic",
172         "description": "description",
173         "medication": {
174           "name": "name",
175           "rx_cui": "rx_cui",
176           "dosage": "dosage",
177           "dosage_form": "dosage_form",
178           "frequency": "frequency",
179           "as_needed": true
180         },
181         "labs": [
182           {
183             "name": "name",
184             "code": "code",
185             "code_type": "quest"
186           },
187           {
188             "name": "name",
189             "code": "code",
190             "code_type": "quest"
191           }
192         ]
193       },
194       {
195         "name": "name",
196         "category": "allopathic",
197         "description": "description",
198         "medication": {
199           "name": "name",
200           "rx_cui": "rx_cui",
201           "dosage": "dosage",
202           "dosage_form": "dosage_form",
203           "frequency": "frequency",
204           "as_needed": true
205         },
206         "labs": [
207           {
208             "name": "name",
209             "code": "code",
210             "code_type": "quest"
211           },
212           {
213             "name": "name",
214             "code": "code",
215             "code_type": "quest"
216           }
217         ]
218       }
219     ],
220     "last_menstrual_period_date": "2023-01-15",
221     "onset_of_current_illness_or_symptom_date": "2023-01-15",
222     "patient": {
223       "first_name": "first_name",
224       "last_name": "last_name",
225       "gender": "male",
226       "external_id": "external_id",
227       "date_of_birth": "2023-01-15",
228       "address": {
229         "address1": "address1",
230         "address2": "address2",
231         "city": "city",
232         "state": "AA",
233         "zip_code": "zip_code",
234         "zip_plus_four_code": "zip_plus_four_code"
235       },
236       "phone_numbers": [
237         {
238           "number": "number",
239           "type": "Home"
240         },
241         {
242           "number": "number",
243           "type": "Home"
244         }
245       ],
246       "phone_consent": true,
247       "email": "email",
248       "email_consent": true,
249       "non_insurance_payers_info": [
250         {
251           "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
252           "member_id": "member_id",
253           "clinical_trial_info": []
254         },
255         {
256           "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
257           "member_id": "member_id",
258           "clinical_trial_info": []
259         }
260       ],
261       "non_insurance_payers": [
262         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
263         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
264       ]
265     },
266     "patient_histories": [
267       {
268         "category": "present_illness",
269         "questions": [
270           {
271             "id": "id",
272             "text": "text",
273             "responses": []
274           },
275           {
276             "id": "id",
277             "text": "text",
278             "responses": []
279           }
280         ]
281       },
282       {
283         "category": "present_illness",
284         "questions": [
285           {
286             "id": "id",
287             "text": "text",
288             "responses": []
289           },
290           {
291             "id": "id",
292             "text": "text",
293             "responses": []
294           }
295         ]
296       }
297     ],
298     "pay_to_address": {
299       "address1": "address1",
300       "address2": "address2",
301       "city": "city",
302       "state": "AA",
303       "zip_code": "zip_code",
304       "zip_plus_four_code": "zip_plus_four_code"
305     },
306     "place_of_service_code": "01",
307     "prior_authorization_number": "prior_authorization_number",
308     "provider_accepts_assignment": true,
309     "referral_number": "referral_number",
310     "referring_provider": {
311       "address": {
312         "address1": "address1",
313         "address2": "address2",
314         "city": "city",
315         "state": "AA",
316         "zip_code": "zip_code",
317         "zip_plus_four_code": "zip_plus_four_code"
318       },
319       "first_name": "first_name",
320       "last_name": "last_name",
321       "npi": "npi",
322       "organization_name": "organization_name",
323       "taxonomy_code": "taxonomy_code"
324     },
325     "rendering_provider": {
326       "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       "first_name": "first_name",
335       "last_name": "last_name",
336       "npi": "npi",
337       "organization_name": "organization_name",
338       "taxonomy_code": "taxonomy_code"
339     },
340     "responsible_party": "INSURANCE_PAY",
341     "schema_instances": [
342       {
343         "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
344         "content": {
345           "content": {
346             "key": "value"
347           }
348         }
349       },
350       {
351         "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
352         "content": {
353           "content": {
354             "key": "value"
355           }
356         }
357       }
358     ],
359     "secondary_payer_carrier_code": "secondary_payer_carrier_code",
360     "service_authorization_exception_code": "1",
361     "service_facility": {
362       "organization_name": "organization_name",
363       "npi": "npi",
364       "address": {
365         "address1": "address1",
366         "address2": "address2",
367         "city": "city",
368         "state": "AA",
369         "zip_code": "zip_code",
370         "zip_plus_four_code": "zip_plus_four_code"
371       },
372       "secondary_identification": "secondary_identification"
373     },
374     "service_lines": [
375       {
376         "modifiers": [
377           "AV",
378           "AV"
379         ],
380         "has_epsdt_indicator": true,
381         "has_family_planning_indicator": true,
382         "procedure_code": "procedure_code",
383         "quantity": "quantity",
384         "units": "MJ",
385         "charge_amount_cents": 1,
386         "diagnosis_pointers": [
387           1,
388           1
389         ],
390         "drug_identification": {
391           "service_id_qualifier": "EN",
392           "national_drug_code": "national_drug_code",
393           "national_drug_unit_count": "national_drug_unit_count",
394           "measurement_unit_code": "ML",
395           "link_sequence_number": "link_sequence_number",
396           "pharmacy_prescription_number": "pharmacy_prescription_number",
397           "conversion_formula": "conversion_formula",
398           "drug_description": "drug_description"
399         },
400         "place_of_service_code": "01",
401         "description": "description",
402         "date_of_service": "2023-01-15",
403         "end_date_of_service": "2023-01-15",
404         "ordering_provider": {
405           "address": {},
406           "first_name": "first_name",
407           "last_name": "last_name",
408           "npi": "npi",
409           "organization_name": "organization_name",
410           "taxonomy_code": "taxonomy_code"
411         },
412         "test_results": [
413           {
414             "value": 1.1,
415             "result_type": "HEMATOCRIT"
416           },
417           {
418             "value": 1.1,
419             "result_type": "HEMATOCRIT"
420           }
421         ],
422         "note": "note"
423       },
424       {
425         "modifiers": [
426           "AV",
427           "AV"
428         ],
429         "has_epsdt_indicator": true,
430         "has_family_planning_indicator": true,
431         "procedure_code": "procedure_code",
432         "quantity": "quantity",
433         "units": "MJ",
434         "charge_amount_cents": 1,
435         "diagnosis_pointers": [
436           1,
437           1
438         ],
439         "drug_identification": {
440           "service_id_qualifier": "EN",
441           "national_drug_code": "national_drug_code",
442           "national_drug_unit_count": "national_drug_unit_count",
443           "measurement_unit_code": "ML",
444           "link_sequence_number": "link_sequence_number",
445           "pharmacy_prescription_number": "pharmacy_prescription_number",
446           "conversion_formula": "conversion_formula",
447           "drug_description": "drug_description"
448         },
449         "place_of_service_code": "01",
450         "description": "description",
451         "date_of_service": "2023-01-15",
452         "end_date_of_service": "2023-01-15",
453         "ordering_provider": {
454           "address": {},
455           "first_name": "first_name",
456           "last_name": "last_name",
457           "npi": "npi",
458           "organization_name": "organization_name",
459           "taxonomy_code": "taxonomy_code"
460         },
461         "test_results": [
462           {
463             "value": 1.1,
464             "result_type": "HEMATOCRIT"
465           },
466           {
467             "value": 1.1,
468             "result_type": "HEMATOCRIT"
469           }
470         ],
471         "note": "note"
472       }
473     ],
474     "subscriber_primary": {
475       "address": {
476         "address1": "address1",
477         "address2": "address2",
478         "city": "city",
479         "state": "AA",
480         "zip_code": "zip_code",
481         "zip_plus_four_code": "zip_plus_four_code"
482       },
483       "date_of_birth": "2023-01-15",
484       "first_name": "first_name",
485       "gender": "male",
486       "insurance_card": {
487         "emr_payer_crosswalk": "HEALTHIE",
488         "group_number": "group_number",
489         "image_url_back": "image_url_back",
490         "image_url_front": "image_url_front",
491         "insurance_type": "01",
492         "member_id": "member_id",
493         "payer_id": "payer_id",
494         "payer_name": "payer_name",
495         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
496         "plan_name": "plan_name",
497         "plan_type": "09",
498         "rx_bin": "rx_bin",
499         "rx_pcn": "rx_pcn"
500       },
501       "last_name": "last_name",
502       "patient_relationship_to_subscriber_code": "01"
503     },
504     "subscriber_secondary": {
505       "address": {
506         "address1": "address1",
507         "address2": "address2",
508         "city": "city",
509         "state": "AA",
510         "zip_code": "zip_code",
511         "zip_plus_four_code": "zip_plus_four_code"
512       },
513       "date_of_birth": "2023-01-15",
514       "first_name": "first_name",
515       "gender": "male",
516       "insurance_card": {
517         "emr_payer_crosswalk": "HEALTHIE",
518         "group_number": "group_number",
519         "image_url_back": "image_url_back",
520         "image_url_front": "image_url_front",
521         "insurance_type": "01",
522         "member_id": "member_id",
523         "payer_id": "payer_id",
524         "payer_name": "payer_name",
525         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
526         "plan_name": "plan_name",
527         "plan_type": "09",
528         "rx_bin": "rx_bin",
529         "rx_pcn": "rx_pcn"
530       },
531       "last_name": "last_name",
532       "patient_relationship_to_subscriber_code": "01"
533     },
534     "subscriber_tertiary": {
535       "address": {
536         "address1": "address1",
537         "address2": "address2",
538         "city": "city",
539         "state": "AA",
540         "zip_code": "zip_code",
541         "zip_plus_four_code": "zip_plus_four_code"
542       },
543       "date_of_birth": "2023-01-15",
544       "first_name": "first_name",
545       "gender": "male",
546       "insurance_card": {
547         "emr_payer_crosswalk": "HEALTHIE",
548         "group_number": "group_number",
549         "image_url_back": "image_url_back",
550         "image_url_front": "image_url_front",
551         "insurance_type": "01",
552         "member_id": "member_id",
553         "payer_id": "payer_id",
554         "payer_name": "payer_name",
555         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
556         "plan_name": "plan_name",
557         "plan_type": "09",
558         "rx_bin": "rx_bin",
559         "rx_pcn": "rx_pcn"
560       },
561       "last_name": "last_name",
562       "patient_relationship_to_subscriber_code": "01"
563     },
564     "supervising_provider": {
565       "address": {
566         "address1": "address1",
567         "address2": "address2",
568         "city": "city",
569         "state": "AA",
570         "zip_code": "zip_code",
571         "zip_plus_four_code": "zip_plus_four_code"
572       },
573       "first_name": "first_name",
574       "last_name": "last_name",
575       "npi": "npi",
576       "organization_name": "organization_name",
577       "taxonomy_code": "taxonomy_code"
578     },
579     "synchronicity": "Synchronous",
580     "tag_ids": [
581       "tag_ids",
582       "tag_ids"
583     ],
584     "vitals": {
585       "height_in": 1,
586       "weight_lbs": 1,
587       "blood_pressure_systolic_mmhg": 1,
588       "blood_pressure_diastolic_mmhg": 1,
589       "body_temperature_f": 1.1,
590       "hemoglobin_gdl": 1.1,
591       "hematocrit_pct": 1.1
592     },
593     "external_claim_submission": {
594       "submission_records": [
595         {
596           "submitted_at": "2024-01-15T09:30:00Z",
597           "claim_frequency_code": "1",
598           "payer_responsibility": "primary",
599           "intended_submission_medium": "paper"
600         },
601         {
602           "submitted_at": "2024-01-15T09:30:00Z",
603           "claim_frequency_code": "1",
604           "payer_responsibility": "primary",
605           "intended_submission_medium": "paper"
606         }
607       ],
608       "claim_created_at": "2024-01-15T09:30:00Z",
609       "patient_control_number": "patient_control_number"
610     },
611     "patient_authorized_release": true
612   },
613   "patient_external_id": "patient_external_id",
614   "charge_external_id": "charge_external_id",
615   "updates": [
616     {
617       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
618       "message": "message",
619       "resolved": true
620     },
621     {
622       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
623       "message": "message",
624       "resolved": true
625     }
626   ],
627   "date_of_service": "2023-01-15",
628   "ehr_source_url": "ehr_source_url",
629   "originating_system": "originating_system",
630   "claim_creation_category": "claim_creation_category",
631   "error": {
632     "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
633     "message": "message",
634     "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
635     "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
636     "resolved": true,
637     "resolved_by": "resolved_by",
638     "resolution_reason": "resolution_reason",
639     "field_in_error": "field_in_error"
640   },
641   "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
642 }

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