Beta

Get all Charge Captures

GET

/api/charge_captures/v1

GET

1 curl -G https://api.joincandidhealth.com/api/charge_captures/v1 \
2      -H "Authorization: Bearer <token>" \
3      -d limit=0 \
4      -d page_token=string

Play

200Retrieved

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

Query parameters

limitintegerOptional

Maximum number of entities per page, defaults to 100.

page_tokenstringOptional

patient_external_idstringOptional

The patient ID from the external EMR platform for the patient

statusenumOptional

the status of the charge captures

charge_external_idstringOptional

A client-specified unique ID to associate with this encounter; for example, your internal encounter ID or a Dr. Chrono encounter ID. This field should not contain PHI.

date_of_servicedateOptional

Date formatted as YYYY-MM-DD; eg: 2019-08-24. This date must be the local date in the timezone where the service occurred.

Response

This endpoint returns an object.

itemslist of objects

next_page_tokenstringOptional

prev_page_tokenstringOptional

Headers

Query parameters

Response