ITB - Online appointment booking service
1.0.0 - Initial Release

ITB - Online appointment booking service, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-portal/ and changes regularly. See the Directory of published versions

OperationDefinition: Book / Modify / Cancel Appointment

Official URL: https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/BookAppointment Version: 1.0.0
Active as of 2026-04-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:Portal Find Appointment response

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INappointment1..1Appointment (Appointment Portal)

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'
INappointment-reference0..1Reference (Appointment Portal)

A resource id for one of proposed Appointments returned by a prior $find operation (e.g., Resource/1234). References can be to an absolute URL, but servers only perform this operation on their own appointments.

INpatient-identifier1..*Identifier

The Patient is identified by their personal number. | SHOULD be an identifier system from a national FHIR Patient profile.

INcomment0..1string

The optional comment can be added for additional notes that could be useful for booking, canceling, or modifying an appointment

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.