Create With Mrn

Beta

POST

/patients/v1/with_mrn

POST

/patients/v1/with_mrn

1 curl -X POST https://pre-api.joincandidhealth.com/patients/v1/with_mrn \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "biological_sex": "FEMALE",
6   "birth_date": "2023-01-15",
7   "contacts": [
8     {
9       "relationship": [
10         "SELF",
11         "SELF"
12       ],
13       "name": {
14         "family": "family",
15         "given": [
16           "given",
17           "given"
18         ],
19         "use": "USUAL"
20       },
21       "telecoms": [
22         {
23           "value": "value",
24           "use": "HOME"
25         },
26         {
27           "value": "value",
28           "use": "HOME"
29         }
30       ],
31       "addresses": [
32         {
33           "use": "HOME",
34           "line": [
35             "line",
36             "line"
37           ],
38           "city": "city",
39           "state": "state",
40           "postal_code": "postal_code",
41           "country": "country"
42         },
43         {
44           "use": "HOME",
45           "line": [
46             "line",
47             "line"
48           ],
49           "city": "city",
50           "state": "state",
51           "postal_code": "postal_code",
52           "country": "country"
53         }
54       ]
55     },
56     {
57       "relationship": [
58         "SELF",
59         "SELF"
60       ],
61       "name": {
62         "family": "family",
63         "given": [
64           "given",
65           "given"
66         ],
67         "use": "USUAL"
68       },
69       "telecoms": [
70         {
71           "value": "value",
72           "use": "HOME"
73         },
74         {
75           "value": "value",
76           "use": "HOME"
77         }
78       ],
79       "addresses": [
80         {
81           "use": "HOME",
82           "line": [
83             "line",
84             "line"
85           ],
86           "city": "city",
87           "state": "state",
88           "postal_code": "postal_code",
89           "country": "country"
90         },
91         {
92           "use": "HOME",
93           "line": [
94             "line",
95             "line"
96           ],
97           "city": "city",
98           "state": "state",
99           "postal_code": "postal_code",
100           "country": "country"
101         }
102       ]
103     }
104   ],
105   "filing_order": {
106     "coverages": [
107       "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
108       "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
109     ]
110   },
111   "general_practitioners": [
112     {
113       "name": {
114         "family": "family",
115         "given": [
116           "given",
117           "given"
118         ],
119         "use": "USUAL"
120       },
121       "telecoms": [
122         {
123           "value": "value",
124           "use": "HOME"
125         },
126         {
127           "value": "value",
128           "use": "HOME"
129         }
130       ]
131     },
132     {
133       "name": {
134         "family": "family",
135         "given": [
136           "given",
137           "given"
138         ],
139         "use": "USUAL"
140       },
141       "telecoms": [
142         {
143           "value": "value",
144           "use": "HOME"
145         },
146         {
147           "value": "value",
148           "use": "HOME"
149         }
150       ]
151     }
152   ],
153   "mrn": "mrn",
154   "name": {
155     "family": "family",
156     "given": [
157       "given",
158       "given"
159     ],
160     "use": "USUAL"
161   },
162   "other_addresses": [
163     {
164       "use": "HOME",
165       "line": [
166         "line",
167         "line"
168       ],
169       "city": "city",
170       "state": "state",
171       "postal_code": "postal_code",
172       "country": "country"
173     },
174     {
175       "use": "HOME",
176       "line": [
177         "line",
178         "line"
179       ],
180       "city": "city",
181       "state": "state",
182       "postal_code": "postal_code",
183       "country": "country"
184     }
185   ],
186   "other_names": [
187     {
188       "family": "family",
189       "given": [
190         "given",
191         "given"
192       ],
193       "use": "USUAL"
194     },
195     {
196       "family": "family",
197       "given": [
198         "given",
199         "given"
200       ],
201       "use": "USUAL"
202     }
203   ],
204   "other_telecoms": [
205     {
206       "value": "value",
207       "use": "HOME"
208     },
209     {
210       "value": "value",
211       "use": "HOME"
212     }
213   ],
214   "primary_address": {
215     "use": "HOME",
216     "line": [
217       "line",
218       "line"
219     ],
220     "city": "city",
221     "state": "state",
222     "postal_code": "postal_code",
223     "country": "country"
224   }
225 }'

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       "billing_provider_npi": "billing_provider_npi"
459     },
460     {
461       "payer_id": "payer_id",
462       "payer_name": "payer_name",
463       "authorization_number": "authorization_number",
464       "cpt_code": "cpt_code",
465       "units": "VISIT",
466       "additional_payer_information": {
467         "availity_eligibility_id": "availity_eligibility_id",
468         "availity_payer_id": "availity_payer_id",
469         "availity_payer_name": "availity_payer_name",
470         "availity_remittance_payer_id": "availity_remittance_payer_id"
471       },
472       "apply_for_all_cpt_codes": true,
473       "no_prior_authorization_required": true,
474       "quantity": 1,
475       "period": {
476         "start": "2023-01-15",
477         "end": "2023-01-15"
478       },
479       "notes": "notes",
480       "billing_provider_npi": "billing_provider_npi"
481     }
482   ],
483   "coverages_for_related_causes": {
484     "coverages": [
485       "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
486       "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"
487     ]
488   },
489   "deceased": "2024-01-15T09:30:00Z",
490   "disability_status": "DISABLED",
491   "do_not_invoice_reason": "BANKRUPTCY",
492   "electronic_communication_opt_in": true,
493   "email": "email",
494   "ethnicity": "HISPANIC_OR_LATINO",
495   "external_provenance": {
496     "external_id": "external_id",
497     "system_name": "system_name"
498   },
499   "gender": "MAN",
500   "guarantor": {
501     "name": {
502       "family": "family",
503       "given": [
504         "given",
505         "given"
506       ],
507       "use": "USUAL",
508       "period": {
509         "start": "2023-01-15",
510         "end": "2023-01-15"
511       },
512       "suffix": "suffix"
513     },
514     "address": {
515       "use": "HOME",
516       "line": [
517         "line",
518         "line"
519       ],
520       "city": "city",
521       "state": "state",
522       "postal_code": "postal_code",
523       "country": "country",
524       "period": {
525         "start": "2023-01-15",
526         "end": "2023-01-15"
527       }
528     },
529     "telecom": {
530       "value": "value",
531       "use": "HOME",
532       "period": {
533         "start": "2023-01-15",
534         "end": "2023-01-15"
535       }
536     },
537     "email": "email",
538     "birth_date": "2023-01-15"
539   },
540   "inferred_patient_metadata": {
541     "inferred_encounter_id": "inferred_encounter_id",
542     "inferred_encounter_latest_date_of_service": "2023-01-15"
543   },
544   "language": "language",
545   "marital_status": "ANNULLED",
546   "multiple_birth": 1,
547   "non_insurance_payer_associations": [
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             "start": "2023-01-15",
561             "end": "2023-01-15"
562           }
563         },
564         {
565           "id": "id",
566           "clinical_trial_arm": "clinical_trial_arm",
567           "period": {
568             "start": "2023-01-15",
569             "end": "2023-01-15"
570           }
571         }
572       ]
573     },
574     {
575       "id": "id",
576       "member_id": "member_id",
577       "period": {
578         "start": "2023-01-15",
579         "end": "2023-01-15"
580       },
581       "clinical_trial_info": [
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           "id": "id",
592           "clinical_trial_arm": "clinical_trial_arm",
593           "period": {
594             "start": "2023-01-15",
595             "end": "2023-01-15"
596           }
597         }
598       ]
599     }
600   ],
601   "note_ids": [
602     "note_ids",
603     "note_ids"
604   ],
605   "orcon": true,
606   "origination_detail": {
607     "referral_source": "HOSPITAL",
608     "referring_provider": {
609       "name": {
610         "family": "family",
611         "given": [
612           "given",
613           "given"
614         ],
615         "use": "USUAL",
616         "period": {
617           "start": "2023-01-15",
618           "end": "2023-01-15"
619         },
620         "suffix": "suffix"
621       },
622       "telecoms": [
623         {
624           "value": "value",
625           "use": "HOME",
626           "period": {
627             "start": "2023-01-15",
628             "end": "2023-01-15"
629           }
630         },
631         {
632           "value": "value",
633           "use": "HOME",
634           "period": {
635             "start": "2023-01-15",
636             "end": "2023-01-15"
637           }
638         }
639       ],
640       "type": "PRIMARY",
641       "npi": "npi",
642       "addresses": [
643         {
644           "use": "HOME",
645           "line": [
646             "line",
647             "line"
648           ],
649           "city": "city",
650           "state": "state",
651           "postal_code": "postal_code",
652           "country": "country",
653           "period": {}
654         },
655         {
656           "use": "HOME",
657           "line": [
658             "line",
659             "line"
660           ],
661           "city": "city",
662           "state": "state",
663           "postal_code": "postal_code",
664           "country": "country",
665           "period": {}
666         }
667       ],
668       "period": {
669         "start": "2023-01-15",
670         "end": "2023-01-15"
671       },
672       "canonical_id": "canonical_id",
673       "fax": "fax",
674       "service_facilities": [
675         {
676           "service_facility_id": "service_facility_id"
677         },
678         {
679           "service_facility_id": "service_facility_id"
680         }
681       ]
682     },
683     "specialization_categories": [
684       "BEHAVIORAL_HEALTH_THERAPY",
685       "BEHAVIORAL_HEALTH_THERAPY"
686     ],
687     "referral_type": "DIRECTED"
688   },
689   "other_identifiers": [
690     {
691       "value": "value",
692       "system": "system",
693       "period": {
694         "start": "2023-01-15",
695         "end": "2023-01-15"
696       }
697     },
698     {
699       "value": "value",
700       "system": "system",
701       "period": {
702         "start": "2023-01-15",
703         "end": "2023-01-15"
704       }
705     }
706   ],
707   "photo": "photo",
708   "primary_service_facility_id": "primary_service_facility_id",
709   "primary_telecom": {
710     "value": "value",
711     "use": "HOME",
712     "period": {
713       "start": "2023-01-15",
714       "end": "2023-01-15"
715     }
716   },
717   "pronouns": [
718     "pronouns",
719     "pronouns"
720   ],
721   "race": "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
722   "referrals": [
723     {
724       "provider": {
725         "name": {
726           "family": "family",
727           "given": [
728             "given",
729             "given"
730           ],
731           "use": "USUAL",
732           "period": {
733             "start": "2023-01-15",
734             "end": "2023-01-15"
735           },
736           "suffix": "suffix"
737         },
738         "telecoms": [
739           {
740             "value": "value",
741             "use": "HOME",
742             "period": {
743               "start": "2023-01-15",
744               "end": "2023-01-15"
745             }
746           },
747           {
748             "value": "value",
749             "use": "HOME",
750             "period": {
751               "start": "2023-01-15",
752               "end": "2023-01-15"
753             }
754           }
755         ],
756         "type": "PRIMARY",
757         "npi": "npi",
758         "addresses": [
759           {
760             "use": "HOME",
761             "line": [
762               "line",
763               "line"
764             ],
765             "city": "city",
766             "state": "state",
767             "postal_code": "postal_code",
768             "country": "country",
769             "period": {}
770           },
771           {
772             "use": "HOME",
773             "line": [
774               "line",
775               "line"
776             ],
777             "city": "city",
778             "state": "state",
779             "postal_code": "postal_code",
780             "country": "country",
781             "period": {}
782           }
783         ],
784         "period": {
785           "start": "2023-01-15",
786           "end": "2023-01-15"
787         },
788         "canonical_id": "canonical_id",
789         "fax": "fax",
790         "service_facilities": [
791           {
792             "service_facility_id": "service_facility_id"
793           },
794           {
795             "service_facility_id": "service_facility_id"
796           }
797         ]
798       },
799       "referral_number": "referral_number",
800       "period": {
801         "start": "2023-01-15",
802         "end": "2023-01-15"
803       },
804       "notes": "notes",
805       "serviceFacility": {
806         "service_facility_id": "service_facility_id"
807       },
808       "units": "VISIT",
809       "quantity": 1,
810       "cptCodes": [
811         "cptCodes",
812         "cptCodes"
813       ],
814       "applyForAllCptCodes": true
815     },
816     {
817       "provider": {
818         "name": {
819           "family": "family",
820           "given": [
821             "given",
822             "given"
823           ],
824           "use": "USUAL",
825           "period": {
826             "start": "2023-01-15",
827             "end": "2023-01-15"
828           },
829           "suffix": "suffix"
830         },
831         "telecoms": [
832           {
833             "value": "value",
834             "use": "HOME",
835             "period": {
836               "start": "2023-01-15",
837               "end": "2023-01-15"
838             }
839           },
840           {
841             "value": "value",
842             "use": "HOME",
843             "period": {
844               "start": "2023-01-15",
845               "end": "2023-01-15"
846             }
847           }
848         ],
849         "type": "PRIMARY",
850         "npi": "npi",
851         "addresses": [
852           {
853             "use": "HOME",
854             "line": [
855               "line",
856               "line"
857             ],
858             "city": "city",
859             "state": "state",
860             "postal_code": "postal_code",
861             "country": "country",
862             "period": {}
863           },
864           {
865             "use": "HOME",
866             "line": [
867               "line",
868               "line"
869             ],
870             "city": "city",
871             "state": "state",
872             "postal_code": "postal_code",
873             "country": "country",
874             "period": {}
875           }
876         ],
877         "period": {
878           "start": "2023-01-15",
879           "end": "2023-01-15"
880         },
881         "canonical_id": "canonical_id",
882         "fax": "fax",
883         "service_facilities": [
884           {
885             "service_facility_id": "service_facility_id"
886           },
887           {
888             "service_facility_id": "service_facility_id"
889           }
890         ]
891       },
892       "referral_number": "referral_number",
893       "period": {
894         "start": "2023-01-15",
895         "end": "2023-01-15"
896       },
897       "notes": "notes",
898       "serviceFacility": {
899         "service_facility_id": "service_facility_id"
900       },
901       "units": "VISIT",
902       "quantity": 1,
903       "cptCodes": [
904         "cptCodes",
905         "cptCodes"
906       ],
907       "applyForAllCptCodes": true
908     }
909   ],
910   "self_pay": true,
911   "service_facilities": [
912     {
913       "service_facility_id": "service_facility_id"
914     },
915     {
916       "service_facility_id": "service_facility_id"
917     }
918   ],
919   "sexual_orientation": "HETEROSEXUAL",
920   "social_security_number": "social_security_number",
921   "tag_ids": [
922     "tag_ids",
923     "tag_ids"
924   ],
925   "non_insurance_payers": [
926     "non_insurance_payers",
927     "non_insurance_payers"
928   ]
929 }

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

coverages_for_related_causesobjectOptional

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

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. Updates made in the Candid UI will unset this flag. 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

coverages_for_related_causesobject

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

deceaseddatetime

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

disability_statusenum

Allowed values:

do_not_invoice_reasonenum

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

electronic_communication_opt_inboolean

emailstring

ethnicityenum

Allowed values:

external_provenanceobject

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

genderenum

guarantorobject

inferred_patient_metadataobject

Metadata for the patient used for patient inference from encounters.

languagestring

marital_statusenum

multiple_birthinteger

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

non_insurance_payer_associationslist of objects

note_idslist of strings

orconboolean

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

origination_detailobject

Information about the patient source, if applicable.

other_identifierslist of objects

Other identifiers for the patient.

photostring

primary_service_facility_idstring

primary_telecomobject

The primary phone number for the patient.

pronounslist of strings

The pronouns of the patient.

raceenum

referralslist of objects

self_payboolean

service_facilitieslist of objects

Associated service facilities for this patient.

sexual_orientationenum

The sexual orientation of the patient.

social_security_numberstring

tag_idslist of strings

non_insurance_payerslist of stringsDeprecated

Errors

400

Bad Request Error

409

Version Conflict Error