ITB - Online appointment booking service
1.0.0 - Initial Release

ITB - Online appointment booking service, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 1.0.0 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-portal/ and changes regularly. See the Directory of published versions

OperationDefinition: Find Appointments (Available Slots)

Official URL: https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/FindAppointments Version: 1.0.0
Active as of 2026-04-20 Computable Name: FindAppointments

Finds available appointment opportunities (slots) and returns them as proposed Appointments.

This operation corresponds to the IHE ITI Scheduling $find operation and returns a Bundle of Appointment resources conforming to the IHE Scheduled Availability Bundle profile.

URL: [base]/Appointment/$find

Output parameters Profile:Available Appointment Portal

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INstart1..1dateTime

Start of the requested time window for which available appointment opportunities (slots) should be returned. This parameter is mandatory as per IHE ITI Scheduling $find.

INend1..1dateTime

End of the requested time window for which available appointment opportunities (slots) should be returned. This parameter is mandatory as per IHE ITI Scheduling $find.

INpractitioner0..*Reference

Restrict the search to Appointments where a specific Practitioner is the performer.

Practitioner is not exposed as a standalone API resource in WOF Portal. This parameter therefore uses a Reference with identifier populated for the logical Practitioner concept, instead of a resolvable FHIR resource reference.

This follows the IHE ITI-style parameter pattern where the parameter type remains Reference, but the logical target is carried using Reference.identifier.

Reference.identifier.system: https://canonical.fhir.link/servicewell/wof-portal/identifier-system/endpoint-identifier-system-for-practitioner/{endpointId}

Reference.identifier.value: source-system primary key for the practitioner

INlocation0..*Reference (Location Area)

Restrict the search to Appointments at a specific location.

Format: Location/{id}

Example: ?location=Location/1234

INorganization0..*Reference

Restrict the search to Appointments associated with a specific billing organization.

BillingOrganization is not exposed as a standalone API resource in WOF Portal. This parameter therefore uses a Reference with identifier populated for the logical BillingOrganization concept, instead of a resolvable FHIR resource reference.

This follows the IHE ITI -style parameter pattern where the parameter type remains Reference, but the logical target is carried using Reference.identifier.

Reference.identifier.system: https://canonical.fhir.link/servicewell/wof-portal/identifier-system/endpoint-identifier-system-for-billingorganization/{endpointId}

Reference.identifier.value: source-system primary key for the billing organization

INvisit-type0..*string

Restrict the search to a specific visit type (service type). In this implementation, visit-type typically carries a WOF Connect service-type identifier (e.g., [system]|[code] where code maps to treatmentId).

INhealthcareService0..1Reference (HealthcareServicePortal)

Restrict the search to a specific HealthcareService.

Format: HealthcareService/{id}

Example: ?healthcareService=HealthcareService/1234

INpractitionerRole0..1Reference (PractitionerRolePortal)

Restrict the search to a specific PractitionerRole.

Format: PractitionerRole/{id}

Example: ?practitionerRole=PractitionerRole/1234

OUTreturn0..1Bundle (Portal Find Appointment response)

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

  • status 'proposed' for available appointment opportunities (slots)

Bundels conforming to ihe-sched-avail-bundle: