Create

Beta

POST

/patients/v1

POST

/patients/v1

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

Try it

200Successful

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       "no_prior_authorization_required": true,
444       "quantity": 1,
445       "period": {
446         "start": "2023-01-15",
447         "end": "2023-01-15"
448       },
449       "notes": "notes"
450     },
451     {
452       "payer_id": "payer_id",
453       "payer_name": "payer_name",
454       "authorization_number": "authorization_number",
455       "cpt_code": "cpt_code",
456       "units": "VISIT",
457       "additional_payer_information": {
458         "availity_eligibility_id": "availity_eligibility_id",
459         "availity_payer_id": "availity_payer_id",
460         "availity_payer_name": "availity_payer_name",
461         "availity_remittance_payer_id": "availity_remittance_payer_id"
462       },
463       "apply_for_all_cpt_codes": true,
464       "no_prior_authorization_required": true,
465       "quantity": 1,
466       "period": {
467         "start": "2023-01-15",
468         "end": "2023-01-15"
469       },
470       "notes": "notes"
471     }
472   ],
473   "deceased": "2024-01-15T09:30:00Z",
474   "disability_status": "DISABLED",
475   "do_not_invoice_reason": "BANKRUPTCY",
476   "electronic_communication_opt_in": true,
477   "email": "email",
478   "ethnicity": "HISPANIC_OR_LATINO",
479   "external_provenance": {
480     "external_id": "external_id",
481     "system_name": "system_name"
482   },
483   "gender": "MAN",
484   "guarantor": {
485     "name": {
486       "family": "family",
487       "given": [
488         "given",
489         "given"
490       ],
491       "use": "USUAL",
492       "period": {
493         "start": "2023-01-15",
494         "end": "2023-01-15"
495       },
496       "suffix": "suffix"
497     },
498     "birth_date": "2023-01-15",
499     "address": {
500       "use": "HOME",
501       "line": [
502         "line",
503         "line"
504       ],
505       "city": "city",
506       "state": "state",
507       "postal_code": "postal_code",
508       "country": "country",
509       "period": {
510         "start": "2023-01-15",
511         "end": "2023-01-15"
512       }
513     },
514     "telecom": {
515       "value": "value",
516       "use": "HOME",
517       "period": {
518         "start": "2023-01-15",
519         "end": "2023-01-15"
520       }
521     },
522     "email": "email"
523   },
524   "language": "language",
525   "marital_status": "ANNULLED",
526   "multiple_birth": 1,
527   "non_insurance_payer_associations": [
528     {
529       "id": "id",
530       "member_id": "member_id",
531       "period": {
532         "start": "2023-01-15",
533         "end": "2023-01-15"
534       },
535       "clinical_trial_info": [
536         {
537           "id": "id",
538           "clinical_trial_arm": "clinical_trial_arm",
539           "period": {}
540         },
541         {
542           "id": "id",
543           "clinical_trial_arm": "clinical_trial_arm",
544           "period": {}
545         }
546       ]
547     },
548     {
549       "id": "id",
550       "member_id": "member_id",
551       "period": {
552         "start": "2023-01-15",
553         "end": "2023-01-15"
554       },
555       "clinical_trial_info": [
556         {
557           "id": "id",
558           "clinical_trial_arm": "clinical_trial_arm",
559           "period": {}
560         },
561         {
562           "id": "id",
563           "clinical_trial_arm": "clinical_trial_arm",
564           "period": {}
565         }
566       ]
567     }
568   ],
569   "note_ids": [
570     "note_ids",
571     "note_ids"
572   ],
573   "other_identifiers": [
574     {
575       "value": "value",
576       "system": "system",
577       "period": {
578         "start": "2023-01-15",
579         "end": "2023-01-15"
580       }
581     },
582     {
583       "value": "value",
584       "system": "system",
585       "period": {
586         "start": "2023-01-15",
587         "end": "2023-01-15"
588       }
589     }
590   ],
591   "photo": "photo",
592   "primary_service_facility_id": "primary_service_facility_id",
593   "pronouns": [
594     "pronouns",
595     "pronouns"
596   ],
597   "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
598   "referrals": [
599     {
600       "provider": {
601         "name": {
602           "family": "family",
603           "given": [
604             "given",
605             "given"
606           ],
607           "use": "USUAL",
608           "period": {
609             "start": "2023-01-15",
610             "end": "2023-01-15"
611           },
612           "suffix": "suffix"
613         },
614         "telecoms": [
615           {
616             "value": "value",
617             "use": "HOME",
618             "period": {}
619           },
620           {
621             "value": "value",
622             "use": "HOME",
623             "period": {}
624           }
625         ],
626         "type": "PRIMARY",
627         "npi": "npi",
628         "addresses": [
629           {
630             "use": "HOME",
631             "line": [
632               "line",
633               "line"
634             ],
635             "city": "city",
636             "state": "state",
637             "postal_code": "postal_code",
638             "country": "country",
639             "period": {}
640           },
641           {
642             "use": "HOME",
643             "line": [
644               "line",
645               "line"
646             ],
647             "city": "city",
648             "state": "state",
649             "postal_code": "postal_code",
650             "country": "country",
651             "period": {}
652           }
653         ],
654         "period": {
655           "start": "2023-01-15",
656           "end": "2023-01-15"
657         },
658         "canonical_id": "canonical_id",
659         "fax": "fax"
660       },
661       "referral_number": "referral_number",
662       "period": {
663         "start": "2023-01-15",
664         "end": "2023-01-15"
665       },
666       "notes": "notes"
667     },
668     {
669       "provider": {
670         "name": {
671           "family": "family",
672           "given": [
673             "given",
674             "given"
675           ],
676           "use": "USUAL",
677           "period": {
678             "start": "2023-01-15",
679             "end": "2023-01-15"
680           },
681           "suffix": "suffix"
682         },
683         "telecoms": [
684           {
685             "value": "value",
686             "use": "HOME",
687             "period": {}
688           },
689           {
690             "value": "value",
691             "use": "HOME",
692             "period": {}
693           }
694         ],
695         "type": "PRIMARY",
696         "npi": "npi",
697         "addresses": [
698           {
699             "use": "HOME",
700             "line": [
701               "line",
702               "line"
703             ],
704             "city": "city",
705             "state": "state",
706             "postal_code": "postal_code",
707             "country": "country",
708             "period": {}
709           },
710           {
711             "use": "HOME",
712             "line": [
713               "line",
714               "line"
715             ],
716             "city": "city",
717             "state": "state",
718             "postal_code": "postal_code",
719             "country": "country",
720             "period": {}
721           }
722         ],
723         "period": {
724           "start": "2023-01-15",
725           "end": "2023-01-15"
726         },
727         "canonical_id": "canonical_id",
728         "fax": "fax"
729       },
730       "referral_number": "referral_number",
731       "period": {
732         "start": "2023-01-15",
733         "end": "2023-01-15"
734       },
735       "notes": "notes"
736     }
737   ],
738   "self_pay": true,
739   "sexual_orientation": "HETEROSEXUAL",
740   "social_security_number": "social_security_number",
741   "tag_ids": [
742     "tag_ids",
743     "tag_ids"
744   ],
745   "non_insurance_payers": [
746     "non_insurance_payers",
747     "non_insurance_payers"
748   ]
749 }

Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.

Query parameters

skip_duplicate_checkbooleanOptional

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 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.

Allowed values:

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

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

other_identifierslist of objects or null

Other identifiers for the patient.

photostring or null

primary_service_facility_idstring or null

pronounslist of strings or null

The pronouns of the patient.

raceenum or null

referralslist of objects or null

self_payboolean or null

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

Create

Headers

Query parameters

Request

Response

Errors