Skip to main content
POST
Create a patient

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

idempotency-key
string

Client-generated UUID, honoured for 24 hours. Fails closed: if the idempotency store is unreachable the write is refused with 503 idempotency_unavailable and nothing reaches the EHR, rather than proceeding with the guarantee silently withdrawn. Omit the header to accept at-least-once instead.

X-Organization-Id
string
required

Target clinic organization ID

Body

application/json
firstName
string
required
Example:

"Jane"

lastName
string
required
Example:

"Doe"

dateOfBirth
string
required

YYYY-MM-DD

Example:

"1984-02-11"

middleName
string
Example:

"Marie"

sex
string

MALE | FEMALE | vendor value; the adapter maps it

Example:

"FEMALE"

email
string
Example:

"jane@example.com"

phones
object[]
address
object
primaryFacilityId
string

Primary facility ID (fac_…)

checkForDuplicates
boolean

Ask the EHR to dedupe-check before committing. When candidates are found the write is WITHHELD and the response is 409 duplicate_candidates — surfacing that is what stops a booking flow creating duplicate charts.

Example:

true

insurance
object
consents
object

Response

Created

code
string
required

Response code

Example:

"success"

data
object
required