FHIR IG analytics| Package | servicewell.fhir.wof-portal |
| Resource Type | OperationDefinition |
| Id | OperationDefinition-BookAppointment.json |
| FHIR Version | R4 |
| Source | file:///azp/_work/1/s/output/OperationDefinition-BookAppointment.html |
| URL | https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/BookAppointment |
| Version | 1.0.0 |
| Status | active |
| Date | 2026-04-20T11:19:47+00:00 |
| Name | BookAppointment |
| Title | Book / Modify / Cancel Appointment |
| Description | Creates, 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. |
| Type | true |
| Kind | operation |
| CapabilityStatement | ||
| servicewell.fhir.wof-portal#1.0.0 | WOFPortalCapabilityStatement | WOF Portal Capability Statement |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition BookAppointment
URL: [base]/Appointment/$book
Output parameters Profile:Portal Find Appointment response
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | appointment | 1..1 | Appointment (Appointment Portal) | The Appointment to be created, modified, or cancelled.
| ||
| IN | appointment-reference | 0..1 | Reference (Appointment Portal) | A resource id for one of proposed Appointments 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 appointments. | ||
| IN | patient-identifier | 1..* | Identifier | The Patient is identified by their personal number. | SHOULD be an identifier system from a national FHIR Patient profile. | ||
| IN | comment | 0..1 | string | The optional comment can be added for additional notes that could be useful for booking, canceling, or modifying an appointment | ||
| OUT | return | 1..1 | Bundle | On success, returns a Bundle that SHALL conform to ihe-sched-avail-bundle, containing the resulting Appointment:
On error, an OperationOutcome is returned instead of this parameter. |
FHIR
FHIRsmith{
"resourceType": "OperationDefinition",
"id": "BookAppointment",
"text": {
"status": "generated",
"div": "<!-- snip (see above) -->"
},
"url": "https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/BookAppointment",
"version": "1.0.0",
"name": "BookAppointment",
"title": "Book / Modify / Cancel Appointment",
"status": "active",
"kind": "operation",
"date": "2026-04-20T11:19:47+00:00",
"publisher": "Service Well AB",
"contact": [
{
"name": "Service Well AB",
"telecom": [
{
"system": "url",
"value": "https://servicewell.se"
},
{
"system": "email",
"value": "info@servicewell.se"
}
]
},
{
"name": "Service well",
"telecom": [
{
"system": "email",
"value": "info@servicewell.se",
"use": "work"
}
]
}
],
"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://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-find-appointment-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://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-appointment"
]
},
{
"name": "appointment-reference",
"use": "in",
"min": 0,
"max": "1",
"documentation": "A resource id for one of proposed Appointments 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 appointments.",
"type": "Reference",
"targetProfile": [
"https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/portal-appointment"
]
},
{
"name": "patient-identifier",
"use": "in",
"min": 1,
"max": "*",
"documentation": "The Patient is identified by their personal number. | SHOULD be an identifier system from a national FHIR Patient profile. ",
"type": "Identifier"
},
{
"name": "comment",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The optional comment can be added for additional notes that could be useful for booking, canceling, or modifying an appointment",
"type": "string"
},
{
"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"
}
]
}