Generated Narrative: CapabilityStatement WOFPortalCapabilityStatement

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
ActivityDefinitionhttps://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-portalyy
HealthcareServicehttps://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/healthcare-service-portalyy
PractitionerRolehttps://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/practitioner-role-portalyyservice
PatientSupported Profiles
  http://hl7.se/fhir/ig/base/StructureDefinition/SEBasePatient		yyidentifier
OrganizationSupported Profiles
  ServiceProviderPortal
  BillingOrganizationPortal		yy_id, identifier
Schedule 
Location yphysical-type

Resource Conformance: supported ActivityDefinition

Base System Profile
ActivityDefinitionPortal
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

Represents shared service concepts identified by code.

Resource Conformance: supported HealthcareService

Base System Profile
HealthcareServicePortal
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

Represents where healthcare services are performed.

Resource Conformance: supported PractitionerRole

Base System Profile
PractitionerRolePortal
Profile Conformance
SHALL
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).

 

Resource Conformance: supported Patient

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

Supported Profiles

http://hl7.se/fhir/ig/base/StructureDefinition/SEBasePatient

Documentation

Represents patients within the WOF Portal, conforming to the Swedish base patient profile.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Use system fro,m se base profile Http://

 

Resource Conformance: supported Organization

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

Supported Profiles

ServiceProviderPortal
BillingOrganizationPortal

Documentation

Organizations in WOF Portal MAY conform to multiple profiles, representing different organizational roles.

ServiceProvider represents the top-level owning organization (tenant) within the platform. BillingOrganization represents financial responsibility and ownership of invoicing and reporting.

Organizations are not exposed as searchable catalogs. They are resolved using stable identifiers only:

  • resource id
  • organization number (identifier)

Clients MAY filter by profile when needed (e.g. using _profile), but profile-based filtering is not required for lookup by id or identifier.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Search by Organization resource id.

SHALLidentifiertoken

Search by organization number using system|value.

 

Resource Conformance: supported Schedule

Core FHIR Resource
Schedule
Reference Policy
Interaction summary

    Documentation

    Represents planned working time, not bookable availability.

    Resource Conformance: supported Location

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

     
     <status value="active"/> <experimental value="false"/> <date value="2026-02-02T12:00:00+00:00"/> <publisher value="Service Well AB"/> <contact> <name value="Service Well AB"/> <telecom> <system value="url"/> <value value="https://servicewell.se"/> </telecom> <telecom> <system value="email"/> <value value="info@servicewell.se"/> </telecom> </contact> <description value="This CapabilityStatement defines the canonical domain model and API principles of the **WOF Portal**"/> <purpose value="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. Client → WOF-PORTAL: <style> .mermaid { min-height: 600px; } </style> ```mermaid sequenceDiagram participant Client as Patient Client participant Portal as WOF Portal Proxy participant Endpoint as Tenant Endpoint %% Organization (ServiceProvider / Care context) Client ->> Portal: GET portal/fhir/Organization Client ->> Portal: GET portal/fhir/Organization/{id}?_summary={true|false} Client ->> Portal: GET portal/fhir/Organization?identifier={tenantIdentifier}&_summary={true|false} %% Patient (endpoint-scoped) Client ->> Endpoint: GET {endpointId}/fhir/Patient %% Appointment (portal + endpoint) Client ->> Portal: GET portal/fhir/Appointment Client ->> Endpoint: GET {endpointId}/fhir/Appointment/{id} Client ->> Endpoint: GET {endpointId}/fhir/Appointment?actor=HealthcareService/{healthcareServiceId} %% IHE Scheduling Client ->> Endpoint: GET {endpointId}/fhir/Appointment/$find Client ->> Endpoint: POST {endpointId}/fhir/Appointment/$book %% HealthcareService (portal-scoped) Client ->> Portal: GET portal/fhir/HealthcareService Client ->> Portal: GET portal/fhir/HealthcareService/{id} %% Location (Areas) Client ->> Portal: GET portal/fhir/Location?physicalType={AreaLiteral} %% PractitionerRole (portal-scoped) Client ->> Portal: GET portal/fhir/PractitionerRole Client ->> Portal: GET portal/fhir/PractitionerRole?service=HealthcareService/{healthcareServiceId} Client ->> Portal: GET portal/fhir/PractitionerRole/{practitionerRoleId} %% ActivityDefinition (portal-scoped) Client ->> Portal: GET portal/fhir/ActivityDefinition Client ->> Portal: 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."/> <kind value="capability"/> <instantiates value="https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server|1.0.0"/> <fhirVersion value="4.0.1"/> <format value="json"/> <format value="xml"/> <rest> <mode value="server"/> <resource> <type value="ActivityDefinition"/> <profile value="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/activity-definition-portal"/> <documentation value="Represents shared service concepts identified by code."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> </resource> <resource> <type value="HealthcareService"/> <profile value="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/healthcare-service-portal"/> <documentation value="Represents where healthcare services are performed."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> </resource> <resource> <type value="PractitionerRole"/> <profile value="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/practitioner-role-portal"/> <documentation value="Represents practitioners acting in specific operational and financial contexts."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="service"/> <type value="reference"/> <documentation value="Filter by PractitionerRole.service (Reference to HealthcareService)."/> </searchParam> </resource> <resource> <type value="Patient"/> <supportedProfile value="http://hl7.se/fhir/ig/base/StructureDefinition/SEBasePatient"/> <documentation value="Represents patients within the WOF Portal, conforming to the Swedish base patient profile."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Use system fro,m se base profile Http://"/> </searchParam> </resource> <resource> <type value="Organization"/> <supportedProfile value="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/service-provider-portal"/> <supportedProfile value="https://canonical.fhir.link/servicewell/wof-portal/StructureDefinition/billing-organization-portal"/> <documentation value="Organizations in WOF Portal MAY conform to multiple profiles, representing different organizational roles. ServiceProvider represents the top-level owning organization (tenant) within the platform. BillingOrganization represents financial responsibility and ownership of invoicing and reporting. Organizations are not exposed as searchable catalogs. They are resolved using stable identifiers only: - resource id - organization number (identifier) Clients MAY filter by profile when needed (e.g. using _profile), but profile-based filtering is not required for lookup by id or identifier."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> <documentation value="Search by Organization resource id."/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> <documentation value="Search by organization number using system|value."/> </searchParam> </resource> <resource> <type value="Schedule"/> <documentation value="Represents planned working time, not bookable availability."/> </resource> <resource> <type value="Location"/> <documentation value="Portal-scoped locations used as areas. Supported interaction: search."/> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="physical-type"/> <type value="token"/> <documentation value="Filter by Location.physicalType (e.g., Area)."/> </searchParam> </resource> <operation> <name value="getOffersContext"/> <definition value="https://canonical.fhir.link/servicewell/wof-portal/OperationDefinition/get-offers-context"/> <documentation value="Returns enriched offer context for presentation and selection."/> </operation> </rest> </CapabilityStatement>