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: Hold_Appointment_Operation

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

Request for a hold on a selected Appointment in order for the user to complete entering data for booking an appointment. This operation precedes the booking and follows the appointment availability interaction. 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 hold request and updates the resource status accordingly.

Generated Narrative: OperationDefinition appointment-hold

URL: [base]/Appointment/$hold

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INappointment-reference1..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.

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

An IHE ITI Scheduling Appointment Bundle Profile of type searchset consisting of the requested held 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 "pending" if the hold is approved or "cancelled" if the hold is rejected.