HomeGuidesAPI Reference
Log In
API Reference

Create patient

post
https://api.heim.health/v1/patients

Create a patient. A Patient is someone who receives clinical care through the Heim platform

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

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

string | null
enum

Title

Allowed:
string
required
length between 2 and 100

First Name

string
required
length between 2 and 100

Last Name

string | null
enum

Sex

Allowed:
string
required
length between 7 and 16

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

string
required

Email address

string | null

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

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.

string
required

Date of Birth in format

string | null

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

address
array of objects

You may optionally supply a single patient address as an object in the array. This address is then available for selection in the dashboard when creating an Appointment for a Patient.

address
Responses

Updated 12 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago