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       "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     },
402     "service_lines": [
403       {
404         "modifiers": [
405           "AV",
406           "AV"
407         ],
408         "has_epsdt_indicator": true,
409         "has_family_planning_indicator": true,
410         "procedure_code": "procedure_code",
411         "quantity": "quantity",
412         "units": "MJ",
413         "charge_amount_cents": 1,
414         "diagnosis_pointers": [
415           1,
416           1
417         ],
418         "drug_identification": {
419           "service_id_qualifier": "EN",
420           "national_drug_code": "national_drug_code",
421           "national_drug_unit_count": "national_drug_unit_count",
422           "measurement_unit_code": "ML",
423           "link_sequence_number": "link_sequence_number",
424           "pharmacy_prescription_number": "pharmacy_prescription_number",
425           "conversion_formula": "conversion_formula",
426           "drug_description": "drug_description"
427         },
428         "place_of_service_code": "01",
429         "description": "description",
430         "date_of_service": "2023-01-15",
431         "end_date_of_service": "2023-01-15",
432         "ordering_provider": {
433           "address": {
434             "address1": "address1",
435             "address2": "address2",
436             "city": "city",
437             "state": "AA",
438             "zip_code": "zip_code",
439             "zip_plus_four_code": "zip_plus_four_code"
440           },
441           "first_name": "first_name",
442           "last_name": "last_name",
443           "npi": "npi",
444           "organization_name": "organization_name",
445           "taxonomy_code": "taxonomy_code"
446         },
447         "test_results": [
448           {
449             "value": 1.1,
450             "result_type": "HEMATOCRIT"
451           },
452           {
453             "value": 1.1,
454             "result_type": "HEMATOCRIT"
455           }
456         ],
457         "note": "note",
458         "revenue_code": "revenue_code"
459       },
460       {
461         "modifiers": [
462           "AV",
463           "AV"
464         ],
465         "has_epsdt_indicator": true,
466         "has_family_planning_indicator": true,
467         "procedure_code": "procedure_code",
468         "quantity": "quantity",
469         "units": "MJ",
470         "charge_amount_cents": 1,
471         "diagnosis_pointers": [
472           1,
473           1
474         ],
475         "drug_identification": {
476           "service_id_qualifier": "EN",
477           "national_drug_code": "national_drug_code",
478           "national_drug_unit_count": "national_drug_unit_count",
479           "measurement_unit_code": "ML",
480           "link_sequence_number": "link_sequence_number",
481           "pharmacy_prescription_number": "pharmacy_prescription_number",
482           "conversion_formula": "conversion_formula",
483           "drug_description": "drug_description"
484         },
485         "place_of_service_code": "01",
486         "description": "description",
487         "date_of_service": "2023-01-15",
488         "end_date_of_service": "2023-01-15",
489         "ordering_provider": {
490           "address": {
491             "address1": "address1",
492             "address2": "address2",
493             "city": "city",
494             "state": "AA",
495             "zip_code": "zip_code",
496             "zip_plus_four_code": "zip_plus_four_code"
497           },
498           "first_name": "first_name",
499           "last_name": "last_name",
500           "npi": "npi",
501           "organization_name": "organization_name",
502           "taxonomy_code": "taxonomy_code"
503         },
504         "test_results": [
505           {
506             "value": 1.1,
507             "result_type": "HEMATOCRIT"
508           },
509           {
510             "value": 1.1,
511             "result_type": "HEMATOCRIT"
512           }
513         ],
514         "note": "note",
515         "revenue_code": "revenue_code"
516       }
517     ],
518     "subscriber_primary": {
519       "address": {
520         "address1": "address1",
521         "address2": "address2",
522         "city": "city",
523         "state": "AA",
524         "zip_code": "zip_code",
525         "zip_plus_four_code": "zip_plus_four_code"
526       },
527       "date_of_birth": "2023-01-15",
528       "first_name": "first_name",
529       "gender": "male",
530       "insurance_card": {
531         "emr_payer_crosswalk": "HEALTHIE",
532         "group_number": "group_number",
533         "image_url_back": "image_url_back",
534         "image_url_front": "image_url_front",
535         "insurance_type": "01",
536         "member_id": "member_id",
537         "payer_id": "payer_id",
538         "payer_name": "payer_name",
539         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
540         "plan_name": "plan_name",
541         "plan_type": "09",
542         "rx_bin": "rx_bin",
543         "rx_pcn": "rx_pcn"
544       },
545       "last_name": "last_name",
546       "patient_relationship_to_subscriber_code": "01"
547     },
548     "subscriber_secondary": {
549       "address": {
550         "address1": "address1",
551         "address2": "address2",
552         "city": "city",
553         "state": "AA",
554         "zip_code": "zip_code",
555         "zip_plus_four_code": "zip_plus_four_code"
556       },
557       "date_of_birth": "2023-01-15",
558       "first_name": "first_name",
559       "gender": "male",
560       "insurance_card": {
561         "emr_payer_crosswalk": "HEALTHIE",
562         "group_number": "group_number",
563         "image_url_back": "image_url_back",
564         "image_url_front": "image_url_front",
565         "insurance_type": "01",
566         "member_id": "member_id",
567         "payer_id": "payer_id",
568         "payer_name": "payer_name",
569         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
570         "plan_name": "plan_name",
571         "plan_type": "09",
572         "rx_bin": "rx_bin",
573         "rx_pcn": "rx_pcn"
574       },
575       "last_name": "last_name",
576       "patient_relationship_to_subscriber_code": "01"
577     },
578     "subscriber_tertiary": {
579       "address": {
580         "address1": "address1",
581         "address2": "address2",
582         "city": "city",
583         "state": "AA",
584         "zip_code": "zip_code",
585         "zip_plus_four_code": "zip_plus_four_code"
586       },
587       "date_of_birth": "2023-01-15",
588       "first_name": "first_name",
589       "gender": "male",
590       "insurance_card": {
591         "emr_payer_crosswalk": "HEALTHIE",
592         "group_number": "group_number",
593         "image_url_back": "image_url_back",
594         "image_url_front": "image_url_front",
595         "insurance_type": "01",
596         "member_id": "member_id",
597         "payer_id": "payer_id",
598         "payer_name": "payer_name",
599         "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
600         "plan_name": "plan_name",
601         "plan_type": "09",
602         "rx_bin": "rx_bin",
603         "rx_pcn": "rx_pcn"
604       },
605       "last_name": "last_name",
606       "patient_relationship_to_subscriber_code": "01"
607     },
608     "supervising_provider": {
609       "address": {
610         "address1": "address1",
611         "address2": "address2",
612         "city": "city",
613         "state": "AA",
614         "zip_code": "zip_code",
615         "zip_plus_four_code": "zip_plus_four_code"
616       },
617       "first_name": "first_name",
618       "last_name": "last_name",
619       "npi": "npi",
620       "organization_name": "organization_name",
621       "taxonomy_code": "taxonomy_code"
622     },
623     "synchronicity": "Synchronous",
624     "tag_ids": [
625       "tag_ids",
626       "tag_ids"
627     ],
628     "vitals": {
629       "height_in": 1,
630       "weight_lbs": 1,
631       "blood_pressure_systolic_mmhg": 1,
632       "blood_pressure_diastolic_mmhg": 1,
633       "body_temperature_f": 1.1,
634       "hemoglobin_gdl": 1.1,
635       "hematocrit_pct": 1.1
636     },
637     "external_claim_submission": {
638       "submission_records": [
639         {
640           "submitted_at": "2024-01-15T09:30:00Z",
641           "claim_frequency_code": "0",
642           "payer_responsibility": "primary",
643           "intended_submission_medium": "paper"
644         },
645         {
646           "submitted_at": "2024-01-15T09:30:00Z",
647           "claim_frequency_code": "0",
648           "payer_responsibility": "primary",
649           "intended_submission_medium": "paper"
650         }
651       ],
652       "claim_created_at": "2024-01-15T09:30:00Z",
653       "patient_control_number": "patient_control_number"
654     },
655     "patient_authorized_release": true
656   },
657   "patient_external_id": "patient_external_id",
658   "charge_external_id": "charge_external_id",
659   "updates": [
660     {
661       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
662       "message": "message",
663       "resolved": true
664     },
665     {
666       "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
667       "message": "message",
668       "resolved": true
669     }
670   ],
671   "date_of_service": "2023-01-15",
672   "ehr_source_url": "ehr_source_url",
673   "originating_system": "originating_system",
674   "claim_creation_category": "claim_creation_category",
675   "error": {
676     "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
677     "message": "message",
678     "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
679     "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
680     "resolved": true,
681     "resolved_by": "resolved_by",
682     "resolution_reason": "resolution_reason",
683     "field_in_error": "field_in_error"
684   },
685   "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
686 }

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

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