Update patient

put

https://api.heim.health/v1/patients/{patientId}

Update patient details by patient id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

patientId

string

required

Pass the patient Id. The format is a string starting with p_

Body Params

A JSON object containing the information required to update a patient.

title

string | null

enum

Title

Allowed:

firstName

string

length between 2 and 100

First Name

lastName

string

length between 2 and 100

Last Name

sex

string | null

enum

Sex

Allowed:

phoneNumber

string

length between 7 and 16

Phone number in the E.164 format. See https://www.twilio.com/docs/glossary/what-e164

string

Email address

nhsNumber

string | null

The Patient's NHS number. This is a 10-digit number without spaces.

externalRef

string | null

An optional external reference you provide from your system. You may filter list responses with this reference to easily find a resource on the Heim platform. Uniqueness is not enforced.

dateOfBirth

string

Date of Birth in format

note

string | null

A note visible to the Practitioner who carries out the task.

Responses

200

Patient updated

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Patient created

400Bad request

401Unauthorised

404Not found