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
This page describes the implementation options of the Images Retrieval task.
The overall business scenarios associated to this task is described in the Business view page
The implementation-indipendent sequence diagrams associated to this task is described in the in the Application view page
The Myhealth@EU general architecture requires that no assumptions are made on the way the service is implemented at the national level.
Different alternatives have been considered for the retrieval and display of images:
This version will rely on the images retrieval through the DICOM Retrieve WADO-RS service.
Using the DICOM WADO-RS, three different REST APIs are supported:
Endpoint | Description |
---|---|
/studies/{studyUID} |
Retrieve metadata or details for a study |
/studies/{studyUID}/series/{seriesUID} |
Retrieve metadata or details for a series |
/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID} |
Retrieve a specific instance (SOP) |
While other options foreseen by the IHE RAD-107 are not requested for the time being
Endpoint | Description |
---|---|
/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}/metadata |
Get metadata for a specific instance |
/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}/frames/{frameNumber} |
Retrieve a specific frame from an image |
/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}/bulkdata/{bulkDataID} |
Access bulk data from an instance |
To retrieve a study/series/instance, the dicom file is retrieved as a ByteArray using a streaming API.
Herefter, a DICOM Conformance Statement for the MyHealth@EU DICOM Web Access to DICOM Objects over RESTful services (WADO-RS). It provides an overview of the DICOM capabilities supported by the service, specifically focusing on the retrieval of DICOM instances at the Study, Series, and Instance levels.
The DICOM Web Access to DICOM Persistent Objects by RESTful Services (WADO-RS) is a web service that allows for the retrieval of DICOM objects using standard HTTP protocols. The MyHealth@EU WADO-RS service conforms to the DICOM standard for web-based access to DICOM instances.
The MyHealth@EU WADO-RS service is compliant with the following DICOM standards:
The service supports retrieval for the following DICOM SOP Classes:
SOP Class | SOP Class UID |
---|---|
CT Image Storage | 1.2.840.10008.5.1.4.1.1.2 |
MR Image Storage | 1.2.840.10008.5.1.4.1.1.4 |
Ultrasound Image Storage | 1.2.840.10008.5.1.4.1.1.6.1 |
Secondary Capture Image Storage | 1.2.840.10008.5.1.4.1.1.7 |
Digital Mammography X-Ray Image Storage - For Presentation | 1.2.840.10008.5.1.4.1.1.1.2 |
Positron Emission Tomography (PET) Image Storage | 1.2.840.10008.5.1.4.1.1.128 |
Enhanced MR Image Storage | 1.2.840.10008.5.1.4.1.1.4.1 |
Other relevant SOP Classes as applicable to your service | [SOP Class UID] |
The service supports the following DICOM WADO-RS operations:
The service supports the following DICOM Transfer Syntaxes for the retrieval of DICOM objects:
Transfer Syntax | Transfer Syntax UID |
---|---|
Implicit VR Little Endian | 1.2.840.10008.1.2 |
Explicit VR Little Endian | 1.2.840.10008.1.2.1 |
Explicit VR Big Endian | 1.2.840.10008.1.2.2 |
JPEG Baseline (Process 1) | 1.2.840.10008.1.2.4.50 |
JPEG Lossless, Non-Hierarchical (Process 14) | 1.2.840.10008.1.2.4.70 |
JPEG 2000 Image Compression (Lossless Only) | 1.2.840.10008.1.2.4.90 |
JPEG 2000 Image Compression | 1.2.840.10008.1.2.4.91 |
RLE Lossless | 1.2.840.10008.1.2.5 |
The MyHealth@EU WADO-RS service provides the following endpoints for DICOM object retrieval:
GET /studies/{studyInstanceUID}
GET /studies/{studyInstanceUID}/series/{seriesInstanceUID}
GET /studies/{studyInstanceUID}/series/{seriesInstanceUID}/instances/{sopInstanceUID}
The service supports the following media types for DICOM instance retrieval:
The WADO-RS service requires copmpliance with the MyHealth@EU security secificaitons for secure access to DICOM instances. Users must be authenticated and authorized to retrieve DICOM objects.