0.1.0 - ci-build

WofPortalIG, published by Service Well AB. This guide is not an authorized publication; it is the continuous build for version 0.1.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

CapabilityStatement: WOF Portal Capability Statement

Official URL: https://canonical.fhir.link/servicewell/wof-portal/CapabilityStatement/WOFPortalCapabilityStatement Version: 0.1.0
Active as of 2026-02-02 Computable Name: WOFPortalCapabilityStatement

This CapabilityStatement defines the canonical domain model and API principles of the WOF Portal, 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.
  • BillingOrganization 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 BillingOrganizations.
  • A BillingOrganization MAY provide services at multiple HealthcareServices.
  • A Practitioner MAY have multiple PractitionerRoles across services and billing contexts.

Offer and availability principles:

  • Offer represents a computed, context-specific view combining ActivityDefinition, HealthcareService, and PractitionerRole.
  • Offer is intended for presentation and selection, not for scheduling.
  • Schedule represents planned working time and SHALL NOT be treated as bookable availability.
  • Actual bookability requires downstream slot or availability checks.

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 Portal API.

Client interaction overview:

The following diagram illustrates outbound API calls from a patient-facing client to the WOF Portal Proxy. It represents actual usage patterns and supported interactions.

WOF.Portal.Patient.Client.Frenda - Outbound API calls (Razor components → services)

Client → Proxy:
- GET portal/fhir/Organization
- GET portal/fhir/Organization/{id}?_summary={true|false}
- GET portal/fhir/Organization?identifier={tenantIdentifier}&_summary={true|false}

- GET {endpointId}/fhir/Patient

- GET portal/fhir/Appointment
- GET {endpointId}/fhir/Appointment/{id}
- GET {endpointId}/fhir/Appointment?actor=HealthcareService/{healthcareServiceId}

- GET {endpointId}/fhir/Appointment/$find
- POST {endpointId}/fhir/Appointment/$book

- GET portal/fhir/HealthcareService
- GET portal/fhir/HealthcareService/{id}

- GET portal/fhir/Location?physicalType={AreaLiteral}

- GET portal/fhir/PractitionerRole
- GET portal/fhir/PractitionerRole?service=HealthcareService/{healthcareServiceId}
- GET portal/fhir/PractitionerRole/{practitionerRoleId}

- GET portal/fhir/ActivityDefinition
- GET portal/fhir/ActivityDefinition/{id}

This diagram is informational and documents expected client usage. It does not expand or modify the formal FHIR conformance rules.

Raw OpenAPI-Swagger Definition file | Download

WOF Portal Capability Statement

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2026-02-02 12:00:00+0000
  • Published by: Service Well AB

Note 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)

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Operations
ConformanceOperationDocumentation
SHALL$getOffersContext

Returns enriched offer context for presentation and selection.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
ActivityDefinition yy
HealthcareService yy
PractitionerRole yyservice
Patient yyidentifier
OrganizationSupported Profiles
  BillingOrganizationModel		yy_id, identifier
Schedule 
Location yphysical-type
Core FHIR Resource
ActivityDefinition
Reference Policy
Interaction summary
  • Supports read, search-type.

Documentation

Represents shared service concepts identified by code.

Core FHIR Resource
HealthcareService
Reference Policy
Interaction summary
  • Supports read, search-type.

Documentation

Represents where healthcare services are performed.

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • Supports read, search-type.

Documentation

Represents practitioners acting in specific operational and financial contexts.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLservicereference

Filter by PractitionerRole.service (Reference to HealthcareService).

 
Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports read, search-type.

Documentation

Represents practitioners acting in specific operational and financial contexts.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Use the identifier system defined in the applicable base profile.

 
Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • Supports read, search-type.

Supported Profiles

BillingOrganizationModel

Documentation

Organizations MAY conform to multiple profiles in WOF Portal. BillingOrganization is represented as Organization constrained by the OrganizationBilling profile. Clients MAY filter by profile when needed (e.g. using _profile), but searches by id and identifier are supported without profile constraints.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Search by Organization resource id.

SHALLidentifiertoken

Search by organization number using system|value.

 
Core FHIR Resource
Schedule
Reference Policy
Interaction summary

    Documentation

    Represents planned working time, not bookable availability.

    Core FHIR Resource
    Location
    Reference Policy
    Interaction summary
    • Supports search-type.

    Documentation

    Portal-scoped locations used as areas. Supported interaction: search.

    Search Parameters
    ConformanceParameterTypeDocumentation
    SHALLphysical-typetoken

    Filter by Location.physicalType (e.g., Area).