medizininformatik-initiative/mii-process-report v1.2.0.0

1.2.0.0 - Support of Asynchronous FHIR Search Requests

on GitHub

Release of the MII report process plugin used to send reports of current FHIR store implementation progress of a DIC to a HRP.

The documentation of the process including the description, the deployment and configuration guides as well as instructions on how to start a process instance can be found in the wiki. For a pre-built jar file, see assets: mii-process-report-1.2.0.0.jar.

General remarks:

• This release is compatible with the Data Sharing Framework version >= 1.0.0. This release does not work with DSF versions < 1.0.0.

Features include:

• The logic for validating allowed search requests in the SearchBundle was refactored from being implemented directly in the ServiceDelegate to its own dedicated service class, improving unit testability.
• The SearchBundle identifier is now based on its own NamingSystem instead of using a CodeSystem, that had to be extended with every major release of the process.
• Reports can now be generated using a dry-run mode, generating and storing the report without sending it to the HRP, making it accessible only to the DIC.
• Error messages are now propagated using the camunda:errorMessageVariable extension in BPMN instead of setting additional process variables.
• Implemented the FHIR R5 Asynchronous Interaction Request Pattern, which is supported by Blaze in R4 as well, to reduce timeout issues for long-running search queries. It can be activated by setting the environment variable DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_ASYNC_ENABLED to true. By default asynchronous queries are deactivated. The polling interval for search results can be configured using the environment variable DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_ASYNC_POLLING_INTERVAL. The default value for the initial polling interval is set to 100 milliseconds and will be doubled after every check, if a result is not yet ready.
• The business key is now overwritten if the report-send process is triggered by the autostart process, so that every instance of the report-send process has its own business key.
• The environment variable DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_ISSUER_URL changed to DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_URL (without ISSUER). It now matches its intended meaning and no longer requires setting the token URL. See the Configuration Change section below.
• Dependencies were updated where applicable.
• Updates CodeSystems and draft Task resources of older process versions so that different versions of the process can be executed in parallel.

Configuration Change:
The environment variable DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_ISSUER_URL changed to DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_URL (without ISSUER). It now specifies the OIDC realm base endpoint instead of the OIDC token endpoint previously. The token endpoint is now automatically discovered using the OIDC discovery protocol. The discovery endpoint can be configured using the environment variable DE_MEDIZININFORMATIK_INITIATIVE_REPORT_DIC_FHIR_SERVER_OAUTH2_DISCOVERY_PATH, using a default value of /.well-known/openid-configuration. Please update your configuration accordingly.

Issues closed:

• Create own service for SearchBundle testing instead of testing as part of service delegate #30
• Use NamingSystem for SearchBundle Identifier instead of the current CodeSystem Value #31
• Add dry-run functionality #41
• Use BPMN errorMessageVariable instead of specific self set variable #42
• Implement Async Request Pattern for FHIR Search Requests #46
• Overwrite business-key if startReportSend process is started by autostart process #49
• Configuration parameters for OAuth2 token URLs incorrectly named issuer URLs #54
• Update Dependencies #57
• Deployment of process with different versions in parallel #59

Contributors:
This release contains contributions from @wetret, @schwzr, and @hhund.