Generated Narrative: OperationDefinition BookAppointment

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.

 <status value="active"/> <kind value="operation"/> <date value="2026-04-02T09:23:40+00:00"/> <publisher value="Service Well AB"/> <contact> <name value="Service Well AB"/> <telecom> <system value="url"/> <value value="https://servicewell.se"/> </telecom> <telecom> <system value="email"/> <value value="info@servicewell.se"/> </telecom> </contact> <description value="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."/> <affectsState value="true"/> <code value="book"/> <base value="https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book"/> <resource value="Appointment"/> <system value="false"/> <type value="true"/> <instance value="false"/> <outputProfile value="https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle"/> <parameter> <name value="appointment"/> <use value="in"/> <min value="1"/> <max value="1"/> <documentation value="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 value="Appointment"/> <targetProfile value="https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt"/> </parameter> <parameter> <name value="return"/> <use value="out"/> <min value="1"/> <max value="1"/> <documentation value="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 value="Bundle"/> </parameter> </OperationDefinition>