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_lines": [
423      {
424        "modifiers": [
425          "AV",
426          "AV"
427        ],
428        "has_epsdt_indicator": true,
429        "has_family_planning_indicator": true,
430        "procedure_code": "procedure_code",
431        "quantity": "quantity",
432        "units": "MJ",
433        "charge_amount_cents": 1,
434        "diagnosis_pointers": [
435          1,
436          1
437        ],
438        "drug_identification": {
439          "service_id_qualifier": "EN",
440          "national_drug_code": "national_drug_code",
441          "national_drug_unit_count": "national_drug_unit_count",
442          "measurement_unit_code": "ML",
443          "link_sequence_number": "link_sequence_number",
444          "pharmacy_prescription_number": "pharmacy_prescription_number",
445          "conversion_formula": "conversion_formula",
446          "drug_description": "drug_description"
447        },
448        "place_of_service_code": "01",
449        "description": "description",
450        "date_of_service": "2023-01-15",
451        "end_date_of_service": "2023-01-15",
452        "ordering_provider": {
453          "address": {
454            "address1": "address1",
455            "address2": "address2",
456            "city": "city",
457            "state": "AA",
458            "zip_code": "zip_code",
459            "zip_plus_four_code": "zip_plus_four_code"
460          },
461          "first_name": "first_name",
462          "last_name": "last_name",
463          "npi": "npi",
464          "organization_name": "organization_name",
465          "taxonomy_code": "taxonomy_code"
466        },
467        "test_results": [
468          {
469            "value": 1.1,
470            "result_type": "HEMATOCRIT"
471          },
472          {
473            "value": 1.1,
474            "result_type": "HEMATOCRIT"
475          }
476        ],
477        "note": "note",
478        "revenue_code": "revenue_code",
479        "prior_authorization_number": "prior_authorization_number",
480        "external_id": "external_id"
481      },
482      {
483        "modifiers": [
484          "AV",
485          "AV"
486        ],
487        "has_epsdt_indicator": true,
488        "has_family_planning_indicator": true,
489        "procedure_code": "procedure_code",
490        "quantity": "quantity",
491        "units": "MJ",
492        "charge_amount_cents": 1,
493        "diagnosis_pointers": [
494          1,
495          1
496        ],
497        "drug_identification": {
498          "service_id_qualifier": "EN",
499          "national_drug_code": "national_drug_code",
500          "national_drug_unit_count": "national_drug_unit_count",
501          "measurement_unit_code": "ML",
502          "link_sequence_number": "link_sequence_number",
503          "pharmacy_prescription_number": "pharmacy_prescription_number",
504          "conversion_formula": "conversion_formula",
505          "drug_description": "drug_description"
506        },
507        "place_of_service_code": "01",
508        "description": "description",
509        "date_of_service": "2023-01-15",
510        "end_date_of_service": "2023-01-15",
511        "ordering_provider": {
512          "address": {
513            "address1": "address1",
514            "address2": "address2",
515            "city": "city",
516            "state": "AA",
517            "zip_code": "zip_code",
518            "zip_plus_four_code": "zip_plus_four_code"
519          },
520          "first_name": "first_name",
521          "last_name": "last_name",
522          "npi": "npi",
523          "organization_name": "organization_name",
524          "taxonomy_code": "taxonomy_code"
525        },
526        "test_results": [
527          {
528            "value": 1.1,
529            "result_type": "HEMATOCRIT"
530          },
531          {
532            "value": 1.1,
533            "result_type": "HEMATOCRIT"
534          }
535        ],
536        "note": "note",
537        "revenue_code": "revenue_code",
538        "prior_authorization_number": "prior_authorization_number",
539        "external_id": "external_id"
540      }
541    ],
542    "subscriber_primary": {
543      "address": {
544        "address1": "address1",
545        "address2": "address2",
546        "city": "city",
547        "state": "AA",
548        "zip_code": "zip_code",
549        "zip_plus_four_code": "zip_plus_four_code"
550      },
551      "date_of_birth": "2023-01-15",
552      "first_name": "first_name",
553      "gender": "male",
554      "insurance_card": {
555        "group_number": "group_number",
556        "plan_name": "plan_name",
557        "plan_type": "09",
558        "insurance_type": "01",
559        "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
560        "payer_address": {
561          "address1": "address1",
562          "address2": "address2",
563          "city": "city",
564          "state": "AA",
565          "zip_code": "zip_code",
566          "zip_plus_four_code": "zip_plus_four_code"
567        },
568        "member_id": "member_id",
569        "payer_name": "payer_name",
570        "payer_id": "payer_id",
571        "rx_bin": "rx_bin",
572        "rx_pcn": "rx_pcn",
573        "image_url_front": "image_url_front",
574        "image_url_back": "image_url_back",
575        "emr_payer_crosswalk": "HEALTHIE",
576        "payer_plan_group_name": "payer_plan_group_name"
577      },
578      "last_name": "last_name",
579      "patient_relationship_to_subscriber_code": "01"
580    },
581    "subscriber_secondary": {
582      "address": {
583        "address1": "address1",
584        "address2": "address2",
585        "city": "city",
586        "state": "AA",
587        "zip_code": "zip_code",
588        "zip_plus_four_code": "zip_plus_four_code"
589      },
590      "date_of_birth": "2023-01-15",
591      "first_name": "first_name",
592      "gender": "male",
593      "insurance_card": {
594        "group_number": "group_number",
595        "plan_name": "plan_name",
596        "plan_type": "09",
597        "insurance_type": "01",
598        "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
599        "payer_address": {
600          "address1": "address1",
601          "address2": "address2",
602          "city": "city",
603          "state": "AA",
604          "zip_code": "zip_code",
605          "zip_plus_four_code": "zip_plus_four_code"
606        },
607        "member_id": "member_id",
608        "payer_name": "payer_name",
609        "payer_id": "payer_id",
610        "rx_bin": "rx_bin",
611        "rx_pcn": "rx_pcn",
612        "image_url_front": "image_url_front",
613        "image_url_back": "image_url_back",
614        "emr_payer_crosswalk": "HEALTHIE",
615        "payer_plan_group_name": "payer_plan_group_name"
616      },
617      "last_name": "last_name",
618      "patient_relationship_to_subscriber_code": "01"
619    },
620    "subscriber_tertiary": {
621      "address": {
622        "address1": "address1",
623        "address2": "address2",
624        "city": "city",
625        "state": "AA",
626        "zip_code": "zip_code",
627        "zip_plus_four_code": "zip_plus_four_code"
628      },
629      "date_of_birth": "2023-01-15",
630      "first_name": "first_name",
631      "gender": "male",
632      "insurance_card": {
633        "group_number": "group_number",
634        "plan_name": "plan_name",
635        "plan_type": "09",
636        "insurance_type": "01",
637        "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
638        "payer_address": {
639          "address1": "address1",
640          "address2": "address2",
641          "city": "city",
642          "state": "AA",
643          "zip_code": "zip_code",
644          "zip_plus_four_code": "zip_plus_four_code"
645        },
646        "member_id": "member_id",
647        "payer_name": "payer_name",
648        "payer_id": "payer_id",
649        "rx_bin": "rx_bin",
650        "rx_pcn": "rx_pcn",
651        "image_url_front": "image_url_front",
652        "image_url_back": "image_url_back",
653        "emr_payer_crosswalk": "HEALTHIE",
654        "payer_plan_group_name": "payer_plan_group_name"
655      },
656      "last_name": "last_name",
657      "patient_relationship_to_subscriber_code": "01"
658    },
659    "supervising_provider": {
660      "address": {
661        "address1": "address1",
662        "address2": "address2",
663        "city": "city",
664        "state": "AA",
665        "zip_code": "zip_code",
666        "zip_plus_four_code": "zip_plus_four_code"
667      },
668      "first_name": "first_name",
669      "last_name": "last_name",
670      "npi": "npi",
671      "organization_name": "organization_name",
672      "secondary_identification": {
673        "reference_identification": "reference_identification",
674        "reference_identification_qualifier": "0B"
675      },
676      "taxonomy_code": "taxonomy_code"
677    },
678    "synchronicity": "Synchronous",
679    "tag_ids": [
680      "tag_ids",
681      "tag_ids"
682    ],
683    "vitals": {
684      "height_in": 1,
685      "weight_lbs": 1,
686      "blood_pressure_systolic_mmhg": 1,
687      "blood_pressure_diastolic_mmhg": 1,
688      "body_temperature_f": 1.1,
689      "hemoglobin_gdl": 1.1,
690      "hematocrit_pct": 1.1
691    },
692    "external_claim_submission": {
693      "claim_created_at": "2024-01-15T09:30:00Z",
694      "patient_control_number": "patient_control_number",
695      "submission_records": [
696        {
697          "submitted_at": "2024-01-15T09:30:00Z",
698          "claim_frequency_code": "0",
699          "payer_responsibility": "primary",
700          "intended_submission_medium": "paper"
701        },
702        {
703          "submitted_at": "2024-01-15T09:30:00Z",
704          "claim_frequency_code": "0",
705          "payer_responsibility": "primary",
706          "intended_submission_medium": "paper"
707        }
708      ]
709    },
710    "patient_authorized_release": true,
711    "treating_provider": {
712      "first_name": "first_name",
713      "last_name": "last_name",
714      "npi": "npi",
715      "taxonomy_code": "taxonomy_code",
716      "address": {
717        "address1": "address1",
718        "address2": "address2",
719        "city": "city",
720        "state": "AA",
721        "zip_code": "zip_code",
722        "zip_plus_four_code": "zip_plus_four_code"
723      },
724      "license_type": "MD"
725    }
726  },
727  "patient_external_id": "patient_external_id",
728  "charge_external_id": "charge_external_id",
729  "updates": [
730    {
731      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
732      "message": "message",
733      "resolved": true
734    },
735    {
736      "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
737      "message": "message",
738      "resolved": true
739    }
740  ],
741  "date_of_service": "2023-01-15",
742  "ehr_source_url": "ehr_source_url",
743  "originating_system": "originating_system",
744  "claim_creation_category": "claim_creation_category",
745  "metadata": [
746    {
747      "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
748      "content": {
749        "content": {
750          "key": "value"
751        }
752      }
753    },
754    {
755      "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
756      "content": {
757        "content": {
758          "key": "value"
759        }
760      }
761    }
762  ],
763  "error": {
764    "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
765    "message": "message",
766    "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
767    "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
768    "resolved": true,
769    "resolved_by": "resolved_by",
770    "resolution_reason": "resolution_reason",
771    "field_in_error": "field_in_error"
772  },
773  "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
774}
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