Scheduling
1.0.0 - Trial-Implementation International flag

This page is part of the IHE ITI Scheduling (v1.0.0: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

OperationDefinition: Book_Appointment_Operation

Official URL: https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book Version: 1.0.0
Active as of 2024-12-12 Computable Name: Book_Appointment_Operation

Request to book a selected Appointment. This operation follows the appointment availability and optional hold interactions. This operation completes the booking of an appointment. The server determines if the nominated appointment is still available (i.e., all the required actors and physical assets needed for the appointment are still available) and either accepts or rejects the book request and updates the resource status accordingly.

In addition to the booking an appointment, this operation can also request to modify or cancel an existing appointment.

Book a New Appointment

When booking a new appoint, the operation SHALL have either an appointment-reference or an appointment-resource parameter. If the appointment-resource parameter is used, the value of Appointment.status SHALL have the value of pending.

A successful new appointment $book operation returns an IHE ITI Appointment resource with the the value of Appointment.status set to booked.

Modify an Existing Appointment

When requesting a modification of an existing appointment, the operation SHALL have an appointment-resource parameter and the value of Appointment.status SHALL have the value of booked.

A successful request to modify an existing modification returns an IHE ITI Appointment resource with the the value of Appointment.status set to booked and the changes that were requested correspondingly reflected in the resource.

Cancel an Existing Appointment

When requesting a cancellation of an existing appointment, the operation SHALL have an appointment-resource parameter and the value of Appointment.status SHALL have the value of cancelled.

A successful request to cancel an existing modification returns an IHE ITI Appointment resource with the the value of Appointment.status set to cancelled

Generated Narrative: OperationDefinition appointment-book

URL: [base]/Appointment/$book

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INappointment-reference0..1Reference (IHE ITI Appointment Profile)

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.

INappointment-resource0..1Appointment (IHE ITI Appointment Profile)

The full appointment resource is needed for appointment change requests

INpatient-resource0..*Patient (Patient)

The Patient resource type is used to provide the patient information as known to the Scheduling client at the time of booking of the appointment.

INcomment0..1string

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

OUTreturn0..1Bundle (IHE ITI Scheduling Bundle Profile)

An IHE ITI Scheduling Appointment Bundle Profile of type searchset consisting of the requested booked Appointment resource and MAY also contain an OperationOutcome with errors, warnings or information as a result of processing the operation. The Appointment resource will have an updated status of "booked" if a new appointment is booked or an existing appointment is modified, or status of "cancelled" if an appointment is cancelled or not created.