MyHealth@Eu NCPeH API
0.0.1 - ci-build 150

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

CapabilityStatement: CapabilityStatement: myHealth@EU NCPeH Server

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

Describes the capabilities of the myHealth@EU NCPeH FHIR server for conformance testing and integration.

Raw OpenAPI-Swagger Definition file | Download

CapabilityStatement: myHealth@EU NCPeH Server

  • Implementation Guide Version: 0.0.1
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • 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

Summary of System-wide Interactions

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
Bundlehttp://hl7.org/fhir/StructureDefinition/Bundleyyycategory, date, patient, specialty, type*, Bundle:patientDocumentReference:patient
Compositionhttp://hl7.org/fhir/StructureDefinition/Compositionyycategory, date, patient, specialty, type*, Composition:patientDocumentReference:patient$document
DiagnosticReporthttp://hl7.org/fhir/StructureDefinition/DiagnosticReportycategory, contenttype, date, patient, type*, DiagnosticReport:patientDocumentReference:patient
DocumentReferencehttp://myhealth.eu/fhir/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheuyyy_id, _lastupdated, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, setting, status, type, modality, bodysite*, DocumentReference:patientDocumentReference:patient
OperationDefinitionhttp://hl7.org/fhir/StructureDefinition/OperationDefinitiony*DocumentReference:patient
Patienthttp://hl7.org/fhir/StructureDefinition/Patient
Additional supported profiles:
  Patient: Minimal
yyidentifier, _lastUpdated, birthdate*DocumentReference:patient
ImagingStudyhttp://hl7.org/fhir/StructureDefinition/ImagingStudyyypatient, basedon, modality, bodysite, identifier, started*, ImagingStudy:patient

Resource Conformance: supported Bundle

Base System Profile
Bundle
Profile Conformance
SHALL
Reference Policy

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcategorytoken

Study type

SHALLdatedate

Date range for the search

SHALLpatientreference

Patient business identifier

SHALLspecialtytoken

Specialty

SHALLtypetoken

The type of the Document

 

Resource Conformance: supported Composition

Base System Profile
Composition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcategorytoken

Study type

SHALLdatedate

Date range for the search

SHALLpatientreference

Patient business identifier

SHALLspecialtytoken

Specialty

SHALLtypetoken

The type of the Document

 
Extended Operations
ConformanceOperationDocumentation
SHALL$document

Resource Conformance: supported DiagnosticReport

Base System Profile
DiagnosticReport
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLcategorytoken

Study type

SHALLcontenttypetoken

The type of the content

SHALLdatedate

Date range for the search

SHALLpatientreference

Patient business identifier

SHALLtypetoken

The type of the Document

 

Resource Conformance: supported DocumentReference

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

SHALL_lastupdateddate

When the resource version last changed

SHALLcategorytoken

Categorization of document

SHALLcreationdate

When this document was created

SHALLdatedate

When this document reference was created

SHALLeventtoken

Main clinical acts documented

SHALLfacilitytoken

Kind of facility where patient was seen

SHALLformattoken

Format/content rules for the document

SHALLidentifiertoken

The identifier for this DocumentReference

SHALLpatientreference

Who/what is the subject of the document

SHALLpatient.identifiertoken

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

SHALLperioddate

Time of service that is being documented

SHALLsettingtoken

Additional details about where the content was created (e.g. clinical specialty)

SHALLstatustoken

current | superseded | entered-in-error

SHALLtypereference

Kind of document (LOINC if possible)

SHALLmodalitytoken

Search based on the modality associated with the document.

SHALLbodysitetoken

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

 

Resource Conformance: supported OperationDefinition

Base System Profile
OperationDefinition
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read.

Resource Conformance: supported Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

Patient: Minimal

Interaction summary
  • Supports search-type, read.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A patient identifier

SHALL_lastUpdateddate

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

SHALLbirthdatedate

The patient’s date of birth

 

Resource Conformance: supported ImagingStudy

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

SHALLbasedonreference

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

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