ITB - Online appointment booking service
1.0.1 - Documentation update

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.1 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.1
Active as of 2026-06-09 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.

To be able to use this operation the customer must use a "patient-token", i.e the patient must be signed in. To get a patient token the client must resolve the OIDC process.

URL: [base]/Appointment/$book

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INappointment-resource1..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'
INpatient-resource1..1Patient (Portal Patient)

Patient resource for whom the appointment is being booked, modified, or cancelled.

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.