MyHealth@Eu NCPeH API
10.0.0-ci - ci-build
150
MyHealth@Eu NCPeH API
10.0.0-ci - ci-build
150
MyHealth@Eu NCPeH API - Local Development build (v10.0.0-ci) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2025-05-27 |
{
"resourceType" : "CapabilityStatement",
"id" : "CapabilityStatementMyHealthEu",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement CapabilityStatementMyHealthEu</b></p><a name=\"CapabilityStatementMyHealthEu\"> </a><a name=\"hcCapabilityStatementMyHealthEu\"> </a><h2 id=\"title\">CapabilityStatement: myHealth@EU Responding NCPeH</h2><ul><li>Implementation Guide Version: 10.0.0-ci </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Published on: 2025-05-27 </li><li>Published by: MyHealthEu </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"/></div><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=\"#Binary1-1\">Binary</a></td><td><a href=\"http://hl7.org/fhir/R4/binary.html\">http://hl7.org/fhir/StructureDefinition/Binary</a></td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#Bundle1-2\">Bundle</a></td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">http://hl7.org/fhir/StructureDefinition/Bundle</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\">y</td><td>identifier, patient</td><td><code>*</code>, <code>Bundle:patient</code></td><td><code>DocumentReference:patient</code></td><td/></tr><tr><td><a href=\"#DocumentReference1-3\">DocumentReference</a></td><td><a href=\"StructureDefinition-DocumentReference-minimal-myhealtheu.html\">http://fhir.ehdsi.eu/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheu</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\">y</td><td>_id, category, contenttype, creation, date, patient, patient.identifier, period, status, type, modality, bodysite</td><td><code>*</code>, <code>DocumentReference:patient</code></td><td><code>DocumentReference:patient</code></td><td/></tr><tr><td><a href=\"#Patient1-4\">Patient</a></td><td><a href=\"http://hl7.org/fhir/R4/patient.html\">http://hl7.org/fhir/StructureDefinition/Patient</a><br/><em>Additional supported profiles:</em><br/>\u00a0\u00a0<a href=\"StructureDefinition-Patient-minimal-myhealtheu.html\">Patient: Minimal</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>identifier, name, _lastUpdated, birthdate, gender</td><td><code>*</code></td><td><code>DocumentReference:patient</code></td><td/></tr><tr><td><a href=\"#ImagingStudy1-5\">ImagingStudy</a></td><td><a href=\"http://hl7.org/fhir/R4/imagingstudy.html\">http://hl7.org/fhir/StructureDefinition/ImagingStudy</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>patient, basedon, patient.identifier, modality, bodysite, identifier, started</td><td><code>*</code>, <code>ImagingStudy:patient</code></td><td/><td/></tr><tr><td><a href=\"#MedicationRequest1-6\">MedicationRequest</a></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html\">http://hl7.org/fhir/StructureDefinition/MedicationRequest</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>identifier, patient, patient.identifier, status, authoredon, medication</td><td/><td/><td/></tr><tr><td><a href=\"#MedicationDispense1-7\">MedicationDispense</a></td><td><a href=\"http://hl7.org/fhir/R4/medicationdispense.html\">http://hl7.org/fhir/StructureDefinition/MedicationDispense</a></td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\">y</td><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#Immunization1-8\">Immunization</a></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html\">http://hl7.org/fhir/StructureDefinition/Immunization</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td>status, date, patient, patient.identifier, vaccine-code, target-disease</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Binary1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Binary</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>Used to fetch a document representation whose content type is not application/fhir+json or application/fhir+xml</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Bundle1-2\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Bundle</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>, <code>create</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>Business identifier of the collection Bundle, equal to the business identifier of the MedicationRequest it groups</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient</td><td><code>reference</code></td><td><div><p>Patient business identifier</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=\"DocumentReference1-3\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>DocumentReference</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-DocumentReference-minimal-myhealtheu.html\">DocumentReference: Minimal</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>, <code>create</code>.</li></ul></div></div><p/><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 of this artifact</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">category</a></td><td><code>token</code></td><td><div><p>Categorization of document (Document Class)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">contenttype</a></td><td><code>token</code></td><td><div><p>Type of content / format (mime type of the document content)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"https://profiles.ihe.net/ITI/MHD/4.2.2/SearchParameter-DocumentReference-Creation.html\">creation</a></td><td><code>date</code></td><td><div><p>When this document was created</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>Who/what is the subject of the document</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>token</code></td><td><div><p>An Identifier for Who/what is the subject of the document</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">date</a></td><td><code>date</code></td><td><div><p>When this document reference was created</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">period</a></td><td><code>date</code></td><td><div><p>Time of service that is being documented</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">status</a></td><td><code>token</code></td><td><div><p>current | superseded | entered-in-error</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/documentreference.html#search\">type</a></td><td><code>reference</code></td><td><div><p>Kind of document (LOINC if possible)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"SearchParameter-DocumentReference-modality.html\">modality</a></td><td><code>token</code></td><td><div><p>Search based on the modality associated with the document.</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"SearchParameter-DocumentReference-bodysite.html\">bodysite</a></td><td><code>token</code></td><td><div><p>Search based on the anatomical region or body site associated with the document.</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=\"Patient1-4\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/patient.html\">Patient</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-Patient-minimal-myhealtheu.html\">Patient: Minimal</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><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>_lastUpdated</td><td><code>date</code></td><td><div><p>Only return resources which were last updated as specified by the given range</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>A patient identifier</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td>name</td><td><code>string</code></td><td><div><p>A patient name</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td>birthdate</td><td><code>date</code></td><td><div><p>The patient’s date of birth</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td>gender</td><td><code>token</code></td><td><div><p>The patient’s gender</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=\"ImagingStudy1-5\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>ImagingStudy</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/imagingstudy.html\">ImagingStudy</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><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 imaged in the study</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>token</code></td><td><div><p>An identifier for the patient imaged in the study (chained parameter)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/imagingstudy.html#search\">modality</a></td><td><code>token</code></td><td><div><p>The modality of the series (e.g., CT, MR)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/imagingstudy.html#search\">bodysite</a></td><td><code>token</code></td><td><div><p>The body site code studied</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/imagingstudy.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>Identifying value for the study</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/imagingstudy.html#search\">started</a></td><td><code>date</code></td><td><div><p>Date/time when the study started</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/imagingstudy.html#search\">basedon</a></td><td><code>reference</code></td><td><div><p>The order for the image, such as Accession Number associated with a ServiceRequest</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-6\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>MedicationRequest</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/medicationrequest.html\">MedicationRequest</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><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>Patient business identifier</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>token</code></td><td><div><p>An identifier for the patient the prescription is for (chained parameter)</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">authoredon</a></td><td><code>date</code></td><td><div><p>The date the prescription was initially authored</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">identifier</a></td><td><code>token</code></td><td><div><p>Prescription business identifier. Used to identify the prescription item and to retrieve the corresponding collection Bundle</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>Used to search available or active prescriptions where supported</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/medicationrequest.html#search\">medication</a></td><td><code>reference</code></td><td><div><p>Used when the requestor needs to filter by prescribed 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=\"MedicationDispense1-7\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>MedicationDispense</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/medicationdispense.html\">MedicationDispense</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>update</code>.</li></ul></div></div><p/></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Immunization1-8\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Immunization</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"http://hl7.org/fhir/R4/immunization.html\">Immunization</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><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\">status</a></td><td><code>token</code></td><td><div><p>Immunization event status</p>\n</div></td></tr><tr><td><b>SHALL</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 (non)-Administration Date</p>\n</div></td></tr><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</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>patient.identifier</td><td><code>token</code></td><td><div><p>An identifier for the patient the vaccination record is for (chained parameter)</p>\n</div></td></tr><tr><td><b>SHOULD</b></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html#search\">vaccine-code</a></td><td><code>token</code></td><td><div><p>Vaccine Product Administered</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/immunization.html#search\">target-disease</a></td><td><code>token</code></td><td><div><p>The target disease the dose is being administered against</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
},
"url" : "http://fhir.ehdsi.eu/ncp-api/CapabilityStatement/CapabilityStatementMyHealthEu",
"version" : "10.0.0-ci",
"name" : "MyHealthEuNcpServerCapability",
"title" : "CapabilityStatement: myHealth@EU Responding NCPeH",
"status" : "active",
"date" : "2025-05-27",
"publisher" : "MyHealthEu",
"contact" : [
{
"name" : "MyHealthEu",
"telecom" : [
{
"system" : "url",
"value" : "http://example.org/MyHealthEu"
}
]
}
],
"description" : "Describes the requirements that a myHealth@EU NCPeH FHIR server SHALL, SHOULD, or MAY meet to be conformant with this guide. See the [RespondingNCP](ActorDefinition-RespondingNCP.html) actor definition; the companion client-side requirements are described in [CapabilityStatement: myHealth@EU Requesting NCPeH](CapabilityStatement-CapabilityStatementMyHealthEuClient.html), for the [RequestingNCP](ActorDefinition-RequestingNCP.html) actor.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "150",
"display" : "Europe"
}
]
}
],
"kind" : "requirements",
"fhirVersion" : "4.0.1",
"format" : [
"application/fhir+xml",
"application/fhir+json"
],
"rest" : [
{
"mode" : "server",
"resource" : [
{
"type" : "Binary",
"profile" : "http://hl7.org/fhir/StructureDefinition/Binary",
"documentation" : "Used to fetch a document representation whose content type is not application/fhir+json or application/fhir+xml",
"interaction" : [
{
"code" : "read"
}
]
},
{
"type" : "Bundle",
"profile" : "http://hl7.org/fhir/StructureDefinition/Bundle",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"searchInclude" : [
"*",
"Bundle:patient"
],
"searchRevInclude" : [
"DocumentReference:patient"
],
"searchParam" : [
{
"name" : "identifier",
"type" : "token",
"documentation" : "Business identifier of the collection Bundle, equal to the business identifier of the MedicationRequest it groups"
},
{
"name" : "patient",
"type" : "reference",
"documentation" : "Patient business identifier"
}
]
},
{
"type" : "DocumentReference",
"profile" : "http://fhir.ehdsi.eu/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheu",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
},
{
"code" : "create"
}
],
"searchInclude" : [
"*",
"DocumentReference:patient"
],
"searchRevInclude" : [
"DocumentReference:patient"
],
"searchParam" : [
{
"name" : "_id",
"definition" : "http://hl7.org/fhir/SearchParameter/Resource-id",
"type" : "token",
"documentation" : "Logical id of this artifact"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "category",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type" : "token",
"documentation" : "Categorization of document (Document Class)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "contenttype",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype",
"type" : "token",
"documentation" : "Type of content / format (mime type of the document content)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "creation",
"definition" : "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
"type" : "date",
"documentation" : "When this document was created"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
"type" : "date",
"documentation" : "When this document reference was created"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Who/what is the subject of the document"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient.identifier",
"type" : "token",
"documentation" : "An Identifier for Who/what is the subject of the document"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "period",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"type" : "date",
"documentation" : "Time of service that is being documented"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type" : "token",
"documentation" : "current | superseded | entered-in-error"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "Kind of document (LOINC if possible)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "modality",
"definition" : "http://fhir.ehdsi.eu/ncp-api/SearchParameter/DocumentReference-modality",
"type" : "token",
"documentation" : "Search based on the modality associated with the document."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "bodysite",
"definition" : "http://fhir.ehdsi.eu/ncp-api/SearchParameter/DocumentReference-bodysite",
"type" : "token",
"documentation" : "Search based on the anatomical region or body site associated with the document."
}
]
},
{
"type" : "Patient",
"profile" : "http://hl7.org/fhir/StructureDefinition/Patient",
"supportedProfile" : [
🔗 "http://fhir.ehdsi.eu/ncp-api/StructureDefinition/Patient-minimal-myhealtheu"
],
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchInclude" : [
"*"
],
"searchRevInclude" : [
"DocumentReference:patient"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"type" : "token",
"documentation" : "A patient identifier"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "name",
"type" : "string",
"documentation" : "A patient name"
},
{
"name" : "_lastUpdated",
"type" : "date",
"documentation" : "Only return resources which were last updated as specified by the given range"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "birthdate",
"type" : "date",
"documentation" : "The patient’s date of birth"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "gender",
"type" : "token",
"documentation" : "The patient’s gender"
}
]
},
{
"type" : "ImagingStudy",
"profile" : "http://hl7.org/fhir/StructureDefinition/ImagingStudy",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchInclude" : [
"*",
"ImagingStudy:patient"
],
"searchParam" : [
{
"name" : "patient",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type" : "reference",
"documentation" : "The patient imaged in the study"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "basedon",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-basedon",
"type" : "reference",
"documentation" : "The order for the image, such as Accession Number associated with a ServiceRequest"
},
{
"name" : "patient.identifier",
"type" : "token",
"documentation" : "An identifier for the patient imaged in the study (chained parameter)"
},
{
"name" : "modality",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-modality",
"type" : "token",
"documentation" : "The modality of the series (e.g., CT, MR)"
},
{
"name" : "bodysite",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-bodysite",
"type" : "token",
"documentation" : "The body site code studied"
},
{
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Identifying value for the study"
},
{
"name" : "started",
"definition" : "http://hl7.org/fhir/SearchParameter/ImagingStudy-started",
"type" : "date",
"documentation" : "Date/time when the study started"
}
]
},
{
"type" : "MedicationRequest",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicationRequest",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type" : "token",
"documentation" : "Prescription business identifier. Used to identify the prescription item and to retrieve the corresponding collection Bundle"
},
{
"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 business identifier"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient.identifier",
"type" : "token",
"documentation" : "An identifier for the patient the prescription is for (chained parameter)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-status",
"type" : "token",
"documentation" : "Used to search available or active prescriptions where supported"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "authoredon",
"definition" : "http://hl7.org/fhir/SearchParameter/MedicationRequest-authoredon",
"type" : "date",
"documentation" : "The date the prescription was initially authored"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "medication",
"definition" : "http://hl7.org/fhir/SearchParameter/medications-medication",
"type" : "reference",
"documentation" : "Used when the requestor needs to filter by prescribed medication"
}
]
},
{
"type" : "MedicationDispense",
"profile" : "http://hl7.org/fhir/StructureDefinition/MedicationDispense",
"interaction" : [
{
"code" : "update"
}
],
"conditionalUpdate" : true
},
{
"type" : "Immunization",
"profile" : "http://hl7.org/fhir/StructureDefinition/Immunization",
"interaction" : [
{
"code" : "search-type"
},
{
"code" : "read"
}
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "status",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-status",
"type" : "token",
"documentation" : "Immunization event status"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "date",
"definition" : "http://hl7.org/fhir/SearchParameter/clinical-date",
"type" : "date",
"documentation" : "Vaccination (non)-Administration Date"
},
{
"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"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "patient.identifier",
"type" : "token",
"documentation" : "An identifier for the patient the vaccination record is for (chained parameter)"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"name" : "vaccine-code",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-vaccine-code",
"type" : "token",
"documentation" : "Vaccine Product Administered"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"name" : "target-disease",
"definition" : "http://hl7.org/fhir/SearchParameter/Immunization-target-disease",
"type" : "token",
"documentation" : "The target disease the dose is being administered against"
}
]
}
]
}
]
}
IG © 2023+ MyHealthEu. Package myhealth.eu.fhir.ncp-api#10.0.0-ci based on FHIR 4.0.1. Generated 2026-09-01
