Notification-Routing-Service

Table of Contents

1. About The Project
   • Release Notes
2. Getting Started
   • Prerequisites
   • Routing Data
   • Installation
3. Usage
4. Security Policy
5. Contributing
6. License
7. Contact

About The Project

This project contains the DEMIS microservice "Notification Routing Service". The task of the service is to provide the destination of a notification. The evaluation is based on the assignment of all addresses in Germany to a public health department by the RKI. In principle, the IfSG is followed here, which prescribes the order in which the addresses of a notification must be used to determine the recipient of a notification. Any special cases, such as federal state-specific peculiarities relating to specific pathogens, are dealt with specifically.

Release Notes

See ReleaseNotes for all information regarding the (newest) releases.

Getting Started

Prerequisites

The Project requires Java 21 and Maven 3.8+.

Routing Data

Routing Data (lookup csv files) are contained in a separat repository. This image is maintained in DockerHub: demis-notification-routing-data.

For local testing you can check out the GitHub repository demis-notification-routing-data and set lookup-data-directory in die application.properties (or the environment-variable DATA_DIR_LOOKUP) to the path of the checked out repository.

Note: For just building a docker image this step is not required.

Installation

The Project can be built with the following command:

mvn clean install

The Docker Image associated to the service can be built with the extra profile docker:

mvn clean install -Pdocker

Usage

The application can be executed from a JAR file or a Docker Image:

# As JAR Application
java -jar target/notification-routing-service.jar
# As Docker Image
docker run --rm -it -p 8080:8080 notification-routing-service:latest

It can also be deployed on Kubernetes by using the Helm Chart defined in the folder deployment/helm/notification-routing-service:

helm install notification-routing-service ./deployment/helm/notification-routing-service

Endpoints

Endpoint	Method	Input	Output
/routing/	POST	serialisierte vollständige FHIR-Meldungen	Routing-Ziele für eine FHIR-Meldung Bsp. { "healthOffices": { "NOTIFIED_PERSON_CURRENT": "1.05.3.78.", "NOTIFIED_PERSON_ORDINARY": "1.11.0.11.01.", "NOTIFIED_PERSON_PRIMARY": "1.05.9.11.", "SUBMITTER": "1.11.0.11.01.", "NOTIFIER": "1.11.0.11.01." } "responsible": "1.05.3.78." }
/routing/health-office/	GET	optional QueryParams: line (This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.) postalCode city district (The name of the administrative area) state (Sub-unit of country) country (a nation as commonly understood)	Identifikator des Gesundheitsamtes als Zeichenkette Bsp. 1.11.0.09.01.
/routing/v2	POST	serialisierte vollständige FHIR-Meldungen	Routing-Ziele für eine FHIR-Meldung Bsp. { "type": "laboratory", "notificationCategory": "7.1", "routes": [ { "type": "specific_receiver", "specific_receiverId": "1.", "modifications": [ "create_pseudo_copy" ] }, { "type": "responsible_health_office", "specific_receiverId": "2.05.3.78.", "modifications": [ "encrypt" ] }, { "type": "responsible_health_office_sormas", "specific_receiverId": "2.05.3.78.", "modifications": [ "encrypt" ] } ], "healthOffices": { "NOTIFIED_PERSON_CURRENT": "1.05.3.78.", "NOTIFIED_PERSON_ORDINARY": "1.11.0.11.01.", "NOTIFIED_PERSON_PRIMARY": "1.05.9.11.", "SUBMITTER": "1.11.0.11.01.", "NOTIFIER": "1.11.0.11.01." }, "responsible": "1.05.3.78." }

Feature Flags

The Spring application properties of the service.

Flag	Description	Default
feature.flag.notifications.7_3	Set to true to return routing information suitable for 7.3 processing	false
feature.flag.search.fuzzy	Set to true to return lookup data from new fuzzy search algorithm	false
feature.flag.search.comparison	Set to true to compare new fuzzy search algorithm to old algorithm (will run new algorithm)	false
feature.flag.tuberculosis.routing.enabled	Set to true to route health office to tuberculosis health offices (if possible)	false

Security Policy

If you want to see the security policy, please check our SECURITY.md.

Contributing

If you want to contribute, please check our CONTRIBUTING.md.

License

Copyright 2024-2025 gematik GmbH

EUROPEAN UNION PUBLIC LICENCE v. 1.2

EUPL © the European Union 2007, 2016

See the LICENSE for the specific language governing permissions and limitations under the License

Additional Notes and Disclaimer from gematik GmbH

1. Copyright notice: Each published work result is accompanied by an explicit statement of the license conditions for use. These are regularly typical conditions in connection with open source or free software. Programs described/provided/linked here are free software, unless otherwise stated.
2. Permission notice: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
   1. The copyright notice (Item 1) and the permission notice (Item 2) shall be included in all copies or substantial portions of the Software.
   2. The software is provided "as is" without warranty of any kind, either express or implied, including, but not limited to, the warranties of fitness for a particular purpose, merchantability, and/or non-infringement. The authors or copyright holders shall not be liable in any manner whatsoever for any damages or other claims arising from, out of or in connection with the software or the use or other dealings with the software, whether in an action of contract, tort, or otherwise.
   3. We take open source license compliance very seriously. We are always striving to achieve compliance at all times and to improve our processes. If you find any issues or have any suggestions or comments, or if you see any other ways in which we can improve, please reach out to: ospo@gematik.de
3. Please note: Parts of this code may have been generated using AI-supported technology. Please take this into account, especially when troubleshooting, for security analyses and possible adjustments.

Contact

E-Mail to DEMIS Entwicklung