WOF Connect📍, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/servicewell/servicewell.fhir.wof-connect/ and changes regularly. See the Directory of published versions
| Active as of 2026-02-11 |
@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .
# - resource -------------------------------------------------------------------
a fhir:OperationDefinition ;
fhir:nodeRole fhir:treeRoot ;
fhir:id [ fhir:v "BookAppointment"] ; #
fhir:text [
fhir:status [ fhir:v "generated" ] ;
fhir:div [ fhir:v "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition BookAppointment</b></p><a name=\"BookAppointment\"> </a><a name=\"hcBookAppointment\"> </a><p>URL: [base]/Appointment/$book</p><p>Output parameters Profile:<a href=\"https://profiles.ihe.net/ITI/Scheduling/1.0.0/StructureDefinition-ihe-sched-avail-bundle.html\">IHE ITI Scheduling Bundle Profile</a></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</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/appointment.html\">Appointment</a> (<a href=\"https://profiles.ihe.net/ITI/Scheduling/1.0.0/StructureDefinition-ihe-sched-appt.html\" title=\"https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt\">IHE ITI Appointment Profile</a>)</td><td/><td><div><p>The Appointment to be created, modified, or cancelled.</p>\n<ul>\n<li>CREATE:\n<ul>\n<li>Appointment.id is absent or refers to a non-existing appointment</li>\n<li>Appointment.status is 'pending'</li>\n</ul>\n</li>\n<li>MODIFY:\n<ul>\n<li>Appointment.id identifies an existing appointment</li>\n<li>Appointment.status is 'booked' and details (time, participants, etc.) are updated</li>\n</ul>\n</li>\n<li>CANCEL:\n<ul>\n<li>Appointment.id identifies an existing appointment</li>\n<li>Appointment.status is 'cancelled'</li>\n</ul>\n</li>\n</ul>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:</p>\n<ul>\n<li>status 'booked' for created or modified appointments</li>\n<li>status 'cancelled' for cancelled appointments</li>\n</ul>\n<p>On error, an OperationOutcome is returned instead of this parameter.</p>\n</div></td></tr></table></div>"^^rdf:XMLLiteral ]
] ; #
fhir:url [
fhir:v "http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/BookAppointment"^^xsd:anyURI ;
fhir:l <http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/BookAppointment>
] ; #
fhir:version [ fhir:v "0.1.1"] ; #
fhir:name [ fhir:v "BookAppointment"] ; #
fhir:title [ fhir:v "Book / Modify / Cancel Appointment"] ; #
fhir:status [ fhir:v "active"] ; #
fhir:kind [ fhir:v "operation"] ; #
fhir:date [ fhir:v "2026-02-11T12:21:17+00:00"^^xsd:dateTime] ; #
fhir:publisher [ fhir:v "Service Well AB"] ; #
fhir:contact ( [
fhir:name [ fhir:v "Service Well AB" ] ;
( fhir:telecom [
fhir:system [ fhir:v "url" ] ;
fhir:value [ fhir:v "https://servicewell.se" ] ] [
fhir:system [ fhir:v "email" ] ;
fhir:value [ fhir:v "info@servicewell.se" ] ] )
] ) ; #
fhir:description [ fhir:v "Creates, modifies, or cancels an Appointment based on the supplied Appointment resource.\n\nThis operation corresponds to the IHE ITI Scheduling $book operation and:\n- CREATES a new Appointment when a new, schedulable Appointment is supplied\n- MODIFIES an existing Appointment when an updated Appointment is supplied\n- CANCELS an existing Appointment when a cancellation Appointment is supplied\n\nOn success, the operation returns the finalized Appointment in an IHE Scheduled Availability Bundle."] ; #
fhir:affectsState [ fhir:v true] ; #
fhir:code [ fhir:v "book"] ; #
fhir:base [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book"^^xsd:anyURI ;
fhir:l <https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book>
] ; #
fhir:resource ( [ fhir:v "Appointment"] ) ; #
fhir:system [ fhir:v false] ; #
fhir:type [ fhir:v true] ; #
fhir:instance [ fhir:v false] ; #
fhir:outputProfile [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle"^^xsd:anyURI ;
fhir:l <https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle>
] ; #
fhir:parameter ( [
fhir:name [ fhir:v "appointment" ] ;
fhir:use [ fhir:v "in" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "The Appointment to be created, modified, or cancelled.\n\n- CREATE:\n - Appointment.id is absent or refers to a non-existing appointment\n - Appointment.status is 'pending'\n- MODIFY:\n - Appointment.id identifies an existing appointment\n - Appointment.status is 'booked' and details (time, participants, etc.) are updated\n- CANCEL:\n - Appointment.id identifies an existing appointment\n - Appointment.status is 'cancelled'" ] ;
fhir:type [ fhir:v "Appointment" ] ;
( fhir:targetProfile [
fhir:v "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt"^^xsd:anyURI ;
fhir:l <https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt> ] )
] [
fhir:name [ fhir:v "return" ] ;
fhir:use [ fhir:v "out" ] ;
fhir:min [ fhir:v 1 ] ;
fhir:max [ fhir:v "1" ] ;
fhir:documentation [ fhir:v "On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:\n- status 'booked' for created or modified appointments\n- status 'cancelled' for cancelled appointments\n\nOn error, an OperationOutcome is returned instead of this parameter." ] ;
fhir:type [ fhir:v "Bundle" ]
] ) . #
IG © 2025+ Service Well AB. Package servicewell.fhir.wof-connect#0.1.1 based on FHIR 4.0.1. Generated 2026-02-11
Links: Table of Contents |
QA Report