| Package | hl7.at.fhir.tc.wg.scheduling.r5 |
| Resource Type | OperationDefinition |
| Id | slot-hold |
| FHIR Version | R5 |
| Source | http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/https://build.fhir.org/ig/HL7Austria/TC-FHIR-AG-Scheduling-R5/OperationDefinition-slot-hold.html |
| URL | http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/OperationDefinition/slot-hold |
| Version | 0.2.0 |
| Status | active |
| Date | 2025-05-23T10:55:12+00:00 |
| Name | Hold_Slot_Operation |
| Authority | hl7 |
| Description | 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. |
| Type | true |
| Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
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. | ||
| IN | slot-status | 1..1 | code | Slot Status (Required) | To create a hold on the slot this parameter needs to have the value | |
| OUT | return | 1..1 | Parameters | The response will be a Parameters resource consisting of the requested held Slot resource, an OperationOutcome with errors, warnings or information as a result of processing the operation and in upon successful creation of a hold a dateTime |
FHIR{
"resourceType": "OperationDefinition",
"id": "slot-hold",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/OperationDefinition/slot-hold",
"version": "0.2.0",
"name": "Hold_Slot_Operation",
"status": "active",
"kind": "operation",
"date": "2025-05-23T10:55:12+00:00",
"publisher": "HL7® Austria, TC FHIR®",
"description": "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. ",
"affectsState": true,
"code": "hold",
"resource": [
"Slot"
],
"system": false,
"type": true,
"instance": false,
"parameter": [
{
"name": "slot-reference",
"use": "in",
"min": 0,
"max": "1",
"documentation": "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.",
"type": "Reference",
"targetProfile": [
"http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-slot"
]
},
{
"name": "slot-identifier",
"use": "in",
"min": 0,
"max": "*",
"documentation": "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.",
"type": "Identifier"
},
{
"name": "slot-status",
"use": "in",
"min": 1,
"max": "1",
"documentation": "To create a hold on the slot this parameter needs to have the value `busy-tentative` or `free` to release it.",
"type": "code",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/slotstatus"
}
},
{
"name": "return",
"use": "out",
"min": 1,
"max": "1",
"documentation": "The response will be a Parameters resource consisting of the requested held Slot resource, an OperationOutcome with errors, warnings or information as a result of processing the operation and in upon successful creation of a hold a dateTime `held-until`, which signals when the hold is automatically released. The Appointment resource will have an updated `status` of \"busy-tentative\" if the hold is approved or \"busy-unavailable\" if the hold is rejected.",
"type": "Parameters"
}
]
}