Appointment

A booked or proposed visit between a patient and practitioners.

With patient/Appointment.rs you see the launched patient's appointments; user/Appointment.rs covers everything on the signed-in clinician's schedule. Appointments reference their participants (Patient, Practitioner, Location) — read those with matching scopes.

Advertises a validated CA Core+ profile.

Access

Mode	Interactions	Scopes
App launch	read + search	`patient/Appointment.rs`, `user/Appointment.rs`
Backend services	read + search	`system/Appointment.rs`

Search parameters

Search results are searchset Bundles; follow the Bundle's next link for cursor pagination.

Parameter	Type	Description
`_id`	token	Match a specific logical resource id.
`_lastUpdated`	date	Filter by last modification time; supports FHIR date prefixes such as ge and lt.
`_count`	number	Page size hint for the searchset Bundle.
`_page_token`	string	Opaque pagination cursor. Never construct one — follow the Bundle's next link.
`date`	date	Appointment start time; supports FHIR date prefixes for ranges.
`patient`	reference	Appointments for a specific Patient.
`practitioner`	reference	Appointments involving a specific Practitioner.
`status`	token	booked, arrived, fulfilled, cancelled, and other appointment statuses.

Upcoming appointments for the launched patient

Request

curl "https://sandbox.avaemr.ca/fhir/r4/{partition_id}/Appointment?patient=Patient/synthetic-patient-1&date=ge2026-08-24&status=booked" \
  -H "Authorization: Bearer $SMART_ACCESS_TOKEN" \
  -H "Accept: application/fhir+json"

Response · launch context

{
  "resourceType": "Bundle",
  "type": "searchset",
  "link": [
    { "relation": "self", "url": "https://sandbox.avaemr.ca/fhir/r4/{partition_id}/Appointment?patient=Patient/synthetic-patient-1&date=ge2026-08-24&status=booked" }
  ],
  "entry": [
    {
      "resource": {
        "resourceType": "Appointment",
        "id": "synthetic-appointment-1",
        "status": "booked",
        "start": "2026-09-02T14:30:00-04:00",
        "end": "2026-09-02T14:50:00-04:00",
        "participant": [
          { "actor": { "reference": "Patient/synthetic-patient-1" }, "status": "accepted" },
          { "actor": { "reference": "Practitioner/synthetic-practitioner-1" }, "status": "accepted" }
        ]
      },
      "search": { "mode": "match" }
    }
  ]
}