DEMIS FHIR Storage Service (FSS)

Table of Contents

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

About The Project

This project is part of the DEMIS project and is the successor of the Notification-Clearing-API Service, as part of the modernisation of the DEMIS project itself. It consists of 3 services:

1. fhir-storage-writer

   This service is responsible for retrieving and writing FHIR Bundle Resources in a Database.

2. fhir-storage-reader

   This one is responsible for retrieving them.

3. fhir-storage-purger

   This service deletes old FHIR resources from the database.

In the common module are defined the common classes and interfaces used by both services.

Release Notes

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

Getting Started

Prerequisites

The Project requires Java 21 and Maven 3.8+.

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 applications can be executed from a JAR file or a Docker Image (example for the reader):

# As JAR Application
cd fhir-storage-reader
java -jar target/fhir-storage-reader.jar
# As Docker Image
docker run --rm -it -p 8080:8080 fhir-storage-reader:latest

It can also be deployed on Kubernetes by using the Helm Chart defined in the folder deployment/helm/fhir-storage-reader:

helm upgrade --install fhir-storage-reader ./deployment/helm/fhir-storage-reader

Endpoints

The two services provide the following endpoints:

fhir-storage-reader

Endpoint	Method	Input	Output
/fhir/Binary	GET	request parameters defining the search	A list of binary FHIR resources matching the given search parameter
/fhir/Binary/{id}	GET	ID of a binary resource as query parameter	The binary resource with the given ID
/fhir/Bundle	GET	request parameters defining the search	A list of FHIR resource bundles matching the given search parameter
/fhir/Bundle/{id}	GET	ID of a bundle as query parameter	The bundle with the given ID

The search parameters are designed to work like the HL7 FHIR search parameters Currently possible search parameters are:

request parameter	description
_lastUpdated	find resources by their lastUpdated field. The search value is a FHIR date
_tag	find resources by their tags
_source	find resources based by their source information
_profile	direct filter for the profile
_sort	define a field for which the result set is sorted, defaults to ascending
_sort:asc	like _sort
_sort:desc	like _sort but with descending sort order
_count	number of resources returned on the result page: limiting page size
_offset	skip these number of results before returning the results
_format	specify the mime-type in which the result shall be returned _format

fhir-storage-writer

Endpoint	Input	Output
/fhir	FHIR bundle or resource as json	A list of created FHIR resource IDs

fhir-storage-purger

TODO

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