Get Patient List

Beta

GET

/lists/v1/patient

GET

/lists/v1/patient

1 from candid import CandidApiClient
2 
3 client = CandidApiClient(
4     client_id="YOUR_CLIENT_ID",
5     client_secret="YOUR_CLIENT_SECRET",
6 )
7 client.pre_encounter.lists.v_1.get_patient_list()

Try it

1 {
2   "items": [
3     {
4       "patient": {
5         "biological_sex": "FEMALE",
6         "birth_date": "2023-01-15",
7         "contacts": [
8           {
9             "relationship": [
10               "SELF",
11               "SELF"
12             ],
13             "name": {
14               "family": "family",
15               "given": [
16                 "given",
17                 "given"
18               ],
19               "use": "USUAL",
20               "period": {},
21               "suffix": "suffix"
22             },
23             "telecoms": [
24               {
25                 "value": "value",
26                 "use": "HOME",
27                 "period": {}
28               },
29               {
30                 "value": "value",
31                 "use": "HOME",
32                 "period": {}
33               }
34             ],
35             "addresses": [
36               {
37                 "use": "HOME",
38                 "line": [
39                   "line",
40                   "line"
41                 ],
42                 "city": "city",
43                 "state": "state",
44                 "postal_code": "postal_code",
45                 "country": "country",
46                 "period": {}
47               },
48               {
49                 "use": "HOME",
50                 "line": [
51                   "line",
52                   "line"
53                 ],
54                 "city": "city",
55                 "state": "state",
56                 "postal_code": "postal_code",
57                 "country": "country",
58                 "period": {}
59               }
60             ],
61             "period": {
62               "start": "2023-01-15",
63               "end": "2023-01-15"
64             },
65             "hipaa_authorization": true
66           },
67           {
68             "relationship": [
69               "SELF",
70               "SELF"
71             ],
72             "name": {
73               "family": "family",
74               "given": [
75                 "given",
76                 "given"
77               ],
78               "use": "USUAL",
79               "period": {},
80               "suffix": "suffix"
81             },
82             "telecoms": [
83               {
84                 "value": "value",
85                 "use": "HOME",
86                 "period": {}
87               },
88               {
89                 "value": "value",
90                 "use": "HOME",
91                 "period": {}
92               }
93             ],
94             "addresses": [
95               {
96                 "use": "HOME",
97                 "line": [
98                   "line",
99                   "line"
100                 ],
101                 "city": "city",
102                 "state": "state",
103                 "postal_code": "postal_code",
104                 "country": "country",
105                 "period": {}
106               },
107               {
108                 "use": "HOME",
109                 "line": [
110                   "line",
111                   "line"
112                 ],
113                 "city": "city",
114                 "state": "state",
115                 "postal_code": "postal_code",
116                 "country": "country",
117                 "period": {}
118               }
119             ],
120             "period": {
121               "start": "2023-01-15",
122               "end": "2023-01-15"
123             },
124             "hipaa_authorization": true
125           }
126         ],
127         "deactivated": true,
128         "filing_order": {
129           "coverages": [
130             "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
131             "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
132           ]
133         },
134         "general_practitioners": [
135           {
136             "name": {
137               "family": "family",
138               "given": [
139                 "given",
140                 "given"
141               ],
142               "use": "USUAL",
143               "period": {},
144               "suffix": "suffix"
145             },
146             "telecoms": [
147               {
148                 "value": "value",
149                 "use": "HOME",
150                 "period": {}
151               },
152               {
153                 "value": "value",
154                 "use": "HOME",
155                 "period": {}
156               }
157             ],
158             "type": "PRIMARY",
159             "npi": "npi",
160             "addresses": [
161               {
162                 "use": "HOME",
163                 "line": [],
164                 "city": "city",
165                 "state": "state",
166                 "postal_code": "postal_code",
167                 "country": "country"
168               },
169               {
170                 "use": "HOME",
171                 "line": [],
172                 "city": "city",
173                 "state": "state",
174                 "postal_code": "postal_code",
175                 "country": "country"
176               }
177             ],
178             "period": {
179               "start": "2023-01-15",
180               "end": "2023-01-15"
181             },
182             "canonical_id": "canonical_id",
183             "fax": "fax"
184           },
185           {
186             "name": {
187               "family": "family",
188               "given": [
189                 "given",
190                 "given"
191               ],
192               "use": "USUAL",
193               "period": {},
194               "suffix": "suffix"
195             },
196             "telecoms": [
197               {
198                 "value": "value",
199                 "use": "HOME",
200                 "period": {}
201               },
202               {
203                 "value": "value",
204                 "use": "HOME",
205                 "period": {}
206               }
207             ],
208             "type": "PRIMARY",
209             "npi": "npi",
210             "addresses": [
211               {
212                 "use": "HOME",
213                 "line": [],
214                 "city": "city",
215                 "state": "state",
216                 "postal_code": "postal_code",
217                 "country": "country"
218               },
219               {
220                 "use": "HOME",
221                 "line": [],
222                 "city": "city",
223                 "state": "state",
224                 "postal_code": "postal_code",
225                 "country": "country"
226               }
227             ],
228             "period": {
229               "start": "2023-01-15",
230               "end": "2023-01-15"
231             },
232             "canonical_id": "canonical_id",
233             "fax": "fax"
234           }
235         ],
236         "id": "id",
237         "mrn": "mrn",
238         "name": {
239           "family": "family",
240           "given": [
241             "given",
242             "given"
243           ],
244           "use": "USUAL",
245           "period": {
246             "start": "2023-01-15",
247             "end": "2023-01-15"
248           },
249           "suffix": "suffix"
250         },
251         "organization_id": "organization_id",
252         "other_addresses": [
253           {
254             "use": "HOME",
255             "line": [
256               "line",
257               "line"
258             ],
259             "city": "city",
260             "state": "state",
261             "postal_code": "postal_code",
262             "country": "country",
263             "period": {
264               "start": "2023-01-15",
265               "end": "2023-01-15"
266             }
267           },
268           {
269             "use": "HOME",
270             "line": [
271               "line",
272               "line"
273             ],
274             "city": "city",
275             "state": "state",
276             "postal_code": "postal_code",
277             "country": "country",
278             "period": {
279               "start": "2023-01-15",
280               "end": "2023-01-15"
281             }
282           }
283         ],
284         "other_names": [
285           {
286             "family": "family",
287             "given": [
288               "given",
289               "given"
290             ],
291             "use": "USUAL",
292             "period": {
293               "start": "2023-01-15",
294               "end": "2023-01-15"
295             },
296             "suffix": "suffix"
297           },
298           {
299             "family": "family",
300             "given": [
301               "given",
302               "given"
303             ],
304             "use": "USUAL",
305             "period": {
306               "start": "2023-01-15",
307               "end": "2023-01-15"
308             },
309             "suffix": "suffix"
310           }
311         ],
312         "other_telecoms": [
313           {
314             "value": "value",
315             "use": "HOME",
316             "period": {
317               "start": "2023-01-15",
318               "end": "2023-01-15"
319             }
320           },
321           {
322             "value": "value",
323             "use": "HOME",
324             "period": {
325               "start": "2023-01-15",
326               "end": "2023-01-15"
327             }
328           }
329         ],
330         "primary_address": {
331           "use": "HOME",
332           "line": [
333             "line",
334             "line"
335           ],
336           "city": "city",
337           "state": "state",
338           "postal_code": "postal_code",
339           "country": "country",
340           "period": {
341             "start": "2023-01-15",
342             "end": "2023-01-15"
343           }
344         },
345         "primary_telecom": {
346           "value": "value",
347           "use": "HOME",
348           "period": {
349             "start": "2023-01-15",
350             "end": "2023-01-15"
351           }
352         },
353         "updated_at": "2024-01-15T09:30:00Z",
354         "updating_user_id": "updating_user_id",
355         "version": 1,
356         "authorizations": [
357           {
358             "payer_id": "payer_id",
359             "payer_name": "payer_name",
360             "authorization_number": "authorization_number",
361             "cpt_code": "cpt_code",
362             "units": "VISIT",
363             "additional_payer_information": {},
364             "apply_for_all_cpt_codes": true,
365             "no_prior_authorization_required": true,
366             "quantity": 1,
367             "period": {},
368             "notes": "notes"
369           },
370           {
371             "payer_id": "payer_id",
372             "payer_name": "payer_name",
373             "authorization_number": "authorization_number",
374             "cpt_code": "cpt_code",
375             "units": "VISIT",
376             "additional_payer_information": {},
377             "apply_for_all_cpt_codes": true,
378             "no_prior_authorization_required": true,
379             "quantity": 1,
380             "period": {},
381             "notes": "notes"
382           }
383         ],
384         "deceased": "2024-01-15T09:30:00Z",
385         "disability_status": "DISABLED",
386         "do_not_invoice_reason": "BANKRUPTCY",
387         "electronic_communication_opt_in": true,
388         "email": "email",
389         "ethnicity": "HISPANIC_OR_LATINO",
390         "external_provenance": {
391           "external_id": "external_id",
392           "system_name": "system_name"
393         },
394         "gender": "MAN",
395         "guarantor": {
396           "name": {
397             "family": "family",
398             "given": [
399               "given",
400               "given"
401             ],
402             "use": "USUAL",
403             "period": {},
404             "suffix": "suffix"
405           },
406           "birth_date": "2023-01-15",
407           "address": {
408             "use": "HOME",
409             "line": [
410               "line",
411               "line"
412             ],
413             "city": "city",
414             "state": "state",
415             "postal_code": "postal_code",
416             "country": "country",
417             "period": {}
418           },
419           "telecom": {
420             "value": "value",
421             "use": "HOME",
422             "period": {}
423           },
424           "email": "email"
425         },
426         "language": "language",
427         "marital_status": "ANNULLED",
428         "multiple_birth": 1,
429         "non_insurance_payer_associations": [
430           {
431             "id": "id",
432             "member_id": "member_id",
433             "period": {},
434             "clinical_trial_info": []
435           },
436           {
437             "id": "id",
438             "member_id": "member_id",
439             "period": {},
440             "clinical_trial_info": []
441           }
442         ],
443         "note_ids": [
444           "note_ids",
445           "note_ids"
446         ],
447         "other_identifiers": [
448           {
449             "value": "value",
450             "system": "system",
451             "period": {}
452           },
453           {
454             "value": "value",
455             "system": "system",
456             "period": {}
457           }
458         ],
459         "photo": "photo",
460         "primary_service_facility_id": "primary_service_facility_id",
461         "pronouns": [
462           "pronouns",
463           "pronouns"
464         ],
465         "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
466         "referrals": [
467           {
468             "provider": {
469               "name": {
470                 "family": "family",
471                 "given": [],
472                 "use": "USUAL"
473               },
474               "telecoms": [],
475               "type": "PRIMARY",
476               "npi": "npi",
477               "addresses": [],
478               "period": {},
479               "canonical_id": "canonical_id",
480               "fax": "fax"
481             },
482             "referral_number": "referral_number",
483             "period": {},
484             "notes": "notes"
485           },
486           {
487             "provider": {
488               "name": {
489                 "family": "family",
490                 "given": [],
491                 "use": "USUAL"
492               },
493               "telecoms": [],
494               "type": "PRIMARY",
495               "npi": "npi",
496               "addresses": [],
497               "period": {},
498               "canonical_id": "canonical_id",
499               "fax": "fax"
500             },
501             "referral_number": "referral_number",
502             "period": {},
503             "notes": "notes"
504           }
505         ],
506         "self_pay": true,
507         "sexual_orientation": "HETEROSEXUAL",
508         "social_security_number": "social_security_number",
509         "tag_ids": [
510           "tag_ids",
511           "tag_ids"
512         ],
513         "non_insurance_payers": [
514           "non_insurance_payers",
515           "non_insurance_payers"
516         ]
517       },
518       "primary_coverage": {
519         "status": "ACTIVE",
520         "subscriber": {
521           "name": {
522             "family": "family",
523             "given": [
524               "given",
525               "given"
526             ],
527             "use": "USUAL",
528             "period": {
529               "start": "2023-01-15",
530               "end": "2023-01-15"
531             },
532             "suffix": "suffix"
533           },
534           "date_of_birth": "2023-01-15",
535           "biological_sex": "FEMALE",
536           "address": {
537             "use": "HOME",
538             "line": [
539               "line",
540               "line"
541             ],
542             "city": "city",
543             "state": "state",
544             "postal_code": "postal_code",
545             "country": "country",
546             "period": {}
547           }
548         },
549         "relationship": "SELF",
550         "patient": "patient",
551         "insurance_plan": {
552           "member_id": "member_id",
553           "payer_id": "payer_id",
554           "payer_name": "payer_name",
555           "additional_payer_information": {
556             "availity_eligibility_id": "availity_eligibility_id",
557             "availity_payer_id": "availity_payer_id",
558             "availity_payer_name": "availity_payer_name",
559             "availity_remittance_payer_id": "availity_remittance_payer_id"
560           },
561           "group_number": "group_number",
562           "name": "name",
563           "plan_type": "09",
564           "type": "01",
565           "period": {
566             "start": "2023-01-15",
567             "end": "2023-01-15"
568           },
569           "insurance_card_image_locator": "insurance_card_image_locator",
570           "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
571         },
572         "verified": true,
573         "eligibility_checks": [
574           {
575             "check_id": "check_id",
576             "service_code": "1",
577             "status": "COMPLETED",
578             "initiated_by": "initiated_by",
579             "initiated_at": "2024-01-15T09:30:00Z"
580           },
581           {
582             "check_id": "check_id",
583             "service_code": "1",
584             "status": "COMPLETED",
585             "initiated_by": "initiated_by",
586             "initiated_at": "2024-01-15T09:30:00Z"
587           }
588         ],
589         "latest_eligibility_check": {
590           "check_id": "check_id",
591           "status": "ACTIVE",
592           "initiated_at": "2024-01-15T09:30:00Z"
593         },
594         "benefits": {
595           "plan_coverage": {
596             "in_network": {},
597             "in_network_flat": [],
598             "out_of_network": {},
599             "out_of_network_flat": []
600           },
601           "service_specific_coverage": [
602             {
603               "service_code": "1"
604             },
605             {
606               "service_code": "1"
607             }
608           ],
609           "benefits_related_entities": [
610             {},
611             {}
612           ],
613           "notes": "notes"
614         }
615       },
616       "next_appointment": {
617         "patient_id": "patient_id",
618         "start_timestamp": "2024-01-15T09:30:00Z",
619         "service_duration": 1,
620         "services": [
621           {
622             "universal_service_identifier": "MD_Visit",
623             "start_timestamp": "2024-01-15T09:30:00Z"
624           },
625           {
626             "universal_service_identifier": "MD_Visit",
627             "start_timestamp": "2024-01-15T09:30:00Z"
628           }
629         ],
630         "status": "PENDING",
631         "placer_appointment_id": "placer_appointment_id",
632         "attending_doctor": {
633           "name": {
634             "family": "family",
635             "given": [
636               "given",
637               "given"
638             ],
639             "use": "USUAL",
640             "period": {},
641             "suffix": "suffix"
642           },
643           "telecoms": [
644             {
645               "value": "value",
646               "use": "HOME",
647               "period": {}
648             },
649             {
650               "value": "value",
651               "use": "HOME",
652               "period": {}
653             }
654           ],
655           "type": "PRIMARY",
656           "npi": "npi",
657           "addresses": [
658             {
659               "use": "HOME",
660               "line": [],
661               "city": "city",
662               "state": "state",
663               "postal_code": "postal_code",
664               "country": "country"
665             },
666             {
667               "use": "HOME",
668               "line": [],
669               "city": "city",
670               "state": "state",
671               "postal_code": "postal_code",
672               "country": "country"
673             }
674           ],
675           "period": {
676             "start": "2023-01-15",
677             "end": "2023-01-15"
678           },
679           "canonical_id": "canonical_id",
680           "fax": "fax"
681         },
682         "estimated_copay_cents": 1,
683         "estimated_patient_responsibility_cents": 1,
684         "patient_deposit_cents": 1,
685         "checked_in_timestamp": "2024-01-15T09:30:00Z",
686         "notes": "notes",
687         "location_resource_id": "location_resource_id",
688         "automated_eligibility_check_complete": true,
689         "work_queue": "EMERGENT_ISSUE"
690       }
691     },
692     {
693       "patient": {
694         "biological_sex": "FEMALE",
695         "birth_date": "2023-01-15",
696         "contacts": [
697           {
698             "relationship": [
699               "SELF",
700               "SELF"
701             ],
702             "name": {
703               "family": "family",
704               "given": [
705                 "given",
706                 "given"
707               ],
708               "use": "USUAL",
709               "period": {},
710               "suffix": "suffix"
711             },
712             "telecoms": [
713               {
714                 "value": "value",
715                 "use": "HOME",
716                 "period": {}
717               },
718               {
719                 "value": "value",
720                 "use": "HOME",
721                 "period": {}
722               }
723             ],
724             "addresses": [
725               {
726                 "use": "HOME",
727                 "line": [
728                   "line",
729                   "line"
730                 ],
731                 "city": "city",
732                 "state": "state",
733                 "postal_code": "postal_code",
734                 "country": "country",
735                 "period": {}
736               },
737               {
738                 "use": "HOME",
739                 "line": [
740                   "line",
741                   "line"
742                 ],
743                 "city": "city",
744                 "state": "state",
745                 "postal_code": "postal_code",
746                 "country": "country",
747                 "period": {}
748               }
749             ],
750             "period": {
751               "start": "2023-01-15",
752               "end": "2023-01-15"
753             },
754             "hipaa_authorization": true
755           },
756           {
757             "relationship": [
758               "SELF",
759               "SELF"
760             ],
761             "name": {
762               "family": "family",
763               "given": [
764                 "given",
765                 "given"
766               ],
767               "use": "USUAL",
768               "period": {},
769               "suffix": "suffix"
770             },
771             "telecoms": [
772               {
773                 "value": "value",
774                 "use": "HOME",
775                 "period": {}
776               },
777               {
778                 "value": "value",
779                 "use": "HOME",
780                 "period": {}
781               }
782             ],
783             "addresses": [
784               {
785                 "use": "HOME",
786                 "line": [
787                   "line",
788                   "line"
789                 ],
790                 "city": "city",
791                 "state": "state",
792                 "postal_code": "postal_code",
793                 "country": "country",
794                 "period": {}
795               },
796               {
797                 "use": "HOME",
798                 "line": [
799                   "line",
800                   "line"
801                 ],
802                 "city": "city",
803                 "state": "state",
804                 "postal_code": "postal_code",
805                 "country": "country",
806                 "period": {}
807               }
808             ],
809             "period": {
810               "start": "2023-01-15",
811               "end": "2023-01-15"
812             },
813             "hipaa_authorization": true
814           }
815         ],
816         "deactivated": true,
817         "filing_order": {
818           "coverages": [
819             "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
820             "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
821           ]
822         },
823         "general_practitioners": [
824           {
825             "name": {
826               "family": "family",
827               "given": [
828                 "given",
829                 "given"
830               ],
831               "use": "USUAL",
832               "period": {},
833               "suffix": "suffix"
834             },
835             "telecoms": [
836               {
837                 "value": "value",
838                 "use": "HOME",
839                 "period": {}
840               },
841               {
842                 "value": "value",
843                 "use": "HOME",
844                 "period": {}
845               }
846             ],
847             "type": "PRIMARY",
848             "npi": "npi",
849             "addresses": [
850               {
851                 "use": "HOME",
852                 "line": [],
853                 "city": "city",
854                 "state": "state",
855                 "postal_code": "postal_code",
856                 "country": "country"
857               },
858               {
859                 "use": "HOME",
860                 "line": [],
861                 "city": "city",
862                 "state": "state",
863                 "postal_code": "postal_code",
864                 "country": "country"
865               }
866             ],
867             "period": {
868               "start": "2023-01-15",
869               "end": "2023-01-15"
870             },
871             "canonical_id": "canonical_id",
872             "fax": "fax"
873           },
874           {
875             "name": {
876               "family": "family",
877               "given": [
878                 "given",
879                 "given"
880               ],
881               "use": "USUAL",
882               "period": {},
883               "suffix": "suffix"
884             },
885             "telecoms": [
886               {
887                 "value": "value",
888                 "use": "HOME",
889                 "period": {}
890               },
891               {
892                 "value": "value",
893                 "use": "HOME",
894                 "period": {}
895               }
896             ],
897             "type": "PRIMARY",
898             "npi": "npi",
899             "addresses": [
900               {
901                 "use": "HOME",
902                 "line": [],
903                 "city": "city",
904                 "state": "state",
905                 "postal_code": "postal_code",
906                 "country": "country"
907               },
908               {
909                 "use": "HOME",
910                 "line": [],
911                 "city": "city",
912                 "state": "state",
913                 "postal_code": "postal_code",
914                 "country": "country"
915               }
916             ],
917             "period": {
918               "start": "2023-01-15",
919               "end": "2023-01-15"
920             },
921             "canonical_id": "canonical_id",
922             "fax": "fax"
923           }
924         ],
925         "id": "id",
926         "mrn": "mrn",
927         "name": {
928           "family": "family",
929           "given": [
930             "given",
931             "given"
932           ],
933           "use": "USUAL",
934           "period": {
935             "start": "2023-01-15",
936             "end": "2023-01-15"
937           },
938           "suffix": "suffix"
939         },
940         "organization_id": "organization_id",
941         "other_addresses": [
942           {
943             "use": "HOME",
944             "line": [
945               "line",
946               "line"
947             ],
948             "city": "city",
949             "state": "state",
950             "postal_code": "postal_code",
951             "country": "country",
952             "period": {
953               "start": "2023-01-15",
954               "end": "2023-01-15"
955             }
956           },
957           {
958             "use": "HOME",
959             "line": [
960               "line",
961               "line"
962             ],
963             "city": "city",
964             "state": "state",
965             "postal_code": "postal_code",
966             "country": "country",
967             "period": {
968               "start": "2023-01-15",
969               "end": "2023-01-15"
970             }
971           }
972         ],
973         "other_names": [
974           {
975             "family": "family",
976             "given": [
977               "given",
978               "given"
979             ],
980             "use": "USUAL",
981             "period": {
982               "start": "2023-01-15",
983               "end": "2023-01-15"
984             },
985             "suffix": "suffix"
986           },
987           {
988             "family": "family",
989             "given": [
990               "given",
991               "given"
992             ],
993             "use": "USUAL",
994             "period": {
995               "start": "2023-01-15",
996               "end": "2023-01-15"
997             },
998             "suffix": "suffix"
999           }
1000         ],
1001         "other_telecoms": [
1002           {
1003             "value": "value",
1004             "use": "HOME",
1005             "period": {
1006               "start": "2023-01-15",
1007               "end": "2023-01-15"
1008             }
1009           },
1010           {
1011             "value": "value",
1012             "use": "HOME",
1013             "period": {
1014               "start": "2023-01-15",
1015               "end": "2023-01-15"
1016             }
1017           }
1018         ],
1019         "primary_address": {
1020           "use": "HOME",
1021           "line": [
1022             "line",
1023             "line"
1024           ],
1025           "city": "city",
1026           "state": "state",
1027           "postal_code": "postal_code",
1028           "country": "country",
1029           "period": {
1030             "start": "2023-01-15",
1031             "end": "2023-01-15"
1032           }
1033         },
1034         "primary_telecom": {
1035           "value": "value",
1036           "use": "HOME",
1037           "period": {
1038             "start": "2023-01-15",
1039             "end": "2023-01-15"
1040           }
1041         },
1042         "updated_at": "2024-01-15T09:30:00Z",
1043         "updating_user_id": "updating_user_id",
1044         "version": 1,
1045         "authorizations": [
1046           {
1047             "payer_id": "payer_id",
1048             "payer_name": "payer_name",
1049             "authorization_number": "authorization_number",
1050             "cpt_code": "cpt_code",
1051             "units": "VISIT",
1052             "additional_payer_information": {},
1053             "apply_for_all_cpt_codes": true,
1054             "no_prior_authorization_required": true,
1055             "quantity": 1,
1056             "period": {},
1057             "notes": "notes"
1058           },
1059           {
1060             "payer_id": "payer_id",
1061             "payer_name": "payer_name",
1062             "authorization_number": "authorization_number",
1063             "cpt_code": "cpt_code",
1064             "units": "VISIT",
1065             "additional_payer_information": {},
1066             "apply_for_all_cpt_codes": true,
1067             "no_prior_authorization_required": true,
1068             "quantity": 1,
1069             "period": {},
1070             "notes": "notes"
1071           }
1072         ],
1073         "deceased": "2024-01-15T09:30:00Z",
1074         "disability_status": "DISABLED",
1075         "do_not_invoice_reason": "BANKRUPTCY",
1076         "electronic_communication_opt_in": true,
1077         "email": "email",
1078         "ethnicity": "HISPANIC_OR_LATINO",
1079         "external_provenance": {
1080           "external_id": "external_id",
1081           "system_name": "system_name"
1082         },
1083         "gender": "MAN",
1084         "guarantor": {
1085           "name": {
1086             "family": "family",
1087             "given": [
1088               "given",
1089               "given"
1090             ],
1091             "use": "USUAL",
1092             "period": {},
1093             "suffix": "suffix"
1094           },
1095           "birth_date": "2023-01-15",
1096           "address": {
1097             "use": "HOME",
1098             "line": [
1099               "line",
1100               "line"
1101             ],
1102             "city": "city",
1103             "state": "state",
1104             "postal_code": "postal_code",
1105             "country": "country",
1106             "period": {}
1107           },
1108           "telecom": {
1109             "value": "value",
1110             "use": "HOME",
1111             "period": {}
1112           },
1113           "email": "email"
1114         },
1115         "language": "language",
1116         "marital_status": "ANNULLED",
1117         "multiple_birth": 1,
1118         "non_insurance_payer_associations": [
1119           {
1120             "id": "id",
1121             "member_id": "member_id",
1122             "period": {},
1123             "clinical_trial_info": []
1124           },
1125           {
1126             "id": "id",
1127             "member_id": "member_id",
1128             "period": {},
1129             "clinical_trial_info": []
1130           }
1131         ],
1132         "note_ids": [
1133           "note_ids",
1134           "note_ids"
1135         ],
1136         "other_identifiers": [
1137           {
1138             "value": "value",
1139             "system": "system",
1140             "period": {}
1141           },
1142           {
1143             "value": "value",
1144             "system": "system",
1145             "period": {}
1146           }
1147         ],
1148         "photo": "photo",
1149         "primary_service_facility_id": "primary_service_facility_id",
1150         "pronouns": [
1151           "pronouns",
1152           "pronouns"
1153         ],
1154         "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
1155         "referrals": [
1156           {
1157             "provider": {
1158               "name": {
1159                 "family": "family",
1160                 "given": [],
1161                 "use": "USUAL"
1162               },
1163               "telecoms": [],
1164               "type": "PRIMARY",
1165               "npi": "npi",
1166               "addresses": [],
1167               "period": {},
1168               "canonical_id": "canonical_id",
1169               "fax": "fax"
1170             },
1171             "referral_number": "referral_number",
1172             "period": {},
1173             "notes": "notes"
1174           },
1175           {
1176             "provider": {
1177               "name": {
1178                 "family": "family",
1179                 "given": [],
1180                 "use": "USUAL"
1181               },
1182               "telecoms": [],
1183               "type": "PRIMARY",
1184               "npi": "npi",
1185               "addresses": [],
1186               "period": {},
1187               "canonical_id": "canonical_id",
1188               "fax": "fax"
1189             },
1190             "referral_number": "referral_number",
1191             "period": {},
1192             "notes": "notes"
1193           }
1194         ],
1195         "self_pay": true,
1196         "sexual_orientation": "HETEROSEXUAL",
1197         "social_security_number": "social_security_number",
1198         "tag_ids": [
1199           "tag_ids",
1200           "tag_ids"
1201         ],
1202         "non_insurance_payers": [
1203           "non_insurance_payers",
1204           "non_insurance_payers"
1205         ]
1206       },
1207       "primary_coverage": {
1208         "status": "ACTIVE",
1209         "subscriber": {
1210           "name": {
1211             "family": "family",
1212             "given": [
1213               "given",
1214               "given"
1215             ],
1216             "use": "USUAL",
1217             "period": {
1218               "start": "2023-01-15",
1219               "end": "2023-01-15"
1220             },
1221             "suffix": "suffix"
1222           },
1223           "date_of_birth": "2023-01-15",
1224           "biological_sex": "FEMALE",
1225           "address": {
1226             "use": "HOME",
1227             "line": [
1228               "line",
1229               "line"
1230             ],
1231             "city": "city",
1232             "state": "state",
1233             "postal_code": "postal_code",
1234             "country": "country",
1235             "period": {}
1236           }
1237         },
1238         "relationship": "SELF",
1239         "patient": "patient",
1240         "insurance_plan": {
1241           "member_id": "member_id",
1242           "payer_id": "payer_id",
1243           "payer_name": "payer_name",
1244           "additional_payer_information": {
1245             "availity_eligibility_id": "availity_eligibility_id",
1246             "availity_payer_id": "availity_payer_id",
1247             "availity_payer_name": "availity_payer_name",
1248             "availity_remittance_payer_id": "availity_remittance_payer_id"
1249           },
1250           "group_number": "group_number",
1251           "name": "name",
1252           "plan_type": "09",
1253           "type": "01",
1254           "period": {
1255             "start": "2023-01-15",
1256             "end": "2023-01-15"
1257           },
1258           "insurance_card_image_locator": "insurance_card_image_locator",
1259           "payer_plan_group_id": "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
1260         },
1261         "verified": true,
1262         "eligibility_checks": [
1263           {
1264             "check_id": "check_id",
1265             "service_code": "1",
1266             "status": "COMPLETED",
1267             "initiated_by": "initiated_by",
1268             "initiated_at": "2024-01-15T09:30:00Z"
1269           },
1270           {
1271             "check_id": "check_id",
1272             "service_code": "1",
1273             "status": "COMPLETED",
1274             "initiated_by": "initiated_by",
1275             "initiated_at": "2024-01-15T09:30:00Z"
1276           }
1277         ],
1278         "latest_eligibility_check": {
1279           "check_id": "check_id",
1280           "status": "ACTIVE",
1281           "initiated_at": "2024-01-15T09:30:00Z"
1282         },
1283         "benefits": {
1284           "plan_coverage": {
1285             "in_network": {},
1286             "in_network_flat": [],
1287             "out_of_network": {},
1288             "out_of_network_flat": []
1289           },
1290           "service_specific_coverage": [
1291             {
1292               "service_code": "1"
1293             },
1294             {
1295               "service_code": "1"
1296             }
1297           ],
1298           "benefits_related_entities": [
1299             {},
1300             {}
1301           ],
1302           "notes": "notes"
1303         }
1304       },
1305       "next_appointment": {
1306         "patient_id": "patient_id",
1307         "start_timestamp": "2024-01-15T09:30:00Z",
1308         "service_duration": 1,
1309         "services": [
1310           {
1311             "universal_service_identifier": "MD_Visit",
1312             "start_timestamp": "2024-01-15T09:30:00Z"
1313           },
1314           {
1315             "universal_service_identifier": "MD_Visit",
1316             "start_timestamp": "2024-01-15T09:30:00Z"
1317           }
1318         ],
1319         "status": "PENDING",
1320         "placer_appointment_id": "placer_appointment_id",
1321         "attending_doctor": {
1322           "name": {
1323             "family": "family",
1324             "given": [
1325               "given",
1326               "given"
1327             ],
1328             "use": "USUAL",
1329             "period": {},
1330             "suffix": "suffix"
1331           },
1332           "telecoms": [
1333             {
1334               "value": "value",
1335               "use": "HOME",
1336               "period": {}
1337             },
1338             {
1339               "value": "value",
1340               "use": "HOME",
1341               "period": {}
1342             }
1343           ],
1344           "type": "PRIMARY",
1345           "npi": "npi",
1346           "addresses": [
1347             {
1348               "use": "HOME",
1349               "line": [],
1350               "city": "city",
1351               "state": "state",
1352               "postal_code": "postal_code",
1353               "country": "country"
1354             },
1355             {
1356               "use": "HOME",
1357               "line": [],
1358               "city": "city",
1359               "state": "state",
1360               "postal_code": "postal_code",
1361               "country": "country"
1362             }
1363           ],
1364           "period": {
1365             "start": "2023-01-15",
1366             "end": "2023-01-15"
1367           },
1368           "canonical_id": "canonical_id",
1369           "fax": "fax"
1370         },
1371         "estimated_copay_cents": 1,
1372         "estimated_patient_responsibility_cents": 1,
1373         "patient_deposit_cents": 1,
1374         "checked_in_timestamp": "2024-01-15T09:30:00Z",
1375         "notes": "notes",
1376         "location_resource_id": "location_resource_id",
1377         "automated_eligibility_check_complete": true,
1378         "work_queue": "EMERGENT_ISSUE"
1379       }
1380     }
1381   ],
1382   "total": 1,
1383   "next_page_token": "next_page_token",
1384   "prev_page_token": "prev_page_token"
1385 }

Gets patients with dependent objects for patients that match the query parameters.

Query parameters

page_tokenstringOptional

A token that can be used to retrieve the next or previous page of results

limitintegerOptional

sort_fieldstringOptional

Defaults to patient.updatedAt.

sort_directionenumOptional

Defaults to ascending.

Allowed values:

filtersstringOptional

A serialized list of filters separated by commas indicating filters to apply. Each filter is of the form ‘path:operator:value’. Example: ‘patient.mrn|eq|12345’. Filters are separated by commas. Example: ‘patient.mrn|eq|12345,appointment.startDate|gt|67890’. All filters are ANDed together. Valid operators are ‘eq’, ‘gt’, ‘lt’, ‘contains’. Path values are camelCase.

Response

This endpoint returns an object.

itemslist of objects

totalinteger

next_page_tokenstring or null

A token that can be used to retrieve the next or previous page of results

prev_page_tokenstring or null

A token that can be used to retrieve the next or previous page of results

Get Patient List

Headers

Query parameters

Response

Errors