Get Visits

Beta

GET

/appointments/v1/visits

GET

/appointments/v1/visits

$ curl https://pre-api.joincandidhealth.com/appointments/v1/visits \
>      -H "Authorization: Bearer <token>"

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

Gets all Visits within a given time range. The return list is ordered by start_time ascending.

IMPORTANT: This endpoint requires a date filter on appointment.startTimestamp to ensure acceptable query performance. Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.

Example filters:

appointment.startTimestamp|gt|2024-01-01 - appointments after January 1, 2024
appointment.startTimestamp|eq|2024-12-08 - appointments on December 8, 2024
appointment.startTimestamp|lt|2024-12-31 - appointments before December 31, 2024

You can combine the date filter with other filters using commas:

appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING

Gets all Visits within a given time range. The return list is ordered by start_time ascending. **IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance. Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations. Example filters: - `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024 - `appointment.startTimestamp|eq|2024-12-08` - appointments on December 8, 2024 - `appointment.startTimestamp|lt|2024-12-31` - appointments before December 31, 2024 You can combine the date filter with other filters using commas: - `appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING`

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

page_tokenstringOptional

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

limitintegerOptional

sort_fieldstringOptional

Defaults to appointment.start_time.

sort_directionenumOptional

Defaults to ascending.

Allowed values:

filtersstringOptional

Required: Must include a date filter on appointment.startTimestamp (using gt, lt, or eq operators). Example: appointment.startTimestamp|gt|2024-01-01

Response

This endpoint returns an object.

itemslist of objects

totalinteger

next_page_tokenstring

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

prev_page_tokenstring

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

Errors

400

Bad Request Error

$	curl https://pre-api.joincandidhealth.com/appointments/v1/visits \
>	-H "Authorization: Bearer <token>"