Update

Beta

PUT

/patients/v1/:id/:version

PUT

/patients/v1/:id/:version

1 import datetime
2 import uuid
3 
4 from candid import CandidApiClient
5 from candid.resources.pre_encounter.resources.common import (
6     Address,
7     AddressUse,
8     ContactPoint,
9     ContactPointUse,
10     ExternalProvider,
11     HumanName,
12     NameUse,
13     Relationship,
14     Sex,
15 )
16 from candid.resources.pre_encounter.resources.patients.resources.v_1 import (
17     Contact,
18     FilingOrder,
19     MutablePatient,
20 )
21 
22 client = CandidApiClient(
23     client_id="YOUR_CLIENT_ID",
24     client_secret="YOUR_CLIENT_SECRET",
25 )
26 client.pre_encounter.patients.v_1.update(
27     id="id",
28     version="version",
29     request=MutablePatient(
30         name=HumanName(
31             family="family",
32             given=["given", "given"],
33             use=NameUse.USUAL,
34         ),
35         other_names=[
36             HumanName(
37                 family="family",
38                 given=["given", "given"],
39                 use=NameUse.USUAL,
40             ),
41             HumanName(
42                 family="family",
43                 given=["given", "given"],
44                 use=NameUse.USUAL,
45             ),
46         ],
47         birth_date=datetime.date.fromisoformat(
48             "2023-01-15",
49         ),
50         biological_sex=Sex.FEMALE,
51         primary_address=Address(
52             use=AddressUse.HOME,
53             line=["line", "line"],
54             city="city",
55             state="state",
56             postal_code="postal_code",
57             country="country",
58         ),
59         other_addresses=[
60             Address(
61                 use=AddressUse.HOME,
62                 line=["line", "line"],
63                 city="city",
64                 state="state",
65                 postal_code="postal_code",
66                 country="country",
67             ),
68             Address(
69                 use=AddressUse.HOME,
70                 line=["line", "line"],
71                 city="city",
72                 state="state",
73                 postal_code="postal_code",
74                 country="country",
75             ),
76         ],
77         primary_telecom=ContactPoint(
78             value="value",
79             use=ContactPointUse.HOME,
80         ),
81         other_telecoms=[
82             ContactPoint(
83                 value="value",
84                 use=ContactPointUse.HOME,
85             ),
86             ContactPoint(
87                 value="value",
88                 use=ContactPointUse.HOME,
89             ),
90         ],
91         contacts=[
92             Contact(
93                 relationship=[Relationship.SELF, Relationship.SELF],
94                 name=HumanName(
95                     family="family",
96                     given=["given", "given"],
97                     use=NameUse.USUAL,
98                 ),
99                 telecoms=[
100                     ContactPoint(
101                         value="value",
102                         use=ContactPointUse.HOME,
103                     ),
104                     ContactPoint(
105                         value="value",
106                         use=ContactPointUse.HOME,
107                     ),
108                 ],
109                 addresses=[
110                     Address(
111                         use=AddressUse.HOME,
112                         line=["line", "line"],
113                         city="city",
114                         state="state",
115                         postal_code="postal_code",
116                         country="country",
117                     ),
118                     Address(
119                         use=AddressUse.HOME,
120                         line=["line", "line"],
121                         city="city",
122                         state="state",
123                         postal_code="postal_code",
124                         country="country",
125                     ),
126                 ],
127             ),
128             Contact(
129                 relationship=[Relationship.SELF, Relationship.SELF],
130                 name=HumanName(
131                     family="family",
132                     given=["given", "given"],
133                     use=NameUse.USUAL,
134                 ),
135                 telecoms=[
136                     ContactPoint(
137                         value="value",
138                         use=ContactPointUse.HOME,
139                     ),
140                     ContactPoint(
141                         value="value",
142                         use=ContactPointUse.HOME,
143                     ),
144                 ],
145                 addresses=[
146                     Address(
147                         use=AddressUse.HOME,
148                         line=["line", "line"],
149                         city="city",
150                         state="state",
151                         postal_code="postal_code",
152                         country="country",
153                     ),
154                     Address(
155                         use=AddressUse.HOME,
156                         line=["line", "line"],
157                         city="city",
158                         state="state",
159                         postal_code="postal_code",
160                         country="country",
161                     ),
162                 ],
163             ),
164         ],
165         general_practitioners=[
166             ExternalProvider(
167                 name=HumanName(
168                     family="family",
169                     given=["given", "given"],
170                     use=NameUse.USUAL,
171                 ),
172                 telecoms=[
173                     ContactPoint(
174                         value="value",
175                         use=ContactPointUse.HOME,
176                     ),
177                     ContactPoint(
178                         value="value",
179                         use=ContactPointUse.HOME,
180                     ),
181                 ],
182             ),
183             ExternalProvider(
184                 name=HumanName(
185                     family="family",
186                     given=["given", "given"],
187                     use=NameUse.USUAL,
188                 ),
189                 telecoms=[
190                     ContactPoint(
191                         value="value",
192                         use=ContactPointUse.HOME,
193                     ),
194                     ContactPoint(
195                         value="value",
196                         use=ContactPointUse.HOME,
197                     ),
198                 ],
199             ),
200         ],
201         filing_order=FilingOrder(
202             coverages=[
203                 uuid.UUID(
204                     "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
205                 ),
206                 uuid.UUID(
207                     "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
208                 ),
209             ],
210         ),
211     ),
212 )

Try it

200Updated

1 {
2   "biological_sex": "FEMALE",
3   "birth_date": "2023-01-15",
4   "contacts": [
5     {
6       "relationship": [
7         "SELF",
8         "SELF"
9       ],
10       "name": {
11         "family": "family",
12         "given": [
13           "given",
14           "given"
15         ],
16         "use": "USUAL",
17         "period": {
18           "start": "2023-01-15",
19           "end": "2023-01-15"
20         },
21         "suffix": "suffix"
22       },
23       "telecoms": [
24         {
25           "value": "value",
26           "use": "HOME",
27           "period": {
28             "start": "2023-01-15",
29             "end": "2023-01-15"
30           }
31         },
32         {
33           "value": "value",
34           "use": "HOME",
35           "period": {
36             "start": "2023-01-15",
37             "end": "2023-01-15"
38           }
39         }
40       ],
41       "addresses": [
42         {
43           "use": "HOME",
44           "line": [
45             "line",
46             "line"
47           ],
48           "city": "city",
49           "state": "state",
50           "postal_code": "postal_code",
51           "country": "country",
52           "period": {
53             "start": "2023-01-15",
54             "end": "2023-01-15"
55           }
56         },
57         {
58           "use": "HOME",
59           "line": [
60             "line",
61             "line"
62           ],
63           "city": "city",
64           "state": "state",
65           "postal_code": "postal_code",
66           "country": "country",
67           "period": {
68             "start": "2023-01-15",
69             "end": "2023-01-15"
70           }
71         }
72       ],
73       "period": {
74         "start": "2023-01-15",
75         "end": "2023-01-15"
76       },
77       "hipaa_authorization": true
78     },
79     {
80       "relationship": [
81         "SELF",
82         "SELF"
83       ],
84       "name": {
85         "family": "family",
86         "given": [
87           "given",
88           "given"
89         ],
90         "use": "USUAL",
91         "period": {
92           "start": "2023-01-15",
93           "end": "2023-01-15"
94         },
95         "suffix": "suffix"
96       },
97       "telecoms": [
98         {
99           "value": "value",
100           "use": "HOME",
101           "period": {
102             "start": "2023-01-15",
103             "end": "2023-01-15"
104           }
105         },
106         {
107           "value": "value",
108           "use": "HOME",
109           "period": {
110             "start": "2023-01-15",
111             "end": "2023-01-15"
112           }
113         }
114       ],
115       "addresses": [
116         {
117           "use": "HOME",
118           "line": [
119             "line",
120             "line"
121           ],
122           "city": "city",
123           "state": "state",
124           "postal_code": "postal_code",
125           "country": "country",
126           "period": {
127             "start": "2023-01-15",
128             "end": "2023-01-15"
129           }
130         },
131         {
132           "use": "HOME",
133           "line": [
134             "line",
135             "line"
136           ],
137           "city": "city",
138           "state": "state",
139           "postal_code": "postal_code",
140           "country": "country",
141           "period": {
142             "start": "2023-01-15",
143             "end": "2023-01-15"
144           }
145         }
146       ],
147       "period": {
148         "start": "2023-01-15",
149         "end": "2023-01-15"
150       },
151       "hipaa_authorization": true
152     }
153   ],
154   "deactivated": true,
155   "filing_order": {
156     "coverages": [
157       "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
158       "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
159     ]
160   },
161   "general_practitioners": [
162     {
163       "name": {
164         "family": "family",
165         "given": [
166           "given",
167           "given"
168         ],
169         "use": "USUAL",
170         "period": {
171           "start": "2023-01-15",
172           "end": "2023-01-15"
173         },
174         "suffix": "suffix"
175       },
176       "telecoms": [
177         {
178           "value": "value",
179           "use": "HOME",
180           "period": {
181             "start": "2023-01-15",
182             "end": "2023-01-15"
183           }
184         },
185         {
186           "value": "value",
187           "use": "HOME",
188           "period": {
189             "start": "2023-01-15",
190             "end": "2023-01-15"
191           }
192         }
193       ],
194       "type": "PRIMARY",
195       "npi": "npi",
196       "addresses": [
197         {
198           "use": "HOME",
199           "line": [
200             "line",
201             "line"
202           ],
203           "city": "city",
204           "state": "state",
205           "postal_code": "postal_code",
206           "country": "country",
207           "period": {
208             "start": "2023-01-15",
209             "end": "2023-01-15"
210           }
211         },
212         {
213           "use": "HOME",
214           "line": [
215             "line",
216             "line"
217           ],
218           "city": "city",
219           "state": "state",
220           "postal_code": "postal_code",
221           "country": "country",
222           "period": {
223             "start": "2023-01-15",
224             "end": "2023-01-15"
225           }
226         }
227       ],
228       "period": {
229         "start": "2023-01-15",
230         "end": "2023-01-15"
231       },
232       "canonical_id": "canonical_id",
233       "fax": "fax"
234     },
235     {
236       "name": {
237         "family": "family",
238         "given": [
239           "given",
240           "given"
241         ],
242         "use": "USUAL",
243         "period": {
244           "start": "2023-01-15",
245           "end": "2023-01-15"
246         },
247         "suffix": "suffix"
248       },
249       "telecoms": [
250         {
251           "value": "value",
252           "use": "HOME",
253           "period": {
254             "start": "2023-01-15",
255             "end": "2023-01-15"
256           }
257         },
258         {
259           "value": "value",
260           "use": "HOME",
261           "period": {
262             "start": "2023-01-15",
263             "end": "2023-01-15"
264           }
265         }
266       ],
267       "type": "PRIMARY",
268       "npi": "npi",
269       "addresses": [
270         {
271           "use": "HOME",
272           "line": [
273             "line",
274             "line"
275           ],
276           "city": "city",
277           "state": "state",
278           "postal_code": "postal_code",
279           "country": "country",
280           "period": {
281             "start": "2023-01-15",
282             "end": "2023-01-15"
283           }
284         },
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           "period": {
296             "start": "2023-01-15",
297             "end": "2023-01-15"
298           }
299         }
300       ],
301       "period": {
302         "start": "2023-01-15",
303         "end": "2023-01-15"
304       },
305       "canonical_id": "canonical_id",
306       "fax": "fax"
307     }
308   ],
309   "id": "id",
310   "mrn": "mrn",
311   "name": {
312     "family": "family",
313     "given": [
314       "given",
315       "given"
316     ],
317     "use": "USUAL",
318     "period": {
319       "start": "2023-01-15",
320       "end": "2023-01-15"
321     },
322     "suffix": "suffix"
323   },
324   "organization_id": "organization_id",
325   "other_addresses": [
326     {
327       "use": "HOME",
328       "line": [
329         "line",
330         "line"
331       ],
332       "city": "city",
333       "state": "state",
334       "postal_code": "postal_code",
335       "country": "country",
336       "period": {
337         "start": "2023-01-15",
338         "end": "2023-01-15"
339       }
340     },
341     {
342       "use": "HOME",
343       "line": [
344         "line",
345         "line"
346       ],
347       "city": "city",
348       "state": "state",
349       "postal_code": "postal_code",
350       "country": "country",
351       "period": {
352         "start": "2023-01-15",
353         "end": "2023-01-15"
354       }
355     }
356   ],
357   "other_names": [
358     {
359       "family": "family",
360       "given": [
361         "given",
362         "given"
363       ],
364       "use": "USUAL",
365       "period": {
366         "start": "2023-01-15",
367         "end": "2023-01-15"
368       },
369       "suffix": "suffix"
370     },
371     {
372       "family": "family",
373       "given": [
374         "given",
375         "given"
376       ],
377       "use": "USUAL",
378       "period": {
379         "start": "2023-01-15",
380         "end": "2023-01-15"
381       },
382       "suffix": "suffix"
383     }
384   ],
385   "other_telecoms": [
386     {
387       "value": "value",
388       "use": "HOME",
389       "period": {
390         "start": "2023-01-15",
391         "end": "2023-01-15"
392       }
393     },
394     {
395       "value": "value",
396       "use": "HOME",
397       "period": {
398         "start": "2023-01-15",
399         "end": "2023-01-15"
400       }
401     }
402   ],
403   "primary_address": {
404     "use": "HOME",
405     "line": [
406       "line",
407       "line"
408     ],
409     "city": "city",
410     "state": "state",
411     "postal_code": "postal_code",
412     "country": "country",
413     "period": {
414       "start": "2023-01-15",
415       "end": "2023-01-15"
416     }
417   },
418   "primary_telecom": {
419     "value": "value",
420     "use": "HOME",
421     "period": {
422       "start": "2023-01-15",
423       "end": "2023-01-15"
424     }
425   },
426   "updated_at": "2024-01-15T09:30:00Z",
427   "updating_user_id": "updating_user_id",
428   "version": 1,
429   "authorizations": [
430     {
431       "payer_id": "payer_id",
432       "payer_name": "payer_name",
433       "authorization_number": "authorization_number",
434       "cpt_code": "cpt_code",
435       "units": "VISIT",
436       "additional_payer_information": {
437         "availity_eligibility_id": "availity_eligibility_id",
438         "availity_payer_id": "availity_payer_id",
439         "availity_payer_name": "availity_payer_name",
440         "availity_remittance_payer_id": "availity_remittance_payer_id"
441       },
442       "apply_for_all_cpt_codes": true,
443       "quantity": 1,
444       "period": {
445         "start": "2023-01-15",
446         "end": "2023-01-15"
447       },
448       "notes": "notes"
449     },
450     {
451       "payer_id": "payer_id",
452       "payer_name": "payer_name",
453       "authorization_number": "authorization_number",
454       "cpt_code": "cpt_code",
455       "units": "VISIT",
456       "additional_payer_information": {
457         "availity_eligibility_id": "availity_eligibility_id",
458         "availity_payer_id": "availity_payer_id",
459         "availity_payer_name": "availity_payer_name",
460         "availity_remittance_payer_id": "availity_remittance_payer_id"
461       },
462       "apply_for_all_cpt_codes": true,
463       "quantity": 1,
464       "period": {
465         "start": "2023-01-15",
466         "end": "2023-01-15"
467       },
468       "notes": "notes"
469     }
470   ],
471   "deceased": "2024-01-15T09:30:00Z",
472   "disability_status": "DISABLED",
473   "do_not_invoice_reason": "BANKRUPTCY",
474   "electronic_communication_opt_in": true,
475   "email": "email",
476   "ethnicity": "HISPANIC_OR_LATINO",
477   "external_provenance": {
478     "external_id": "external_id",
479     "system_name": "system_name"
480   },
481   "gender": "MAN",
482   "guarantor": {
483     "name": {
484       "family": "family",
485       "given": [
486         "given",
487         "given"
488       ],
489       "use": "USUAL",
490       "period": {
491         "start": "2023-01-15",
492         "end": "2023-01-15"
493       },
494       "suffix": "suffix"
495     },
496     "birth_date": "2023-01-15",
497     "address": {
498       "use": "HOME",
499       "line": [
500         "line",
501         "line"
502       ],
503       "city": "city",
504       "state": "state",
505       "postal_code": "postal_code",
506       "country": "country",
507       "period": {
508         "start": "2023-01-15",
509         "end": "2023-01-15"
510       }
511     },
512     "telecom": {
513       "value": "value",
514       "use": "HOME",
515       "period": {
516         "start": "2023-01-15",
517         "end": "2023-01-15"
518       }
519     },
520     "email": "email"
521   },
522   "language": "language",
523   "marital_status": "ANNULLED",
524   "multiple_birth": 1,
525   "non_insurance_payer_associations": [
526     {
527       "id": "id",
528       "member_id": "member_id",
529       "period": {
530         "start": "2023-01-15",
531         "end": "2023-01-15"
532       },
533       "clinical_trial_info": [
534         {
535           "id": "id",
536           "clinical_trial_arm": "clinical_trial_arm",
537           "period": {}
538         },
539         {
540           "id": "id",
541           "clinical_trial_arm": "clinical_trial_arm",
542           "period": {}
543         }
544       ]
545     },
546     {
547       "id": "id",
548       "member_id": "member_id",
549       "period": {
550         "start": "2023-01-15",
551         "end": "2023-01-15"
552       },
553       "clinical_trial_info": [
554         {
555           "id": "id",
556           "clinical_trial_arm": "clinical_trial_arm",
557           "period": {}
558         },
559         {
560           "id": "id",
561           "clinical_trial_arm": "clinical_trial_arm",
562           "period": {}
563         }
564       ]
565     }
566   ],
567   "note_ids": [
568     "note_ids",
569     "note_ids"
570   ],
571   "other_identifiers": [
572     {
573       "value": "value",
574       "system": "system",
575       "period": {
576         "start": "2023-01-15",
577         "end": "2023-01-15"
578       }
579     },
580     {
581       "value": "value",
582       "system": "system",
583       "period": {
584         "start": "2023-01-15",
585         "end": "2023-01-15"
586       }
587     }
588   ],
589   "photo": "photo",
590   "primary_service_facility_id": "primary_service_facility_id",
591   "pronouns": [
592     "pronouns",
593     "pronouns"
594   ],
595   "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
596   "referrals": [
597     {
598       "provider": {
599         "name": {
600           "family": "family",
601           "given": [
602             "given",
603             "given"
604           ],
605           "use": "USUAL",
606           "period": {
607             "start": "2023-01-15",
608             "end": "2023-01-15"
609           },
610           "suffix": "suffix"
611         },
612         "telecoms": [
613           {
614             "value": "value",
615             "use": "HOME",
616             "period": {}
617           },
618           {
619             "value": "value",
620             "use": "HOME",
621             "period": {}
622           }
623         ],
624         "type": "PRIMARY",
625         "npi": "npi",
626         "addresses": [
627           {
628             "use": "HOME",
629             "line": [
630               "line",
631               "line"
632             ],
633             "city": "city",
634             "state": "state",
635             "postal_code": "postal_code",
636             "country": "country",
637             "period": {}
638           },
639           {
640             "use": "HOME",
641             "line": [
642               "line",
643               "line"
644             ],
645             "city": "city",
646             "state": "state",
647             "postal_code": "postal_code",
648             "country": "country",
649             "period": {}
650           }
651         ],
652         "period": {
653           "start": "2023-01-15",
654           "end": "2023-01-15"
655         },
656         "canonical_id": "canonical_id",
657         "fax": "fax"
658       },
659       "referral_number": "referral_number",
660       "period": {
661         "start": "2023-01-15",
662         "end": "2023-01-15"
663       },
664       "notes": "notes"
665     },
666     {
667       "provider": {
668         "name": {
669           "family": "family",
670           "given": [
671             "given",
672             "given"
673           ],
674           "use": "USUAL",
675           "period": {
676             "start": "2023-01-15",
677             "end": "2023-01-15"
678           },
679           "suffix": "suffix"
680         },
681         "telecoms": [
682           {
683             "value": "value",
684             "use": "HOME",
685             "period": {}
686           },
687           {
688             "value": "value",
689             "use": "HOME",
690             "period": {}
691           }
692         ],
693         "type": "PRIMARY",
694         "npi": "npi",
695         "addresses": [
696           {
697             "use": "HOME",
698             "line": [
699               "line",
700               "line"
701             ],
702             "city": "city",
703             "state": "state",
704             "postal_code": "postal_code",
705             "country": "country",
706             "period": {}
707           },
708           {
709             "use": "HOME",
710             "line": [
711               "line",
712               "line"
713             ],
714             "city": "city",
715             "state": "state",
716             "postal_code": "postal_code",
717             "country": "country",
718             "period": {}
719           }
720         ],
721         "period": {
722           "start": "2023-01-15",
723           "end": "2023-01-15"
724         },
725         "canonical_id": "canonical_id",
726         "fax": "fax"
727       },
728       "referral_number": "referral_number",
729       "period": {
730         "start": "2023-01-15",
731         "end": "2023-01-15"
732       },
733       "notes": "notes"
734     }
735   ],
736   "self_pay": true,
737   "sexual_orientation": "HETEROSEXUAL",
738   "social_security_number": "social_security_number",
739   "tag_ids": [
740     "tag_ids",
741     "tag_ids"
742   ],
743   "non_insurance_payers": [
744     "non_insurance_payers",
745     "non_insurance_payers"
746   ]
747 }

Updates a patient. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.

Path parameters

idstringRequired

The unique identifier for a Patient

versionstringRequired

Request

This endpoint expects an object.

nameobjectRequired

other_nameslist of objectsRequired

Other names for the patient.

birth_datedateRequired

biological_sexenumRequired

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

Allowed values:

primary_addressobjectRequired

The primary address for the patient.

other_addresseslist of objectsRequired

Other addresses for the patient.

primary_telecomobjectRequired

The primary phone number for the patient.

other_telecomslist of objectsRequired

Other phone numbers for the patient.

contactslist of objectsRequired

Contacts for the patient.

general_practitionerslist of objectsRequired

filing_orderobjectRequired

The patient's active coverages, in order of primary, secondary, etc.

other_identifierslist of objectsOptional

Other identifiers for the patient.

genderenumOptional

social_security_numberstringOptional

sexual_orientationenumOptional

The sexual orientation of the patient.

pronounslist of stringsOptional

The pronouns of the patient.

raceenumOptional

ethnicityenumOptional

Allowed values:

disability_statusenumOptional

Allowed values:

marital_statusenumOptional

deceaseddatetimeOptional

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

multiple_birthintegerOptional

The number of siblings the patient was born with. Leave unset if the patient was not part of a multiple birth.

emailstringOptional

electronic_communication_opt_inbooleanOptional

photostringOptional

languagestringOptional

external_provenanceobjectOptional

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

non_insurance_payer_associationslist of objectsOptional

guarantorobjectOptional

self_paybooleanOptional

authorizationslist of objectsOptional

referralslist of objectsOptional

primary_service_facility_idstringOptional

do_not_invoice_reasonenumOptional

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

Allowed values:

note_idslist of stringsOptional

tag_idslist of stringsOptional

non_insurance_payerslist of stringsOptionalDeprecated

Response

This endpoint returns an object.

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 “YYYYMMDD” 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.

primary_telecomobject

The primary phone number 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 objectsOptional

deceaseddatetimeOptional

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

disability_statusenumOptional

Allowed values:

do_not_invoice_reasonenumOptional

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

Allowed values:

electronic_communication_opt_inbooleanOptional

emailstringOptional

ethnicityenumOptional

Allowed values:

external_provenanceobjectOptional

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

genderenumOptional

guarantorobjectOptional

languagestringOptional

marital_statusenumOptional

multiple_birthintegerOptional

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 objectsOptional

note_idslist of stringsOptional

other_identifierslist of objectsOptional

Other identifiers for the patient.

photostringOptional

primary_service_facility_idstringOptional

pronounslist of stringsOptional

The pronouns of the patient.

raceenumOptional

referralslist of objectsOptional

self_paybooleanOptional

sexual_orientationenumOptional

The sexual orientation of the patient.

social_security_numberstringOptional

tag_idslist of stringsOptional

non_insurance_payerslist of stringsOptionalDeprecated

Update

Path parameters

Headers

Request

Response

Errors