Find Charge Captures by Metadata

Beta

POST

/api/charge_captures/v1/find-by-metadata

POST

/api/charge_captures/v1/find-by-metadata

1 import requests
2 
3 url = "https://api.joincandidhealth.com/api/charge_captures/v1/find-by-metadata"
4 
5 payload = { "metadata": [
6         {
7             "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
8             "content": { "content": { "key": "value" } }
9         },
10         {
11             "schema_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
12             "content": { "content": { "key": "value" } }
13         }
14     ] }
15 headers = {
16     "Authorization": "<token>.",
17     "Content-Type": "application/json"
18 }
19 
20 response = requests.post(url, json=payload, headers=headers)
21 
22 print(response.json())

200Successful

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

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

This endpoint expects an object.

metadatalist of objectsRequired

Filter by metadata schema instances. This will return all charge captures that match any of the provided schema instances.

limitintegerOptional

Maximum number of entities per page, defaults to 100.

page_tokenstringOptional

Response

This endpoint returns an object.

item_countinteger

itemslist of objects

next_page_tokenstring

prev_page_tokenstring