For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
        • POSTCreate a Charge Capture
        • POSTCreate a Charge Capture from pre-encounter patient and appointment
        • PATCHUpdate a ChargeCapturePostBilledChange
        • PATCHUpdate Charge Capture
        • GETGet Charge Capture
        • GETGet all Charge Captures
        • POSTFind Charge Captures by Metadata
Contact Sales
LogoLogo
API ReferenceCharge CaptureV1

Get Charge Capture

Beta
GET
/api/charge_captures/v1/:charge_capture_id
GET
/api/charge_captures/v1/:charge_capture_id
$curl https://api.joincandidhealth.com/api/charge_captures/v1/d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32 \
>     -H "Authorization: Bearer <token>"
200Retrieved
1{
2  "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
3  "status": "planned",
4  "charge_capture_data": {
5    "accident_date": "2023-01-15",
6    "additional_information": "additional_information",
7    "admission_date": "2023-01-15",
8    "appointment_type": "appointment_type",
9    "benefits_assigned_to_provider": true,
10    "billable_status": "BILLABLE",
11    "billing_notes": [
12      {
13        "text": "text"
14      },
15      {
16        "text": "text"
17      }
18    ],
19    "billing_provider": {
20      "address": {
21        "address1": "address1",
22        "address2": "address2",
23        "city": "city",
24        "state": "AA",
25        "zip_code": "zip_code",
26        "zip_plus_four_code": "zip_plus_four_code"
27      },
28      "first_name": "first_name",
29      "last_name": "last_name",
30      "npi": "npi",
31      "organization_name": "organization_name",
32      "provider_commercial_license_type": "0",
33      "secondary_identification": {
34        "reference_identification": "reference_identification",
35        "reference_identification_qualifier": "G2"
36      },
37      "tax_id": "tax_id",
38      "taxonomy_code": "taxonomy_code"
39    },
40    "claim_supplemental_information": [
41      {
42        "attachment_report_type_code": "03",
43        "attachment_transmission_code": "BM",
44        "attachment_control_number": "attachment_control_number"
45      },
46      {
47        "attachment_report_type_code": "03",
48        "attachment_transmission_code": "BM",
49        "attachment_control_number": "attachment_control_number"
50      }
51    ],
52    "clinical_notes": [
53      {
54        "category": "clinical",
55        "notes": [
56          {
57            "text": "text",
58            "author_name": "author_name",
59            "author_npi": "author_npi",
60            "timestamp": "2024-01-15T09:30:00Z"
61          },
62          {
63            "text": "text",
64            "author_name": "author_name",
65            "author_npi": "author_npi",
66            "timestamp": "2024-01-15T09:30:00Z"
67          }
68        ]
69      },
70      {
71        "category": "clinical",
72        "notes": [
73          {
74            "text": "text",
75            "author_name": "author_name",
76            "author_npi": "author_npi",
77            "timestamp": "2024-01-15T09:30:00Z"
78          },
79          {
80            "text": "text",
81            "author_name": "author_name",
82            "author_npi": "author_npi",
83            "timestamp": "2024-01-15T09:30:00Z"
84          }
85        ]
86      }
87    ],
88    "date_of_service": "2023-01-15",
89    "delay_reason_code": "1",
90    "diagnoses": [
91      {
92        "name": "name",
93        "code_type": "ABF",
94        "code": "code",
95        "present_on_admission_indicator": "YES"
96      },
97      {
98        "name": "name",
99        "code_type": "ABF",
100        "code": "code",
101        "present_on_admission_indicator": "YES"
102      }
103    ],
104    "discharge_date": "2023-01-15",
105    "end_date_of_service": "2023-01-15",
106    "epsdt_referral": {
107      "condition_indicator1": "AV",
108      "condition_indicator2": "AV",
109      "condition_indicator3": "AV"
110    },
111    "existing_medications": [
112      {
113        "name": "name",
114        "rx_cui": "rx_cui",
115        "dosage": "dosage",
116        "dosage_form": "dosage_form",
117        "frequency": "frequency",
118        "as_needed": true
119      },
120      {
121        "name": "name",
122        "rx_cui": "rx_cui",
123        "dosage": "dosage",
124        "dosage_form": "dosage_form",
125        "frequency": "frequency",
126        "as_needed": true
127      }
128    ],
129    "external_id": "external_id",
130    "guarantor": {
131      "first_name": "first_name",
132      "last_name": "last_name",
133      "external_id": "external_id",
134      "date_of_birth": "2023-01-15",
135      "address": {
136        "address1": "address1",
137        "address2": "address2",
138        "city": "city",
139        "state": "AA",
140        "zip_code": "zip_code",
141        "zip_plus_four_code": "zip_plus_four_code"
142      },
143      "phone_numbers": [
144        {
145          "number": "number",
146          "type": "Home"
147        },
148        {
149          "number": "number",
150          "type": "Home"
151        }
152      ],
153      "phone_consent": true,
154      "email": "email",
155      "email_consent": true,
156      "auto_charge_consent": true
157    },
158    "initial_referring_provider": {
159      "address": {
160        "address1": "address1",
161        "address2": "address2",
162        "city": "city",
163        "state": "AA",
164        "zip_code": "zip_code",
165        "zip_plus_four_code": "zip_plus_four_code"
166      },
167      "first_name": "first_name",
168      "last_name": "last_name",
169      "npi": "npi",
170      "organization_name": "organization_name",
171      "qualifier": "DQ",
172      "secondary_identification": {
173        "reference_identification": "reference_identification",
174        "reference_identification_qualifier": "0B"
175      },
176      "taxonomy_code": "taxonomy_code"
177    },
178    "interventions": [
179      {
180        "name": "name",
181        "category": "allopathic",
182        "description": "description",
183        "medication": {
184          "name": "name",
185          "rx_cui": "rx_cui",
186          "dosage": "dosage",
187          "dosage_form": "dosage_form",
188          "frequency": "frequency",
189          "as_needed": true
190        },
191        "labs": [
192          {
193            "name": "name",
194            "code": "code",
195            "code_type": "quest"
196          },
197          {
198            "name": "name",
199            "code": "code",
200            "code_type": "quest"
201          }
202        ]
203      },
204      {
205        "name": "name",
206        "category": "allopathic",
207        "description": "description",
208        "medication": {
209          "name": "name",
210          "rx_cui": "rx_cui",
211          "dosage": "dosage",
212          "dosage_form": "dosage_form",
213          "frequency": "frequency",
214          "as_needed": true
215        },
216        "labs": [
217          {
218            "name": "name",
219            "code": "code",
220            "code_type": "quest"
221          },
222          {
223            "name": "name",
224            "code": "code",
225            "code_type": "quest"
226          }
227        ]
228      }
229    ],
230    "last_menstrual_period_date": "2023-01-15",
231    "onset_of_current_illness_or_symptom_date": "2023-01-15",
232    "patient": {
233      "first_name": "first_name",
234      "last_name": "last_name",
235      "gender": "male",
236      "external_id": "external_id",
237      "date_of_birth": "2023-01-15",
238      "address": {
239        "address1": "address1",
240        "address2": "address2",
241        "city": "city",
242        "state": "AA",
243        "zip_code": "zip_code",
244        "zip_plus_four_code": "zip_plus_four_code"
245      },
246      "phone_numbers": [
247        {
248          "number": "number",
249          "type": "Home"
250        },
251        {
252          "number": "number",
253          "type": "Home"
254        }
255      ],
256      "phone_consent": true,
257      "email": "email",
258      "email_consent": true,
259      "auto_charge_consent": true,
260      "non_insurance_payers_info": [
261        {
262          "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
263          "member_id": "member_id",
264          "clinical_trial_info": [
265            {},
266            {}
267          ]
268        },
269        {
270          "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
271          "member_id": "member_id",
272          "clinical_trial_info": [
273            {},
274            {}
275          ]
276        }
277      ],
278      "non_insurance_payers": [
279        "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
280        "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
281      ]
282    },
283    "patient_histories": [
284      {
285        "category": "present_illness",
286        "questions": [
287          {
288            "id": "id",
289            "text": "text",
290            "responses": [
291              {},
292              {}
293            ]
294          },
295          {
296            "id": "id",
297            "text": "text",
298            "responses": [
299              {},
300              {}
301            ]
302          }
303        ]
304      },
305      {
306        "category": "present_illness",
307        "questions": [
308          {
309            "id": "id",
310            "text": "text",
311            "responses": [
312              {},
313              {}
314            ]
315          },
316          {
317            "id": "id",
318            "text": "text",
319            "responses": [
320              {},
321              {}
322            ]
323          }
324        ]
325      }
326    ],
327    "pay_to_address": {
328      "address1": "address1",
329      "address2": "address2",
330      "city": "city",
331      "state": "AA",
332      "zip_code": "zip_code",
333      "zip_plus_four_code": "zip_plus_four_code"
334    },
335    "place_of_service_code": "01",
336    "prior_authorization_number": "prior_authorization_number",
337    "property_casualty_claim_number": "property_casualty_claim_number",
338    "property_casualty_patient_identifier": {
339      "property_casualty_patient_identifier_qualifier": "1W",
340      "property_casualty_patient_identifier": "property_casualty_patient_identifier"
341    },
342    "provider_accepts_assignment": true,
343    "referral_number": "referral_number",
344    "referring_provider": {
345      "address": {
346        "address1": "address1",
347        "address2": "address2",
348        "city": "city",
349        "state": "AA",
350        "zip_code": "zip_code",
351        "zip_plus_four_code": "zip_plus_four_code"
352      },
353      "first_name": "first_name",
354      "last_name": "last_name",
355      "npi": "npi",
356      "organization_name": "organization_name",
357      "secondary_identification": {
358        "reference_identification": "reference_identification",
359        "reference_identification_qualifier": "0B"
360      },
361      "taxonomy_code": "taxonomy_code"
362    },
363    "related_causes_information": {
364      "related_causes_code_1": "AA",
365      "related_causes_code_2": "AA",
366      "state_or_province_code": "state_or_province_code"
367    },
368    "rendering_provider": {
369      "address": {
370        "address1": "address1",
371        "address2": "address2",
372        "city": "city",
373        "state": "AA",
374        "zip_code": "zip_code",
375        "zip_plus_four_code": "zip_plus_four_code"
376      },
377      "first_name": "first_name",
378      "last_name": "last_name",
379      "npi": "npi",
380      "organization_name": "organization_name",
381      "secondary_identification": {
382        "reference_identification": "reference_identification",
383        "reference_identification_qualifier": "0B"
384      },
385      "taxonomy_code": "taxonomy_code"
386    },
387    "responsible_party": "INSURANCE_PAY",
388    "schema_instances": [
389      {
390        "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
391        "content": {
392          "content": {
393            "key": "value"
394          }
395        }
396      },
397      {
398        "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
399        "content": {
400          "content": {
401            "key": "value"
402          }
403        }
404      }
405    ],
406    "secondary_payer_carrier_code": "secondary_payer_carrier_code",
407    "service_authorization_exception_code": "1",
408    "service_facility": {
409      "organization_name": "organization_name",
410      "npi": "npi",
411      "address": {
412        "address1": "address1",
413        "address2": "address2",
414        "city": "city",
415        "state": "AA",
416        "zip_code": "zip_code",
417        "zip_plus_four_code": "zip_plus_four_code"
418      },
419      "secondary_identification": "secondary_identification",
420      "mammography_certification_number": "mammography_certification_number"
421    },
422    "service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
423    "service_lines": [
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            "address1": "address1",
456            "address2": "address2",
457            "city": "city",
458            "state": "AA",
459            "zip_code": "zip_code",
460            "zip_plus_four_code": "zip_plus_four_code"
461          },
462          "first_name": "first_name",
463          "last_name": "last_name",
464          "npi": "npi",
465          "organization_name": "organization_name",
466          "taxonomy_code": "taxonomy_code"
467        },
468        "test_results": [
469          {
470            "value": 1.1,
471            "result_type": "HEMATOCRIT"
472          },
473          {
474            "value": 1.1,
475            "result_type": "HEMATOCRIT"
476          }
477        ],
478        "note": "note",
479        "revenue_code": "revenue_code",
480        "prior_authorization_number": "prior_authorization_number",
481        "external_id": "external_id"
482      },
483      {
484        "modifiers": [
485          "AV",
486          "AV"
487        ],
488        "has_epsdt_indicator": true,
489        "has_family_planning_indicator": true,
490        "procedure_code": "procedure_code",
491        "quantity": "quantity",
492        "units": "MJ",
493        "charge_amount_cents": 1,
494        "diagnosis_pointers": [
495          1,
496          1
497        ],
498        "drug_identification": {
499          "service_id_qualifier": "EN",
500          "national_drug_code": "national_drug_code",
501          "national_drug_unit_count": "national_drug_unit_count",
502          "measurement_unit_code": "ML",
503          "link_sequence_number": "link_sequence_number",
504          "pharmacy_prescription_number": "pharmacy_prescription_number",
505          "conversion_formula": "conversion_formula",
506          "drug_description": "drug_description"
507        },
508        "place_of_service_code": "01",
509        "description": "description",
510        "date_of_service": "2023-01-15",
511        "end_date_of_service": "2023-01-15",
512        "ordering_provider": {
513          "address": {
514            "address1": "address1",
515            "address2": "address2",
516            "city": "city",
517            "state": "AA",
518            "zip_code": "zip_code",
519            "zip_plus_four_code": "zip_plus_four_code"
520          },
521          "first_name": "first_name",
522          "last_name": "last_name",
523          "npi": "npi",
524          "organization_name": "organization_name",
525          "taxonomy_code": "taxonomy_code"
526        },
527        "test_results": [
528          {
529            "value": 1.1,
530            "result_type": "HEMATOCRIT"
531          },
532          {
533            "value": 1.1,
534            "result_type": "HEMATOCRIT"
535          }
536        ],
537        "note": "note",
538        "revenue_code": "revenue_code",
539        "prior_authorization_number": "prior_authorization_number",
540        "external_id": "external_id"
541      }
542    ],
543    "subscriber_primary": {
544      "address": {
545        "address1": "address1",
546        "address2": "address2",
547        "city": "city",
548        "state": "AA",
549        "zip_code": "zip_code",
550        "zip_plus_four_code": "zip_plus_four_code"
551      },
552      "date_of_birth": "2023-01-15",
553      "first_name": "first_name",
554      "gender": "male",
555      "insurance_card": {
556        "group_number": "group_number",
557        "plan_name": "plan_name",
558        "plan_type": "09",
559        "insurance_type": "01",
560        "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
561        "payer_address": {
562          "address1": "address1",
563          "address2": "address2",
564          "city": "city",
565          "state": "AA",
566          "zip_code": "zip_code",
567          "zip_plus_four_code": "zip_plus_four_code"
568        },
569        "member_id": "member_id",
570        "payer_name": "payer_name",
571        "payer_id": "payer_id",
572        "rx_bin": "rx_bin",
573        "rx_pcn": "rx_pcn",
574        "image_url_front": "image_url_front",
575        "image_url_back": "image_url_back",
576        "emr_payer_crosswalk": "HEALTHIE",
577        "payer_plan_group_name": "payer_plan_group_name"
578      },
579      "last_name": "last_name",
580      "patient_relationship_to_subscriber_code": "01"
581    },
582    "subscriber_secondary": {
583      "address": {
584        "address1": "address1",
585        "address2": "address2",
586        "city": "city",
587        "state": "AA",
588        "zip_code": "zip_code",
589        "zip_plus_four_code": "zip_plus_four_code"
590      },
591      "date_of_birth": "2023-01-15",
592      "first_name": "first_name",
593      "gender": "male",
594      "insurance_card": {
595        "group_number": "group_number",
596        "plan_name": "plan_name",
597        "plan_type": "09",
598        "insurance_type": "01",
599        "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
600        "payer_address": {
601          "address1": "address1",
602          "address2": "address2",
603          "city": "city",
604          "state": "AA",
605          "zip_code": "zip_code",
606          "zip_plus_four_code": "zip_plus_four_code"
607        },
608        "member_id": "member_id",
609        "payer_name": "payer_name",
610        "payer_id": "payer_id",
611        "rx_bin": "rx_bin",
612        "rx_pcn": "rx_pcn",
613        "image_url_front": "image_url_front",
614        "image_url_back": "image_url_back",
615        "emr_payer_crosswalk": "HEALTHIE",
616        "payer_plan_group_name": "payer_plan_group_name"
617      },
618      "last_name": "last_name",
619      "patient_relationship_to_subscriber_code": "01"
620    },
621    "subscriber_tertiary": {
622      "address": {
623        "address1": "address1",
624        "address2": "address2",
625        "city": "city",
626        "state": "AA",
627        "zip_code": "zip_code",
628        "zip_plus_four_code": "zip_plus_four_code"
629      },
630      "date_of_birth": "2023-01-15",
631      "first_name": "first_name",
632      "gender": "male",
633      "insurance_card": {
634        "group_number": "group_number",
635        "plan_name": "plan_name",
636        "plan_type": "09",
637        "insurance_type": "01",
638        "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
639        "payer_address": {
640          "address1": "address1",
641          "address2": "address2",
642          "city": "city",
643          "state": "AA",
644          "zip_code": "zip_code",
645          "zip_plus_four_code": "zip_plus_four_code"
646        },
647        "member_id": "member_id",
648        "payer_name": "payer_name",
649        "payer_id": "payer_id",
650        "rx_bin": "rx_bin",
651        "rx_pcn": "rx_pcn",
652        "image_url_front": "image_url_front",
653        "image_url_back": "image_url_back",
654        "emr_payer_crosswalk": "HEALTHIE",
655        "payer_plan_group_name": "payer_plan_group_name"
656      },
657      "last_name": "last_name",
658      "patient_relationship_to_subscriber_code": "01"
659    },
660    "supervising_provider": {
661      "address": {
662        "address1": "address1",
663        "address2": "address2",
664        "city": "city",
665        "state": "AA",
666        "zip_code": "zip_code",
667        "zip_plus_four_code": "zip_plus_four_code"
668      },
669      "first_name": "first_name",
670      "last_name": "last_name",
671      "npi": "npi",
672      "organization_name": "organization_name",
673      "secondary_identification": {
674        "reference_identification": "reference_identification",
675        "reference_identification_qualifier": "0B"
676      },
677      "taxonomy_code": "taxonomy_code"
678    },
679    "synchronicity": "Synchronous",
680    "tag_ids": [
681      "tag_ids",
682      "tag_ids"
683    ],
684    "vitals": {
685      "height_in": 1,
686      "weight_lbs": 1,
687      "blood_pressure_systolic_mmhg": 1,
688      "blood_pressure_diastolic_mmhg": 1,
689      "body_temperature_f": 1.1,
690      "hemoglobin_gdl": 1.1,
691      "hematocrit_pct": 1.1
692    },
693    "external_claim_submission": {
694      "claim_created_at": "2024-01-15T09:30:00Z",
695      "patient_control_number": "patient_control_number",
696      "submission_records": [
697        {
698          "submitted_at": "2024-01-15T09:30:00Z",
699          "claim_frequency_code": "0",
700          "payer_responsibility": "primary",
701          "intended_submission_medium": "paper"
702        },
703        {
704          "submitted_at": "2024-01-15T09:30:00Z",
705          "claim_frequency_code": "0",
706          "payer_responsibility": "primary",
707          "intended_submission_medium": "paper"
708        }
709      ]
710    },
711    "patient_authorized_release": true,
712    "treating_provider": {
713      "first_name": "first_name",
714      "last_name": "last_name",
715      "npi": "npi",
716      "taxonomy_code": "taxonomy_code",
717      "address": {
718        "address1": "address1",
719        "address2": "address2",
720        "city": "city",
721        "state": "AA",
722        "zip_code": "zip_code",
723        "zip_plus_four_code": "zip_plus_four_code"
724      },
725      "license_type": "MD"
726    }
727  },
728  "patient_external_id": "patient_external_id",
729  "charge_external_id": "charge_external_id",
730  "updates": [
731    {
732      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
733      "message": "message",
734      "resolved": true
735    },
736    {
737      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
738      "message": "message",
739      "resolved": true
740    }
741  ],
742  "date_of_service": "2023-01-15",
743  "ehr_source_url": "ehr_source_url",
744  "originating_system": "originating_system",
745  "claim_creation_category": "claim_creation_category",
746  "metadata": [
747    {
748      "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
749      "content": {
750        "content": {
751          "key": "value"
752        }
753      }
754    },
755    {
756      "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
757      "content": {
758        "content": {
759          "key": "value"
760        }
761      }
762    }
763  ],
764  "error": {
765    "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
766    "message": "message",
767    "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
768    "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
769    "resolved": true,
770    "resolved_by": "resolved_by",
771    "resolution_reason": "resolution_reason",
772    "field_in_error": "field_in_error"
773  },
774  "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
775}
Was this page helpful?
Previous

Get all Charge Captures

Next
Built with

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
ehr_source_urlstring
originating_systemstring
claim_creation_categorystring
metadatalist of objects

Key-value pairs that adhere to metadata schemas. Multiple metadata instances can be associated with a charge capture.

errorobject
claim_creation_idUUID