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
| Official URL: http://fhir.ehdsi.eu/ncp-api/CapabilityStatement/CapabilityStatementMyHealthEuClient | Version: 10.0.0-ci | |||
| Active as of 2026-08-27 | Computable Name: MyHealthEuNcpClientCapability | |||
Describes the requirements that a myHealth@EU NCPeH FHIR client (Requesting NCP) SHALL, SHOULD, or MAY meet to be conformant with this guide. See the RequestingNCP actor definition; the companion server-side requirements are described in CapabilityStatement: myHealth@EU Responding NCPeH, for the RespondingNCP actor.
Raw OpenAPI-Swagger Definition file | Download
application/fhir+xml, application/fhir+jsonNote to Implementers: FHIR Capabilities
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.
clientThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Binary | http://hl7.org/fhir/StructureDefinition/Binary | y | |||||||
| Bundle | http://hl7.org/fhir/StructureDefinition/Bundle | y | y | y | identifier, patient | *, Bundle:patient | DocumentReference:patient | ||
| DocumentReference | http://fhir.ehdsi.eu/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheu | y | y | y | _id, category, contenttype, creation, date, patient, patient.identifier, period, status, type, modality, bodysite | *, DocumentReference:patient | DocumentReference:patient | ||
| Patient | http://hl7.org/fhir/StructureDefinition/Patient Additional supported profiles: Patient: Minimal | y | y | identifier, name, _lastUpdated, birthdate, gender | * | DocumentReference:patient | |||
| ImagingStudy | http://hl7.org/fhir/StructureDefinition/ImagingStudy | y | y | patient, basedon, patient.identifier, modality, bodysite, identifier, started | *, ImagingStudy:patient | ||||
| MedicationRequest | http://hl7.org/fhir/StructureDefinition/MedicationRequest | y | y | identifier, patient, patient.identifier, status, authoredon, medication | |||||
| MedicationDispense | http://hl7.org/fhir/StructureDefinition/MedicationDispense | y | |||||||
| Immunization | http://hl7.org/fhir/StructureDefinition/Immunization | y | y | status, date, patient, patient.identifier, vaccine-code, target-disease |
read.Used to fetch a document representation whose content type is not application/fhir+json or application/fhir+xml
search-type, read, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Business identifier of the collection Bundle, equal to the business identifier of the MedicationRequest it groups |
| SHALL | patient | reference | Patient business identifier |
search-type, read, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Logical id of this artifact |
| SHALL | category | token | Categorization of document (Document Class) |
| SHALL | contenttype | token | Type of content / format (mime type of the document content) |
| SHALL | creation | date | When this document was created |
| SHALL | patient | reference | Who/what is the subject of the document |
| SHALL | patient.identifier | token | An Identifier for Who/what is the subject of the document |
| SHOULD | date | date | When this document reference was created |
| SHOULD | period | date | Time of service that is being documented |
| SHOULD | status | token | current | superseded | entered-in-error |
| SHOULD | type | reference | Kind of document (LOINC if possible) |
| SHOULD | modality | token | Search based on the modality associated with the document. |
| SHOULD | bodysite | token | Search based on the anatomical region or body site associated with the document. |
search-type, read.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
| SHALL | identifier | token | A patient identifier |
| SHALL | name | string | A patient name |
| SHALL | birthdate | date | The patient’s date of birth |
| SHALL | gender | token | The patient’s gender |
search-type, read.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient imaged in the study |
| SHALL | patient.identifier | token | An identifier for the patient imaged in the study (chained parameter) |
| SHALL | modality | token | The modality of the series (e.g., CT, MR) |
| SHALL | bodysite | token | The body site code studied |
| SHALL | identifier | token | Identifying value for the study |
| SHALL | started | date | Date/time when the study started |
| SHOULD | basedon | reference | The order for the image, such as Accession Number associated with a ServiceRequest |
search-type, read.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | Patient business identifier |
| SHALL | patient.identifier | token | An identifier for the patient the prescription is for (chained parameter) |
| SHALL | authoredon | date | The date the prescription was initially authored |
| SHOULD | identifier | token | Prescription business identifier. Used to identify the prescription item and to retrieve the corresponding collection Bundle |
| SHOULD | status | token | Used to search available or active prescriptions where supported |
| MAY | medication | reference | Used when the requestor needs to filter by prescribed medication |
update.search-type, read.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | status | token | Immunization event status |
| SHALL | date | date | Vaccination (non)-Administration Date |
| SHALL | patient | reference | The patient for the vaccination record |
| SHALL | patient.identifier | token | An identifier for the patient the vaccination record is for (chained parameter) |
| SHOULD | vaccine-code | token | Vaccine Product Administered |
| MAY | target-disease | token | The target disease the dose is being administered against |