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

encounter_external_idstring

ehr_source_urlstringOptional

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     "existing_medications": [
62       {
63         "name": "string",
64         "rx_cui": "string",
65         "dosage": "string",
66         "dosage_form": "string",
67         "frequency": "string",
68         "as_needed": true
69       }
70     ],
71     "external_id": "string",
72     "guarantor": {
73       "first_name": "string",
74       "last_name": "string",
75       "external_id": "string",
76       "date_of_birth": "2023-01-01",
77       "address": {
78         "address1": "string",
79         "city": "string",
80         "state": "AA",
81         "zip_code": "string",
82         "address2": "string",
83         "zip_plus_four_code": "string"
84       },
85       "phone_numbers": [
86         {
87           "number": "string",
88           "type": "Home"
89         }
90       ],
91       "phone_consent": true,
92       "email": "string",
93       "email_consent": true
94     },
95     "initial_referring_provider": {
96       "address": {
97         "address1": "string",
98         "city": "string",
99         "state": "AA",
100         "zip_code": "string",
101         "zip_plus_four_code": "string",
102         "address2": "string"
103       },
104       "first_name": "string",
105       "last_name": "string",
106       "npi": "string",
107       "organization_name": "string",
108       "qualifier": "DQ",
109       "taxonomy_code": "string"
110     },
111     "interventions": [
112       {
113         "name": "string",
114         "category": "allopathic",
115         "description": "string",
116         "medication": {
117           "name": "string",
118           "rx_cui": "string",
119           "dosage": "string",
120           "dosage_form": "string",
121           "frequency": "string",
122           "as_needed": true
123         },
124         "labs": [
125           {
126             "name": "string",
127             "code": "string",
128             "code_type": "quest"
129           }
130         ]
131       }
132     ],
133     "last_menstrual_period_date": "2023-01-01",
134     "onset_of_current_illness_or_symptom_date": "2023-01-01",
135     "patient": {
136       "first_name": "string",
137       "last_name": "string",
138       "gender": "male",
139       "external_id": "string",
140       "date_of_birth": "2023-01-01",
141       "address": {
142         "address1": "string",
143         "city": "string",
144         "state": "AA",
145         "zip_code": "string",
146         "address2": "string",
147         "zip_plus_four_code": "string"
148       },
149       "phone_numbers": [
150         {
151           "number": "string",
152           "type": "Home"
153         }
154       ],
155       "phone_consent": true,
156       "email": "string",
157       "email_consent": true,
158       "non_insurance_payers_info": [
159         {
160           "non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
161           "member_id": "string"
162         }
163       ],
164       "non_insurance_payers": [
165         "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
166       ]
167     },
168     "patient_authorized_release": true,
169     "patient_histories": [
170       {
171         "category": "present_illness",
172         "questions": [
173           {
174             "id": "string",
175             "text": "string",
176             "responses": [
177               {
178                 "response": "string",
179                 "follow_ups": [
180                   {
181                     "id": "string",
182                     "text": "string",
183                     "response": "string"
184                   }
185                 ]
186               }
187             ]
188           }
189         ]
190       }
191     ],
192     "pay_to_address": {
193       "address1": "string",
194       "city": "string",
195       "state": "AA",
196       "zip_code": "string",
197       "zip_plus_four_code": "string",
198       "address2": "string"
199     },
200     "place_of_service_code": "01",
201     "prior_authorization_number": "string",
202     "provider_accepts_assignment": true,
203     "referral_number": "string",
204     "referring_provider": {
205       "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       "first_name": "string",
214       "last_name": "string",
215       "npi": "string",
216       "organization_name": "string",
217       "taxonomy_code": "string"
218     },
219     "rendering_provider": {
220       "address": {
221         "address1": "string",
222         "city": "string",
223         "state": "AA",
224         "zip_code": "string",
225         "zip_plus_four_code": "string",
226         "address2": "string"
227       },
228       "first_name": "string",
229       "last_name": "string",
230       "npi": "string",
231       "organization_name": "string",
232       "taxonomy_code": "string"
233     },
234     "responsible_party": "INSURANCE_PAY",
235     "service_authorization_exception_code": "1",
236     "service_facility": {
237       "organization_name": "string",
238       "npi": "string",
239       "address": {
240         "address1": "string",
241         "city": "string",
242         "state": "AA",
243         "zip_code": "string",
244         "zip_plus_four_code": "string",
245         "address2": "string"
246       },
247       "secondary_identification": "string"
248     },
249     "service_lines": [
250       {
251         "procedure_code": "string",
252         "quantity": "string",
253         "units": "MJ",
254         "diagnosis_pointers": [
255           0
256         ],
257         "modifiers": [
258           "22"
259         ],
260         "charge_amount_cents": 0,
261         "drug_identification": {
262           "service_id_qualifier": "EN",
263           "national_drug_code": "string",
264           "national_drug_unit_count": "string",
265           "measurement_unit_code": "ML",
266           "link_sequence_number": "string",
267           "pharmacy_prescription_number": "string",
268           "conversion_formula": "string",
269           "drug_description": "string"
270         },
271         "place_of_service_code": "01",
272         "description": "string",
273         "date_of_service": "2023-01-01",
274         "end_date_of_service": "2023-01-01",
275         "ordering_provider": {
276           "npi": "string",
277           "address": {
278             "address1": "string",
279             "city": "string",
280             "state": "AA",
281             "zip_code": "string",
282             "zip_plus_four_code": "string",
283             "address2": "string"
284           },
285           "first_name": "string",
286           "last_name": "string",
287           "organization_name": "string",
288           "taxonomy_code": "string"
289         },
290         "test_results": [
291           {
292             "value": 1,
293             "result_type": "HEMATOCRIT"
294           }
295         ]
296       }
297     ],
298     "subscriber_primary": {
299       "first_name": "string",
300       "gender": "male",
301       "insurance_card": {
302         "member_id": "string",
303         "payer_id": "string",
304         "payer_name": "string",
305         "emr_payer_crosswalk": "HEALTHIE",
306         "group_number": "string",
307         "image_url_back": "string",
308         "image_url_front": "string",
309         "insurance_type": "01",
310         "plan_name": "string",
311         "plan_type": "09",
312         "rx_bin": "string",
313         "rx_pcn": "string"
314       },
315       "last_name": "string",
316       "patient_relationship_to_subscriber_code": "01",
317       "address": {
318         "address1": "string",
319         "city": "string",
320         "state": "AA",
321         "zip_code": "string",
322         "address2": "string",
323         "zip_plus_four_code": "string"
324       },
325       "date_of_birth": "2023-01-01"
326     },
327     "subscriber_secondary": {
328       "first_name": "string",
329       "gender": "male",
330       "insurance_card": {
331         "member_id": "string",
332         "payer_id": "string",
333         "payer_name": "string",
334         "emr_payer_crosswalk": "HEALTHIE",
335         "group_number": "string",
336         "image_url_back": "string",
337         "image_url_front": "string",
338         "insurance_type": "01",
339         "plan_name": "string",
340         "plan_type": "09",
341         "rx_bin": "string",
342         "rx_pcn": "string"
343       },
344       "last_name": "string",
345       "patient_relationship_to_subscriber_code": "01",
346       "address": {
347         "address1": "string",
348         "city": "string",
349         "state": "AA",
350         "zip_code": "string",
351         "address2": "string",
352         "zip_plus_four_code": "string"
353       },
354       "date_of_birth": "2023-01-01"
355     },
356     "supervising_provider": {
357       "address": {
358         "address1": "string",
359         "city": "string",
360         "state": "AA",
361         "zip_code": "string",
362         "zip_plus_four_code": "string",
363         "address2": "string"
364       },
365       "first_name": "string",
366       "last_name": "string",
367       "npi": "string",
368       "organization_name": "string",
369       "taxonomy_code": "string"
370     },
371     "synchronicity": "Synchronous",
372     "tag_ids": [
373       "string"
374     ],
375     "vitals": {
376       "height_in": 0,
377       "weight_lbs": 0,
378       "blood_pressure_systolic_mmhg": 0,
379       "blood_pressure_diastolic_mmhg": 0,
380       "body_temperature_f": 1,
381       "hemoglobin_gdl": 1,
382       "hematocrit_pct": 1
383     },
384     "external_claim_submission": {
385       "claim_created_at": "2023-01-01T00:00:00Z",
386       "patient_control_number": "string",
387       "submission_records": [
388         {
389           "submitted_at": "2023-01-01T00:00:00Z",
390           "claim_frequency_code": "1",
391           "payer_responsibility": "primary",
392           "intended_submission_medium": "paper"
393         }
394       ]
395     },
396     "schema_instances": [
397       {
398         "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
399         "content": {
400           "string": {}
401         }
402       }
403     ]
404   },
405   "patient_external_id": "string",
406   "encounter_external_id": "string",
407   "ehr_source_url": "string"
408 }

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	"existing_medications": [
62	{
63	"name": "string",
64	"rx_cui": "string",
65	"dosage": "string",
66	"dosage_form": "string",
67	"frequency": "string",
68	"as_needed": true
69	}
70	],
71	"external_id": "string",
72	"guarantor": {
73	"first_name": "string",
74	"last_name": "string",
75	"external_id": "string",
76	"date_of_birth": "2023-01-01",
77	"address": {
78	"address1": "string",
79	"city": "string",
80	"state": "AA",
81	"zip_code": "string",
82	"address2": "string",
83	"zip_plus_four_code": "string"
84	},
85	"phone_numbers": [
86	{
87	"number": "string",
88	"type": "Home"
89	}
90	],
91	"phone_consent": true,
92	"email": "string",
93	"email_consent": true
94	},
95	"initial_referring_provider": {
96	"address": {
97	"address1": "string",
98	"city": "string",
99	"state": "AA",
100	"zip_code": "string",
101	"zip_plus_four_code": "string",
102	"address2": "string"
103	},
104	"first_name": "string",
105	"last_name": "string",
106	"npi": "string",
107	"organization_name": "string",
108	"qualifier": "DQ",
109	"taxonomy_code": "string"
110	},
111	"interventions": [
112	{
113	"name": "string",
114	"category": "allopathic",
115	"description": "string",
116	"medication": {
117	"name": "string",
118	"rx_cui": "string",
119	"dosage": "string",
120	"dosage_form": "string",
121	"frequency": "string",
122	"as_needed": true
123	},
124	"labs": [
125	{
126	"name": "string",
127	"code": "string",
128	"code_type": "quest"
129	}
130	]
131	}
132	],
133	"last_menstrual_period_date": "2023-01-01",
134	"onset_of_current_illness_or_symptom_date": "2023-01-01",
135	"patient": {
136	"first_name": "string",
137	"last_name": "string",
138	"gender": "male",
139	"external_id": "string",
140	"date_of_birth": "2023-01-01",
141	"address": {
142	"address1": "string",
143	"city": "string",
144	"state": "AA",
145	"zip_code": "string",
146	"address2": "string",
147	"zip_plus_four_code": "string"
148	},
149	"phone_numbers": [
150	{
151	"number": "string",
152	"type": "Home"
153	}
154	],
155	"phone_consent": true,
156	"email": "string",
157	"email_consent": true,
158	"non_insurance_payers_info": [
159	{
160	"non_insurance_payer_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
161	"member_id": "string"
162	}
163	],
164	"non_insurance_payers": [
165	"d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
166	]
167	},
168	"patient_authorized_release": true,
169	"patient_histories": [
170	{
171	"category": "present_illness",
172	"questions": [
173	{
174	"id": "string",
175	"text": "string",
176	"responses": [
177	{
178	"response": "string",
179	"follow_ups": [
180	{
181	"id": "string",
182	"text": "string",
183	"response": "string"
184	}
185	]
186	}
187	]
188	}
189	]
190	}
191	],
192	"pay_to_address": {
193	"address1": "string",
194	"city": "string",
195	"state": "AA",
196	"zip_code": "string",
197	"zip_plus_four_code": "string",
198	"address2": "string"
199	},
200	"place_of_service_code": "01",
201	"prior_authorization_number": "string",
202	"provider_accepts_assignment": true,
203	"referral_number": "string",
204	"referring_provider": {
205	"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	"first_name": "string",
214	"last_name": "string",
215	"npi": "string",
216	"organization_name": "string",
217	"taxonomy_code": "string"
218	},
219	"rendering_provider": {
220	"address": {
221	"address1": "string",
222	"city": "string",
223	"state": "AA",
224	"zip_code": "string",
225	"zip_plus_four_code": "string",
226	"address2": "string"
227	},
228	"first_name": "string",
229	"last_name": "string",
230	"npi": "string",
231	"organization_name": "string",
232	"taxonomy_code": "string"
233	},
234	"responsible_party": "INSURANCE_PAY",
235	"service_authorization_exception_code": "1",
236	"service_facility": {
237	"organization_name": "string",
238	"npi": "string",
239	"address": {
240	"address1": "string",
241	"city": "string",
242	"state": "AA",
243	"zip_code": "string",
244	"zip_plus_four_code": "string",
245	"address2": "string"
246	},
247	"secondary_identification": "string"
248	},
249	"service_lines": [
250	{
251	"procedure_code": "string",
252	"quantity": "string",
253	"units": "MJ",
254	"diagnosis_pointers": [
255	0
256	],
257	"modifiers": [
258	"22"
259	],
260	"charge_amount_cents": 0,
261	"drug_identification": {
262	"service_id_qualifier": "EN",
263	"national_drug_code": "string",
264	"national_drug_unit_count": "string",
265	"measurement_unit_code": "ML",
266	"link_sequence_number": "string",
267	"pharmacy_prescription_number": "string",
268	"conversion_formula": "string",
269	"drug_description": "string"
270	},
271	"place_of_service_code": "01",
272	"description": "string",
273	"date_of_service": "2023-01-01",
274	"end_date_of_service": "2023-01-01",
275	"ordering_provider": {
276	"npi": "string",
277	"address": {
278	"address1": "string",
279	"city": "string",
280	"state": "AA",
281	"zip_code": "string",
282	"zip_plus_four_code": "string",
283	"address2": "string"
284	},
285	"first_name": "string",
286	"last_name": "string",
287	"organization_name": "string",
288	"taxonomy_code": "string"
289	},
290	"test_results": [
291	{
292	"value": 1,
293	"result_type": "HEMATOCRIT"
294	}
295	]
296	}
297	],
298	"subscriber_primary": {
299	"first_name": "string",
300	"gender": "male",
301	"insurance_card": {
302	"member_id": "string",
303	"payer_id": "string",
304	"payer_name": "string",
305	"emr_payer_crosswalk": "HEALTHIE",
306	"group_number": "string",
307	"image_url_back": "string",
308	"image_url_front": "string",
309	"insurance_type": "01",
310	"plan_name": "string",
311	"plan_type": "09",
312	"rx_bin": "string",
313	"rx_pcn": "string"
314	},
315	"last_name": "string",
316	"patient_relationship_to_subscriber_code": "01",
317	"address": {
318	"address1": "string",
319	"city": "string",
320	"state": "AA",
321	"zip_code": "string",
322	"address2": "string",
323	"zip_plus_four_code": "string"
324	},
325	"date_of_birth": "2023-01-01"
326	},
327	"subscriber_secondary": {
328	"first_name": "string",
329	"gender": "male",
330	"insurance_card": {
331	"member_id": "string",
332	"payer_id": "string",
333	"payer_name": "string",
334	"emr_payer_crosswalk": "HEALTHIE",
335	"group_number": "string",
336	"image_url_back": "string",
337	"image_url_front": "string",
338	"insurance_type": "01",
339	"plan_name": "string",
340	"plan_type": "09",
341	"rx_bin": "string",
342	"rx_pcn": "string"
343	},
344	"last_name": "string",
345	"patient_relationship_to_subscriber_code": "01",
346	"address": {
347	"address1": "string",
348	"city": "string",
349	"state": "AA",
350	"zip_code": "string",
351	"address2": "string",
352	"zip_plus_four_code": "string"
353	},
354	"date_of_birth": "2023-01-01"
355	},
356	"supervising_provider": {
357	"address": {
358	"address1": "string",
359	"city": "string",
360	"state": "AA",
361	"zip_code": "string",
362	"zip_plus_four_code": "string",
363	"address2": "string"
364	},
365	"first_name": "string",
366	"last_name": "string",
367	"npi": "string",
368	"organization_name": "string",
369	"taxonomy_code": "string"
370	},
371	"synchronicity": "Synchronous",
372	"tag_ids": [
373	"string"
374	],
375	"vitals": {
376	"height_in": 0,
377	"weight_lbs": 0,
378	"blood_pressure_systolic_mmhg": 0,
379	"blood_pressure_diastolic_mmhg": 0,
380	"body_temperature_f": 1,
381	"hemoglobin_gdl": 1,
382	"hematocrit_pct": 1
383	},
384	"external_claim_submission": {
385	"claim_created_at": "2023-01-01T00:00:00Z",
386	"patient_control_number": "string",
387	"submission_records": [
388	{
389	"submitted_at": "2023-01-01T00:00:00Z",
390	"claim_frequency_code": "1",
391	"payer_responsibility": "primary",
392	"intended_submission_medium": "paper"
393	}
394	]
395	},
396	"schema_instances": [
397	{
398	"schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
399	"content": {
400	"string": {}
401	}
402	}
403	]
404	},
405	"patient_external_id": "string",
406	"encounter_external_id": "string",
407	"ehr_source_url": "string"
408	}