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

MyHealth@EU Application View

The application domain describes what are the logical (software) components involved in the MyHealth@EU business services and how they interact, collaborate or are coordinated.

The business processes associated with these services can be generalized through a set of common (meta) business processes, as described in the MyHealth@EU common business processes.

In this version of the guide, sequence diagrams are used to illustrate how these common business processes are realized independently of their technical implementation.

The MyHealth@EU Participants

The sequence diagrams documented in this guide identify a set of common participants:

  • The Requestor : the human actor managing the process.
  • The Requesting NCP : the National Contact Point for eHealth node that issues cross-border messages.
  • The Responding NCP : the National Contact Point for eHealth node that receives and processes cross-border messages.
  • The National Infrastructure : the actual national infrastructure responsible for providing or receiving the data.

In these diagrams, the following aspects are not explicitly highlighted:

  • The separation within the NCP between the National Connector component and the Common NCP node, which is typically implemented using the OpenNCP reference implementation.
  • The actual application used by the Requestor to perform the described actions.

The Sequence Diagrams

For each identified business process the following table describes the current implementation status and where to find the associated sequence diagram.

  Business Processes Impl. Status Sequence Diagram View
🆔 Patient Identification Pre-production Patient Identification
📥 Document Retrieval Pre-production Document Retrieval
📤 Document Provision Under definition Document Provision
📊 Study Retrieval Under definition Study Retrieval
🖼️ Image Retrieval Under definition Image Retrieval

Find Identity by Traits

The Patient Identification is a task used by almost all the use cases.

It is realized by searching patients by identifier and/or identification traits.

RequestorRequestorRequesting NCPRequesting NCPResponding NCPResponding NCPNational InfrastructureNational InfrastructureFind Identity by TraitsPatient IdentificationIdentification RequestPatient SearchPatient SearchPatient Minimal DataPatient Minimal DataPatient Minimal DataPatient OK

Figure 1 - Find Identity by Traits

Note: Implementation details are provided in the Patient Search page .

Document Retrieval

The Document Retrieval may be realized by:

  • searching and retrieving the documents
  • fetching the documents

RequestorRequestorRequesting NCPRequesting NCPResponding NCPResponding NCPNational InfrastructureNational Infrastructurealt[Search and Get]Search and Get DocumentsSearch DocumentsSearch DocumentsSearch DocumentsDocument Minimal DataDocument Minimal DataDocument Minimal DataSelect Document(s)Get Document(s)Get Document(s)Get Document(s)Document(s)Document(s)Document(s)[Fetch]Fetch DocumentsFetch Document(s)Fetch Document(s)Fetch Document(s)Document(s)Document(s)Document(s)

Figure 2 - Document Retrieval

Note: Implementation details are provided in the Document Retrieval page .

Document Provision

The Document Provision is realized by sending a document to the receiving country (typically the country of Affiliation)

RequestorRequestorRequesting NCPRequesting NCPResponding NCPResponding NCPNational InfrastructureNational InfrastructureProvide Document(s)Select Document(s)Send Document(s)Send Document(s)Send Document(s)Document(s) ReceivedDocument(s) ReceivedDocument(s) Received

Figure 3 - Document Provision

Note: Implementation details are provided in the Document Provision page .

Study Retrieval

The Imaging Study Retrieval may be realized by searching and retrieving - or fetching - the study manifest.

RequestorRequestorRequesting NCPRequesting NCPResponding NCPResponding NCPNational InfrastructureNational Infrastructurealt[Search and Get]Search and Get Imaging Study ManifestSearch StudySearch StudySearch StudyStudy Minimal DataStudy Minimal DataStudy Minimal DataSelect Study(ies)Get Study(ies)Get Study(ies)Get Study(ies)Study(ies)Study(ies)Study(ies)[Fetch]Fetch Study ManifestFetch Study(ies)Fetch Study(ies)Fetch Study(ies)Study(ies)Study(ies)Study(ies)

Figure 4 - Imaging Study Retrieval

Note: Implementation details are provided in the Study Retrieval page .

Images Retrieval

Indipendently on the way imaging study, series or instance identifiers have been collected - for example from the Imaging Study Manifest, diagnostic reports or other documents - those identifiers, or a selection of them, are used to fetch the evidences having those instance identifiers or belonging to the selected study or series.

RequestorRequestorRequesting NCPRequesting NCPResponding NCPResponding NCPNational InfrastructureNational InfrastructurePACSPACSGet and Select Study/Series/Instance idsalt[Study level]Get/Select Study references[Series level]Get/Select Series references[Instance level]Get/Select Image referencesGet Study/Series/ListedGet Study/Series/Listed ImagesGet Study/Series/Listed ImagesGet Study/Series/Listed ImagesStudy/Series/Listed ImagesStudy/Series/Listed ImagesStudy/Series/Listed Images

Figure 5 - Image Retrieval

Note: Implementation details are provided in the Images Retrieval page .