Create appointment

post

https://api.heim.health/v1/appointments

Create an appointment

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

To create an appointment

patientId

string

required

The id of the patient. The format is a string starting with p_

taskId

string

required

The Id of the task. The format is a string starting with tsk_

windowId

string | null

The windowId starting with win_ that is obtained from the Availability API. If this is omitted, then patient-led scheduling will be initiated https://docs.heim.health/docs/scheduling-appointments#scheduling-modes where the Patient will choose a window.

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.

note

string | null

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

phoneNumber

string

required

length between 7 and 16

The mobile/cell phone number of the main contact for this Appointment. This number should support SMS messages in order to receive important notifications. Must be a fully qualified number starting with + and the country code, such as +44 or +1 with no spaces in the number.

location

object

required

The location where the appointment will take place. This must be a fully validated address, as no additional validation will occur. A poorly validated address may incur additional charges.

documentIds

array of strings

The optional document ids to attach to the appointment that have already been uploaded. This feature may not be available to your organisation.

documentIds

planFrom

date | null

Only available for appointments of type "scheduled" https://docs.heim.health/docs/scheduling-appointments#appointment-types. This date is used to set the earliest date that the Appointment should happen.

planTo

date | null

Only available for appointments of type "scheduled" https://docs.heim.health/docs/scheduling-appointments#appointment-types. This date is used to set the latest date that the Appointment should happen. Please note that there may be a constraint in place to enforce a minimum number of days between planFrom and planTo dates.

metadata

object | null

A property used to pass additional information for use during the Appointment lifecycle. Please see this guide to using metadata https://docs.heim.health/docs/metadata

Responses

201Appointment created

400Bad request

401Unauthorised