Beta

Get Charge Capture

GET

/api/charge_captures/v1/:charge_capture_id

GET

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

Play

200Retrieved

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

Path parameters

charge_capture_idUUIDRequired

Response

This endpoint returns an object.

idUUID

statusenum

charge_capture_dataobject

patient_external_idstring

charge_external_idstring

ehr_source_urlstringOptional

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.

Path parameters

Headers

Response