EU Health Data API
1.0.0-ballot - ballot
150
EU Health Data API
1.0.0-ballot - ballot
150
EU Health Data API, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/euridice-org/eu-health-data-api/ and changes regularly. See the Directory of published versions
| Active as of 2026-01-26 |
{
"resourceType" : "CapabilityStatement",
"id" : "document-consumer-eu-api",
"language" : "en",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement document-consumer-eu-api</b></p><a name=\"document-consumer-eu-api\"> </a><a name=\"hcdocument-consumer-eu-api\"> </a><h2 id=\"title\">EEHRxF Document Consumer CapabilityStatement</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-01-26 </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><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div><p>The Document Consumer actor queries for document metadata and retrieves documents\nfrom a Document Access Provider. It also queries for patient context using PDQm.\nIt groups with the IUA Authorization Client, SMART App, or SMART Backend Service selected by the\nenvironment and use case. The Authorization Server is a separate participant; see\n<a href=\"authorization.html#environment-specific-requirements\">Authorization</a>.</p>\n</div><div class=\"lead\"><em>Security</em></div><blockquote><div><p>This abstract requirements statement does not advertise a fixed security service. A concrete\ndeployment SHALL declare exactly one security-service coding from the <a href=\"ValueSet-eu-api-authorization-security-service.html\">EU Health Data API\nAuthorization Security Service ValueSet</a>,\nselected for its environment. It SHALL NOT advertise both services unless a future profile defines\ndual conformance.</p>\n<h3>IHE IUA</h3>\n<p>The consumer groups with the IUA Authorization Client and requests the applicable IUA MHD\ntransaction scopes for its supported transactions:</p>\n<ul>\n<li>ITI-67</li>\n<li>ITI-68</li>\n</ul>\n<p>PDQm ITI-78 has no IUA MHD transaction scope.</p>\n<h3>SMART Backend Services</h3>\n<p>For a pre-authorized system-to-system use case, the consumer groups with the SMART Backend Service,\nuses <code>client_credentials</code> and <code>private_key_jwt</code>, and requests:</p>\n<ul>\n<li>system/DocumentReference.rs (read + search DocumentReference - ITI-67)</li>\n<li>system/Binary.r (read Binary for document retrieval - ITI-68)</li>\n<li>system/Bundle.r (read Bundle for FHIR Document retrieval - ITI-68)</li>\n<li>system/Patient.rs (read + search Patient for context - ITI-78)</li>\n</ul>\n<h3>Interactive SMART</h3>\n<p>Where an interactive use case applies, the consumer groups with the SMART App, uses authorization\ncode with PKCE, and replaces the <code>system/</code> prefix above with the applicable <code>patient/</code> or <code>user/</code>\nscope prefix.</p>\n<p>All modes use TLS 1.2 or higher. See <a href=\"authorization.html#smart-app-launch\">Authorization</a> for the\nselected capability set, discovery, token, and scope rules.</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>\u00a0</td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"/><td class=\"text-center\"/><td>_id, _lastUpdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type</td><td/><td/><td/></tr><tr><td><a href=\"#Binary1-2\">Binary</a></td><td>\u00a0</td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#Patient1-3\">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\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"><span title=\"SHALL\"><b>Y</b></span></td><td class=\"text-center\"/><td class=\"text-center\"/><td>identifier, _id, active, family, given, telecom, birthdate, address, address-city, address-country, address-postalcode, address-state, gender</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: SHALL </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><strong>SHALL</strong> support <br/><code>read</code><div><p>Read DocumentReference by logical ID</p>\n</div><code>search-type</code><div><p>Search DocumentReference (ITI-67)</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>DocumentReference resources are queried using ITI-67 and returned as base FHIR resources. No EU or MHD return profile is required.</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><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Logical id</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>Patient reference</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>token</code></td><td><div><p>Chained patient identifier</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Resource version last updated</p>\n</div></td></tr><tr><td><b>MAY</b></td><td>author.given</td><td><code>string</code></td><td><div><p>Author given name</p>\n</div></td></tr><tr><td><b>MAY</b></td><td>author.family</td><td><code>string</code></td><td><div><p>Author family name</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">category</a></td><td><code>token</code></td><td><div><p>Document category</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.5/SearchParameter-DocumentReference-Creation.html\">creation</a></td><td><code>date</code></td><td><div><p>Document creation time</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">date</a></td><td><code>date</code></td><td><div><p>Reference creation time</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">event</a></td><td><code>token</code></td><td><div><p>Main clinical acts documented</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">facility</a></td><td><code>token</code></td><td><div><p>Facility kind</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">format</a></td><td><code>token</code></td><td><div><p>Document format</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>Document identifier</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">period</a></td><td><code>date</code></td><td><div><p>Documented service period</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">related</a></td><td><code>reference</code></td><td><div><p>Related identifier or resource</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">security-label</a></td><td><code>token</code></td><td><div><p>Document security label</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">setting</a></td><td><code>token</code></td><td><div><p>Clinical setting</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">status</a></td><td><code>token</code></td><td><div><p>Document reference status</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">type</a></td><td><code>token</code></td><td><div><p>Document type</p>\n</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=\"Binary1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Binary</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/binary.html\">Binary</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><strong>SHALL</strong> support <br/><code>read</code><div><p>Retrieve document content (ITI-68)</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Binary resources contain the actual document content and are retrieved using the\nITI-68 Retrieve Document transaction.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </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><strong>SHALL</strong> support <br/><code>read</code><div><p>Read Patient by logical ID</p>\n</div><code>search-type</code><div><p>Search for patients (PDQm ITI-78)</p>\n</div></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 resources are searched to establish patient context before querying for documents.\nThis uses PDQm [ITI-78] with identifier as a required search parameter.</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><a href=\"http://hl7.org/fhir/R4/patient.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>Patient identifier (e.g., national ID, MRN) - required for patient lookup</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Patient logical ID</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">active</a></td><td><code>token</code></td><td><div><p>Whether the patient record is active</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">family</a></td><td><code>string</code></td><td><div><p>Patient family name</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">given</a></td><td><code>string</code></td><td><div><p>Patient given name</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">telecom</a></td><td><code>token</code></td><td><div><p>Telecom details of the patient</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">birthdate</a></td><td><code>date</code></td><td><div><p>Patient date of birth</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">address</a></td><td><code>string</code></td><td><div><p>A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">address-city</a></td><td><code>string</code></td><td><div><p>A city specified in an address</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">address-country</a></td><td><code>string</code></td><td><div><p>A country specified in an address</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">address-postalcode</a></td><td><code>string</code></td><td><div><p>A postal code specified in an address</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">address-state</a></td><td><code>string</code></td><td><div><p>A state specified in an address</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/patient.html#search\">gender</a></td><td><code>token</code></td><td><div><p>Administrative gender of the patient</p>\n</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/document-consumer-eu-api",
"version" : "1.0.0-ballot",
"name" : "DocumentConsumerEuApi",
"title" : "EEHRxF Document Consumer CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2026-01-26",
"publisher" : "HL7 Europe",
"contact" : [
{
"name" : "HL7 Europe",
"telecom" : [
{
"system" : "url",
"value" : "http://hl7.eu"
}
]
}
],
"description" : "Requirements for an EEHRxF Document Consumer that queries and retrieves FHIR Documents.",
"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" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"rest" : [
{
"mode" : "client",
"documentation" : "The Document Consumer actor queries for document metadata and retrieves documents\nfrom a Document Access Provider. It also queries for patient context using PDQm.\nIt groups with the IUA Authorization Client, SMART App, or SMART Backend Service selected by the\nenvironment and use case. The Authorization Server is a separate participant; see\n[Authorization](authorization.html#environment-specific-requirements).",
"security" : {
"description" : "This abstract requirements statement does not advertise a fixed security service. A concrete\ndeployment SHALL declare exactly one security-service coding from the [EU Health Data API\nAuthorization Security Service ValueSet](ValueSet-eu-api-authorization-security-service.html),\nselected for its environment. It SHALL NOT advertise both services unless a future profile defines\ndual conformance.\n\n### IHE IUA\n\nThe consumer groups with the IUA Authorization Client and requests the applicable IUA MHD\ntransaction scopes for its supported transactions:\n- ITI-67\n- ITI-68\n\nPDQm ITI-78 has no IUA MHD transaction scope.\n\n### SMART Backend Services\n\nFor a pre-authorized system-to-system use case, the consumer groups with the SMART Backend Service,\nuses `client_credentials` and `private_key_jwt`, and requests:\n- system/DocumentReference.rs (read + search DocumentReference - ITI-67)\n- system/Binary.r (read Binary for document retrieval - ITI-68)\n- system/Bundle.r (read Bundle for FHIR Document retrieval - ITI-68)\n- system/Patient.rs (read + search Patient for context - ITI-78)\n\n### Interactive SMART\n\nWhere an interactive use case applies, the consumer groups with the SMART App, uses authorization\ncode with PKCE, and replaces the `system/` prefix above with the applicable `patient/` or `user/`\nscope prefix.\n\nAll modes use TLS 1.2 or higher. See [Authorization](authorization.html#smart-app-launch) for the\nselected capability set, discovery, token, and scope rules."
},
"resource" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "DocumentReference",
"documentation" : "DocumentReference resources are queried using ITI-67 and returned as base FHIR resources. No EU or MHD return profile is required.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read DocumentReference by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search DocumentReference (ITI-67)"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "_lastUpdated",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type" : "date",
"documentation" : "Resource version last updated"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "author.given",
"type" : "string",
"documentation" : "Author given name"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "author.family",
"type" : "string",
"documentation" : "Author family name"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type" : "token",
"documentation" : "Document category"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "creation",
"definition" : "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
"type" : "date",
"documentation" : "Document creation time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
"type" : "date",
"documentation" : "Reference creation time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "event",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"type" : "token",
"documentation" : "Main clinical acts documented"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "facility",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"type" : "token",
"documentation" : "Facility kind"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "format",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"type" : "token",
"documentation" : "Document format"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Document identifier"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Patient reference"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient.identifier",
"type" : "token",
"documentation" : "Chained patient identifier"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"type" : "date",
"documentation" : "Documented service period"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "related",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
"type" : "reference",
"documentation" : "Related identifier or resource"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "security-label",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
"type" : "token",
"documentation" : "Document security label"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "setting",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"type" : "token",
"documentation" : "Clinical setting"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type" : "token",
"documentation" : "Document reference status"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-type",
"type" : "token",
"documentation" : "Document type"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Binary",
"documentation" : "Binary resources contain the actual document content and are retrieved using the\nITI-68 Retrieve Document transaction.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Retrieve document content (ITI-68)"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"type" : "Patient",
"supportedProfile" : [
🔗 "http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core"
],
"documentation" : "Patient resources are searched to establish patient context before querying for documents.\nThis uses PDQm [ITI-78] with identifier as a required search parameter.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read Patient by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for patients (PDQm ITI-78)"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-identifier",
"type" : "token",
"documentation" : "Patient identifier (e.g., national ID, MRN) - required for patient lookup"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Patient logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "active",
"definition" : "http://hl7.org/fhir/SearchParameter/Patient-active",
"type" : "token",
"documentation" : "Whether the patient record is active"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "family",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-family",
"type" : "string",
"documentation" : "Patient family name"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "given",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-given",
"type" : "string",
"documentation" : "Patient given name"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "telecom",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-telecom",
"type" : "token",
"documentation" : "Telecom details of the patient"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "birthdate",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-birthdate",
"type" : "date",
"documentation" : "Patient date of birth"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address",
"type" : "string",
"documentation" : "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address-city",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-city",
"type" : "string",
"documentation" : "A city specified in an address"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address-country",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-country",
"type" : "string",
"documentation" : "A country specified in an address"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address-postalcode",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
"type" : "string",
"documentation" : "A postal code specified in an address"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "address-state",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-address-state",
"type" : "string",
"documentation" : "A state specified in an address"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "gender",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
"type" : "token",
"documentation" : "Administrative gender of the patient"
}
]
}
]
}
]
}
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.health-data-api#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-11-05
