BookAppointment
type: OperationDefinition
node role: treeRoot
id:
  v: BookAppointment
text:
  status:
    v: generated
  div:
    v: Generated Narrative: OperationDefinition BookAppointment URL: [base]/Appointment/$book Output parameters Profile:IHE ITI Scheduling Bundle Profile Parameters Use Name Scope Cardinality Type Binding Documentation IN appointment 1..1 Appointment (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' OUT return 1..1 Bundle 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.
url:
  v: http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/BookAppointment
  l: BookAppointment
version:
  v: 0.1.3
name:
  v: BookAppointment
title:
  v: Book / Modify / Cancel Appointment
status:
  v: active
kind:
  v: operation
date:
  v: 2026-04-02T09:23:40+00:00
publisher:
  v: Service Well AB
contact:
  name:
    v: Service Well AB
  telecom:
    system:
      v: url
    value:
      v: https://servicewell.se
  telecom:
    system:
      v: email
description:
  v: 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.
affects state:
  v: true
code:
  v: book
base:
  v: https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book
  l: appointment-book
resource:
  v: Appointment
system:
  v: false
type:
  v: true
instance:
  v: false
output profile:
  v: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle
  l: ihe-sched-avail-bundle
parameter:
  name:
    v: appointment
  use:
    v: in
  min:
    v: 1
  max:
    v: 1
  documentation:
    v: 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'
  type:
    v: Appointment
  target profile:
    v: https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt
    l: ihe-sched-appt
parameter:
  name:
    v: return
  use:
    v: out
  min:
    v: 1
  max:
    v: 1
  documentation:
    v: 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.
  type:
    v: Bundle