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-09-28 |
{
"resourceType" : "CapabilityStatement",
"id" : "resource-access-provider-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 resource-access-provider-eu-api</b></p><a name=\"resource-access-provider-eu-api\"> </a><a name=\"hcresource-access-provider-eu-api\"> </a><h2 id=\"title\">EEHRxF Resource Access Provider 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-09-28 </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=\"http://hl7.org/fhir/uv/ipa/STU1.1/CapabilityStatement-ipa-server.html\">International Patient Access Server CapabilityStatement</a></p><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 Resource Access Provider actor responds to queries for clinical data resources\nfollowing IPA patterns. This enables direct resource access complementing\ndocument-based exchange via MHD.</p>\n<p>The protected API groups with the IUA Resource Server or SMART FHIR Resource Server selected by the\nenvironment and use case. Its Authorization Server remains an independent participant.</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.\nThe Resource Server validates access tokens and granted authorization; the independent Authorization\nServer performs token issuance and any client-assertion validation.</p>\n<h3>IHE IUA</h3>\n<p>The provider groups with the IUA Resource Server. The IPA and PDQm interactions in this statement\nhave no IUA MHD transaction scopes; the deployment applies the IUA authorization policy defined for\nits environment.</p>\n<h3>SMART Backend Services</h3>\n<p>For a pre-authorized system-to-system use case, the provider groups with the SMART FHIR Resource\nServer and accepts <code>system/</code> scopes for the resources it supports.</p>\n<h3>Interactive SMART</h3>\n<p>Where an interactive use case applies, the provider groups with the SMART FHIR Resource Server and\naccepts the corresponding <code>patient/</code> or <code>user/</code> scopes for the resources it supports.</p>\n<p>For the IG-level CT grouping recommendation for SMART server roles, see\n<a href=\"authorization.html#smart-server-time-synchronization\">SMART Server Time Synchronization</a>.</p>\n<p>All modes use TLS 1.2 or higher and return errors according to the selected authorization specification.</p>\n<h3>Resource Flexibility</h3>\n<p>Following IPA's approach, servers MAY choose which clinical resources to support based on their\ncapabilities and use cases. Patient is required for lookup context; other resources are recommended\nbut servers may implement a subset. The server's CapabilityStatement declares which resources are\nactually supported.</p>\n<h3>Scopes for Supported Resources</h3>\n<p>For SMART Backend Services, servers SHALL accept scopes for the resources they support:</p>\n<ul>\n<li>system/Patient.rs (REQUIRED - read + search Patient)</li>\n<li>system/Condition.rs (if Condition supported)</li>\n<li>system/AllergyIntolerance.rs (if AllergyIntolerance supported)</li>\n<li>system/Observation.rs (if Observation supported)</li>\n<li>system/DiagnosticReport.rs (if DiagnosticReport supported)</li>\n<li>system/ImagingStudy.rs (if ImagingStudy supported)</li>\n<li>system/MedicationRequest.rs (if MedicationRequest supported)</li>\n<li>system/MedicationDispense.rs (if MedicationDispense supported)</li>\n<li>system/Immunization.rs (if Immunization supported)</li>\n<li>system/MedicationStatement.rs (if MedicationStatement supported)</li>\n<li>system/Encounter.rs (if Encounter supported)</li>\n<li>system/Practitioner.r (if Practitioner supported)</li>\n<li>system/Organization.r (if Organization supported)</li>\n</ul>\n<p>These are <strong>SMART App Launch 2.2 Backend Services FHIR Resource Scopes</strong>, not IUA transaction scopes.\nInteractive SMART uses the corresponding <code>patient/</code> or <code>user/</code> forms. See\n<a href=\"authorization.html#tokens-scopes-enforcement-and-errors\">Authorization</a>.</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=\"#Patient1-1\">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><tr><td><a href=\"#Practitioner1-2\">Practitioner</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=\"#Organization1-3\">Organization</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=\"#Condition1-4\">Condition</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>patient, clinical-status, category, code</td><td/><td/><td/></tr><tr><td><a href=\"#AllergyIntolerance1-5\">AllergyIntolerance</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>patient, clinical-status</td><td/><td/><td/></tr><tr><td><a href=\"#Observation1-6\">Observation</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>patient, category, code, date, status, patient+category, patient+code, patient+category+date, patient+category+code</td><td/><td/><td/></tr><tr><td><a href=\"#DiagnosticReport1-7\">DiagnosticReport</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>patient, category, code, date, status, patient+category, patient+category+code, patient+category+date</td><td/><td/><td/></tr><tr><td><a href=\"#ImagingStudy1-8\">ImagingStudy</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>patient</td><td/><td/><td/></tr><tr><td><a href=\"#MedicationRequest1-9\">MedicationRequest</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>patient, status, intent, authoredon</td><td/><td/><td/></tr><tr><td><a href=\"#MedicationDispense1-10\">MedicationDispense</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>patient, status, whenhandedover</td><td/><td/><td/></tr><tr><td><a href=\"#Immunization1-11\">Immunization</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>patient, date, status</td><td/><td/><td/></tr><tr><td><a href=\"#MedicationStatement1-12\">MedicationStatement</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>patient, status, effective</td><td/><td/><td/></tr><tr><td><a href=\"#Encounter1-13\">Encounter</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>patient, date, status, class, patient+date</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: 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 for lookup purposes</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 support patient lookup per PDQm [ITI-78] with identifier as a\nrequired search parameter. Note: Patient is used for lookup context, not as a\nprimary clinical data resource in this actor.</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>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>Patient logical ID</p>\n</div></td></tr><tr><td><b>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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>SHALL</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 class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Practitioner1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Practitioner</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/practitioner.html\">Practitioner</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 Practitioner by logical ID</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Practitioner resources provide clinical context for referenced healthcare providers.\nRead-only access supports resolving practitioner references in clinical resources.\nServers SHOULD support this resource but MAY omit it based on their capabilities.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Organization1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Organization</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/organization.html\">Organization</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 Organization by logical ID</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Organization resources provide context for referenced healthcare organizations.\nRead-only access supports resolving organization references in clinical resources.\nServers SHOULD support this resource but MAY omit it based on their capabilities.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Condition1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Condition</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/condition.html\">Condition</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 Condition by logical ID</p>\n</div><code>search-type</code><div><p>Search for Condition resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Condition resources represent problems, diagnoses, and health concerns.\nIf supported, servers SHALL support search by patient and SHOULD support additional filters.\nServers MAY omit this resource based on their capabilities.</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/condition.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient who has the condition (SHALL support)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">clinical-status</a></td><td><code>token</code></td><td><div><p>The clinical status of the condition</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">category</a></td><td><code>token</code></td><td><div><p>The category of condition</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/condition.html#search\">code</a></td><td><code>token</code></td><td><div><p>Code for the condition</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=\"AllergyIntolerance1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>AllergyIntolerance</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/allergyintolerance.html\">AllergyIntolerance</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 AllergyIntolerance by logical ID</p>\n</div><code>search-type</code><div><p>Search for AllergyIntolerance resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>AllergyIntolerance resources represent patient allergies and intolerances.\nIf supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.</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/allergyintolerance.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient who has the allergy or intolerance (SHALL support)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/allergyintolerance.html#search\">clinical-status</a></td><td><code>token</code></td><td><div><p>The clinical status of the allergy or intolerance</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=\"Observation1-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Observation</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/observation.html\">Observation</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 Observation by logical ID</p>\n</div><code>search-type</code><div><p>Search for Observation resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Observation resources represent clinical observations including vital signs,\nlaboratory results, and other measurements. If supported, servers SHALL support\nsearch by patient+category, patient+code, patient+category+date, and\npatient+category+code. Servers MAY omit this resource based on their capabilities.</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/observation.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient the observation is about (SHALL support)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a></td><td><code>token</code></td><td><div><p>Category of observation (e.g., vital-signs, laboratory)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">code</a></td><td><code>token</code></td><td><div><p>The code of the observation type</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">date</a></td><td><code>date</code></td><td><div><p>Obtained date/time. Date modifiers ge, le, gt, lt SHOULD be supported.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">status</a></td><td><code>token</code></td><td><div><p>The status of the observation</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">code</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/observation.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">category</a>+<a href=\"http://hl7.org/fhir/R4/observation.html#search\">code</a></td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"DiagnosticReport1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>DiagnosticReport</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/diagnosticreport.html\">DiagnosticReport</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 DiagnosticReport by logical ID</p>\n</div><code>search-type</code><div><p>Search for DiagnosticReport resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>DiagnosticReport resources represent laboratory results and imaging reports.\nIf supported, servers SHALL support search by patient+category, patient+category+code,\nand patient+category+date (IHE QEDm; not defined by IPA). For imaging reports, the\nHL7 Europe Imaging and MADO implementation guides MAY define additional search requirements.\nServers MAY omit this resource based on their capabilities.</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/diagnosticreport.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient the report is about (SHALL support)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">category</a></td><td><code>token</code></td><td><div><p>Category of report (e.g., LAB, RAD)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">code</a></td><td><code>token</code></td><td><div><p>The code for the report type</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">date</a></td><td><code>date</code></td><td><div><p>The clinically relevant time of the report</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">status</a></td><td><code>token</code></td><td><div><p>The status of the report</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">category</a></td><td><code>reference</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">category</a>+<a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">code</a></td><td><code>reference</code>+<code>token</code>+<code>token</code></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">category</a>+<a href=\"http://hl7.org/fhir/R4/diagnosticreport.html#search\">date</a></td><td><code>reference</code>+<code>token</code>+<code>date</code></td></tr></tbody></table></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"ImagingStudy1-8\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>ImagingStudy</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/imagingstudy.html\">ImagingStudy</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 ImagingStudy by logical ID</p>\n</div><code>search-type</code><div><p>Search for ImagingStudy resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>ImagingStudy resources represent imaging studies available for a patient. ImagingStudy is\nnot profiled in EU Core; resources SHOULD conform to the HL7 Europe Imaging ImagingStudy\nprofile (http://hl7.eu/fhir/imaging/StructureDefinition/ImagingStudyEuImaging).\nIf supported, servers SHALL support search by patient. The MADO implementation guide MAY\ndefine additional search requirements. Servers MAY omit this resource based on their capabilities.</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/imagingstudy.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient the imaging study is about (SHALL support)</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=\"MedicationRequest1-9\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>MedicationRequest</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/medicationrequest.html\">MedicationRequest</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 MedicationRequest by logical ID</p>\n</div><code>search-type</code><div><p>Search for MedicationRequest resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>MedicationRequest resources represent medication orders and prescriptions.\nIf supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.</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/medicationrequest.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient for whom the medication was ordered (SHALL support)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">status</a></td><td><code>token</code></td><td><div><p>Status of the prescription</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">intent</a></td><td><code>token</code></td><td><div><p>The intent of the medication request</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">authoredon</a></td><td><code>date</code></td><td><div><p>Return prescriptions written on this date</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=\"MedicationDispense1-10\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>MedicationDispense</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/medicationdispense.html\">MedicationDispense</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 MedicationDispense by logical ID</p>\n</div><code>search-type</code><div><p>Search for MedicationDispense resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>MedicationDispense resources represent medication dispensing events.\nIf supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.</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/medicationdispense.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient for whom the medication was dispensed (SHALL support)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationdispense.html#search\">status</a></td><td><code>token</code></td><td><div><p>Status of the dispense</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationdispense.html#search\">whenhandedover</a></td><td><code>date</code></td><td><div><p>When the medication was handed over</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=\"Immunization1-11\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Immunization</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/immunization.html\">Immunization</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 Immunization by logical ID</p>\n</div><code>search-type</code><div><p>Search for Immunization resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Immunization resources represent vaccination records.\nIf supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.</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/immunization.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient for the vaccination record (SHALL support)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html#search\">date</a></td><td><code>date</code></td><td><div><p>Vaccination date</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html#search\">status</a></td><td><code>token</code></td><td><div><p>Status of the immunization</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=\"MedicationStatement1-12\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>MedicationStatement</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/medicationstatement.html\">MedicationStatement</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 MedicationStatement by logical ID</p>\n</div><code>search-type</code><div><p>Search for MedicationStatement resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>MedicationStatement resources represent a patient's medication usage, including\nself-reported medications. If supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.</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/medicationstatement.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient for the medication statement (SHALL support)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationstatement.html#search\">status</a></td><td><code>token</code></td><td><div><p>Status of the medication statement</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationstatement.html#search\">effective</a></td><td><code>date</code></td><td><div><p>Date when patient was taking the medication</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=\"Encounter1-13\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHOULD </span>Encounter</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/encounter.html\">Encounter</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 Encounter by logical ID</p>\n</div><code>search-type</code><div><p>Search for Encounter resources</p>\n</div></li></ul></div></div><p/><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Encounter resources represent patient encounters (visits, admissions, etc.).\nIf supported, servers SHALL support search by patient and by patient+date (IHE QEDm).\nServers MAY omit this resource based on their capabilities.</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/encounter.html#search\">patient</a></td><td><code>reference</code></td><td><div><p>The patient present at the encounter (SHALL support)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/encounter.html#search\">date</a></td><td><code>date</code></td><td><div><p>A date within the encounter period</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/encounter.html#search\">status</a></td><td><code>token</code></td><td><div><p>Status of the encounter</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/encounter.html#search\">class</a></td><td><code>token</code></td><td><div><p>Classification of the encounter (e.g., inpatient, outpatient)</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\"><span class=\"lead\">Combined Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameters</th><th>Types</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/encounter.html#search\">patient</a>+<a href=\"http://hl7.org/fhir/R4/encounter.html#search\">date</a></td><td><code>reference</code>+<code>date</code></td></tr></tbody></table></div></div></div></div></div></div>"
},
"url" : "http://hl7.eu/fhir/health-data-api/CapabilityStatement/resource-access-provider-eu-api",
"version" : "1.0.0-ballot",
"name" : "ResourceAccessProviderEuApi",
"title" : "EEHRxF Resource Access Provider CapabilityStatement",
"status" : "active",
"experimental" : false,
"date" : "2026-09-28",
"publisher" : "HL7 Europe",
"contact" : [
{
"name" : "HL7 Europe",
"telecom" : [
{
"system" : "url",
"value" : "http://hl7.eu"
}
]
}
],
"description" : "Requirements for an EEHRxF Resource Access Provider that serves clinical FHIR resources using IPA patterns.",
"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",
"instantiates" : [
🔗 "http://hl7.org/fhir/uv/ipa/CapabilityStatement/ipa-server"
],
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"rest" : [
{
"mode" : "server",
"documentation" : "The Resource Access Provider actor responds to queries for clinical data resources\nfollowing IPA patterns. This enables direct resource access complementing\ndocument-based exchange via MHD.\n\nThe protected API groups with the IUA Resource Server or SMART FHIR Resource Server selected by the\nenvironment and use case. Its Authorization Server remains an independent participant.",
"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.\nThe Resource Server validates access tokens and granted authorization; the independent Authorization\nServer performs token issuance and any client-assertion validation.\n\n### IHE IUA\n\nThe provider groups with the IUA Resource Server. The IPA and PDQm interactions in this statement\nhave no IUA MHD transaction scopes; the deployment applies the IUA authorization policy defined for\nits environment.\n\n### SMART Backend Services\n\nFor a pre-authorized system-to-system use case, the provider groups with the SMART FHIR Resource\nServer and accepts `system/` scopes for the resources it supports.\n\n### Interactive SMART\n\nWhere an interactive use case applies, the provider groups with the SMART FHIR Resource Server and\naccepts the corresponding `patient/` or `user/` scopes for the resources it supports.\n\nFor the IG-level CT grouping recommendation for SMART server roles, see\n[SMART Server Time Synchronization](authorization.html#smart-server-time-synchronization).\n\nAll modes use TLS 1.2 or higher and return errors according to the selected authorization specification.\n\n### Resource Flexibility\n\nFollowing IPA's approach, servers MAY choose which clinical resources to support based on their\ncapabilities and use cases. Patient is required for lookup context; other resources are recommended\nbut servers may implement a subset. The server's CapabilityStatement declares which resources are\nactually supported.\n\n### Scopes for Supported Resources\n\nFor SMART Backend Services, servers SHALL accept scopes for the resources they support:\n- system/Patient.rs (REQUIRED - read + search Patient)\n- system/Condition.rs (if Condition supported)\n- system/AllergyIntolerance.rs (if AllergyIntolerance supported)\n- system/Observation.rs (if Observation supported)\n- system/DiagnosticReport.rs (if DiagnosticReport supported)\n- system/ImagingStudy.rs (if ImagingStudy supported)\n- system/MedicationRequest.rs (if MedicationRequest supported)\n- system/MedicationDispense.rs (if MedicationDispense supported)\n- system/Immunization.rs (if Immunization supported)\n- system/MedicationStatement.rs (if MedicationStatement supported)\n- system/Encounter.rs (if Encounter supported)\n- system/Practitioner.r (if Practitioner supported)\n- system/Organization.r (if Organization supported)\n\nThese are **SMART App Launch 2.2 Backend Services FHIR Resource Scopes**, not IUA transaction scopes.\nInteractive SMART uses the corresponding `patient/` or `user/` forms. See\n[Authorization](authorization.html#tokens-scopes-enforcement-and-errors)."
},
"resource" : [
{
"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 support patient lookup per PDQm [ITI-78] with identifier as a\nrequired search parameter. Note: Patient is used for lookup context, not as a\nprimary clinical data resource in this actor.",
"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 for lookup purposes"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"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" : "SHALL"
}
],
"name" : "gender",
"definition" : "http://hl7.org/fhir/SearchParameter/individual-gender",
"type" : "token",
"documentation" : "Administrative gender of the patient"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Practitioner",
"documentation" : "Practitioner resources provide clinical context for referenced healthcare providers.\nRead-only access supports resolving practitioner references in clinical resources.\nServers SHOULD support this resource but MAY omit it based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read Practitioner by logical ID"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Organization",
"documentation" : "Organization resources provide context for referenced healthcare organizations.\nRead-only access supports resolving organization references in clinical resources.\nServers SHOULD support this resource but MAY omit it based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read Organization by logical ID"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Condition",
"documentation" : "Condition resources represent problems, diagnoses, and health concerns.\nIf supported, servers SHALL support search by patient and SHOULD support additional filters.\nServers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read Condition by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for Condition resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient who has the condition (SHALL support)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-clinical-status",
"type" : "token",
"documentation" : "The clinical status of the condition"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Condition-category",
"type" : "token",
"documentation" : "The category of condition"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "Code for the condition"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "AllergyIntolerance",
"documentation" : "AllergyIntolerance resources represent patient allergies and intolerances.\nIf supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read AllergyIntolerance by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for AllergyIntolerance resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient who has the allergy or intolerance (SHALL support)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "clinical-status",
"definition" : "http://hl7.org/fhir/SearchParameter/AllergyIntolerance-clinical-status",
"type" : "token",
"documentation" : "The clinical status of the allergy or intolerance"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Observation",
"documentation" : "Observation resources represent clinical observations including vital signs,\nlaboratory results, and other measurements. If supported, servers SHALL support\nsearch by patient+category, patient+code, patient+category+date, and\npatient+category+code. Servers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read Observation by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for Observation resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient the observation is about (SHALL support)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-category",
"type" : "token",
"documentation" : "Category of observation (e.g., vital-signs, laboratory)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "The code of the observation type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Obtained date/time. Date modifiers ge, le, gt, lt SHOULD be supported."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Observation-status",
"type" : "token",
"documentation" : "The status of the observation"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "code"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "category"
},
{
"url" : "required",
"valueString" : "date"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "DiagnosticReport",
"documentation" : "DiagnosticReport resources represent laboratory results and imaging reports.\nIf supported, servers SHALL support search by patient+category, patient+category+code,\nand patient+category+date (IHE QEDm; not defined by IPA). For imaging reports, the\nHL7 Europe Imaging and MADO implementation guides MAY define additional search requirements.\nServers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read DiagnosticReport by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for DiagnosticReport resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient the report is about (SHALL support)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-category",
"type" : "token",
"documentation" : "Category of report (e.g., LAB, RAD)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "code",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-code",
"type" : "token",
"documentation" : "The code for the report type"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "The clinically relevant time of the report"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DiagnosticReport-status",
"type" : "token",
"documentation" : "The status of the report"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "ImagingStudy",
"documentation" : "ImagingStudy resources represent imaging studies available for a patient. ImagingStudy is\nnot profiled in EU Core; resources SHOULD conform to the HL7 Europe Imaging ImagingStudy\nprofile (http://hl7.eu/fhir/imaging/StructureDefinition/ImagingStudyEuImaging).\nIf supported, servers SHALL support search by patient. The MADO implementation guide MAY\ndefine additional search requirements. Servers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read ImagingStudy by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for ImagingStudy resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient the imaging study is about (SHALL support)"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "MedicationRequest",
"documentation" : "MedicationRequest resources represent medication orders and prescriptions.\nIf supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read MedicationRequest by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for MedicationRequest resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient for whom the medication was ordered (SHALL support)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Status of the prescription"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "intent",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-intent",
"type" : "token",
"documentation" : "The intent of the medication request"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "authoredon",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
"type" : "date",
"documentation" : "Return prescriptions written on this date"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "MedicationDispense",
"documentation" : "MedicationDispense resources represent medication dispensing events.\nIf supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read MedicationDispense by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for MedicationDispense resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient for whom the medication was dispensed (SHALL support)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Status of the dispense"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "whenhandedover",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationDispense-whenhandedover",
"type" : "date",
"documentation" : "When the medication was handed over"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "Immunization",
"documentation" : "Immunization resources represent vaccination records.\nIf supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read Immunization by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for Immunization resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient for the vaccination record (SHALL support)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Vaccination date"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-status",
"type" : "token",
"documentation" : "Status of the immunization"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"type" : "MedicationStatement",
"documentation" : "MedicationStatement resources represent a patient's medication usage, including\nself-reported medications. If supported, servers SHALL support search by patient.\nServers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read MedicationStatement by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for MedicationStatement resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient for the medication statement (SHALL support)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Status of the medication statement"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "effective",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationStatement-effective",
"type" : "date",
"documentation" : "Date when patient was taking the medication"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
},
{
"extension" : [
{
"url" : "required",
"valueString" : "patient"
},
{
"url" : "required",
"valueString" : "date"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
}
],
"type" : "Encounter",
"documentation" : "Encounter resources represent patient encounters (visits, admissions, etc.).\nIf supported, servers SHALL support search by patient and by patient+date (IHE QEDm).\nServers MAY omit this resource based on their capabilities.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "Read Encounter by logical ID"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "Search for Encounter resources"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient present at the encounter (SHALL support)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "A date within the encounter period"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-status",
"type" : "token",
"documentation" : "Status of the encounter"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "class",
"definition" : "http://hl7.org/fhir/SearchParameter/Encounter-class",
"type" : "token",
"documentation" : "Classification of the encounter (e.g., inpatient, outpatient)"
}
]
}
]
}
]
}
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
