Get History

Beta

GET

/patients/v1/:id/history

GET

/patients/v1/:id/history

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

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

Gets a patient along with it's full history. The return list is ordered by version ascending.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

idstringRequired

The unique identifier for a Patient

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.

advanced_directiveslist of enums

authorizationslist of objects

coverages_for_related_causesobject

Additional coverages for the patient applicable to related causes such as Auto or Workers Comp

deceaseddatetime

Time of death for the patient. Leave unset if the patient is not deceased.

disability_statusenum

Allowed values:

do_not_invoice_reasonenum

If this value is defined, the customer will not be invoiced.

electronic_communication_consentobject

Granular consent for electronic communication channels.

emailstring

ethnicityenum

Allowed values:

external_provenanceobject

Information about the upstream system that owns this patient data. Leave unset if Candid owns patient data.

genderenum

guarantorobject

hipaa_codestring

inferred_patient_metadataobject

Metadata for the patient used for patient inference from encounters.

languagestring

marital_statusenum

multiple_birthinteger

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

note_idslist of strings

orconboolean

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

origination_detailobject

Information about the patient source, if applicable.

other_identifierslist of objects

Other identifiers for the patient.

photostring

primary_service_facility_idstring

primary_telecomobject

The primary phone number for the patient.

pronounslist of strings

The pronouns of the patient.

raceenum

referralslist of objects

self_payboolean

service_facilitieslist of objects

Associated service facilities for this patient.

sexual_orientationenum

The sexual orientation of the patient.

social_security_numberstring

tag_idslist of strings

electronic_communication_opt_inbooleanDeprecated

Use electronic_communication_consent for granular channel-level consent. This field is kept in sync automatically but should not be used for new integrations.

non_insurance_payerslist of stringsDeprecated

Errors

404

Not Found Error

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