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
| Active as of 2025-02-07 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="appointment-book"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition appointment-book</b></p><a name="appointment-book"> </a><a name="hcappointment-book"> </a><a name="appointment-book-en-US"> </a><p>URL: [base]/Appointment/$book</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>appointment-resource</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/resource.html">Resource</a> (<a href="StructureDefinition-at-scheduling-appointment.html" title="http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-appointment">HL7® AT Scheduling Appointment Profile</a>)</td><td/><td><div><p>The full appointment resource is needed for this operation. The appointment SHALL have the status "proposed".</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R5/parameters.html">Parameters</a></td><td/><td><div><p>The response will be a Parameters resource consisting of the requested Appointment resource and an OperationOutcome with errors, warnings or information as a result of processing the operation. The Appointment resource will have an updated <code>status</code> of "booked" if the request is approved or "cancelled" if it is rejected.</p>
</div></td></tr></table></div>
</text>
<url
value="http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/OperationDefinition/appointment-book"/>
<version value="0.1.0"/>
<name value="Book_Appointment_Operation"/>
<status value="active"/>
<kind value="operation"/>
<date value="2025-02-07T11:56:07+00:00"/>
<publisher value="HL7® Austria, TC FHIR®"/>
<description
value="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. "/>
<affectsState value="true"/>
<code value="book"/>
<resource value="Appointment"/>
<system value="false"/>
<type value="true"/>
<instance value="false"/>
<parameter>
<name value="appointment-resource"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The full appointment resource is needed for this operation. The appointment SHALL have the status "proposed"."/>
<type value="Resource"/>
<targetProfile
value="http://hl7.at/fhir/TC-FHIR-AG-Scheduling-R5/R5/StructureDefinition/at-scheduling-appointment"/>
</parameter>
<parameter>
<name value="return"/>
<use value="out"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The response will be a Parameters resource consisting of the requested Appointment resource and 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 the request is approved or "cancelled" if it is rejected."/>
<type value="Parameters"/>
</parameter>
</OperationDefinition>