WOF Connect📍
0.1.1 - ci-build [WIP]
WOF Connect📍
0.1.1 - ci-build [WIP]
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
| Official URL: http://canonical.fhir.link/servicewell/wof-connect/CapabilityStatement/WofConnectCapabilityStatement | Version: 0.1.1 | |||
| Active as of 2026-02-10 | Computable Name: WofConnectCapabilityStatement | |||
This CapabilityStatement defines the canonical domain model and API principles of WOF Connect, owned and operated by Service Well.
IHE Scheduling: This server instantiates IHE.Scheduling.server (v1.0.0).
Layering principle:
Domain separation principles:
Many-to-many relationships are intentional:
Integration principle:
This CapabilityStatement documents the canonical behavior of the WOF Connect API.
Raw OpenAPI-Swagger Definition file | Download
jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
This CapabilityStatement instantiates the CapabilityStatement IHE Scheduling Serverversion: 1.0.0)
serverThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revincludehttp://hl7.se/fhir/ig/base/StructureDefinition/SEBasePatient|1.1.0
search-typeSearch Patients: GET [base]/Patient?identifier=system|value.
readRead a Patient by logical id: GET [base]/Patient/{id}.
Patient resources returned by WOF Connect integrations. Supported interactions: search, read.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Filter by personal identity number using system|value. Refer to the FHIR base profile defined by the national HL7 affiliate (e.g. HL7 Sweden). In Sweden, use system=http://electronichealth.se/identifier/personnummer. Example: GET [base]/Patient?identifier=http://electronichealth.se/identifier/personnummer|197601082394 |
readRead Appointment: GET [base]/Appointment/{id} (may require patient context).
search-typeSearch Appointments (patient-scoped): GET [base]/Appointment?[params]
Appointment supports:
- Read/search interactions for retrieving booked appointments (patient-scoped).
- IHE ITI Scheduling operations for finding availability and booking ($find, $hold, $book).
Note: Some endpoints require patient context (e.g. personal identity number) for authorization and/or routing.
read, search-type.ActivityDefinition represents a shared service concept (treatment/visit type) identified by code.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | code | token | Search by service concept code (e.g. WOF Connect service-type or service-type-id coding). |
read, search-type.HealthcareService represents where care is performed. In WOF Connect, this typically corresponds to a clinic/location context used for scheduling and availability.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Search by HealthcareService identifier (e.g. clinic id or external system identifier). |
read, search-type.PractitionerRole represents a practitioner acting in a specific operational context, typically tied to a HealthcareService and used for scheduling and booking.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | service | reference | Filter by PractitionerRole.healthcareService (service). |
| SHALL | practitioner | reference | Filter by PractitionerRole.practitioner. |
read, search-type.Organization represents an economic or billing entity in WOF Connect. Organizations are typically returned as part of Schedule and PractitionerRole context and MAY be retrieved directly when referenced.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Read or search Organization by logical id. |
| SHALL | identifier | token | Search Organization by business or billing identifier using system|value. The exact identifier system is vendor-specific but MUST be stable per endpoint. |
https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/IHE.Scheduling.Schedule|1.0.0
read, search-type.Schedules represent planned working time and related scheduled context.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | actor | reference | Filter schedules by Schedule.actor (HealthcareService, Practitioner, PractitionerRole). |
| SHALL | service-type | token | Filter schedules by service type (Schedule.serviceType). Use token system|code where system is typically:
Note: Schedules also carry endpoint-id as an additional coding for uniqueness, but endpoint-id alone is not a service type filter. |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $get-schedule-context | Returns a searchset Bundle conforming to WofConnectScheduleContextOperationResponse, containing:
|
read.Practitioner resources are returned as scheduling context (e.g., GetScheduleContext) and MAY be retrieved directly by reference.