ITB - Online appointment booking service
1.0.1 - Documentation update
ITB - Online appointment booking service
1.0.1 - Documentation update
This page is part of the Wof Portal Public API (v1.0.1: V1 Release Update) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: https://canonical.fhir.link/servicewell/wof-portal/ValueSet/booked-appointment-statuses | Version: 1.0.1 | |||
| Active as of 2026-06-09 | Computable Name: BookedAppointmentStatuses | |||
Value set for allowed appointment statuses in WOF when an appointment is booked.
References
http://hl7.org/fhir/appointmentstatus version 📦4.0.1| Code | Display | Definition |
| booked | The appointment is confirmed to occur at the specified date/time. | A successful book response returns status #booked. | All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified. |
| cancelled | Used in the $book operation payload to request cancellation of an appointment | If a $book request with status #cancelled is successful, the response returns an Appointment with status #cancelled. | The appointment has been cancelled. |
Expansion performed internally based on codesystem AppointmentStatus v4.0.1 (CodeSystem)
This value set contains 2 concepts
| System | Code | Display (en) | Definition | JSON | XML |
http://hl7.org/fhir/appointmentstatus | booked | The appointment is confirmed to occur at the specified date/time. | A successful book response returns status #booked. | All participant(s) have been considered and the appointment is confirmed to go ahead at the date/times specified. | ||
http://hl7.org/fhir/appointmentstatus | cancelled | Used in the $book operation payload to request cancellation of an appointment | If a $book request with status #cancelled is successful, the response returns an Appointment with status #cancelled. | The appointment has been cancelled. |
Explanation of the columns that may appear on this page:
| Level | A few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies |
| System | The source of the definition of the code (when the value set draws in codes defined elsewhere) |
| Code | The code (used as the code in the resource instance) |
| Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
| Definition | An explanation of the meaning of the concept |
| Comments | Additional notes about how to use the code |