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
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
application/fhir+xml
, application/fhir+json
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.
server
The 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 |
---|---|---|---|---|---|---|---|---|---|
Bundle | http://hl7.org/fhir/StructureDefinition/Bundle | y | y | y | category, date, patient, specialty, type | * , Bundle:patient | DocumentReference:patient | ||
Composition | http://hl7.org/fhir/StructureDefinition/Composition | y | y | category, date, patient, specialty, type | * , Composition:patient | DocumentReference:patient | $document | ||
DiagnosticReport | http://hl7.org/fhir/StructureDefinition/DiagnosticReport | y | category, contenttype, date, patient, type | * , DiagnosticReport:patient | DocumentReference:patient | ||||
DocumentReference | http://myhealth.eu/fhir/ncp-api/StructureDefinition/DocumentReference-minimal-myhealtheu | y | y | y | _id, _lastupdated, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, setting, status, type, modality, bodysite | * , DocumentReference:patient | DocumentReference:patient | ||
OperationDefinition | http://hl7.org/fhir/StructureDefinition/OperationDefinition | y | * | DocumentReference:patient | |||||
Patient | http://hl7.org/fhir/StructureDefinition/Patient Additional supported profiles: Patient: Minimal | y | y | identifier, _lastUpdated, birthdate | * | DocumentReference:patient | |||
ImagingStudy | http://hl7.org/fhir/StructureDefinition/ImagingStudy | y | y | patient, basedon, modality, bodysite, identifier, started | * , ImagingStudy:patient |
search-type
, read
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | category | token | Study type |
SHALL | date | date | Date range for the search |
SHALL | patient | reference | Patient business identifier |
SHALL | specialty | token | Specialty |
SHALL | type | token | The type of the Document |
search-type
, read
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | category | token | Study type |
SHALL | date | date | Date range for the search |
SHALL | patient | reference | Patient business identifier |
SHALL | specialty | token | Specialty |
SHALL | type | token | The type of the Document |
Conformance | Operation | Documentation |
---|---|---|
SHALL | $document |
search-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | category | token | Study type |
SHALL | contenttype | token | The type of the content |
SHALL | date | date | Date range for the search |
SHALL | patient | reference | Patient business identifier |
SHALL | type | token | The type of the Document |
search-type
, read
, create
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | Logical id of this artifact |
SHALL | _lastupdated | date | When the resource version last changed |
SHALL | category | token | Categorization of document |
SHALL | creation | date | When this document was created |
SHALL | date | date | When this document reference was created |
SHALL | event | token | Main clinical acts documented |
SHALL | facility | token | Kind of facility where patient was seen |
SHALL | format | token | Format/content rules for the document |
SHALL | identifier | token | The identifier for this DocumentReference |
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 |
SHALL | period | date | Time of service that is being documented |
SHALL | setting | token | Additional details about where the content was created (e.g. clinical specialty) |
SHALL | status | token | current | superseded | entered-in-error |
SHALL | type | reference | Kind of document (LOINC if possible) |
SHALL | modality | token | Search based on the modality associated with the document. |
SHALL | bodysite | token | Search based on the anatomical region or body site associated with the document. |
read
.search-type
, read
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | A patient identifier |
SHALL | _lastUpdated | date | Only return resources which were last updated as specified by the given range |
SHALL | birthdate | date | The patient’s date of birth |
search-type
, read
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | The patient imaged in the study |
SHALL | basedon | reference | The order for the image, such as Accession Number associated with a ServiceRequest |
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 |