WOF Connect📍
0.1.1 - ci-build [WIP]

This page is part of the WOF Connect Implementation Guide (v0.1.1: Pre-Release Draft) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 0.1.3. For a full list of available versions, see the Directory of published versions

OperationDefinition: Book / Modify / Cancel Appointment

Official URL: http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/BookAppointment Version: 0.1.1
Active as of 2026-03-20 Computable Name: BookAppointment

Creates, modifies, or cancels an Appointment based on the supplied Appointment resource.

This operation corresponds to the IHE ITI Scheduling $book operation and:

  • CREATES a new Appointment when a new, schedulable Appointment is supplied
  • MODIFIES an existing Appointment when an updated Appointment is supplied
  • CANCELS an existing Appointment when a cancellation Appointment is supplied

On success, the operation returns the finalized Appointment in an IHE Scheduled Availability Bundle.

URL: [base]/Appointment/$book

Output parameters Profile:IHE ITI Scheduling Bundle Profile

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INappointment1..1Appointment (IHE ITI Appointment Profile)

The Appointment to be created, modified, or cancelled.

  • CREATE:
    • Appointment.id is absent or refers to a non-existing appointment
    • Appointment.status is 'pending'
  • MODIFY:
    • Appointment.id identifies an existing appointment
    • Appointment.status is 'booked' and details (time, participants, etc.) are updated
  • CANCEL:
    • Appointment.id identifies an existing appointment
    • Appointment.status is 'cancelled'
OUTreturn1..1Bundle

On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:

  • status 'booked' for created or modified appointments
  • status 'cancelled' for cancelled appointments

On error, an OperationOutcome is returned instead of this parameter.