Skip to main content
POST
Create a patient

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key
string
required

A unique value you choose for this request, such as a UUID. Sending the same key again returns the first answer instead of doing the work twice, so a timed-out request is safe to retry. Reusing a key for a different request is refused with 409 idempotency_key_conflict, and retrying while the first request is still running with 409 idempotency_key_reused. See Retries and idempotency.

Minimum string length: 1

Path Parameters

clinic_id
string<uuid>
required

Body

application/json

Unknown top-level fields, and every named read-only field (mrn, portal_access_enabled, admission_status, client_status, insurance, pharmacies, care_providers, couple, profile_image, notification_settings — the last refused with the distinct code notification_settings_not_writable), are refused BY NAME, never silently dropped — enforced by the database, not this schema. allergies, current_medications and chronic_conditions are not accepted here either: they are the clinic's reviewed clinical record, so they are refused by name. Send allergies to createAllergy and conditions to createCondition; each is held for a clinician to confirm. They are still returned when you read a patient.

first_name
string
required
Minimum string length: 1
last_name
string
required
Minimum string length: 1
client_type
enum<string>
required
Available options:
adult,
minor
middle_name
string
preferred_name
string
title
string
suffix
string
date_of_birth
string<date>
gender
enum<string>
Available options:
male,
female,
other
marital_status
enum<string>
Available options:
single,
married,
divorced,
widowed,
separated
email
string<email>
phone
string
secondary_phone
string
country
string
nationality
string
occupation
string
residential_address
string
work_address
string
city
string
state
string
zip
string
next_of_kin
object
national_id
string
preferred_language
string
referred_by
string
referral_source_id
string<uuid>
employment
object
is_dependent
boolean
is_waitlist
boolean
sponsor_id
string<uuid>
billing
object
medical_history
string
blood_type
enum<string>
Available options:
O+,
O-,
A+,
A-,
B+,
B-,
AB+,
AB-
genotype
enum<string>
Available options:
AA,
AS,
SS,
AC,
SC
family_history
string
smoking_status
string
alcohol_use
string
recreational_drug_use
string
physical_activity
string
living_arrangement
string
status
enum<string>
Available options:
active,
prospect,
inactive,
blocked
is_vip
boolean
primary_location_id
string<uuid>
emails
object[]
phones
object[]
guardians
object[]
run_automations
boolean
default:false

Default false suppresses the patient.created Agent Studio dispatch.

Response

OK. data carries duplicate_candidates alongside the created record when a possible match was found.

data
object
required