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

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

Get

Next
Built with
Scans up to 1000 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending. **Polling Pattern:** To continuously poll for updates without gaps: 1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`) 2. The API returns 100 by default and up to 1000 patient records, sorted by `updated_at` ascending 3. Find the `updated_at` value from the last record in the response 4. Use that `updated_at` value as the `since` parameter in your next request 5. Repeat steps 2-4 to ingest updates until you receive an empty list **Important Notes:** - The `since` parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version) - All patient records include `updated_at`, `id`, `version`, `deactivated`, and `updating_user` fields for tracking changes - Timestamps have millisecond resolution for precise ordering
Scan

Authentication

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

Query Parameters

sincedatetimeRequired
maxResultsintegerOptional

Response

This endpoint returns a list of objects.
biological_sexenum
The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html
Allowed values:
birth_datedate
contactslist of objects
Contacts for the patient.
deactivatedboolean
True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.
filing_orderobject
The patient's active coverages, in order of primary, secondary, etc.
general_practitionerslist of objects
idstring
The unique UUID identifier for a Patient. Patient ID is used in machine contexts.
mrnstring
The medical record number for the patient. Human-friendly Candid generated MRNs are of the form "YYMMDDXXXX", where "YYMMDD" is the date of patient creation and "XXXX" is a zero-padded incrementing integer.
nameobject
organization_idstring
The organization that owns this object.
other_addresseslist of objects
Other addresses for the patient.
other_nameslist of objects
Other names for the patient.
other_telecomslist of objects
Other phone numbers for the patient.
primary_addressobject
The primary address for the patient.
updated_atdatetime
updating_user_idstring
The user ID of the user who last updated the object.
versioninteger
The version of the object. Any update to any property of an object object will create a new version.
authorizationslist of objects or null
deceaseddatetime or null
Time of death for the patient. Leave unset if the patient is not deceased.
disability_statusenum or null
Allowed values:
do_not_invoice_reasonenum or null
If this value is defined, the customer will not be invoiced.
electronic_communication_opt_inboolean or null
emailstring or null
ethnicityenum or null
Allowed values:
external_provenanceobject or null
Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data.
genderenum or null
guarantorobject or null
inferred_patient_metadataobject or null
Metadata for the patient used for patient inference from encounters.
languagestring or null
marital_statusenum or null
multiple_birthinteger or null
The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth.
non_insurance_payer_associationslist of objects or null
note_idslist of strings or null
orconboolean or null
ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Defaults to false.
origination_detailobject or null
Information about the patient source, if applicable.
other_identifierslist of objects or null
Other identifiers for the patient.
photostring or null
primary_service_facility_idstring or null
primary_telecomobject or null
The primary phone number for the patient.
pronounslist of strings or null
The pronouns of the patient.
raceenum or null
referralslist of objects or null
self_payboolean or null
service_facilitieslist of objects or null
Associated service facilities for this patient.
sexual_orientationenum or null
The sexual orientation of the patient.
social_security_numberstring or null
tag_idslist of strings or null
non_insurance_payerslist of strings or nullDeprecated

Scans up to 1000 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.

Polling Pattern: To continuously poll for updates without gaps:

  1. Make your initial request with a since timestamp (e.g., since=2020-01-01T13:00:00.000Z)
  2. The API returns 100 by default and up to 1000 patient records, sorted by updated_at ascending
  3. Find the updated_at value from the last record in the response
  4. Use that updated_at value as the since parameter in your next request
  5. Repeat steps 2-4 to ingest updates until you receive an empty list

Important Notes:

  • The since parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version)
  • All patient records include updated_at, id, version, deactivated, and updating_user fields for tracking changes
  • Timestamps have millisecond resolution for precise ordering

The biological sex of the patient. This corresponds to the HL7 AdministrativeGender https://www.hl7.org/fhir/valueset-administrative-gender.html

The medical record number for the patient. Human-friendly Candid generated MRNs are of the form “YYMMDDXXXX”, where “YYMMDD” is the date of patient creation and “XXXX” is a zero-padded incrementing integer.

ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Defaults to false.

OAuth authentication of the form <token>.