POST
Create Patient

Authorizations

Authorization
string
header
required

An EESI API key (sk-eesi-...) or a Clerk session token.

Headers

authorization
string | null
X-API-Key
string | null

Body

application/json
name
string
required
Required string length: 1 - 255
phone_number
string
required
Pattern: ^\+[1-9]\d{1,14}$
preferred_name
string | null
Maximum string length: 128
timezone
string
default:America/Toronto
language
string
default:English
Required string length: 1 - 64
notes
string | null
Maximum string length: 4000
companion_config
CompanionConfig · object

How the companion presents itself to one patient.

care_profile
Care Profile · object
schedules
CareScheduleCreateRequest · object[]
Maximum array length: 10

Response

Successful Response

patient_uuid
string
required
name
string
required
preferred_name
string | null
required
phone_number
string
required
timezone
string
required
language
string
required
notes
string | null
required
companion_config
Companion Config · object
required
care_profile
Care Profile · object
required
status
enum<string>
required
Available options:
active,
paused,
archived
created_at
string<date-time>
required
updated_at
string<date-time>
required
schedules
CareScheduleResponse · object[]
required
latest_call
CareCallResponse · object | null
required
open_alert_count
integer
required
recent_observations
CareObservationResponse · object[]
required