Elation Health Appointments API

Scheduling and appointment management

Documentation GitHub OpenAPI

Business capability

Scheduling & Appointment Management BC-2800.10

Operations 23

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

DELETE /appointments/{id}/ Delete a calendar event (legacy endpoint) · Delete Event #

Ask an LLM

“How do I remove a scheduled event using the legacy appointments API?”

“Can I take an event off the calendar with the old unversioned endpoint?”

Tell an agent destructive · confirm first

Delete legacy event {id}.

Remove event {id} from the calendar using the original endpoint.

GET /appointments/{id}/ Look up a calendar event (legacy endpoint) · Get Event #

Ask an LLM

“How do I pull up one scheduled event by its id on the legacy appointments path?”

“What does the original unversioned appointments endpoint return for a single event?”

Tell an agent

Fetch legacy calendar event {id}.

Show me event {id} from the old appointments endpoint.

PUT /appointments/{id}/ Replace a calendar event (legacy PUT) · Update Event #

Ask an LLM

“Can I overwrite an entire event record through the legacy appointments PUT?”

“Which legacy call does a full replacement of a scheduled event?”

Tell an agent

Replace event {id} in full via the legacy PUT endpoint.

Overwrite every field of legacy event {id}.

PATCH /appointments/{id}/ Patch a calendar event (legacy PATCH) · Update Event #

Ask an LLM

“Can I change just part of an event with the legacy PATCH call?”

“What legacy endpoint edits a few fields on an existing event?”

Tell an agent

Patch a few fields on legacy event {id}.

Apply a partial edit to event {id} through the old PATCH route.

POST /appointments/ Book a calendar event (legacy endpoint) · Create Event #

Ask an LLM

“How do I schedule a patient event with a physician through the legacy appointments API?”

“Which fields must I send to create an event on the old unversioned endpoint?”

Tell an agent

Schedule a legacy event for patient {patient} with physician {physician} at practice {practice} on {scheduled_date} for {reason}, slot type {time_slot_type}.

Create an old-style {time_slot_type} event on {scheduled_date} for patient {patient}.

GET /appointments/ Find calendar events by slot type (legacy) · Find Events #

Ask an LLM

“How can I search the calendar for events of one time slot type?”

“Can I narrow the legacy event search to one physician and a date window?”

Tell an agent

Find {time_slot_type} events for physician {physician} between {from_date} and {to_date}.

Search legacy calendar events with slot type {time_slot_type}.

GET /appointments/rooms List appointment rooms for a practice · Find Appointment Rooms #

Ask an LLM

“Which exam rooms can appointments be booked into at my practice?”

“Can I see the rooms configured for scheduling?”

Tell an agent

List appointment rooms for practice {practice}.

Show every bookable appointment room.

PATCH /appointments/id/ Assign a patient to an appointment slot · Update Appointment Slot #

Ask an LLM

“Can I put a patient into an open appointment slot?”

“What does patching an appointment slot require?”

Tell an agent

Fill the appointment slot with patient {patient}.

Patch the open slot so it holds patient {patient}.

PUT /appointments/id/ Replace an appointment slot · Update Appointment Slot #

Ask an LLM

“How do I fully replace an appointment slot record?”

“Which call overwrites a whole appointment slot at once?”

Tell an agent

Replace appointment slot {id}.

Overwrite slot {id} with new slot details.

OPTIONS /appointments/slots/ Create an appointment slot · Create Appointment Slot #

Ask an LLM

“How do I open a new appointment slot on the schedule?”

“Can I add bookable slots through the slots endpoint?”

Tell an agent

Create a new appointment slot.

Add an open slot to the schedule.

GET /appointments/ [WIP] Find calendar events (WIP draft endpoint) · Find Events [WIP] #

Ask an LLM

“Is there a work-in-progress version of the event search?”

“What does the WIP find-events endpoint filter on?”

Tell an agent

Run the WIP event search for slot type {time_slot_type}.

Use the draft WIP finder to list {time_slot_type} events from {from_date}.

POST /appointments/ [WIP] Book a calendar event (WIP draft endpoint) · Create Event [WIP] #

Ask an LLM

“Is there a WIP version of event creation I can test against?”

“What does the work-in-progress create-event call need?”

Tell an agent

Create a WIP event for patient {patient} with physician {physician} on {scheduled_date}, slot type {time_slot_type}.

Use the draft WIP endpoint to book {reason} at practice {practice}.

PUT /appointments/{id}/ [WIP] Replace an event (WIP draft PUT) · Update Event [WIP] #

Ask an LLM

“Can the WIP endpoint overwrite a whole event?”

“Which WIP call replaces every field of an event?”

Tell an agent

Replace WIP event {id} with date {scheduled_date} and reason {reason}.

Fully rewrite event {id} through the WIP PUT.

PATCH /appointments/{id}/ [WIP] Patch an event (WIP draft PATCH) · Update Event [WIP] #

Ask an LLM

“Can I move just the date of an event using the WIP PATCH?”

“Does the WIP event PATCH accept a single changed field?”

Tell an agent

Reschedule WIP event {id} to {scheduled_date}.

Change the duration of event {id} to {duration} with the WIP PATCH.

POST /appointments/[WIP] Create an appointment with status (WIP) · Create Appointment [WIP] #

Ask an LLM

“Can I set an appointment's status and billing details when creating it in the WIP API?”

“Which WIP endpoint creates an appointment with metadata attached?”

Tell an agent

Create a WIP appointment for patient {patient} with physician {physician} on {scheduled_date} with status {status}.

Draft-create an appointment at practice {practice} for {reason} with metadata {metadata}.

PUT /appointments/{id}/ [WIP] Replace an appointment (WIP PUT) · Update Appointment [WIP] #

Ask an LLM

“How do I replace an appointment including its billing details via the WIP API?”

“Is there a WIP full-replace for appointments that includes status?”

Tell an agent

Replace WIP appointment {id} with status {status} and date {scheduled_date}.

Rewrite appointment {id} including billing details {billing_details} via the WIP PUT.

PATCH /appointments/{id}/ [WIP] Patch an appointment's status (WIP) · Update Appointment [WIP] #

Ask an LLM

“Can I change only an appointment's status with the WIP PATCH?”

“What WIP call edits an appointment's metadata without resending the rest?”

Tell an agent

Set the status of WIP appointment {id} to {status}.

Patch metadata {metadata} onto appointment {id} through the WIP route.

GET /api/2.0/appointments/ List appointments with filters · List Appointments #

Ask an LLM

“How do I list a patient's appointments in Elation?”

“Can I filter appointments by physician, practice and a date range?”

Tell an agent

List appointments for patient {patient} from {from_date} to {to_date}.

Show physician {physician}'s appointments ordered by {order_by}.

POST /api/2.0/appointments/ Schedule a new appointment · Create Appointment #

Ask an LLM

“What do I need to book a patient appointment through API v2?”

“Can I create a telehealth appointment with a specific appointment type?”

Tell an agent

Book patient {patient} with physician {physician} at practice {practice} on {scheduled_date}.

Create a telehealth appointment of type {appointment_type_id} for patient {patient} on {scheduled_date}.

DELETE /api/2.0/appointments/{id}/ Delete an appointment · Delete Appointment #

Ask an LLM

“How do I delete an appointment in v2?”

“Can a booked appointment be removed through the API?”

Tell an agent destructive · confirm first

Delete appointment {id}.

Remove v2 appointment {id} from the schedule.

GET /api/2.0/appointments/{id}/ Get one appointment's details · Retrieve Appointment #

Ask an LLM

“How do I get the full details of one appointment?”

“What does a single appointment record include in v2?”

Tell an agent

Get appointment {id}.

Retrieve the v2 appointment record {id}.

PATCH /api/2.0/appointments/{id}/ Reschedule or edit part of an appointment · Partially Update Appointment #

Ask an LLM

“Can I reschedule an appointment by changing just its date?”

“Where do I update only an appointment's status in v2?”

Tell an agent

Move appointment {id} to {scheduled_date}.

Set v2 appointment {id} status to {status}.

PUT /api/2.0/appointments/{id}/ Replace an appointment record · Update Appointment #

Ask an LLM

“Can I replace an entire appointment record in v2?”

“Which v2 call overwrites all appointment fields at once?”

Tell an agent

Replace appointment {id} with a new date {scheduled_date} for patient {patient}.

Overwrite v2 appointment {id} in full.

Elation Health Appointments API

Operations 23

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification