Create appointment

This endpoint books an appointment for the given patient with the given provider at the specified location. When is_guardian is true, the booking is made by a guardian and a patient object with the dependent's details must be provided. Set unavailable to true to create a block instead of a patient appointment.

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

Used to scope the request to the specified institution

int32
required

Used to scope the request to the specified location

boolean
Defaults to false

Send NexHealth appointment created notifications to patient

Body Params

Create appointment

int32
1 to 5
Defaults to 1

Number of appointments (default:1, max:5) that can be booked in a single slot. Only supported for eClinicalWorks and NextGen.

appt
object
required

Appointment detail object

Headers
string
required
Defaults to v3.0.0

The NexHealth API version

Responses

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