Get Charge Capture

Beta

GET

/api/charge_captures/v1/:charge_capture_id

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.

GET

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

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         }
168       ],
169       "non_insurance_payers": [
170         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
171       ]
172     },
173     "patient_authorized_release": true,
174     "patient_histories": [
175       {
176         "category": "present_illness",
177         "questions": [
178           {
179             "id": "string",
180             "text": "string",
181             "responses": [
182               {
183                 "response": "string",
184                 "follow_ups": [
185                   {
186                     "id": "string",
187                     "text": "string",
188                     "response": "string"
189                   }
190                 ]
191               }
192             ]
193           }
194         ]
195       }
196     ],
197     "pay_to_address": {
198       "address1": "string",
199       "city": "string",
200       "state": "AA",
201       "zip_code": "string",
202       "zip_plus_four_code": "string",
203       "address2": "string"
204     },
205     "place_of_service_code": "01",
206     "prior_authorization_number": "string",
207     "provider_accepts_assignment": true,
208     "referral_number": "string",
209     "referring_provider": {
210       "address": {
211         "address1": "string",
212         "city": "string",
213         "state": "AA",
214         "zip_code": "string",
215         "zip_plus_four_code": "string",
216         "address2": "string"
217       },
218       "first_name": "string",
219       "last_name": "string",
220       "npi": "string",
221       "organization_name": "string",
222       "taxonomy_code": "string"
223     },
224     "rendering_provider": {
225       "address": {
226         "address1": "string",
227         "city": "string",
228         "state": "AA",
229         "zip_code": "string",
230         "zip_plus_four_code": "string",
231         "address2": "string"
232       },
233       "first_name": "string",
234       "last_name": "string",
235       "npi": "string",
236       "organization_name": "string",
237       "taxonomy_code": "string"
238     },
239     "responsible_party": "INSURANCE_PAY",
240     "service_authorization_exception_code": "1",
241     "service_facility": {
242       "organization_name": "string",
243       "npi": "string",
244       "address": {
245         "address1": "string",
246         "city": "string",
247         "state": "AA",
248         "zip_code": "string",
249         "zip_plus_four_code": "string",
250         "address2": "string"
251       },
252       "secondary_identification": "string"
253     },
254     "service_lines": [
255       {
256         "procedure_code": "string",
257         "quantity": "string",
258         "units": "MJ",
259         "diagnosis_pointers": [
260           0
261         ],
262         "modifiers": [
263           "22"
264         ],
265         "has_epsdt_indicator": true,
266         "has_family_planning_indicator": true,
267         "charge_amount_cents": 0,
268         "drug_identification": {
269           "service_id_qualifier": "EN",
270           "national_drug_code": "string",
271           "national_drug_unit_count": "string",
272           "measurement_unit_code": "ML",
273           "link_sequence_number": "string",
274           "pharmacy_prescription_number": "string",
275           "conversion_formula": "string",
276           "drug_description": "string"
277         },
278         "place_of_service_code": "01",
279         "description": "string",
280         "date_of_service": "2023-01-01",
281         "end_date_of_service": "2023-01-01",
282         "ordering_provider": {
283           "npi": "string",
284           "address": {
285             "address1": "string",
286             "city": "string",
287             "state": "AA",
288             "zip_code": "string",
289             "zip_plus_four_code": "string",
290             "address2": "string"
291           },
292           "first_name": "string",
293           "last_name": "string",
294           "organization_name": "string",
295           "taxonomy_code": "string"
296         },
297         "test_results": [
298           {
299             "value": 1,
300             "result_type": "HEMATOCRIT"
301           }
302         ]
303       }
304     ],
305     "subscriber_primary": {
306       "first_name": "string",
307       "gender": "male",
308       "insurance_card": {
309         "member_id": "string",
310         "payer_id": "string",
311         "payer_name": "string",
312         "emr_payer_crosswalk": "HEALTHIE",
313         "group_number": "string",
314         "image_url_back": "string",
315         "image_url_front": "string",
316         "insurance_type": "01",
317         "plan_name": "string",
318         "plan_type": "09",
319         "rx_bin": "string",
320         "rx_pcn": "string"
321       },
322       "last_name": "string",
323       "patient_relationship_to_subscriber_code": "01",
324       "address": {
325         "address1": "string",
326         "city": "string",
327         "state": "AA",
328         "zip_code": "string",
329         "address2": "string",
330         "zip_plus_four_code": "string"
331       },
332       "date_of_birth": "2023-01-01"
333     },
334     "subscriber_secondary": {
335       "first_name": "string",
336       "gender": "male",
337       "insurance_card": {
338         "member_id": "string",
339         "payer_id": "string",
340         "payer_name": "string",
341         "emr_payer_crosswalk": "HEALTHIE",
342         "group_number": "string",
343         "image_url_back": "string",
344         "image_url_front": "string",
345         "insurance_type": "01",
346         "plan_name": "string",
347         "plan_type": "09",
348         "rx_bin": "string",
349         "rx_pcn": "string"
350       },
351       "last_name": "string",
352       "patient_relationship_to_subscriber_code": "01",
353       "address": {
354         "address1": "string",
355         "city": "string",
356         "state": "AA",
357         "zip_code": "string",
358         "address2": "string",
359         "zip_plus_four_code": "string"
360       },
361       "date_of_birth": "2023-01-01"
362     },
363     "supervising_provider": {
364       "address": {
365         "address1": "string",
366         "city": "string",
367         "state": "AA",
368         "zip_code": "string",
369         "zip_plus_four_code": "string",
370         "address2": "string"
371       },
372       "first_name": "string",
373       "last_name": "string",
374       "npi": "string",
375       "organization_name": "string",
376       "taxonomy_code": "string"
377     },
378     "synchronicity": "Synchronous",
379     "tag_ids": [
380       "string"
381     ],
382     "vitals": {
383       "height_in": 0,
384       "weight_lbs": 0,
385       "blood_pressure_systolic_mmhg": 0,
386       "blood_pressure_diastolic_mmhg": 0,
387       "body_temperature_f": 1,
388       "hemoglobin_gdl": 1,
389       "hematocrit_pct": 1
390     },
391     "external_claim_submission": {
392       "claim_created_at": "2023-01-01T00:00:00Z",
393       "patient_control_number": "string",
394       "submission_records": [
395         {
396           "submitted_at": "2023-01-01T00:00:00Z",
397           "claim_frequency_code": "1",
398           "payer_responsibility": "primary",
399           "intended_submission_medium": "paper"
400         }
401       ]
402     },
403     "schema_instances": [
404       {
405         "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
406         "content": {
407           "string": {}
408         }
409       }
410     ]
411   },
412   "patient_external_id": "string",
413   "charge_external_id": "string",
414   "ehr_source_url": "string",
415   "date_of_service": "2023-01-01"
416 }

Built with

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

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	}
168	],
169	"non_insurance_payers": [
170	"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
171	]
172	},
173	"patient_authorized_release": true,
174	"patient_histories": [
175	{
176	"category": "present_illness",
177	"questions": [
178	{
179	"id": "string",
180	"text": "string",
181	"responses": [
182	{
183	"response": "string",
184	"follow_ups": [
185	{
186	"id": "string",
187	"text": "string",
188	"response": "string"
189	}
190	]
191	}
192	]
193	}
194	]
195	}
196	],
197	"pay_to_address": {
198	"address1": "string",
199	"city": "string",
200	"state": "AA",
201	"zip_code": "string",
202	"zip_plus_four_code": "string",
203	"address2": "string"
204	},
205	"place_of_service_code": "01",
206	"prior_authorization_number": "string",
207	"provider_accepts_assignment": true,
208	"referral_number": "string",
209	"referring_provider": {
210	"address": {
211	"address1": "string",
212	"city": "string",
213	"state": "AA",
214	"zip_code": "string",
215	"zip_plus_four_code": "string",
216	"address2": "string"
217	},
218	"first_name": "string",
219	"last_name": "string",
220	"npi": "string",
221	"organization_name": "string",
222	"taxonomy_code": "string"
223	},
224	"rendering_provider": {
225	"address": {
226	"address1": "string",
227	"city": "string",
228	"state": "AA",
229	"zip_code": "string",
230	"zip_plus_four_code": "string",
231	"address2": "string"
232	},
233	"first_name": "string",
234	"last_name": "string",
235	"npi": "string",
236	"organization_name": "string",
237	"taxonomy_code": "string"
238	},
239	"responsible_party": "INSURANCE_PAY",
240	"service_authorization_exception_code": "1",
241	"service_facility": {
242	"organization_name": "string",
243	"npi": "string",
244	"address": {
245	"address1": "string",
246	"city": "string",
247	"state": "AA",
248	"zip_code": "string",
249	"zip_plus_four_code": "string",
250	"address2": "string"
251	},
252	"secondary_identification": "string"
253	},
254	"service_lines": [
255	{
256	"procedure_code": "string",
257	"quantity": "string",
258	"units": "MJ",
259	"diagnosis_pointers": [
260	0
261	],
262	"modifiers": [
263	"22"
264	],
265	"has_epsdt_indicator": true,
266	"has_family_planning_indicator": true,
267	"charge_amount_cents": 0,
268	"drug_identification": {
269	"service_id_qualifier": "EN",
270	"national_drug_code": "string",
271	"national_drug_unit_count": "string",
272	"measurement_unit_code": "ML",
273	"link_sequence_number": "string",
274	"pharmacy_prescription_number": "string",
275	"conversion_formula": "string",
276	"drug_description": "string"
277	},
278	"place_of_service_code": "01",
279	"description": "string",
280	"date_of_service": "2023-01-01",
281	"end_date_of_service": "2023-01-01",
282	"ordering_provider": {
283	"npi": "string",
284	"address": {
285	"address1": "string",
286	"city": "string",
287	"state": "AA",
288	"zip_code": "string",
289	"zip_plus_four_code": "string",
290	"address2": "string"
291	},
292	"first_name": "string",
293	"last_name": "string",
294	"organization_name": "string",
295	"taxonomy_code": "string"
296	},
297	"test_results": [
298	{
299	"value": 1,
300	"result_type": "HEMATOCRIT"
301	}
302	]
303	}
304	],
305	"subscriber_primary": {
306	"first_name": "string",
307	"gender": "male",
308	"insurance_card": {
309	"member_id": "string",
310	"payer_id": "string",
311	"payer_name": "string",
312	"emr_payer_crosswalk": "HEALTHIE",
313	"group_number": "string",
314	"image_url_back": "string",
315	"image_url_front": "string",
316	"insurance_type": "01",
317	"plan_name": "string",
318	"plan_type": "09",
319	"rx_bin": "string",
320	"rx_pcn": "string"
321	},
322	"last_name": "string",
323	"patient_relationship_to_subscriber_code": "01",
324	"address": {
325	"address1": "string",
326	"city": "string",
327	"state": "AA",
328	"zip_code": "string",
329	"address2": "string",
330	"zip_plus_four_code": "string"
331	},
332	"date_of_birth": "2023-01-01"
333	},
334	"subscriber_secondary": {
335	"first_name": "string",
336	"gender": "male",
337	"insurance_card": {
338	"member_id": "string",
339	"payer_id": "string",
340	"payer_name": "string",
341	"emr_payer_crosswalk": "HEALTHIE",
342	"group_number": "string",
343	"image_url_back": "string",
344	"image_url_front": "string",
345	"insurance_type": "01",
346	"plan_name": "string",
347	"plan_type": "09",
348	"rx_bin": "string",
349	"rx_pcn": "string"
350	},
351	"last_name": "string",
352	"patient_relationship_to_subscriber_code": "01",
353	"address": {
354	"address1": "string",
355	"city": "string",
356	"state": "AA",
357	"zip_code": "string",
358	"address2": "string",
359	"zip_plus_four_code": "string"
360	},
361	"date_of_birth": "2023-01-01"
362	},
363	"supervising_provider": {
364	"address": {
365	"address1": "string",
366	"city": "string",
367	"state": "AA",
368	"zip_code": "string",
369	"zip_plus_four_code": "string",
370	"address2": "string"
371	},
372	"first_name": "string",
373	"last_name": "string",
374	"npi": "string",
375	"organization_name": "string",
376	"taxonomy_code": "string"
377	},
378	"synchronicity": "Synchronous",
379	"tag_ids": [
380	"string"
381	],
382	"vitals": {
383	"height_in": 0,
384	"weight_lbs": 0,
385	"blood_pressure_systolic_mmhg": 0,
386	"blood_pressure_diastolic_mmhg": 0,
387	"body_temperature_f": 1,
388	"hemoglobin_gdl": 1,
389	"hematocrit_pct": 1
390	},
391	"external_claim_submission": {
392	"claim_created_at": "2023-01-01T00:00:00Z",
393	"patient_control_number": "string",
394	"submission_records": [
395	{
396	"submitted_at": "2023-01-01T00:00:00Z",
397	"claim_frequency_code": "1",
398	"payer_responsibility": "primary",
399	"intended_submission_medium": "paper"
400	}
401	]
402	},
403	"schema_instances": [
404	{
405	"schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
406	"content": {
407	"string": {}
408	}
409	}
410	]
411	},
412	"patient_external_id": "string",
413	"charge_external_id": "string",
414	"ehr_source_url": "string",
415	"date_of_service": "2023-01-01"
416	}