Skip to main content
POST
Create a new patient

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Body

application/json
name
string
required

Patient display name. If omitted, first_name and/or last_name are used.

Minimum string length: 1
Example:

"Maria Santos"

first_name
string

Patient first name

Minimum string length: 1
Example:

"Maria"

last_name
string

Patient last name

Minimum string length: 1
Example:

"Santos"

date_of_birth
string

Date of birth (YYYY-MM-DD)

Minimum string length: 1
Example:

"1990-03-15"

gender
string

Patient gender

Minimum string length: 1
Example:

"female"

phone
string

Patient phone number

Minimum string length: 1
Example:

"+14155550123"

email
string<email>

Patient email

Example:

"maria@example.com"

address
any | null

Structured address JSON

mrn
string | null

Medical record number (optional). Omit, or send null/empty when the patient has no MRN.

Maximum string length: 64
Example:

"MRN-12345"

external_id
string

Optional caller-supplied identifier. Unique per organization; immutable once set. Duplicate values return 409 with the existing record.

Required string length: 1 - 255
Example:

"PARTNER-12345"

provider_id
string

Optional internal provider id (see GET /providers) to assign this patient to. Must be a provider in your organization. Defaults to the provider that owns the API key.

Minimum string length: 1
Example:

"aaaaaaa1-0000-0000-0000-000000000001"

Response

Patient created

data
object
required