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
        • GETGet Charge Capture Claim Creation
        • GETGet Charge Capture Claim Creation Summary
        • PATCHMark a ClaimCreationAttempt error as resolved
        • GETGet all Charge Capture Claim Creations
Contact Sales
LogoLogo
API ReferenceCharge Capture BundlesV1

Get all Charge Capture Claim Creations

Beta
GET
/api/charge_capture_claim_creation/v1
GET
/api/charge_capture_claim_creation/v1
$curl https://api.joincandidhealth.com/api/charge_capture_claim_creation/v1 \
> -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "items": [
3 {
4 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
5 "status": "not-started",
6 "characteristics": {
7 "characteristics": {
8 "key": "value"
9 }
10 },
11 "errors": [
12 {
13 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
14 "message": "message",
15 "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
16 "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
17 "resolved": true,
18 "resolved_by": "resolved_by",
19 "resolution_reason": "resolution_reason",
20 "field_in_error": "field_in_error"
21 },
22 {
23 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
24 "message": "message",
25 "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
26 "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
27 "resolved": true,
28 "resolved_by": "resolved_by",
29 "resolution_reason": "resolution_reason",
30 "field_in_error": "field_in_error"
31 }
32 ],
33 "created_encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
34 "encounter_creation_input": {
35 "accident_date": "2023-01-15",
36 "additional_information": "additional_information",
37 "admission_date": "2023-01-15",
38 "appointment_type": "appointment_type",
39 "benefits_assigned_to_provider": true,
40 "billable_status": "BILLABLE",
41 "billing_notes": [
42 {
43 "text": "text"
44 },
45 {
46 "text": "text"
47 }
48 ],
49 "billing_provider": {
50 "address": {
51 "address1": "address1",
52 "address2": "address2",
53 "city": "city",
54 "state": "AA",
55 "zip_code": "zip_code",
56 "zip_plus_four_code": "zip_plus_four_code"
57 },
58 "first_name": "first_name",
59 "last_name": "last_name",
60 "npi": "npi",
61 "organization_name": "organization_name",
62 "provider_commercial_license_type": "0",
63 "secondary_identification": {
64 "reference_identification": "reference_identification",
65 "reference_identification_qualifier": "G2"
66 },
67 "tax_id": "tax_id",
68 "taxonomy_code": "taxonomy_code"
69 },
70 "claim_supplemental_information": [
71 {
72 "attachment_report_type_code": "03",
73 "attachment_transmission_code": "BM",
74 "attachment_control_number": "attachment_control_number"
75 },
76 {
77 "attachment_report_type_code": "03",
78 "attachment_transmission_code": "BM",
79 "attachment_control_number": "attachment_control_number"
80 }
81 ],
82 "clinical_notes": [
83 {
84 "category": "clinical",
85 "notes": [
86 {},
87 {}
88 ]
89 },
90 {
91 "category": "clinical",
92 "notes": [
93 {},
94 {}
95 ]
96 }
97 ],
98 "date_of_service": "2023-01-15",
99 "delay_reason_code": "1",
100 "diagnoses": [
101 {
102 "name": "name",
103 "code_type": "ABF",
104 "code": "code",
105 "present_on_admission_indicator": "YES"
106 },
107 {
108 "name": "name",
109 "code_type": "ABF",
110 "code": "code",
111 "present_on_admission_indicator": "YES"
112 }
113 ],
114 "discharge_date": "2023-01-15",
115 "end_date_of_service": "2023-01-15",
116 "epsdt_referral": {
117 "condition_indicator1": "AV",
118 "condition_indicator2": "AV",
119 "condition_indicator3": "AV"
120 },
121 "existing_medications": [
122 {
123 "name": "name",
124 "rx_cui": "rx_cui",
125 "dosage": "dosage",
126 "dosage_form": "dosage_form",
127 "frequency": "frequency",
128 "as_needed": true
129 },
130 {
131 "name": "name",
132 "rx_cui": "rx_cui",
133 "dosage": "dosage",
134 "dosage_form": "dosage_form",
135 "frequency": "frequency",
136 "as_needed": true
137 }
138 ],
139 "external_id": "external_id",
140 "guarantor": {
141 "first_name": "first_name",
142 "last_name": "last_name",
143 "external_id": "external_id",
144 "date_of_birth": "2023-01-15",
145 "address": {
146 "address1": "address1",
147 "address2": "address2",
148 "city": "city",
149 "state": "AA",
150 "zip_code": "zip_code",
151 "zip_plus_four_code": "zip_plus_four_code"
152 },
153 "phone_numbers": [
154 {},
155 {}
156 ],
157 "phone_consent": true,
158 "email": "email",
159 "email_consent": true,
160 "auto_charge_consent": true
161 },
162 "initial_referring_provider": {
163 "address": {
164 "address1": "address1",
165 "address2": "address2",
166 "city": "city",
167 "state": "AA",
168 "zip_code": "zip_code",
169 "zip_plus_four_code": "zip_plus_four_code"
170 },
171 "first_name": "first_name",
172 "last_name": "last_name",
173 "npi": "npi",
174 "organization_name": "organization_name",
175 "qualifier": "DQ",
176 "secondary_identification": {
177 "reference_identification": "reference_identification",
178 "reference_identification_qualifier": "0B"
179 },
180 "taxonomy_code": "taxonomy_code"
181 },
182 "interventions": [
183 {
184 "name": "name",
185 "category": "allopathic",
186 "description": "description",
187 "medication": {},
188 "labs": [
189 {},
190 {}
191 ]
192 },
193 {
194 "name": "name",
195 "category": "allopathic",
196 "description": "description",
197 "medication": {},
198 "labs": [
199 {},
200 {}
201 ]
202 }
203 ],
204 "last_menstrual_period_date": "2023-01-15",
205 "onset_of_current_illness_or_symptom_date": "2023-01-15",
206 "patient": {
207 "first_name": "first_name",
208 "last_name": "last_name",
209 "gender": "male",
210 "external_id": "external_id",
211 "date_of_birth": "2023-01-15",
212 "address": {
213 "address1": "address1",
214 "address2": "address2",
215 "city": "city",
216 "state": "AA",
217 "zip_code": "zip_code",
218 "zip_plus_four_code": "zip_plus_four_code"
219 },
220 "phone_numbers": [
221 {},
222 {}
223 ],
224 "phone_consent": true,
225 "email": "email",
226 "email_consent": true,
227 "auto_charge_consent": true,
228 "non_insurance_payers_info": [
229 {},
230 {}
231 ],
232 "non_insurance_payers": [
233 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
234 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
235 ]
236 },
237 "patient_histories": [
238 {
239 "category": "present_illness",
240 "questions": [
241 {},
242 {}
243 ]
244 },
245 {
246 "category": "present_illness",
247 "questions": [
248 {},
249 {}
250 ]
251 }
252 ],
253 "pay_to_address": {
254 "address1": "address1",
255 "address2": "address2",
256 "city": "city",
257 "state": "AA",
258 "zip_code": "zip_code",
259 "zip_plus_four_code": "zip_plus_four_code"
260 },
261 "place_of_service_code": "01",
262 "prior_authorization_number": "prior_authorization_number",
263 "property_casualty_claim_number": "property_casualty_claim_number",
264 "property_casualty_patient_identifier": {
265 "property_casualty_patient_identifier_qualifier": "1W",
266 "property_casualty_patient_identifier": "property_casualty_patient_identifier"
267 },
268 "provider_accepts_assignment": true,
269 "referral_number": "referral_number",
270 "referring_provider": {
271 "address": {
272 "address1": "address1",
273 "address2": "address2",
274 "city": "city",
275 "state": "AA",
276 "zip_code": "zip_code",
277 "zip_plus_four_code": "zip_plus_four_code"
278 },
279 "first_name": "first_name",
280 "last_name": "last_name",
281 "npi": "npi",
282 "organization_name": "organization_name",
283 "secondary_identification": {
284 "reference_identification": "reference_identification",
285 "reference_identification_qualifier": "0B"
286 },
287 "taxonomy_code": "taxonomy_code"
288 },
289 "related_causes_information": {
290 "related_causes_code_1": "AA",
291 "related_causes_code_2": "AA",
292 "state_or_province_code": "state_or_province_code"
293 },
294 "rendering_provider": {
295 "address": {
296 "address1": "address1",
297 "address2": "address2",
298 "city": "city",
299 "state": "AA",
300 "zip_code": "zip_code",
301 "zip_plus_four_code": "zip_plus_four_code"
302 },
303 "first_name": "first_name",
304 "last_name": "last_name",
305 "npi": "npi",
306 "organization_name": "organization_name",
307 "secondary_identification": {
308 "reference_identification": "reference_identification",
309 "reference_identification_qualifier": "0B"
310 },
311 "taxonomy_code": "taxonomy_code"
312 },
313 "responsible_party": "INSURANCE_PAY",
314 "schema_instances": [
315 {
316 "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
317 "content": {
318 "content": {
319 "key": "value"
320 }
321 }
322 },
323 {
324 "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
325 "content": {
326 "content": {
327 "key": "value"
328 }
329 }
330 }
331 ],
332 "secondary_payer_carrier_code": "secondary_payer_carrier_code",
333 "service_authorization_exception_code": "1",
334 "service_facility": {
335 "organization_name": "organization_name",
336 "npi": "npi",
337 "address": {
338 "address1": "address1",
339 "address2": "address2",
340 "city": "city",
341 "state": "AA",
342 "zip_code": "zip_code",
343 "zip_plus_four_code": "zip_plus_four_code"
344 },
345 "secondary_identification": "secondary_identification",
346 "mammography_certification_number": "mammography_certification_number"
347 },
348 "service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
349 "service_lines": [
350 {
351 "modifiers": [
352 "AV",
353 "AV"
354 ],
355 "has_epsdt_indicator": true,
356 "has_family_planning_indicator": true,
357 "procedure_code": "procedure_code",
358 "quantity": "quantity",
359 "units": "MJ",
360 "charge_amount_cents": 1,
361 "diagnosis_pointers": [
362 1,
363 1
364 ],
365 "drug_identification": {},
366 "place_of_service_code": "01",
367 "description": "description",
368 "date_of_service": "2023-01-15",
369 "end_date_of_service": "2023-01-15",
370 "ordering_provider": {},
371 "test_results": [
372 {},
373 {}
374 ],
375 "note": "note",
376 "revenue_code": "revenue_code",
377 "prior_authorization_number": "prior_authorization_number",
378 "external_id": "external_id"
379 },
380 {
381 "modifiers": [
382 "AV",
383 "AV"
384 ],
385 "has_epsdt_indicator": true,
386 "has_family_planning_indicator": true,
387 "procedure_code": "procedure_code",
388 "quantity": "quantity",
389 "units": "MJ",
390 "charge_amount_cents": 1,
391 "diagnosis_pointers": [
392 1,
393 1
394 ],
395 "drug_identification": {},
396 "place_of_service_code": "01",
397 "description": "description",
398 "date_of_service": "2023-01-15",
399 "end_date_of_service": "2023-01-15",
400 "ordering_provider": {},
401 "test_results": [
402 {},
403 {}
404 ],
405 "note": "note",
406 "revenue_code": "revenue_code",
407 "prior_authorization_number": "prior_authorization_number",
408 "external_id": "external_id"
409 }
410 ],
411 "subscriber_primary": {
412 "address": {
413 "address1": "address1",
414 "address2": "address2",
415 "city": "city",
416 "state": "AA",
417 "zip_code": "zip_code",
418 "zip_plus_four_code": "zip_plus_four_code"
419 },
420 "date_of_birth": "2023-01-15",
421 "first_name": "first_name",
422 "gender": "male",
423 "insurance_card": {
424 "group_number": "group_number",
425 "plan_name": "plan_name",
426 "plan_type": "09",
427 "insurance_type": "01",
428 "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
429 "payer_address": {},
430 "member_id": "member_id",
431 "payer_name": "payer_name",
432 "payer_id": "payer_id",
433 "rx_bin": "rx_bin",
434 "rx_pcn": "rx_pcn",
435 "image_url_front": "image_url_front",
436 "image_url_back": "image_url_back",
437 "emr_payer_crosswalk": "HEALTHIE",
438 "payer_plan_group_name": "payer_plan_group_name"
439 },
440 "last_name": "last_name",
441 "patient_relationship_to_subscriber_code": "01"
442 },
443 "subscriber_secondary": {
444 "address": {
445 "address1": "address1",
446 "address2": "address2",
447 "city": "city",
448 "state": "AA",
449 "zip_code": "zip_code",
450 "zip_plus_four_code": "zip_plus_four_code"
451 },
452 "date_of_birth": "2023-01-15",
453 "first_name": "first_name",
454 "gender": "male",
455 "insurance_card": {
456 "group_number": "group_number",
457 "plan_name": "plan_name",
458 "plan_type": "09",
459 "insurance_type": "01",
460 "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
461 "payer_address": {},
462 "member_id": "member_id",
463 "payer_name": "payer_name",
464 "payer_id": "payer_id",
465 "rx_bin": "rx_bin",
466 "rx_pcn": "rx_pcn",
467 "image_url_front": "image_url_front",
468 "image_url_back": "image_url_back",
469 "emr_payer_crosswalk": "HEALTHIE",
470 "payer_plan_group_name": "payer_plan_group_name"
471 },
472 "last_name": "last_name",
473 "patient_relationship_to_subscriber_code": "01"
474 },
475 "subscriber_tertiary": {
476 "address": {
477 "address1": "address1",
478 "address2": "address2",
479 "city": "city",
480 "state": "AA",
481 "zip_code": "zip_code",
482 "zip_plus_four_code": "zip_plus_four_code"
483 },
484 "date_of_birth": "2023-01-15",
485 "first_name": "first_name",
486 "gender": "male",
487 "insurance_card": {
488 "group_number": "group_number",
489 "plan_name": "plan_name",
490 "plan_type": "09",
491 "insurance_type": "01",
492 "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
493 "payer_address": {},
494 "member_id": "member_id",
495 "payer_name": "payer_name",
496 "payer_id": "payer_id",
497 "rx_bin": "rx_bin",
498 "rx_pcn": "rx_pcn",
499 "image_url_front": "image_url_front",
500 "image_url_back": "image_url_back",
501 "emr_payer_crosswalk": "HEALTHIE",
502 "payer_plan_group_name": "payer_plan_group_name"
503 },
504 "last_name": "last_name",
505 "patient_relationship_to_subscriber_code": "01"
506 },
507 "supervising_provider": {
508 "address": {
509 "address1": "address1",
510 "address2": "address2",
511 "city": "city",
512 "state": "AA",
513 "zip_code": "zip_code",
514 "zip_plus_four_code": "zip_plus_four_code"
515 },
516 "first_name": "first_name",
517 "last_name": "last_name",
518 "npi": "npi",
519 "organization_name": "organization_name",
520 "secondary_identification": {
521 "reference_identification": "reference_identification",
522 "reference_identification_qualifier": "0B"
523 },
524 "taxonomy_code": "taxonomy_code"
525 },
526 "synchronicity": "Synchronous",
527 "tag_ids": [
528 "tag_ids",
529 "tag_ids"
530 ],
531 "vitals": {
532 "height_in": 1,
533 "weight_lbs": 1,
534 "blood_pressure_systolic_mmhg": 1,
535 "blood_pressure_diastolic_mmhg": 1,
536 "body_temperature_f": 1.1,
537 "hemoglobin_gdl": 1.1,
538 "hematocrit_pct": 1.1
539 },
540 "external_claim_submission": {
541 "claim_created_at": "2024-01-15T09:30:00Z",
542 "patient_control_number": "patient_control_number",
543 "submission_records": [
544 {},
545 {}
546 ]
547 },
548 "patient_authorized_release": true,
549 "treating_provider": {
550 "first_name": "first_name",
551 "last_name": "last_name",
552 "npi": "npi",
553 "taxonomy_code": "taxonomy_code",
554 "address": {
555 "address1": "address1",
556 "address2": "address2",
557 "city": "city",
558 "state": "AA",
559 "zip_code": "zip_code",
560 "zip_plus_four_code": "zip_plus_four_code"
561 },
562 "license_type": "MD"
563 }
564 }
565 },
566 {
567 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
568 "status": "not-started",
569 "characteristics": {
570 "characteristics": {
571 "key": "value"
572 }
573 },
574 "errors": [
575 {
576 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
577 "message": "message",
578 "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
579 "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
580 "resolved": true,
581 "resolved_by": "resolved_by",
582 "resolution_reason": "resolution_reason",
583 "field_in_error": "field_in_error"
584 },
585 {
586 "id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
587 "message": "message",
588 "claim_creation_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
589 "charge_capture_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
590 "resolved": true,
591 "resolved_by": "resolved_by",
592 "resolution_reason": "resolution_reason",
593 "field_in_error": "field_in_error"
594 }
595 ],
596 "created_encounter_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
597 "encounter_creation_input": {
598 "accident_date": "2023-01-15",
599 "additional_information": "additional_information",
600 "admission_date": "2023-01-15",
601 "appointment_type": "appointment_type",
602 "benefits_assigned_to_provider": true,
603 "billable_status": "BILLABLE",
604 "billing_notes": [
605 {
606 "text": "text"
607 },
608 {
609 "text": "text"
610 }
611 ],
612 "billing_provider": {
613 "address": {
614 "address1": "address1",
615 "address2": "address2",
616 "city": "city",
617 "state": "AA",
618 "zip_code": "zip_code",
619 "zip_plus_four_code": "zip_plus_four_code"
620 },
621 "first_name": "first_name",
622 "last_name": "last_name",
623 "npi": "npi",
624 "organization_name": "organization_name",
625 "provider_commercial_license_type": "0",
626 "secondary_identification": {
627 "reference_identification": "reference_identification",
628 "reference_identification_qualifier": "G2"
629 },
630 "tax_id": "tax_id",
631 "taxonomy_code": "taxonomy_code"
632 },
633 "claim_supplemental_information": [
634 {
635 "attachment_report_type_code": "03",
636 "attachment_transmission_code": "BM",
637 "attachment_control_number": "attachment_control_number"
638 },
639 {
640 "attachment_report_type_code": "03",
641 "attachment_transmission_code": "BM",
642 "attachment_control_number": "attachment_control_number"
643 }
644 ],
645 "clinical_notes": [
646 {
647 "category": "clinical",
648 "notes": [
649 {},
650 {}
651 ]
652 },
653 {
654 "category": "clinical",
655 "notes": [
656 {},
657 {}
658 ]
659 }
660 ],
661 "date_of_service": "2023-01-15",
662 "delay_reason_code": "1",
663 "diagnoses": [
664 {
665 "name": "name",
666 "code_type": "ABF",
667 "code": "code",
668 "present_on_admission_indicator": "YES"
669 },
670 {
671 "name": "name",
672 "code_type": "ABF",
673 "code": "code",
674 "present_on_admission_indicator": "YES"
675 }
676 ],
677 "discharge_date": "2023-01-15",
678 "end_date_of_service": "2023-01-15",
679 "epsdt_referral": {
680 "condition_indicator1": "AV",
681 "condition_indicator2": "AV",
682 "condition_indicator3": "AV"
683 },
684 "existing_medications": [
685 {
686 "name": "name",
687 "rx_cui": "rx_cui",
688 "dosage": "dosage",
689 "dosage_form": "dosage_form",
690 "frequency": "frequency",
691 "as_needed": true
692 },
693 {
694 "name": "name",
695 "rx_cui": "rx_cui",
696 "dosage": "dosage",
697 "dosage_form": "dosage_form",
698 "frequency": "frequency",
699 "as_needed": true
700 }
701 ],
702 "external_id": "external_id",
703 "guarantor": {
704 "first_name": "first_name",
705 "last_name": "last_name",
706 "external_id": "external_id",
707 "date_of_birth": "2023-01-15",
708 "address": {
709 "address1": "address1",
710 "address2": "address2",
711 "city": "city",
712 "state": "AA",
713 "zip_code": "zip_code",
714 "zip_plus_four_code": "zip_plus_four_code"
715 },
716 "phone_numbers": [
717 {},
718 {}
719 ],
720 "phone_consent": true,
721 "email": "email",
722 "email_consent": true,
723 "auto_charge_consent": true
724 },
725 "initial_referring_provider": {
726 "address": {
727 "address1": "address1",
728 "address2": "address2",
729 "city": "city",
730 "state": "AA",
731 "zip_code": "zip_code",
732 "zip_plus_four_code": "zip_plus_four_code"
733 },
734 "first_name": "first_name",
735 "last_name": "last_name",
736 "npi": "npi",
737 "organization_name": "organization_name",
738 "qualifier": "DQ",
739 "secondary_identification": {
740 "reference_identification": "reference_identification",
741 "reference_identification_qualifier": "0B"
742 },
743 "taxonomy_code": "taxonomy_code"
744 },
745 "interventions": [
746 {
747 "name": "name",
748 "category": "allopathic",
749 "description": "description",
750 "medication": {},
751 "labs": [
752 {},
753 {}
754 ]
755 },
756 {
757 "name": "name",
758 "category": "allopathic",
759 "description": "description",
760 "medication": {},
761 "labs": [
762 {},
763 {}
764 ]
765 }
766 ],
767 "last_menstrual_period_date": "2023-01-15",
768 "onset_of_current_illness_or_symptom_date": "2023-01-15",
769 "patient": {
770 "first_name": "first_name",
771 "last_name": "last_name",
772 "gender": "male",
773 "external_id": "external_id",
774 "date_of_birth": "2023-01-15",
775 "address": {
776 "address1": "address1",
777 "address2": "address2",
778 "city": "city",
779 "state": "AA",
780 "zip_code": "zip_code",
781 "zip_plus_four_code": "zip_plus_four_code"
782 },
783 "phone_numbers": [
784 {},
785 {}
786 ],
787 "phone_consent": true,
788 "email": "email",
789 "email_consent": true,
790 "auto_charge_consent": true,
791 "non_insurance_payers_info": [
792 {},
793 {}
794 ],
795 "non_insurance_payers": [
796 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
797 "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
798 ]
799 },
800 "patient_histories": [
801 {
802 "category": "present_illness",
803 "questions": [
804 {},
805 {}
806 ]
807 },
808 {
809 "category": "present_illness",
810 "questions": [
811 {},
812 {}
813 ]
814 }
815 ],
816 "pay_to_address": {
817 "address1": "address1",
818 "address2": "address2",
819 "city": "city",
820 "state": "AA",
821 "zip_code": "zip_code",
822 "zip_plus_four_code": "zip_plus_four_code"
823 },
824 "place_of_service_code": "01",
825 "prior_authorization_number": "prior_authorization_number",
826 "property_casualty_claim_number": "property_casualty_claim_number",
827 "property_casualty_patient_identifier": {
828 "property_casualty_patient_identifier_qualifier": "1W",
829 "property_casualty_patient_identifier": "property_casualty_patient_identifier"
830 },
831 "provider_accepts_assignment": true,
832 "referral_number": "referral_number",
833 "referring_provider": {
834 "address": {
835 "address1": "address1",
836 "address2": "address2",
837 "city": "city",
838 "state": "AA",
839 "zip_code": "zip_code",
840 "zip_plus_four_code": "zip_plus_four_code"
841 },
842 "first_name": "first_name",
843 "last_name": "last_name",
844 "npi": "npi",
845 "organization_name": "organization_name",
846 "secondary_identification": {
847 "reference_identification": "reference_identification",
848 "reference_identification_qualifier": "0B"
849 },
850 "taxonomy_code": "taxonomy_code"
851 },
852 "related_causes_information": {
853 "related_causes_code_1": "AA",
854 "related_causes_code_2": "AA",
855 "state_or_province_code": "state_or_province_code"
856 },
857 "rendering_provider": {
858 "address": {
859 "address1": "address1",
860 "address2": "address2",
861 "city": "city",
862 "state": "AA",
863 "zip_code": "zip_code",
864 "zip_plus_four_code": "zip_plus_four_code"
865 },
866 "first_name": "first_name",
867 "last_name": "last_name",
868 "npi": "npi",
869 "organization_name": "organization_name",
870 "secondary_identification": {
871 "reference_identification": "reference_identification",
872 "reference_identification_qualifier": "0B"
873 },
874 "taxonomy_code": "taxonomy_code"
875 },
876 "responsible_party": "INSURANCE_PAY",
877 "schema_instances": [
878 {
879 "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
880 "content": {
881 "content": {
882 "key": "value"
883 }
884 }
885 },
886 {
887 "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
888 "content": {
889 "content": {
890 "key": "value"
891 }
892 }
893 }
894 ],
895 "secondary_payer_carrier_code": "secondary_payer_carrier_code",
896 "service_authorization_exception_code": "1",
897 "service_facility": {
898 "organization_name": "organization_name",
899 "npi": "npi",
900 "address": {
901 "address1": "address1",
902 "address2": "address2",
903 "city": "city",
904 "state": "AA",
905 "zip_code": "zip_code",
906 "zip_plus_four_code": "zip_plus_four_code"
907 },
908 "secondary_identification": "secondary_identification",
909 "mammography_certification_number": "mammography_certification_number"
910 },
911 "service_facility_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
912 "service_lines": [
913 {
914 "modifiers": [
915 "AV",
916 "AV"
917 ],
918 "has_epsdt_indicator": true,
919 "has_family_planning_indicator": true,
920 "procedure_code": "procedure_code",
921 "quantity": "quantity",
922 "units": "MJ",
923 "charge_amount_cents": 1,
924 "diagnosis_pointers": [
925 1,
926 1
927 ],
928 "drug_identification": {},
929 "place_of_service_code": "01",
930 "description": "description",
931 "date_of_service": "2023-01-15",
932 "end_date_of_service": "2023-01-15",
933 "ordering_provider": {},
934 "test_results": [
935 {},
936 {}
937 ],
938 "note": "note",
939 "revenue_code": "revenue_code",
940 "prior_authorization_number": "prior_authorization_number",
941 "external_id": "external_id"
942 },
943 {
944 "modifiers": [
945 "AV",
946 "AV"
947 ],
948 "has_epsdt_indicator": true,
949 "has_family_planning_indicator": true,
950 "procedure_code": "procedure_code",
951 "quantity": "quantity",
952 "units": "MJ",
953 "charge_amount_cents": 1,
954 "diagnosis_pointers": [
955 1,
956 1
957 ],
958 "drug_identification": {},
959 "place_of_service_code": "01",
960 "description": "description",
961 "date_of_service": "2023-01-15",
962 "end_date_of_service": "2023-01-15",
963 "ordering_provider": {},
964 "test_results": [
965 {},
966 {}
967 ],
968 "note": "note",
969 "revenue_code": "revenue_code",
970 "prior_authorization_number": "prior_authorization_number",
971 "external_id": "external_id"
972 }
973 ],
974 "subscriber_primary": {
975 "address": {
976 "address1": "address1",
977 "address2": "address2",
978 "city": "city",
979 "state": "AA",
980 "zip_code": "zip_code",
981 "zip_plus_four_code": "zip_plus_four_code"
982 },
983 "date_of_birth": "2023-01-15",
984 "first_name": "first_name",
985 "gender": "male",
986 "insurance_card": {
987 "group_number": "group_number",
988 "plan_name": "plan_name",
989 "plan_type": "09",
990 "insurance_type": "01",
991 "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
992 "payer_address": {},
993 "member_id": "member_id",
994 "payer_name": "payer_name",
995 "payer_id": "payer_id",
996 "rx_bin": "rx_bin",
997 "rx_pcn": "rx_pcn",
998 "image_url_front": "image_url_front",
999 "image_url_back": "image_url_back",
1000 "emr_payer_crosswalk": "HEALTHIE",
1001 "payer_plan_group_name": "payer_plan_group_name"
1002 },
1003 "last_name": "last_name",
1004 "patient_relationship_to_subscriber_code": "01"
1005 },
1006 "subscriber_secondary": {
1007 "address": {
1008 "address1": "address1",
1009 "address2": "address2",
1010 "city": "city",
1011 "state": "AA",
1012 "zip_code": "zip_code",
1013 "zip_plus_four_code": "zip_plus_four_code"
1014 },
1015 "date_of_birth": "2023-01-15",
1016 "first_name": "first_name",
1017 "gender": "male",
1018 "insurance_card": {
1019 "group_number": "group_number",
1020 "plan_name": "plan_name",
1021 "plan_type": "09",
1022 "insurance_type": "01",
1023 "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1024 "payer_address": {},
1025 "member_id": "member_id",
1026 "payer_name": "payer_name",
1027 "payer_id": "payer_id",
1028 "rx_bin": "rx_bin",
1029 "rx_pcn": "rx_pcn",
1030 "image_url_front": "image_url_front",
1031 "image_url_back": "image_url_back",
1032 "emr_payer_crosswalk": "HEALTHIE",
1033 "payer_plan_group_name": "payer_plan_group_name"
1034 },
1035 "last_name": "last_name",
1036 "patient_relationship_to_subscriber_code": "01"
1037 },
1038 "subscriber_tertiary": {
1039 "address": {
1040 "address1": "address1",
1041 "address2": "address2",
1042 "city": "city",
1043 "state": "AA",
1044 "zip_code": "zip_code",
1045 "zip_plus_four_code": "zip_plus_four_code"
1046 },
1047 "date_of_birth": "2023-01-15",
1048 "first_name": "first_name",
1049 "gender": "male",
1050 "insurance_card": {
1051 "group_number": "group_number",
1052 "plan_name": "plan_name",
1053 "plan_type": "09",
1054 "insurance_type": "01",
1055 "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1056 "payer_address": {},
1057 "member_id": "member_id",
1058 "payer_name": "payer_name",
1059 "payer_id": "payer_id",
1060 "rx_bin": "rx_bin",
1061 "rx_pcn": "rx_pcn",
1062 "image_url_front": "image_url_front",
1063 "image_url_back": "image_url_back",
1064 "emr_payer_crosswalk": "HEALTHIE",
1065 "payer_plan_group_name": "payer_plan_group_name"
1066 },
1067 "last_name": "last_name",
1068 "patient_relationship_to_subscriber_code": "01"
1069 },
1070 "supervising_provider": {
1071 "address": {
1072 "address1": "address1",
1073 "address2": "address2",
1074 "city": "city",
1075 "state": "AA",
1076 "zip_code": "zip_code",
1077 "zip_plus_four_code": "zip_plus_four_code"
1078 },
1079 "first_name": "first_name",
1080 "last_name": "last_name",
1081 "npi": "npi",
1082 "organization_name": "organization_name",
1083 "secondary_identification": {
1084 "reference_identification": "reference_identification",
1085 "reference_identification_qualifier": "0B"
1086 },
1087 "taxonomy_code": "taxonomy_code"
1088 },
1089 "synchronicity": "Synchronous",
1090 "tag_ids": [
1091 "tag_ids",
1092 "tag_ids"
1093 ],
1094 "vitals": {
1095 "height_in": 1,
1096 "weight_lbs": 1,
1097 "blood_pressure_systolic_mmhg": 1,
1098 "blood_pressure_diastolic_mmhg": 1,
1099 "body_temperature_f": 1.1,
1100 "hemoglobin_gdl": 1.1,
1101 "hematocrit_pct": 1.1
1102 },
1103 "external_claim_submission": {
1104 "claim_created_at": "2024-01-15T09:30:00Z",
1105 "patient_control_number": "patient_control_number",
1106 "submission_records": [
1107 {},
1108 {}
1109 ]
1110 },
1111 "patient_authorized_release": true,
1112 "treating_provider": {
1113 "first_name": "first_name",
1114 "last_name": "last_name",
1115 "npi": "npi",
1116 "taxonomy_code": "taxonomy_code",
1117 "address": {
1118 "address1": "address1",
1119 "address2": "address2",
1120 "city": "city",
1121 "state": "AA",
1122 "zip_code": "zip_code",
1123 "zip_plus_four_code": "zip_plus_four_code"
1124 },
1125 "license_type": "MD"
1126 }
1127 }
1128 }
1129 ],
1130 "next_page_token": "next_page_token",
1131 "prev_page_token": "prev_page_token"
1132}
Was this page helpful?
Previous

Create a Charge Capture

Next
Built with

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

limitintegerOptional
Maximum number of entities per page, defaults to 100.
sortenumOptional

Defaults to created_at

Allowed values:
sort_directionenumOptional
Sort direction. Defaults to descending order if not provided.
Allowed values:
page_tokenstringOptional
patient_external_idstringOptional
The patient ID from the external EMR platform for the patient
claim_creation_statusenumOptional
the status of the charge capture Claim Creation, refers to whether it was able to create a claim.
charge_statusenumOptional
the status of the charge captures
Allowed values:
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_service_mindateOptional

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

date_of_service_maxdateOptional

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

claim_idsUUIDOptional

A list of claim IDs to filter by. This will return all charge capture claim_creations that have a resulting claim with one of the IDs in this list.

claim_creation_idsUUIDOptional
A list of Claim Creation IDs to filter by.
billing_provider_npisstringOptional

A list of billing provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list.

service_facility_namestringOptional

A string to filter by. This will return all charge capture claim_creations which include one or more charges with this service facility name.

primary_payer_idsstringOptional

A list of primary payer IDs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the primary payer IDs in this list.

rendering_provider_npisstringOptional

A list of rendering provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list.

rendering_provider_namesstringOptional

A list of rendering provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list.

supervising_provider_npisstringOptional

A list of supervising provider NPIs to filter by. This will return all charge capture claim_creations which include one or more charges with one of the NPIs in this list.

supervising_provider_namesstringOptional

A list of supervising provider names to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list.

claim_statusenumOptional
the status of the claim to filter by created from charge capture bundle.
claim_creation_categorystringOptional

A list of claim creation categories to filter by. This will return all charge capture claim_creations which include one or more charges with one of the names in this list.

tagsstringOptional
A list of tags to filter by. This will return all charge captures with one of the tags.
primary_payer_namesstringOptional
A list of primary payer names to filter by. This will return all charge captures with one of the names.
patient_namesstringOptional
A list of patient names to filter by. This will return all charge captures with one of the names.
has_charge_capture_updatesbooleanOptional

If true, only return claim_creations that have charge captures that have been updated since the Claim Creation has had a status of BILLED. See the updates property on ChargeCapture for more details.

Response

This endpoint returns an object.
itemslist of objects
next_page_tokenstring
prev_page_tokenstring