OZO FHIR implementation guide
0.6.3 - ci-build

OZO FHIR implementation guide - Local Development build (v0.6.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: OZO Server Base CapabilityStatement

Official URL: http://ozoverbindzorg.nl/fhir/CapabilityStatement/OZO-Server Version: 0.6.3
Active as of 2026-03-27 Computable Name: OZOServerCapabilityStatement

The OZO FHIR API provides healthcare communication services for the OZO platform, connecting care professionals with informal caregivers. This base CapabilityStatement is returned for unauthenticated requests. Authenticate with Nuts credentials to receive a role-specific CapabilityStatement detailing your permitted interactions.

Raw OpenAPI-Swagger Definition file | Download

OZO Server Base CapabilityStatement

  • Implementation Guide Version: 0.6.3
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2026-03-27
  • Published by: Headease

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.

FHIR RESTful Capabilities

Mode: server

The OZO FHIR API requires authentication via the Nuts protocol with DPoP tokens. Access is role-based: system, practitioner, related person, or patient. Each role has a specific CapabilityStatement describing permitted interactions. The proxy enforces notify-then-pull for Subscriptions (no payload in notifications) as required in Dutch healthcare.

Security

Authentication via Nuts Verifiable Credentials with DPoP proof-of-possession tokens. mTLS required for system-to-system communication. See the Authentication and Authorization sections of this Implementation Guide for details.

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
Patienthttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOPatient
Practitionerhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOPractitioner
RelatedPersonhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZORelatedPerson
Organizationhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOOrganization
CareTeamhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCareTeam
CommunicationRequesthttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCommunicationRequest
Communicationhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCommunication
Taskhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOTask
AuditEventhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOAuditEvent
Subscription 

Resource Conformance: supported Patient

Base System Profile
OZO Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Resource Conformance: supported Practitioner

    Base System Profile
    OZO Practitioner
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary

      Resource Conformance: supported RelatedPerson

      Base System Profile
      OZO RelatedPerson
      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary

        Resource Conformance: supported Organization

        Base System Profile
        OZO Organization
        Profile Conformance
        SHALL
        Reference Policy

        Interaction summary

          Resource Conformance: supported CareTeam

          Base System Profile
          OZO CareTeam
          Profile Conformance
          SHALL
          Reference Policy

          Interaction summary

            Documentation

            Patient care teams. See also OZOOrganizationalCareTeam for department/organization teams.

            Resource Conformance: supported CommunicationRequest

            Base System Profile
            OZO CommunicationRequest
            Profile Conformance
            SHALL
            Reference Policy

            Interaction summary

              Resource Conformance: supported Communication

              Base System Profile
              OZO Communication
              Profile Conformance
              SHALL
              Reference Policy

              Interaction summary

                Resource Conformance: supported Task

                Base System Profile
                OZO Task
                Profile Conformance
                SHALL
                Reference Policy

                Interaction summary

                  Resource Conformance: supported AuditEvent

                  Base System Profile
                  OZO AuditEvent
                  Profile Conformance
                  SHALL
                  Reference Policy

                  Interaction summary

                    Resource Conformance: supported Subscription

                    Core FHIR Resource
                    Subscription
                    Reference Policy
                    Interaction summary

                      Documentation

                      Subscriptions use the notify-then-pull pattern: notifications contain no resource payload. The subscriber must fetch the resource after receiving the notification.