Wof Portal
0.1.0 - ci-build [WIP]

Wof Portal, 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

Artifacts Summary

Contents:

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 Portal Capability Statement

This CapabilityStatement defines the canonical domain model and API principles of the WOF Portal

Behavior: Operation Definitions

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

$getOffersContext — Booking Content Context

$getOffersContext is a read-oriented FHIR operation designed to let a frontend quickly populate booking content so a patient can choose what to book and with whom/where — without needing multiple round-trips.
It may include ActivityDefinitionPortal, HealthcareServicePortal, PractitionerRolePortal and OfferPortal.
It MUST NOT include Schedule, Slot, or bookable time slots.

This operation returns a profiled Bundle that may include:

  • ActivityDefinitionPortal (what is being offered)
  • HealthcareServicePortal (where / which clinic service offers it)
  • PractitionerRolePortal (who can perform it)
  • Offer resources (a lightweight “relation + settings” object)

The response is intentionally shaped for fast content rendering, not for scheduling.

Structures: Resource Profiles

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

ActivityDefinitionPortal

ActivityDefinition represents what can be offered and booked as a service.

It answers the question: “What service is the patient booking?”

Actor-specific obligations

  • WofPortalClient only needs to populate code.coding.code when submitting a known service type code.
  • WofPortalServer populates the full representation, including meta, presentation fields, kind, and the complete code structure.
BillingOrganizationPortal

BillingOrganization represents the entity that is financially responsible for healthcare services.
Bundle (Offers Context) — WOF Portal

Response Bundle for $getOffersContext. Contains a subset of ActivityDefinitionPortal, HealthcareServicePortal, PractitionerRolePortal and OfferPortal. Intended for fast content rendering. Does not include scheduling or bookable time slots (no Schedule, no Slot).
HealthcareServicePortal

HealthcareServicePortal represents the place and operational context where care is performed.

It answers the question: “Where can the patient receive a service?”

The profile is used to present bookable care locations in the portal, including the responsible organization, contact information, location references, technical endpoint, and portal-specific clinic information.

Portal-specific presentation details are grouped in the clinicInfo extension, while booking-related attachment payloads are grouped in the attachments extension.
Location Area

Location profile exposed by WOF Portal Public API.
OfferPortal

OfferPortal represents a bookable offering in a specific context.

It answers the question: “Which service can be booked, by whom, and where — and what are the booking-facing settings in that context?”
PractitionerRolePortal

PractitionerRolePortal represents a practitioner acting in a specific operational and financial context.

It answers the question: “In which role, at which service location, and under which financial responsibility does this practitioner perform services?”
SchedulePortal

SchedulePortal represents when a practitioner is planned to work during a given time period.

It answers the question: “Who is working in the coming weeks, and who can potentially be shown as bookable?”
ServiceProviderPortal

ServiceProvider represents the top-level owning organization within the platform.

It answers the question: “Which organization owns the configuration, endpoints, and service structure for a customer?”

Structures: Extension Definitions

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

Binary Reference

Reference to a contained Binary resource.
Campaigns

Campaign identifiers encoded as JSON.
Clinic Info

Container extension for clinic information shown in the portal.
HealthcareService Attachments

Attachment container extension for booking rules.
PractitionerRole Description

Description of the practitioner role.
Sort Key

Sort order key for Location.

Example: Example Instances

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

Example ActivityDefinitionPortal Extraktion

Example ActivityDefinitionPortal resource for the service concept Extraktion.
Example HealthcareServicePortal

Example HealthcareServicePortal resource with clinic information and booking attachments.