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

• Narrative Content
• XML
• JSON
• TTL

: Book / Modify / Cancel Appointment - JSON Representation

Active as of 2026-02-11

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "BookAppointment",
  "text" : {
    "status" : "generated",
    "div" : "<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>"
  },
  "url" : "http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/BookAppointment",
  "version" : "0.1.1",
  "name" : "BookAppointment",
  "title" : "Book / Modify / Cancel Appointment",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-02-11T12:21:17+00:00",
  "publisher" : "Service Well AB",
  "contact" : [
    {
      "name" : "Service Well AB",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://servicewell.se"
        },
        {
          "system" : "email",
          "value" : "info@servicewell.se"
        }
      ]
    }
  ],
  "description" : "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.",
  "affectsState" : true,
  "code" : "book",
  "base" : "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-book",
  "resource" : [
    "Appointment"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "outputProfile" : "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-avail-bundle",
  "parameter" : [
    {
      "name" : "appointment",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "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'",
      "type" : "Appointment",
      "targetProfile" : [
        🔗 "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/ihe-sched-appt"
      ]
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "documentation" : "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.",
      "type" : "Bundle"
    }
  ]
}