Skip to main content
PATCH
Update a patient

Authorizations

Authorization
string
header
required

API key passed as a Bearer token

Path Parameters

patient_id
string
required

Body

application/json

Request body for updating a patient. All fields optional; at least one required.

The national identity (idCountry/idType/idValue) is not editable here — it stays the deduplication key. internalCode follows PATCH semantics: omit to leave it unchanged, send null to clear it.

name
string | null

New display name.

Required string length: 1 - 500
Example:

"Jane Doe"

internalCode
string | null

Caller-provided internal code, unique within your institution. Omit to leave unchanged; send null to clear.

Required string length: 1 - 128
Example:

"EMR-99999"

Response

Successful Response

A single patient. id is the stable public id (sp_...).

id
string
required

Stable public identifier.

Example:

"sp_a1b2c3d4e5f6g7h8"

name
string
required
Example:

"John Doe"

createdAt
string
required

ISO-8601 timestamp when the patient was created.

idCountry
string | null
Example:

"COLOMBIA"

idType
string | null
Example:

"CC"

idValue
string | null
Example:

"1024567890"

internalCode
string | null

Caller-provided internal code for your institution (null if none).

Example:

"EMR-12345"