Appointment

Last updated: 16 Sep 2025

Introduction #

The Appointment model represents a single scheduled meeting from a patient, that may be in the future or past.

Basic usage #

To get an appointment by identifier, use the get method on the Appointment model manager:

from canvas_sdk.v1.data.appointment import Appointment

appointment = Appointment.objects.get(id="f53626e4-0683-43ac-a1b7-c52815639ce2")

If you have a patient object, the appointments for a patient can be accessed with the appointments attribute on a Patient object:

from canvas_sdk.v1.data.patient import Patient

patient = Patient.objects.get(id="1eed3ea2a8d546a1b681a2a45de1d790")
appointments = patient.appointments.all()

To get appointments part of a recurrence.

from canvas_sdk.v1.data.appointment import Appointment

appointment = Appointment.objects.get(id="f53626e4-0683-43ac-a1b7-c52815639ce2")

# parent appointment
parent_appointment = appointment.parent_appointment

# children appointments
children = parent_appointment.children.all()

Filtering #

Appointments can be filtered by any attribute that exists on the model.

Filtering for appointments is done with the filter method on the Appointment model manager.

By attribute #

Specify an attribute with filter to filter by that attribute:

from canvas_sdk.v1.data.appointment import Appointment, AppointmentProgressStatus

appointments = Appointment.objects.filter(status=AppointmentProgressStatus.CONFIRMED)

Filtering by External Identifiers #

To query Appointments by external identifiers, the external_identifiers relation can be used with double-underscores to identify values stored on the AppointmentExternalIdentifier model. For example:

from canvas_sdk.v1.data.appointment import Appointment

appointment = Appointment.objects.filter(
    external_identifiers__system="COMPANY_IDENTIFIER",
    external_identifiers__value="ejNoTa5vKzoT9oSjg87MVB").first()

Attributes #

Appointment #

Field Name	Type
id	UUID
dbid	Integer
entered_in_error	CanvasUser
patient	Patient
appointment_rescheduled_from	Appointment
parent_appointment	Appointment
provider	Staff
start_time	DateTime
duration_minutes	Integer
comment	String
note_id	Integer
note_type_id	Integer
status	String
meeting_link	URL
telehealth_instructions_sent	Boolean
location	PracticeLocation
description	String
external_identifiers	AppointmentExternalIdentifier[]
metadata	AppointmentMetadata[]

AppointmentExternalIdentifier #

Field Name	Type
id	UUID
dbid	Integer
created	DateTime
modified	DateTime
use	String
identifier_type	String
system	String
value	String
issued_date	Date
expiration_date	Date
appointment	Appointment

AppointmentMetadata #

Field Name	Type
id	UUID
dbid	Integer
appointment	Appointment
key	String
value	String

from canvas_sdk.v1.data.appointment import Appointment
from logger import log

appointment_id = "f53626e4-0683-43ac-a1b7-c52815639ce2"
appointment = Appointment.objects.get(id=appointment_id)
appointment_metadata = appointment.metadata.all()

for metadata in appointment_metadata:
   log.info(f"Appointment metadata: {metadata.key}, {metadata.value}")