0.1.0 - ci-build
0.1.0 - ci-build
TCFHIRAGSchedulingR5 - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/OperationDefinition/slot-hold | Version: 0.1.0 | |||
| Active as of 2025-02-07 | Responsible: HL7® Austria, TC FHIR® | Computable Name: Hold_Slot_Operation | ||
Request for a hold on a selected Slot 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 slot 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 slot-hold
URL: [base]/Slot/$hold
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | slot-reference | 0..1 | Reference (HL7® AT Scheduling Slot Profile) | A resource id for one of proposed Slots 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 slots. | ||
| IN | slot-identifier | 0..* | Identifier | When slot-identifiers are provided, the server is expected to perform an internal lookup to identify the corresponding slot instance. The server SHALL reject the request if the provided identifiers do not resolve to a single slot instance. | ||
| OUT | return | 1..1 | Parameters | The response will be a Parameters resource consisting of the requested held Slot resource and an OperationOutcome with errors, warnings or information as a result of processing the operation. The Appointment resource will have an updated |
This operation is used by the Scheduling Client and Scheduling Server Actors. The Hold Slot operation is used to request that a specific appointment-slot (selected from one of the available potential slots returned with the response of a preceding query) is held by the Scheduling Server, until the appointment is booked, cancelled, or the hold on the slot expires.
The Scheduling Server is expected to hold the necessary time slots and resources for the potential appointment to take place at the given time and for the given duration.
Note that it is possible that between the time the Find Potential Appointments response was received, and the time the Hold Slot request is issued, the requested slot is no longer available. In such case, the server SHALL respond with an OperationOutcome that describes the issue.
ToDo