Skip to content
This repository has been archived by the owner on Mar 22, 2024. It is now read-only.

Process KDS Report Description v0.2.0

Reto Wettstein edited this page Oct 21, 2022 · 1 revision

This repository contains a Report Process to be used in order to send the monthly report about the implementation progress of the MII core data-set (KDS) from a Data Integration Center (DIC) to a Health Research Platform (HRP). The infrastructure and communincation messages on which the process is based can be seen in the following figure. The organizations use the Data Sharing Framework (DSF) for deployment and execution of the process.

Report: Process Figure

The Report Process in v0.2.0 is composed of 3 different subprocesses:

Autostart Process

The autostart process can be used by a DIC to automatically trigger the creation and sending of a KDS implementation progress report to a HRP on a recurring basis. The autostart process is optional and can be switched on and off. It consists of the following tasks:

  • Start the send process every 7 days (once a week)

Prerequisites

In order to start the autostart process, the following needs to be known:

  • DIC identifier of the local organization (dic-identifier)

Start Autostart Process

The autostart process can be started by sending the Task resources that can be found here to the local DSF FHIR server:

  • Replace the placeholder <REPLACE-WITH-YOUR-ORGANIZATION-IDENTIFIER> with the dic-identifier
  • Replace the placeholder <REPLACE-WITH-DATE-AND-TIME> with the current date and time in the form yyyy-MM-dd'T'HH:mm:ssX
  • Replace the placeholder <REPLACE-WITH-BUSINESS-KEY> with a UUID in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx

Stop Autostart Process

The autostart process can be stopped by sending the Task resources that can be found here to the local DSF FHIR server:

  • Replace the placeholder <REPLACE-WITH-YOUR-ORGANIZATION-IDENTIFIER> with the dic-identifier
  • Replace the placeholder <REPLACE-WITH-DATE-AND-TIME> with the current date and time in the form yyyy-MM-dd'T'HH:mm:ssX
  • Replace the placeholder <REPLACE-WITH-BUSINESS-KEY> with the same business key used to start the autostart process

Send Process

The send process is used at a DIC to create and send a KDS implementation progress report to a HRP. This subprocess performs the following steps:

  • Download the search bundle, on which the KDS report should be based on, from the HRP
  • Validate the search bundle based on allowed search parameters and HTTP methods
  • Creating the KDS report by executing the search bundle against the local KDS fhir store
  • Providing the KDS report on the local DSF FHIR server for the HRP
  • Receiving and storing a receipt whether the HRP was able to successfully download the KDS report from the local DSF FHIR server

Prerequisites

In order to start the send process, the following needs to be known:

  • DIC identifier of the local organization (dic-identifier)

Start Send Process

The send process can be started by sending the Task resources that can be found here to the local DSF FHIR server:

  • Replace the placeholder <REPLACE-WITH-YOUR-ORGANIZATION-IDENTIFIER> with the dic-identifier
  • Replace the placeholder <REPLACE-WITH-DATE-AND-TIME> with the current date and time in the form yyyy-MM-dd'T'HH:mm:ssX

Receive Process

The receive process is used at a HRP to download and store a KDS implementation progess report from a DIC. This subprocess performs the following steps:

  • Download a KDS report from a DIC DSF FHIR server
  • Store the KDS report on the local DSF FHIR server
  • Send a receipt whether the HRP was able to successfully download the KDS report from the DIC DSF FHIR server

Prerequisites

In order to start the send process at a DIC, the HRP needs to prepare the local DSF FHIR Server by uploading the search bundle, on which the KDS implementation progress report should be based on. An example of the search bundle can be found here.

Clone this wiki locally