MyHealth@Eu NCPeH API
9.1.1-ci - ci-build 150

MyHealth@Eu NCPeH API - Local Development build (v9.1.1-ci) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: CapabilityStatement: myHealth@EU Responding NCPeH

Official URL: http://fhir.ehdsi.eu/ncp-api/CapabilityStatement/CapabilityStatementMyHealthEu Version: 9.1.1-ci
Active as of 2025-05-27 Computable Name: MyHealthEuNcpServerCapability

Describes the requirements that a myHealth@EU NCPeH FHIR server SHALL, SHOULD, or MAY meet to be conformant with this guide. See the RespondingNCP actor definition; the companion client-side requirements are described in CapabilityStatement: myHealth@EU Requesting NCPeH, for the RequestingNCP actor.

Raw OpenAPI-Swagger Definition file | Download

CapabilityStatement: myHealth@EU Responding NCPeH

  • Implementation Guide Version: 9.1.1-ci
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Published on: 2025-05-27
  • Published by: MyHealthEu

Note 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.

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Binaryhttp://hl7.org/fhir/StructureDefinition/Binaryy
DocumentReferencehttp://fhir.ehdsi.eu/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheuyyy_id, category, contenttype, creation, date, patient, patient.identifier, period, status, type, modality, bodysite*, DocumentReference:patientDocumentReference:patient
Patienthttp://hl7.org/fhir/StructureDefinition/Patient
Additional supported profiles:
  Patient: Minimal		yyidentifier, name, _lastUpdated, birthdate, gender*DocumentReference:patient
ImagingStudyhttp://hl7.org/fhir/StructureDefinition/ImagingStudyyypatient, basedon, patient.identifier, modality, bodysite, identifier, started*, ImagingStudy:patient
Base System Profile
Binary
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Documentation

Used to fetch a document representation whose content type is not application/fhir+json or application/fhir+xml

Base System Profile
DocumentReference: Minimal
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read, create.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id of this artifact

SHALLcontenttypetoken

Type of content / format (mime type of the document content)

SHALLcreationdate

When this document was created

SHALLpatientreference

Who/what is the subject of the document

SHALLpatient.identifiertoken

An Identifier for Who/what is the subject of the document

SHOULDcategorytoken

Categorization of document (Document Class)

SHOULDdatedate

When this document reference was created

SHOULDperioddate

Time of service that is being documented

SHOULDstatustoken

current | superseded | entered-in-error

SHOULDtypereference

Kind of document (LOINC if possible)

SHOULDmodalitytoken

Search based on the modality associated with the document.

SHOULDbodysitetoken

Search based on the anatomical region or body site associated with the document.

 
Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

Patient: Minimal

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_lastUpdateddate

Only return resources which were last updated as specified by the given range

SHALLidentifiertoken

A patient identifier

SHOULDnamestring

A patient name

SHOULDbirthdatedate

The patient’s date of birth

SHOULDgendertoken

The patient’s gender

 
Base System Profile
ImagingStudy
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient imaged in the study

SHALLpatient.identifiertoken

An identifier for the patient imaged in the study (chained parameter)

SHALLmodalitytoken

The modality of the series (e.g., CT, MR)

SHALLbodysitetoken

The body site code studied

SHALLidentifiertoken

Identifying value for the study

SHALLstarteddate

Date/time when the study started

SHOULDbasedonreference

The order for the image, such as Accession Number associated with a ServiceRequest