Contact Sales
DocsAPI reference
DocsAPI reference
  • API Reference
Contact Sales
LogoLogo
API ReferencePre EncounterListsV1

Get Appointment List

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

Get

Next
Built with
Get
Searches for appointments that match the query parameters.

Authentication

AuthorizationBearer
OAuth authentication of the form `<token>`.

Query parameters

sort_fieldstringOptional
Defaults to appointment.startTimestamp.
sort_directionenumOptional
Defaults to asc.
Allowed values:
limitintegerOptional
Defaults to 100.
page_tokenstringOptional
A token that can be used to retrieve the next or previous page of results
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', 'ieq'. ieq is a case-insensitive equality operator. 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
Defaults to 100.
A token that can be used to retrieve the next or previous page of results

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’, ‘ieq’. ieq is a case-insensitive equality operator. Path values are camelCase.

OAuth authentication of the form <token>.