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
| Active as of 2026-03-27 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="OZO-Server"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement OZO-Server</b></p><a name="OZO-Server"> </a><a name="hcOZO-Server"> </a><h2 id="title">OZO Server Base CapabilityStatement</h2><ul><li>Implementation Guide Version: 0.6.3 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Published on: 2026-03-27 </li><li>Published by: Headease </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div><p>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.</p>
</div><div class="lead"><em>Security</em></div><blockquote><div><p>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.</p>
</div></blockquote></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Patient1-1">Patient</a></td><td><a href="StructureDefinition-ozo-patient.html">http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOPatient</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#Practitioner1-2">Practitioner</a></td><td><a href="StructureDefinition-ozo-practitioner.html">http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOPractitioner</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#RelatedPerson1-3">RelatedPerson</a></td><td><a href="StructureDefinition-ozo-relatedperson.html">http://ozoverbindzorg.nl/fhir/StructureDefinition/OZORelatedPerson</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#Organization1-4">Organization</a></td><td><a href="StructureDefinition-ozo-organization.html">http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOOrganization</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#CareTeam1-5">CareTeam</a></td><td><a href="StructureDefinition-ozo-careteam.html">http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCareTeam</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#CommunicationRequest1-6">CommunicationRequest</a></td><td><a href="StructureDefinition-ozo-communicationrequest.html">http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCommunicationRequest</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#Communication1-7">Communication</a></td><td><a href="StructureDefinition-ozo-communication.html">http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCommunication</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#Task1-8">Task</a></td><td><a href="StructureDefinition-ozo-task.html">http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOTask</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#AuditEvent1-9">AuditEvent</a></td><td><a href="StructureDefinition-ozo-auditevent.html">http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOAuditEvent</a></td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr><tr><td><a href="#Subscription1-10">Subscription</a></td><td> </td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Patient1-1" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Patient</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ozo-patient.html">OZO Patient</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Practitioner1-2" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Practitioner</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ozo-practitioner.html">OZO Practitioner</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="RelatedPerson1-3" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>RelatedPerson</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ozo-relatedperson.html">OZO RelatedPerson</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Organization1-4" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Organization</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ozo-organization.html">OZO Organization</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="CareTeam1-5" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>CareTeam</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ozo-careteam.html">OZO CareTeam</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Patient care teams. See also OZOOrganizationalCareTeam for department/organization teams.</p>
</div></blockquote></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="CommunicationRequest1-6" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>CommunicationRequest</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ozo-communicationrequest.html">OZO CommunicationRequest</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Communication1-7" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Communication</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ozo-communication.html">OZO Communication</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Task1-8" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Task</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ozo-task.html">OZO Task</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="AuditEvent1-9" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>AuditEvent</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-ozo-auditevent.html">OZO AuditEvent</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Subscription1-10" class="panel-title"><span style="float: right;">Resource Conformance: supported </span>Subscription</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/subscription.html">Subscription</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul/></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Subscriptions use the notify-then-pull pattern: notifications contain no resource payload. The subscriber must fetch the resource after receiving the notification.</p>
</div></blockquote></div></div></div></div></div></div>
</text>
<url value="http://ozoverbindzorg.nl/fhir/CapabilityStatement/OZO-Server"/>
<version value="0.6.3"/>
<name value="OZOServerCapabilityStatement"/>
<title value="OZO Server Base CapabilityStatement"/>
<status value="active"/>
<experimental value="false"/>
<date value="2026-03-27"/>
<publisher value="Headease"/>
<contact>
<name value="Headease"/>
<telecom>
<system value="url"/>
<value value="https://headease.nl"/>
</telecom>
</contact>
<description
value="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."/>
<kind value="instance"/>
<fhirVersion value="4.0.1"/>
<format value="json"/>
<format value="xml"/>
<rest>
<mode value="server"/>
<documentation
value="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>
<cors value="false"/>
<description
value="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."/>
</security>
<resource>
<type value="Patient"/>
<profile
value="http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOPatient"/>
</resource>
<resource>
<type value="Practitioner"/>
<profile
value="http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOPractitioner"/>
</resource>
<resource>
<type value="RelatedPerson"/>
<profile
value="http://ozoverbindzorg.nl/fhir/StructureDefinition/OZORelatedPerson"/>
</resource>
<resource>
<type value="Organization"/>
<profile
value="http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOOrganization"/>
</resource>
<resource>
<type value="CareTeam"/>
<profile
value="http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCareTeam"/>
<documentation
value="Patient care teams. See also OZOOrganizationalCareTeam for department/organization teams."/>
</resource>
<resource>
<type value="CommunicationRequest"/>
<profile
value="http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCommunicationRequest"/>
</resource>
<resource>
<type value="Communication"/>
<profile
value="http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOCommunication"/>
</resource>
<resource>
<type value="Task"/>
<profile
value="http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOTask"/>
</resource>
<resource>
<type value="AuditEvent"/>
<profile
value="http://ozoverbindzorg.nl/fhir/StructureDefinition/OZOAuditEvent"/>
</resource>
<resource>
<type value="Subscription"/>
<documentation
value="Subscriptions use the notify-then-pull pattern: notifications contain no resource payload. The subscriber must fetch the resource after receiving the notification."/>
</resource>
</rest>
</CapabilityStatement>