FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageservicewell.fhir.wof-connect
Resource TypeOperationDefinition
IdOperationDefinition-BookAppointment.json
FHIR VersionR4
Sourcehttp://canonical.fhir.link/servicewell/wof-connect/0.1.3/OperationDefinition-BookAppointment.html
URLhttp://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/BookAppointment
Version0.1.3
Statusactive
Date2026-04-02T09:20:58+00:00
NameBookAppointment
TitleBook / Modify / Cancel Appointment
DescriptionCreates, modifies, or cancels an Appointment based on the supplied Appointment resource. This operation corresponds to the IHE ITI Scheduling $book operation and: - CREATES a new Appointment when a new, schedulable Appointment is supplied - MODIFIES an existing Appointment when an updated Appointment is supplied - CANCELS an existing Appointment when a cancellation Appointment is supplied On success, the operation returns the finalized Appointment in an IHE Scheduled Availability Bundle.
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
servicewell.fhir.wof-connect#0.1.3WofConnectCapabilityStatementWOF Connect Capability Statement

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition BookAppointment

URL: [base]/Appointment/$book

Output parameters Profile:IHE ITI Scheduling Bundle Profile

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INappointment1..1Appointment (IHE ITI Appointment Profile)

The Appointment to be created, modified, or cancelled.

  • CREATE:
    • Appointment.id is absent or refers to a non-existing appointment
    • Appointment.status is 'pending'
  • MODIFY:
    • Appointment.id identifies an existing appointment
    • Appointment.status is 'booked' and details (time, participants, etc.) are updated
  • CANCEL:
    • Appointment.id identifies an existing appointment
    • Appointment.status is 'cancelled'
OUTreturn1..1Bundle

On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:

  • status 'booked' for created or modified appointments
  • status 'cancelled' for cancelled appointments

On error, an OperationOutcome is returned instead of this parameter.


Source1

{
  "resourceType": "OperationDefinition",
  "id": "BookAppointment",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/BookAppointment",
  "version": "0.1.3",
  "name": "BookAppointment",
  "title": "Book / Modify / Cancel Appointment",
  "status": "active",
  "kind": "operation",
  "date": "2026-04-02T09:20:58+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"
    }
  ]
}