Create With Mrn

Beta

POST

/patients/v1/with_mrn

POST

/patients/v1/with_mrn

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

Try it

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       "service_facilities": [
235         {
236           "service_facility_id": "service_facility_id"
237         },
238         {
239           "service_facility_id": "service_facility_id"
240         }
241       ]
242     },
243     {
244       "name": {
245         "family": "family",
246         "given": [
247           "given",
248           "given"
249         ],
250         "use": "USUAL",
251         "period": {
252           "start": "2023-01-15",
253           "end": "2023-01-15"
254         },
255         "suffix": "suffix"
256       },
257       "telecoms": [
258         {
259           "value": "value",
260           "use": "HOME",
261           "period": {
262             "start": "2023-01-15",
263             "end": "2023-01-15"
264           }
265         },
266         {
267           "value": "value",
268           "use": "HOME",
269           "period": {
270             "start": "2023-01-15",
271             "end": "2023-01-15"
272           }
273         }
274       ],
275       "type": "PRIMARY",
276       "npi": "npi",
277       "addresses": [
278         {
279           "use": "HOME",
280           "line": [
281             "line",
282             "line"
283           ],
284           "city": "city",
285           "state": "state",
286           "postal_code": "postal_code",
287           "country": "country",
288           "period": {
289             "start": "2023-01-15",
290             "end": "2023-01-15"
291           }
292         },
293         {
294           "use": "HOME",
295           "line": [
296             "line",
297             "line"
298           ],
299           "city": "city",
300           "state": "state",
301           "postal_code": "postal_code",
302           "country": "country",
303           "period": {
304             "start": "2023-01-15",
305             "end": "2023-01-15"
306           }
307         }
308       ],
309       "period": {
310         "start": "2023-01-15",
311         "end": "2023-01-15"
312       },
313       "canonical_id": "canonical_id",
314       "fax": "fax",
315       "service_facilities": [
316         {
317           "service_facility_id": "service_facility_id"
318         },
319         {
320           "service_facility_id": "service_facility_id"
321         }
322       ]
323     }
324   ],
325   "id": "id",
326   "mrn": "mrn",
327   "name": {
328     "family": "family",
329     "given": [
330       "given",
331       "given"
332     ],
333     "use": "USUAL",
334     "period": {
335       "start": "2023-01-15",
336       "end": "2023-01-15"
337     },
338     "suffix": "suffix"
339   },
340   "organization_id": "organization_id",
341   "other_addresses": [
342     {
343       "use": "HOME",
344       "line": [
345         "line",
346         "line"
347       ],
348       "city": "city",
349       "state": "state",
350       "postal_code": "postal_code",
351       "country": "country",
352       "period": {
353         "start": "2023-01-15",
354         "end": "2023-01-15"
355       }
356     },
357     {
358       "use": "HOME",
359       "line": [
360         "line",
361         "line"
362       ],
363       "city": "city",
364       "state": "state",
365       "postal_code": "postal_code",
366       "country": "country",
367       "period": {
368         "start": "2023-01-15",
369         "end": "2023-01-15"
370       }
371     }
372   ],
373   "other_names": [
374     {
375       "family": "family",
376       "given": [
377         "given",
378         "given"
379       ],
380       "use": "USUAL",
381       "period": {
382         "start": "2023-01-15",
383         "end": "2023-01-15"
384       },
385       "suffix": "suffix"
386     },
387     {
388       "family": "family",
389       "given": [
390         "given",
391         "given"
392       ],
393       "use": "USUAL",
394       "period": {
395         "start": "2023-01-15",
396         "end": "2023-01-15"
397       },
398       "suffix": "suffix"
399     }
400   ],
401   "other_telecoms": [
402     {
403       "value": "value",
404       "use": "HOME",
405       "period": {
406         "start": "2023-01-15",
407         "end": "2023-01-15"
408       }
409     },
410     {
411       "value": "value",
412       "use": "HOME",
413       "period": {
414         "start": "2023-01-15",
415         "end": "2023-01-15"
416       }
417     }
418   ],
419   "primary_address": {
420     "use": "HOME",
421     "line": [
422       "line",
423       "line"
424     ],
425     "city": "city",
426     "state": "state",
427     "postal_code": "postal_code",
428     "country": "country",
429     "period": {
430       "start": "2023-01-15",
431       "end": "2023-01-15"
432     }
433   },
434   "updated_at": "2024-01-15T09:30:00Z",
435   "updating_user_id": "updating_user_id",
436   "version": 1,
437   "authorizations": [
438     {
439       "payer_id": "payer_id",
440       "payer_name": "payer_name",
441       "authorization_number": "authorization_number",
442       "cpt_code": "cpt_code",
443       "units": "VISIT",
444       "additional_payer_information": {
445         "availity_eligibility_id": "availity_eligibility_id",
446         "availity_payer_id": "availity_payer_id",
447         "availity_payer_name": "availity_payer_name",
448         "availity_remittance_payer_id": "availity_remittance_payer_id"
449       },
450       "apply_for_all_cpt_codes": true,
451       "no_prior_authorization_required": true,
452       "quantity": 1,
453       "period": {
454         "start": "2023-01-15",
455         "end": "2023-01-15"
456       },
457       "notes": "notes"
458     },
459     {
460       "payer_id": "payer_id",
461       "payer_name": "payer_name",
462       "authorization_number": "authorization_number",
463       "cpt_code": "cpt_code",
464       "units": "VISIT",
465       "additional_payer_information": {
466         "availity_eligibility_id": "availity_eligibility_id",
467         "availity_payer_id": "availity_payer_id",
468         "availity_payer_name": "availity_payer_name",
469         "availity_remittance_payer_id": "availity_remittance_payer_id"
470       },
471       "apply_for_all_cpt_codes": true,
472       "no_prior_authorization_required": true,
473       "quantity": 1,
474       "period": {
475         "start": "2023-01-15",
476         "end": "2023-01-15"
477       },
478       "notes": "notes"
479     }
480   ],
481   "deceased": "2024-01-15T09:30:00Z",
482   "disability_status": "DISABLED",
483   "do_not_invoice_reason": "BANKRUPTCY",
484   "electronic_communication_opt_in": true,
485   "email": "email",
486   "ethnicity": "HISPANIC_OR_LATINO",
487   "external_provenance": {
488     "external_id": "external_id",
489     "system_name": "system_name"
490   },
491   "gender": "MAN",
492   "guarantor": {
493     "name": {
494       "family": "family",
495       "given": [
496         "given",
497         "given"
498       ],
499       "use": "USUAL",
500       "period": {
501         "start": "2023-01-15",
502         "end": "2023-01-15"
503       },
504       "suffix": "suffix"
505     },
506     "address": {
507       "use": "HOME",
508       "line": [
509         "line",
510         "line"
511       ],
512       "city": "city",
513       "state": "state",
514       "postal_code": "postal_code",
515       "country": "country",
516       "period": {
517         "start": "2023-01-15",
518         "end": "2023-01-15"
519       }
520     },
521     "telecom": {
522       "value": "value",
523       "use": "HOME",
524       "period": {
525         "start": "2023-01-15",
526         "end": "2023-01-15"
527       }
528     },
529     "email": "email",
530     "birth_date": "2023-01-15"
531   },
532   "inferred_patient_metadata": {
533     "inferred_encounter_id": "inferred_encounter_id",
534     "inferred_encounter_latest_date_of_service": "2023-01-15"
535   },
536   "language": "language",
537   "marital_status": "ANNULLED",
538   "multiple_birth": 1,
539   "non_insurance_payer_associations": [
540     {
541       "id": "id",
542       "member_id": "member_id",
543       "period": {
544         "start": "2023-01-15",
545         "end": "2023-01-15"
546       },
547       "clinical_trial_info": [
548         {
549           "id": "id",
550           "clinical_trial_arm": "clinical_trial_arm",
551           "period": {
552             "start": "2023-01-15",
553             "end": "2023-01-15"
554           }
555         },
556         {
557           "id": "id",
558           "clinical_trial_arm": "clinical_trial_arm",
559           "period": {
560             "start": "2023-01-15",
561             "end": "2023-01-15"
562           }
563         }
564       ]
565     },
566     {
567       "id": "id",
568       "member_id": "member_id",
569       "period": {
570         "start": "2023-01-15",
571         "end": "2023-01-15"
572       },
573       "clinical_trial_info": [
574         {
575           "id": "id",
576           "clinical_trial_arm": "clinical_trial_arm",
577           "period": {
578             "start": "2023-01-15",
579             "end": "2023-01-15"
580           }
581         },
582         {
583           "id": "id",
584           "clinical_trial_arm": "clinical_trial_arm",
585           "period": {
586             "start": "2023-01-15",
587             "end": "2023-01-15"
588           }
589         }
590       ]
591     }
592   ],
593   "note_ids": [
594     "note_ids",
595     "note_ids"
596   ],
597   "orcon": true,
598   "origination_detail": {
599     "referral_source": "HOSPITAL",
600     "referring_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             "start": "2023-01-15",
620             "end": "2023-01-15"
621           }
622         },
623         {
624           "value": "value",
625           "use": "HOME",
626           "period": {
627             "start": "2023-01-15",
628             "end": "2023-01-15"
629           }
630         }
631       ],
632       "type": "PRIMARY",
633       "npi": "npi",
634       "addresses": [
635         {
636           "use": "HOME",
637           "line": [
638             "line",
639             "line"
640           ],
641           "city": "city",
642           "state": "state",
643           "postal_code": "postal_code",
644           "country": "country",
645           "period": {}
646         },
647         {
648           "use": "HOME",
649           "line": [
650             "line",
651             "line"
652           ],
653           "city": "city",
654           "state": "state",
655           "postal_code": "postal_code",
656           "country": "country",
657           "period": {}
658         }
659       ],
660       "period": {
661         "start": "2023-01-15",
662         "end": "2023-01-15"
663       },
664       "canonical_id": "canonical_id",
665       "fax": "fax",
666       "service_facilities": [
667         {
668           "service_facility_id": "service_facility_id"
669         },
670         {
671           "service_facility_id": "service_facility_id"
672         }
673       ]
674     },
675     "specialization_categories": [
676       "BEHAVIORAL_HEALTH_THERAPY",
677       "BEHAVIORAL_HEALTH_THERAPY"
678     ],
679     "referral_type": "DIRECTED"
680   },
681   "other_identifiers": [
682     {
683       "value": "value",
684       "system": "system",
685       "period": {
686         "start": "2023-01-15",
687         "end": "2023-01-15"
688       }
689     },
690     {
691       "value": "value",
692       "system": "system",
693       "period": {
694         "start": "2023-01-15",
695         "end": "2023-01-15"
696       }
697     }
698   ],
699   "photo": "photo",
700   "primary_service_facility_id": "primary_service_facility_id",
701   "primary_telecom": {
702     "value": "value",
703     "use": "HOME",
704     "period": {
705       "start": "2023-01-15",
706       "end": "2023-01-15"
707     }
708   },
709   "pronouns": [
710     "pronouns",
711     "pronouns"
712   ],
713   "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
714   "referrals": [
715     {
716       "provider": {
717         "name": {
718           "family": "family",
719           "given": [
720             "given",
721             "given"
722           ],
723           "use": "USUAL",
724           "period": {
725             "start": "2023-01-15",
726             "end": "2023-01-15"
727           },
728           "suffix": "suffix"
729         },
730         "telecoms": [
731           {
732             "value": "value",
733             "use": "HOME",
734             "period": {
735               "start": "2023-01-15",
736               "end": "2023-01-15"
737             }
738           },
739           {
740             "value": "value",
741             "use": "HOME",
742             "period": {
743               "start": "2023-01-15",
744               "end": "2023-01-15"
745             }
746           }
747         ],
748         "type": "PRIMARY",
749         "npi": "npi",
750         "addresses": [
751           {
752             "use": "HOME",
753             "line": [
754               "line",
755               "line"
756             ],
757             "city": "city",
758             "state": "state",
759             "postal_code": "postal_code",
760             "country": "country",
761             "period": {}
762           },
763           {
764             "use": "HOME",
765             "line": [
766               "line",
767               "line"
768             ],
769             "city": "city",
770             "state": "state",
771             "postal_code": "postal_code",
772             "country": "country",
773             "period": {}
774           }
775         ],
776         "period": {
777           "start": "2023-01-15",
778           "end": "2023-01-15"
779         },
780         "canonical_id": "canonical_id",
781         "fax": "fax",
782         "service_facilities": [
783           {
784             "service_facility_id": "service_facility_id"
785           },
786           {
787             "service_facility_id": "service_facility_id"
788           }
789         ]
790       },
791       "referral_number": "referral_number",
792       "period": {
793         "start": "2023-01-15",
794         "end": "2023-01-15"
795       },
796       "notes": "notes",
797       "serviceFacility": {
798         "service_facility_id": "service_facility_id"
799       },
800       "units": "VISIT",
801       "quantity": 1,
802       "cptCodes": [
803         "cptCodes",
804         "cptCodes"
805       ],
806       "applyForAllCptCodes": true
807     },
808     {
809       "provider": {
810         "name": {
811           "family": "family",
812           "given": [
813             "given",
814             "given"
815           ],
816           "use": "USUAL",
817           "period": {
818             "start": "2023-01-15",
819             "end": "2023-01-15"
820           },
821           "suffix": "suffix"
822         },
823         "telecoms": [
824           {
825             "value": "value",
826             "use": "HOME",
827             "period": {
828               "start": "2023-01-15",
829               "end": "2023-01-15"
830             }
831           },
832           {
833             "value": "value",
834             "use": "HOME",
835             "period": {
836               "start": "2023-01-15",
837               "end": "2023-01-15"
838             }
839           }
840         ],
841         "type": "PRIMARY",
842         "npi": "npi",
843         "addresses": [
844           {
845             "use": "HOME",
846             "line": [
847               "line",
848               "line"
849             ],
850             "city": "city",
851             "state": "state",
852             "postal_code": "postal_code",
853             "country": "country",
854             "period": {}
855           },
856           {
857             "use": "HOME",
858             "line": [
859               "line",
860               "line"
861             ],
862             "city": "city",
863             "state": "state",
864             "postal_code": "postal_code",
865             "country": "country",
866             "period": {}
867           }
868         ],
869         "period": {
870           "start": "2023-01-15",
871           "end": "2023-01-15"
872         },
873         "canonical_id": "canonical_id",
874         "fax": "fax",
875         "service_facilities": [
876           {
877             "service_facility_id": "service_facility_id"
878           },
879           {
880             "service_facility_id": "service_facility_id"
881           }
882         ]
883       },
884       "referral_number": "referral_number",
885       "period": {
886         "start": "2023-01-15",
887         "end": "2023-01-15"
888       },
889       "notes": "notes",
890       "serviceFacility": {
891         "service_facility_id": "service_facility_id"
892       },
893       "units": "VISIT",
894       "quantity": 1,
895       "cptCodes": [
896         "cptCodes",
897         "cptCodes"
898       ],
899       "applyForAllCptCodes": true
900     }
901   ],
902   "self_pay": true,
903   "service_facilities": [
904     {
905       "service_facility_id": "service_facility_id"
906     },
907     {
908       "service_facility_id": "service_facility_id"
909     }
910   ],
911   "sexual_orientation": "HETEROSEXUAL",
912   "social_security_number": "social_security_number",
913   "tag_ids": [
914     "tag_ids",
915     "tag_ids"
916   ],
917   "non_insurance_payers": [
918     "non_insurance_payers",
919     "non_insurance_payers"
920   ]
921 }

Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient is created their MRN will not be editable. BadRequestError is returned when the MRN is greater than 20 characters. VersionConflictError is returned when the patient’s external ID is already in use.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query Parameters

skip_duplicate_checkbooleanOptional

Request

This endpoint expects an object.

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:

birth_datedateRequired

contactslist of objectsRequired

Contacts for the patient.

filing_orderobjectRequired

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

general_practitionerslist of objectsRequired

mrnstringRequired

The medical record number for the patient.

nameobjectRequired

other_addresseslist of objectsRequired

Other addresses for the patient.

other_nameslist of objectsRequired

Other names for the patient.

other_telecomslist of objectsRequired

Other phone numbers for the patient.

primary_addressobjectRequired

The primary address for the patient.

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.

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

inferred_patient_metadataobjectOptional

Metadata for the patient used for patient inference from encounters.

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

orconbooleanOptional

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

origination_detailobjectOptional

Information about the patient source, if applicable.

other_identifierslist of objectsOptional

Other identifiers for the patient.

photostringOptional

primary_service_facility_idstringOptional

primary_telecomobjectOptional

The primary phone number for the patient.

pronounslist of stringsOptional

The pronouns of the patient.

raceenumOptional

referralslist of objectsOptional

self_paybooleanOptional

service_facilitieslist of objectsOptional

Associated service facilities for this patient.

sexual_orientationenumOptional

The sexual orientation of the patient.

social_security_numberstringOptional

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 “YYMMDD” is the date of patient creation and “XXXX” is a zero-padded incrementing integer.

nameobject

organization_idstring

The organization that owns this object.

other_addresseslist of objects

Other addresses for the patient.

other_nameslist of objects

Other names for the patient.

other_telecomslist of objects

Other phone numbers for the patient.

primary_addressobject

The primary address for the patient.

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

authorizationslist of objects or null

deceaseddatetime or null

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

disability_statusenum or null

Allowed values:

do_not_invoice_reasonenum or null

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

electronic_communication_opt_inboolean or null

emailstring or null

ethnicityenum or null

Allowed values:

external_provenanceobject or null

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

genderenum or null

guarantorobject or null

inferred_patient_metadataobject or null

Metadata for the patient used for patient inference from encounters.

languagestring or null

marital_statusenum or null

multiple_birthinteger or null

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

non_insurance_payer_associationslist of objects or null

note_idslist of strings or null

orconboolean or null

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

origination_detailobject or null

Information about the patient source, if applicable.

other_identifierslist of objects or null

Other identifiers for the patient.

photostring or null

primary_service_facility_idstring or null

primary_telecomobject or null

The primary phone number for the patient.

pronounslist of strings or null

The pronouns of the patient.

raceenum or null

referralslist of objects or null

self_payboolean or null

service_facilitieslist of objects or null

Associated service facilities for this patient.

sexual_orientationenum or null

The sexual orientation of the patient.

social_security_numberstring or null

tag_idslist of strings or null

non_insurance_payerslist of strings or nullDeprecated

Authentication

Query Parameters

Request

Response

Errors