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 Client CapabilityStatement

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

Authenticated client access to the OZO FHIR API for Practitioner, RelatedPerson, and Patient roles. All three roles share the same interactions — the AAA proxy transparently scopes access by rewriting search queries based on the caller's credentials and CareTeam memberships. Write operations validate that the sender/requester is the authenticated user.

Raw OpenAPI-Swagger Definition file | Download

OZO Client 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

Client access for Practitioner, RelatedPerson, and Patient roles. The AAA proxy automatically filters all search results based on the caller's identity and CareTeam memberships. Write operations validate that the sender/requester is the authenticated user. See the CapabilityStatements documentation page for per-role scoping 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/OZOPatientyy
Practitionerhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOPractitioneryy
RelatedPersonhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZORelatedPersonyy
CareTeamhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCareTeamyy
CommunicationRequesthttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCommunicationRequestyyy
Communicationhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCommunicationyyy
Taskhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOTaskyy
AuditEventhttp://ozoverbindzorg.nl/fhir/StructureDefinition/OZOAuditEventyyy
Subscription yyyy

Resource Conformance: supported Patient

Base System Profile
OZO Patient
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

Proxy auto-scopes to patients within the caller's CareTeam context.

Resource Conformance: supported Practitioner

Base System Profile
OZO Practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

Proxy auto-scopes to practitioners within the caller's CareTeam context.

Resource Conformance: supported RelatedPerson

Base System Profile
OZO RelatedPerson
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

Proxy auto-scopes to related persons within the caller's CareTeam context.

Resource Conformance: supported CareTeam

Base System Profile
OZO CareTeam
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

Proxy auto-scopes to CareTeams where the caller is a participant or subject.

Resource Conformance: supported CommunicationRequest

Base System Profile
OZO CommunicationRequest
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type, create.

Documentation

Threads where the caller or their CareTeam is a recipient. Create requires requester = authenticated user.

Resource Conformance: supported Communication

Base System Profile
OZO Communication
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type, create.

Documentation

Messages in threads accessible to the caller. Create requires sender = authenticated user.

Resource Conformance: supported Task

Base System Profile
OZO Task
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

Tasks owned by or assigned to the caller. Used as read/unread indicator.

Resource Conformance: supported AuditEvent

Base System Profile
OZO AuditEvent
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type, create.

Documentation

Audit events within the caller's access scope. Create requires agent[requestor=true].who = authenticated user.

Resource Conformance: supported Subscription

Core FHIR Resource
Subscription
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Documentation

Subscriptions with criteria automatically rewritten by the proxy to scope to the caller's access. Uses notify-then-pull pattern (empty payload).