FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageservicewell.fhir.wof-connect
Resource TypeCapabilityStatement
IdCapabilityStatement-WofConnectCapabilityStatement.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/servicewell/servicewell.fhir.wof-connect/CapabilityStatement-WofConnectCapabilityStatement.html
URLhttp://canonical.fhir.link/servicewell/wof-connect/CapabilityStatement/WofConnectCapabilityStatement
Version0.1.1
Statusactive
Date2026-02-10T07:00:00+00:00
NameWofConnectCapabilityStatement
TitleWOF Connect Capability Statement
DescriptionThis 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.
Kindcapability

Resources that use this resource

No resources found


Resources that this resource uses

CapabilityStatement
IHE.Scheduling.serverIHE Scheduling Server
OperationDefinition
BookAppointmentBook / Modify / Cancel Appointment
FindAppointmentsFind Appointments (Available Slots)
GetScheduleContextGet Schedule Context
appointment-holdHold_Appointment_Operation
StructureDefinition
wof-connect-activitydefinitionWof Connect ActivityDefinition
wof-connect-appointmentWof Connect Appointment
wof-connect-economyorganizationWof Connect Economy Organization
wof-connect-healthcareserviceWof Connect HealthcareService
wof-connect-patientWof Connect Patient
wof-connect-practitionerWof Connect Practitioner
wof-connect-practitionerroleWof Connect PractitionerRole
wof-connect-scheduleWof Connect Schedule
SEBasePatientSE base profil for patient

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement WofConnectCapabilityStatement

WOF Connect Capability Statement

  • Implementation Guide Version: 0.1.1
  • FHIR Version: 4.0.1
  • Supported Formats: json
  • Published on: 2026-02-10 07: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

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 Conformance: SHALL Patient

Base System Profile
Wof Connect Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

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

Interaction summary
  • SHALL support
    search-type

    Search Patients: GET [base]/Patient?identifier=system|value.

    read

    Read a Patient by logical id: GET [base]/Patient/{id}.

Documentation

Patient resources returned by WOF Connect integrations. Supported interactions: search, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

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

 

Resource Conformance: SHALL Appointment

Base System Profile
Wof Connect Appointment
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support
    read

    Read Appointment: GET [base]/Appointment/{id} (may require patient context).

    search-type

    Search Appointments (patient-scoped): GET [base]/Appointment?[params]

Documentation

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.

Extended Operations
ConformanceOperationDocumentation
SHALL$find

IHE $find to find available appointment opportunities within a time window.

SHALL$hold

IHE $hold to temporarily hold an appointment opportunity.

SHOULD$book

IHE $book to create/modify/cancel an appointment.

Resource Conformance: SHALL ActivityDefinition

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Documentation

ActivityDefinition represents a shared service concept (treatment/visit type) identified by code.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcodetoken

Search by service concept code (e.g. WOF Connect service-type or service-type-id coding).

 

Resource Conformance: SHALL HealthcareService

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Documentation

HealthcareService represents where care is performed. In WOF Connect, this typically corresponds to a clinic/location context used for scheduling and availability.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Search by HealthcareService identifier (e.g. clinic id or external system identifier).

 

Resource Conformance: SHALL PractitionerRole

Base System Profile
Wof Connect PractitionerRole
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Documentation

PractitionerRole represents a practitioner acting in a specific operational context, typically tied to a HealthcareService and used for scheduling and booking.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLservicereference

Filter by PractitionerRole.healthcareService (service).

SHALLpractitionerreference

Filter by PractitionerRole.practitioner.

 

Resource Conformance: SHALL Organization

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read, search-type.

Documentation

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.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Read or search Organization by logical id.

SHALLidentifiertoken

Search Organization by business or billing identifier using system|value. The exact identifier system is vendor-specific but MUST be stable per endpoint.

 

Resource Conformance: SHALL Schedule

Base System Profile
Wof Connect Schedule
Profile Conformance
SHALL
Reference Policy

Supported Profiles

https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/IHE.Scheduling.Schedule|1.0.0

Interaction summary
  • SHALL support read, search-type.

Documentation

Schedules represent planned working time and related scheduled context.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLactorreference

Filter schedules by Schedule.actor (HealthcareService, Practitioner, PractitionerRole).

SHALLservice-typetoken

Filter schedules by service type (Schedule.serviceType). Use token system|code where system is typically:

  • http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id|{serviceTypeId}

Note: Schedules also carry endpoint-id as an additional coding for uniqueness, but endpoint-id alone is not a service type filter.

 
Extended Operations
ConformanceOperationDocumentation
SHALL$get-schedule-context

Returns a searchset Bundle conforming to WofConnectScheduleContextOperationResponse, containing:

  • Organization (WofConnectEconomyOrganization)
  • HealthcareService (WofConnectHealthcareService)
  • ActivityDefinition (WofConnectActivityDefinition)
  • Schedule (WofConnectSchedule)
  • Practitioner (WofConnectPractitioner)
  • PractitionerRole (WofConnectPractitionerRole)

Resource Conformance: SHALL Practitioner

Base System Profile
Wof Connect Practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read.

Documentation

Practitioner resources are returned as scheduling context (e.g., GetScheduleContext) and MAY be retrieved directly by reference.


Source1

{
  "resourceType": "CapabilityStatement",
  "id": "WofConnectCapabilityStatement",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://canonical.fhir.link/servicewell/wof-connect/CapabilityStatement/WofConnectCapabilityStatement",
  "version": "0.1.1",
  "name": "WofConnectCapabilityStatement",
  "title": "WOF Connect Capability Statement",
  "status": "active",
  "experimental": false,
  "date": "2026-02-10T07:00:00+00:00",
  "publisher": "Service Well AB",
  "contact": [
    {
      "name": "Service Well AB",
      "telecom": [
        {
          "system": "url",
          "value": "https://servicewell.se"
        },
        {
          "system": "email",
          "value": "info@servicewell.se"
        }
      ]
    }
  ],
  "description": "This CapabilityStatement defines the canonical domain model and API principles of **WOF Connect**,\nowned and operated by Service Well.\n\n**IHE Scheduling:** This server instantiates IHE.Scheduling.server (v1.0.0).\n\n**Layering principle:**\n- **WOF Connect** defines vendor-facing interoperability contracts.\n- **WOF Portal** builds on WOF Connect to provide a single, enriched, canonical API.\n\n**Domain separation principles:**\n- **ActivityDefinition** represents a shared service concept and SHALL be identified by code, not by resource id.\n- **HealthcareService** represents where care is performed.\n- **Organization (Economy/Billing)** represents financial responsibility and is independent of service location.\n- **PractitionerRole** represents a practitioner acting in a specific operational and financial context.\n\n**Many-to-many relationships are intentional:**\n- A HealthcareService MAY be associated with multiple Organizations.\n- An Organization MAY provide services at multiple HealthcareServices.\n- A Practitioner MAY have multiple PractitionerRoles across services and billing contexts.\n\n**Integration principle:**\n- External systems integrate with the platform by implementing **WOF Connect**.\n- WOF Portal APIs MAY return enriched and aggregated views not available in WOF Connect.\n\nThis CapabilityStatement documents the canonical behavior of the WOF Connect API.",
  "kind": "capability",
  "instantiates": [
    "https://profiles.ihe.net/ITI/Scheduling/CapabilityStatement/IHE.Scheduling.server|1.0.0"
  ],
  "fhirVersion": "4.0.1",
  "format": [
    "json"
  ],
  "rest": [
    {
      "mode": "server",
      "resource": [
        {
          "type": "Patient",
          "profile": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-patient",
          "supportedProfile": [
            "http://hl7.se/fhir/ig/base/StructureDefinition/SEBasePatient|1.1.0"
          ],
          "documentation": "Patient resources returned by WOF Connect integrations. Supported interactions: search, read.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search Patients: GET [base]/Patient?identifier=system|value."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read a Patient by logical id: GET [base]/Patient/{id}."
            }
          ],
          "searchParam": [
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
              "type": "token",
              "documentation": "Filter by personal identity number using system|value.\nRefer to the FHIR base profile defined by the national HL7 affiliate (e.g. HL7 Sweden).\nIn Sweden, use system=http://electronichealth.se/identifier/personnummer.\nExample: GET [base]/Patient?identifier=http://electronichealth.se/identifier/personnummer|197601082394"
            }
          ]
        },
        {
          "type": "Appointment",
          "profile": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-appointment",
          "documentation": "Appointment supports:\n- Read/search interactions for retrieving booked appointments (patient-scoped).\n- IHE ITI Scheduling operations for finding availability and booking ($find, $hold, $book).\n\nNote: Some endpoints require patient context (e.g. personal identity number) for authorization and/or routing.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read Appointment: GET [base]/Appointment/{id} (may require patient context)."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search Appointments (patient-scoped): GET [base]/Appointment?[params]"
            }
          ],
          "operation": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "find",
              "definition": "http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/FindAppointments",
              "documentation": "IHE $find to find available appointment opportunities within a time window."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "book",
              "definition": "http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/BookAppointment",
              "documentation": "IHE $book to create/modify/cancel an appointment."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "hold",
              "definition": "https://profiles.ihe.net/ITI/Scheduling/OperationDefinition/appointment-hold",
              "documentation": "IHE $hold to temporarily hold an appointment opportunity."
            }
          ]
        },
        {
          "type": "ActivityDefinition",
          "profile": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-activitydefinition",
          "documentation": "ActivityDefinition represents a shared service concept (treatment/visit type) identified by code.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "code",
              "definition": "http://hl7.org/fhir/SearchParameter/ActivityDefinition-code",
              "type": "token",
              "documentation": "Search by service concept code (e.g. WOF Connect service-type or service-type-id coding)."
            }
          ]
        },
        {
          "type": "HealthcareService",
          "profile": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-healthcareservice",
          "documentation": "HealthcareService represents where care is performed.\nIn WOF Connect, this typically corresponds to a clinic/location context\nused for scheduling and availability.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-identifier",
              "type": "token",
              "documentation": "Search by HealthcareService identifier (e.g. clinic id or external system identifier)."
            }
          ]
        },
        {
          "type": "PractitionerRole",
          "profile": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitionerrole",
          "documentation": "PractitionerRole represents a practitioner acting in a specific operational context,\ntypically tied to a HealthcareService and used for scheduling and booking.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "service",
              "definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-service",
              "type": "reference",
              "documentation": "Filter by PractitionerRole.healthcareService (service)."
            },
            {
              "name": "practitioner",
              "definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-practitioner",
              "type": "reference",
              "documentation": "Filter by PractitionerRole.practitioner."
            }
          ]
        },
        {
          "type": "Organization",
          "profile": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-economyorganization",
          "documentation": "Organization represents an economic or billing entity in WOF Connect.\nOrganizations are typically returned as part of Schedule and PractitionerRole context\nand MAY be retrieved directly when referenced.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Read or search Organization by logical id."
            },
            {
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Organization-identifier",
              "type": "token",
              "documentation": "Search Organization by business or billing identifier using system|value.\nThe exact identifier system is vendor-specific but MUST be stable per endpoint."
            }
          ]
        },
        {
          "type": "Schedule",
          "profile": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-schedule",
          "supportedProfile": [
            "https://profiles.ihe.net/ITI/Scheduling/StructureDefinition/IHE.Scheduling.Schedule|1.0.0"
          ],
          "documentation": "Schedules represent planned working time and related scheduled context.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "actor",
              "definition": "http://hl7.org/fhir/SearchParameter/Schedule-actor",
              "type": "reference",
              "documentation": "Filter schedules by Schedule.actor (HealthcareService, Practitioner, PractitionerRole)."
            },
            {
              "name": "service-type",
              "definition": "http://hl7.org/fhir/SearchParameter/Schedule-service-type",
              "type": "token",
              "documentation": "Filter schedules by service type (Schedule.serviceType).\nUse token system|code where system is typically:\n- http://canonical.fhir.link/servicewell/wof-connect/identifiercodesystem/service-type-id|{serviceTypeId}\n\nNote: Schedules also carry endpoint-id as an additional coding for uniqueness, but endpoint-id alone is not a service type filter."
            }
          ],
          "operation": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "get-schedule-context",
              "definition": "http://canonical.fhir.link/servicewell/wof-connect/OperationDefinition/GetScheduleContext",
              "documentation": "Returns a searchset Bundle conforming to WofConnectScheduleContextOperationResponse, containing:\n- Organization (WofConnectEconomyOrganization)\n- HealthcareService (WofConnectHealthcareService)\n- ActivityDefinition (WofConnectActivityDefinition)\n- Schedule (WofConnectSchedule)\n- Practitioner (WofConnectPractitioner)\n- PractitionerRole (WofConnectPractitionerRole)"
            }
          ]
        },
        {
          "type": "Practitioner",
          "profile": "http://canonical.fhir.link/servicewell/wof-connect/StructureDefinition/wof-connect-practitioner",
          "documentation": "Practitioner resources are returned as scheduling context (e.g., GetScheduleContext)\nand MAY be retrieved directly by reference.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read"
            }
          ]
        }
      ]
    }
  ]
}