Skip to main content
PUT
Set a patient's external ID for a given type

Authorizations

X-API-Key
string
header
required

Path Parameters

patient_id
string<uuid>
required

Patient UUID

external_id_type_id
string<uuid>
required

External ID type UUID

Body

application/json

PUT body — only value is mutable.

value
string
required
Required string length: 1 - 500

Response

Updated

Response shape for the patient external-ids endpoints AND for the embedded external_id_values field on PatientResponse.

id
string<uuid>
required
patient_id
string<uuid>
required
value
string
required
external_id_type
ExternalIdTypeSummary · object
required

Read-only summary of an external_id_types row.

Used embedded in ExternalIdValueResponse (where created_at stays None) and as the body of GET /v1/external-id-types (where it's populated).

created_at
string<date-time>
required
updated_at
string<date-time>
required