EU Health Data API
1.0.0-ballot - ballot
150
EU Health Data API
1.0.0-ballot - ballot
150
This page is part of the EU Health Data API (v1.0.0-ballot: STU1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Draft as of 2026-03-10 |
{
"resourceType" : "CapabilityStatement",
"id" : "EEHRxF-DocumentAccessProvider-Example",
"language" : "en",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement EEHRxF-DocumentAccessProvider-Example</b></p><a name=\"EEHRxF-DocumentAccessProvider-Example\"> </a><a name=\"hcEEHRxF-DocumentAccessProvider-Example\"> </a><h2 id=\"title\">Example: Document Access Provider Supporting EPS and Laboratory</h2><ul><li>Implementation Guide Version: 1.0.0-ballot </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>json</code>, <code>xml</code></li><li>Published on: 2026-03-10 </li><li>Published by: HL7 Europe </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><p>This CapabilityStatement instantiates the CapabilityStatement <a href=\"CapabilityStatement-EEHRxF-DocumentAccessProvider.html\">EEHRxF Document Access Provider CapabilityStatement</a></p><h3 id=\"shallIGs\">SHALL Support the Following Implementation Guides</h3><ul><li>http://hl7.eu/fhir/eps</li><li>http://hl7.eu/fhir/laboratory</li></ul><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>This server provides document exchange for European Patient Summaries and\nLaboratory Reports. It supports MHD ITI-67 (Find Document References),\nITI-68 (Retrieve Document), and PDQm ITI-78 (Patient Demographics Query).</p>\n</div><div class=\"lead\"><em>Security</em></div><div class=\"row\"><div class=\"col-lg-6\">Enable CORS: no</div><div class=\"col-lg-6\">Security services supported: <code>SMART-on-FHIR</code></div></div><blockquote><div><p>SMART Backend Services authorization required.</p>\n</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=\"#DocumentReference1-1\">DocumentReference</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"StructureDefinition-EehrxfMhdDocumentReference.html\">EEHRxF MHD DocumentReference Profile</a><br/>\u00a0\u00a0<a href=\"https://profiles.ihe.net/ITI/MHD/4.2.3/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">MHD DocumentReference Minimal</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>patient, type, status, date, _id</td><td/><td/><td/></tr><tr><td><a href=\"#Patient1-2\">Patient</a></td><td>Supported Profiles<br/>\u00a0\u00a0<a href=\"http://hl7.eu/fhir/base/2.0.0-ballot/StructureDefinition-patient-eu-core.html\">Patient (EU core)</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>identifier, _id</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DocumentReference1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: supported </span>DocumentReference</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/documentreference.html\">DocumentReference</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><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-EehrxfMhdDocumentReference.html\">EEHRxF MHD DocumentReference Profile</a><br/><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.3/StructureDefinition-IHE.MHD.Minimal.DocumentReference.html\">MHD DocumentReference Minimal</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>DocumentReference resources are served via ITI-67. This server indexes Patient\nSummaries (LOINC 60591-5) and Laboratory Reports (LOINC 11502-2).</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>type</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>status</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>date</td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-2\" 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-4\"><span class=\"lead\">Core FHIR Resource</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</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><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"http://hl7.eu/fhir/base/2.0.0-ballot/StructureDefinition-patient-eu-core.html\">Patient (EU core)</a></p></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Patient lookup via PDQm ITI-78.</p>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td>_id</td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "http://hl7.eu/fhir/health-data-api/CapabilityStatement/EEHRxF-DocumentAccessProvider-Example",
"version" : "1.0.0-ballot",
"name" : "ExampleDocumentAccessProviderEPSLab",
"title" : "Example: Document Access Provider Supporting EPS and Laboratory",
"status" : "draft",
"experimental" : true,
"date" : "2026-03-10",
"publisher" : "HL7 Europe",
"contact" : [
{
"name" : "HL7 Europe",
"telecom" : [
{
"system" : "url",
"value" : "http://hl7.eu"
}
]
}
],
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "150",
"display" : "Europe"
}
]
}
],
"copyright" : "Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).",
"kind" : "instance",
"instantiates" : [
🔗 "http://hl7.eu/fhir/health-data-api/CapabilityStatement/EEHRxF-DocumentAccessProvider"
],
"implementation" : {
"description" : "Example hospital document access provider",
"url" : "https://example.org/fhir"
},
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"implementationGuide" : [
"http://hl7.eu/fhir/eps",
"http://hl7.eu/fhir/laboratory"
],
"rest" : [
{
"mode" : "server",
"documentation" : "This server provides document exchange for European Patient Summaries and\nLaboratory Reports. It supports MHD ITI-67 (Find Document References),\nITI-68 (Retrieve Document), and PDQm ITI-78 (Patient Demographics Query).",
"security" : {
"service" : [
{
"coding" : [
{
"system" : "http://hl7.org/fhir/restful-security-service",
"code" : "SMART-on-FHIR"
}
]
}
],
"description" : "SMART Backend Services authorization required."
},
"resource" : [
{
"type" : "DocumentReference",
"supportedProfile" : [
🔗 "http://hl7.eu/fhir/health-data-api/StructureDefinition/EehrxfMhdDocumentReference"🔗 ,
"https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference"
],
"documentation" : "DocumentReference resources are served via ITI-67. This server indexes Patient\nSummaries (LOINC 60591-5) and Laboratory Reports (LOINC 11502-2).",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "patient",
"type" : "reference"
},
{
"name" : "type",
"type" : "token"
},
{
"name" : "status",
"type" : "token"
},
{
"name" : "date",
"type" : "date"
},
{
"name" : "_id",
"type" : "token"
}
]
},
{
"type" : "Patient",
"supportedProfile" : [
🔗 "http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core"
],
"documentation" : "Patient lookup via PDQm ITI-78.",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"searchParam" : [
{
"name" : "identifier",
"type" : "token"
},
{
"name" : "_id",
"type" : "token"
}
]
}
]
}
]
}
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.health-data-api#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-03-13
