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

Artifacts Summary

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

WOF Connect Capability Statement

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:

  • WOF Connect defines vendor-facing interoperability contracts.
  • WOF Portal builds on WOF Connect to provide a single, enriched, canonical API.

Domain separation principles:

  • ActivityDefinition represents a shared service concept and SHALL be identified by code, not by resource id.
  • HealthcareService represents where care is performed.
  • Organization (Economy/Billing) represents financial responsibility and is independent of service location.
  • PractitionerRole represents a practitioner acting in a specific operational and financial context.

Many-to-many relationships are intentional:

  • A HealthcareService MAY be associated with multiple Organizations.
  • An Organization MAY provide services at multiple HealthcareServices.
  • A Practitioner MAY have multiple PractitionerRoles across services and billing contexts.

Integration principle:

  • External systems integrate with the platform by implementing WOF Connect.
  • WOF Portal APIs MAY return enriched and aggregated views not available in WOF Connect.

This CapabilityStatement documents the canonical behavior of the WOF Connect API.

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.

Book / Modify / Cancel Appointment

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.

Find Appointments (Available Slots)

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.

Get Schedule Context

Returns a Bundle containing Schedule resources together with related actors and activity definitions for a given period. Only resources that are actually scheduled are included.

WOF Capabilities OperationDefinition

Returns a Basic resource carrying the WOF-CONNECT capabilities extension (WofConnectCharacteristic) for this endpoint.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

ITB AppointmentResponse

ITBAppointmentResponse is used to handle ..

ITB Slot

A slot profile in ITB

WOF Capabilities Carrier

Basic resource used to carry the WOF-CONNECT capabilities extension.

WOF Connect GetScheduleContext Operation Response

Bundle (searchset) returned by the WOF-CONNECT GetScheduleContext operation.

Wof Connect ActivityDefinition
Wof Connect Appointment

Appointment representation of an available slot (Frenda slot mapped to Appointment). Inherits IHE Scheduling Appointment.

Wof Connect Booking Appointment

Appointment representation of a booked visit (Frenda booking mapped to Appointment). Inherits IHE Scheduling Appointment.

Wof Connect Economy Organization
Wof Connect HealthcareService
Wof Connect HealthcareService List

A list of HealthcareService references

Wof Connect Patient

Patient returned by WOF Connect integrations.

Wof Connect Practitioner
Wof Connect PractitionerRole

PractitionerRole as exposed by WOF Connect integrations.

Wof Connect Schedule

Schedule for bookable service availability as exposed by WOF Connect integrations.

Wof Connect Slot

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

WOF Connect Appointment Update - Reschedule & Cancellation

Information about web rescheduling and whether the appointment can be rescheduled or cancelled at the current time.

WofConnect Characteristic

Grouped characteristics for a HealthcareService: Scheduling, API and Security.

WofConnect List Reference

Points to a contained List resource that defines related items.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

Allowed Personal Number Identifier Systems

ValueSet containing allowed identifier.system values for national personal numbers.

WOF Connect Practitioner Role

Full ValueSet for WOF Connect practitioner roles used across PMS adapters.

WOF Connect Service Types

Full ValueSet for WOF Connect service types used across PMS adapters.

WOF-Connect Characteristic

WOF-Connect ValueSet for Characteristic for the source PMS system - e.g., Frenda, Opus Dental, used in WOF-Connect HealthcareService.characteristic

WOF-Connect PMS System

Full ValueSet for for WOF-Connect source Practice Management System

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

WOF Connect Identifier CodeSystem – Slot ID

Identifier system for PMS slot identifiers used when exposing available slots as Appointment resources in WOF Connect integrations. Represents the PMS-native slot identifier (e.g., Frenda slotId).

WOF Connect Practitioner Role

Practitioner roles used across PMS adapters.

WOF Connect Service Types

Service types used across PMS adapters.

WOF Personal Number Identifier Systems

Allowed identifier.system values for national personal numbers used in WOF Connect.

WOF-Connect Characteristic

WOF-Connect CodeSystem for Characteristic for the source PMS system - e.g., Frenda, Opus Dental, used in WOF-Connect HealthcareService.characteristic

WOF-Connect PMS System

Code system for WOF-Connect source Practice Management System

Terminology: Naming Systems

These define identifier and/or code system identities used by systems conforming to this implementation guide.

Endpoint Id as Code

NamingSystem describing the dynamic code system used for endpoints that identifies with an ID

Service Type Id as Code

NamingSystem describing the dynamic code system used for service types that identifies with an ID, for example treatment.id in Frenda

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

Appointment-GetAllExample
Appointment-GetByIdExample

Akut

OpBookAppointment-BookExample
OpBookAppointment-CancelExample
OpBookAppointment-ModifyExample
OpFindAppointments-Example
Patient-GetByPersonalNumberExample