Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pull_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: docs
on:
# trigger build on every PR phase
pull_request:
types: [opened, reopened, review_requested]
types: [opened, synchronize, reopened, review_requested]
# trigger deployment manually
workflow_dispatch:

Expand Down
1,229 changes: 590 additions & 639 deletions docs/package-lock.json

Large diffs are not rendered by default.

30 changes: 22 additions & 8 deletions docs/src/.vuepress/sidebar/operations-v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@ export function generate_v1_latest_sidebar() {
"release-notes", "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", "root-certificates", "passwords-secrets", {
text: "FHIR Reverse Proxy",
icon: "module",
prefix: "fhir-reverse-proxy/",
link: "fhir-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "fhir-reverse-proxy/configuration",
link: "configuration",
}
]},
{
Expand All @@ -37,11 +39,13 @@ export function generate_v1_latest_sidebar() {
}, {
text: "BPE Reverse Proxy",
icon: "module",
prefix: "bpe-reverse-proxy/",
link: "bpe-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "bpe-reverse-proxy/configuration",
link: "configuration",
}
]
}, {
Expand Down Expand Up @@ -81,12 +85,14 @@ export function generate_v1_gt_eq_1_7_0_sidebar() {
},
"release-notes", "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", "root-certificates", "passwords-secrets", {
text: "FHIR Reverse Proxy",
icon: "module",
icon: "module",
prefix: "fhir-reverse-proxy/",
link: "fhir-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "fhir-reverse-proxy/configuration",
link: "configuration",
}
]},
{
Expand All @@ -110,11 +116,13 @@ export function generate_v1_gt_eq_1_7_0_sidebar() {
}, {
text: "BPE Reverse Proxy",
icon: "module",
prefix: "bpe-reverse-proxy/",
link: "bpe-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "bpe-reverse-proxy/configuration",
link: "configuration",
}
]
}, {
Expand Down Expand Up @@ -153,11 +161,13 @@ export function generate_v1_gt_eq_1_5_0_sidebar() {
}, "release-notes", "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", {
text: "FHIR Reverse Proxy",
icon: "module",
prefix: "fhir-reverse-proxy/",
link: "fhir-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "fhir-reverse-proxy/configuration",
link: "configuration",
}
]}, {
text: "FHIR Server",
Expand All @@ -180,11 +190,13 @@ export function generate_v1_gt_eq_1_5_0_sidebar() {
}, {
text: "BPE Reverse Proxy",
icon: "module",
prefix: "bpe-reverse-proxy/",
link: "bpe-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "bpe-reverse-proxy/configuration",
link: "configuration",
}
]
}, {
Expand Down Expand Up @@ -224,11 +236,13 @@ export function generate_v1_gt_eq_1_0_0_sidebar() {
}, "release-notes", "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", {
text: "FHIR Reverse Proxy",
icon: "module",
prefix: "fhir-reverse-proxy/",
link: "fhir-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "fhir-reverse-proxy/configuration",
link: "configuration",
}
]},
{
Expand Down
16 changes: 12 additions & 4 deletions docs/src/.vuepress/sidebar/operations-v2.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,13 @@ export function generate_v2_latest_sidebar() {
"release-notes", "install", "upgrade-from-2", "upgrade-from-1", "allowList-mgm", "root-certificates", "passwords-secrets", {
text: "FHIR Reverse Proxy",
icon: "module",
prefix: "fhir-reverse-proxy/",
link: "fhir-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "fhir-reverse-proxy/configuration",
link: "configuration",
}
]
},
Expand Down Expand Up @@ -40,11 +42,13 @@ export function generate_v2_latest_sidebar() {
}, {
text: "BPE Reverse Proxy",
icon: "module",
prefix: "bpe-reverse-proxy/",
link: "bpe-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "bpe-reverse-proxy/configuration",
link: "configuration",
}
]
}, {
Expand Down Expand Up @@ -90,11 +94,13 @@ export function generate_v2_0_0_sidebar() {
"release-notes", "install", "upgrade-from-1", "allowList-mgm", "root-certificates", "passwords-secrets", {
text: "FHIR Reverse Proxy",
icon: "module",
prefix: "fhir-reverse-proxy/",
link: "fhir-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "fhir-reverse-proxy/configuration",
link: "configuration",
}
]
},
Expand Down Expand Up @@ -123,11 +129,13 @@ export function generate_v2_0_0_sidebar() {
}, {
text: "BPE Reverse Proxy",
icon: "module",
prefix: "bpe-reverse-proxy/",
link: "bpe-reverse-proxy/",
children: [
{
icon: "config",
text: "Configuration",
link: "bpe-reverse-proxy/configuration",
link: "configuration",
}
]
}, {
Expand Down
10 changes: 5 additions & 5 deletions docs/src/.vuepress/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,9 @@ export default hopeTheme({
prefix: "/operations/",
children: [ {
text: "Current Version - 2.0.2",
link: "get-started.md",
link: "get-started",
icon: "launch"
}, "old-versions.md"],
}, "old-versions"],
},
],
},
Expand Down Expand Up @@ -96,7 +96,7 @@ export default hopeTheme({
icon: "info",
prefix: "explore/",
link: "explore/",
children: ["concepts/introduction.md", "concepts/basics", "concepts/architecture", "concepts/security", "concepts/allow-list", "concepts/process-plugins"],
children: ["concepts/introduction", "concepts/basics", "concepts/architecture", "concepts/security", "concepts/allow-list", "concepts/process-plugins"],
},
{
text: "Security Disclosure Policy",
Expand Down Expand Up @@ -215,7 +215,7 @@ export default hopeTheme({
"creating-codesystems-for-dsf-processes",
"creating-task-resources-based-on-a-definition",
"creating-valuesets-for-dsf-processes",
"managing-mutiple-incoming-messages-and-missing-messages",
"managing-multiple-incoming-messages-and-missing-messages",
"setting-targets-for-message-events",
"starting-a-process-via-task-resources",
"user-tasks-in-the-dsf",
Expand Down Expand Up @@ -294,7 +294,7 @@ export default hopeTheme({
"creating-codesystems-for-dsf-processes",
"creating-task-resources-based-on-a-definition",
"creating-valuesets-for-dsf-processes",
"managing-mutiple-incoming-messages-and-missing-messages",
"managing-multiple-incoming-messages-and-missing-messages",
"starting-a-process-via-task-resources",
"user-tasks-in-the-dsf",
],
Expand Down
4 changes: 1 addition & 3 deletions docs/src/community/consultation-hours.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ icon: guide

Mondays, 14:00–14:50

Location: https://dsf.dev/sprechstunde
Location: Click [here](https://lecture.senfcall.de/sim-ock-1vk-l8o) to join the consultation hour.
:::

Click [here](https://lecture.senfcall.de/sim-ock-1vk-l8o) to join the consultation hour.

6 changes: 3 additions & 3 deletions docs/src/community/contribute/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ We are thrilled that you consider contributing to our projects. Your contributio
* **MII Zulip**: If you are part of the German Medical Informatics Initiative, [join the MII Zulip community](https://mii.zulipchat.com/#narrow/stream/392426-Data-Sharing-Framework-.28DSF.29) to assist others, share your knowledge, and learn from fellow contributors.
* **GitHub Discussions**: Engage with our community in [GitHub Discussions](https://github.com/datasharingframework/dsf/discussions) by answering questions, providing feedback, and sharing your insights.
2. **Testing releases**:
* **Stay ahead**: Help us testing the latest releases. Your feedback on functionality, bugs, and user experience is invaluable.
* **Stay ahead**: Help us test the latest releases. Your feedback on functionality, bugs, and user experience is invaluable.
* **Report findings**: Share your testing results to help us refine and enhance our releases.
3. **Reviewing changes**:
* **Peer review**: Contribute by reviewing pull requests. Your insights can help ensure the quality and integrity of code changes.
* **Constructive feedback**: Offer constructive feedback and suggestions to help improve and refine proposed changes.
4. **Documentation changes**:
* **Improve documentation**: Help us improving and updating our documentation. Clear and accurate documentation is crucial for user understanding and success. Please checkout our [Getting started guide for documentation contributions](./documentation) to DSF.
* **Improve documentation**: Help us improve and update our documentation. Clear and accurate documentation is crucial for user understanding and success. Please checkout our [Getting started guide for documentation contributions](./documentation) to DSF.
* **Suggest improvements**: If you notice gaps or areas for enhancement in our documentation, we welcome [your suggestions and contributions](https://github.com/datasharingframework/datasharingframework.github.io).
5. **Contributing bug reports**:
* **Report bugs**: If you find a bug, please report it via [an issue on GitHub](https://github.com/datasharingframework/dsf/issues). Detailed bug reports are incredibly helpful.
Expand All @@ -27,7 +27,7 @@ We are thrilled that you consider contributing to our projects. Your contributio
* **Suggest features**: You have an idea for a new feature? We'd love to hear it! Open an issue to describe your proposed feature and its potential benefits according to our feature request template.
* **Collaborate on implementation**: If you're able to, contribute to the development of your proposed feature or bug fix. Collaboration can lead to more innovative and effective solutions. Please checkout our [Getting started guide for code contributions](./code) to DSF.
7. **Contributing process plugins**:
* **Develop process plugins for the DSF**: If you have ideas for a process plugin, we encourage you to develop and contribute them. Our [Getting started guide for process plugin development](https://dsf.dev/stable/develop/) will be a useful reference.
* **Develop process plugins for the DSF**: If you have ideas for a process plugin, we encourage you to develop and contribute them. Our [Getting started guide for process plugin development](/process-development/) will be a useful reference.
* **Share your work**: Your plugins could be a valuable addition to the ecosystem and benefit other users.

Before you start contributing, we recommend reading our getting started guidelines for detailed information on our processes and standards. This ensures a smooth and productive experience for everyone involved.
Expand Down
9 changes: 3 additions & 6 deletions docs/src/community/events/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,12 @@ title: Events
icon: news
---
## Upcoming Events
::: info **Save The Date - DSF Community Events 2026**

The DSF Community invites you to two events in the first quarter of 2026:
**1. DSF Hackathon (online) – January 20, 2026, 10:00 a.m.–4:00 p.m.**
**2nd DSF Spring School – February 24–26, 2026 at Heilbronn University**

::: info *Currently no upcoming events announced*
:::

## Past Events
- [DSF Springschool 2026 Announcemnt](../../posts/2026-01-21-spring-school-2026.md)
- [DSF Hackathon 2026](../../posts/2026-01-21-hackathon.md)
- [FHIR Devdays 2025 Follow-up](../../posts/2025-07-04-follow-up-fhir-devdays.md)
- [FHIR Devdays 2025 Announcement](../../posts/2025-05-07-fhir-devdays-2025)
- [Springschool 2025](../../posts/2025-04-23-spring-school-2025)
Expand Down
2 changes: 1 addition & 1 deletion docs/src/community/events/tutorials/2023-05-30-MIE2023.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,5 @@ You need a laptop with a web browser for the hands-on portion of the tutorial.
- … gain knowledge on various distributed processes specific to bio-medical research.
- … understand the unique challenges and considerations from the German MII resulting in the design and architecture of the DSF.
- … be introduced to the key concepts of the DSF and the various contexts in which it can be applied.
- … learn how to evaluate if the DSF is appropriate for their particular project or application your planning.
- … learn how to evaluate if the DSF is appropriate for their particular project or application you're planning.
- … understand the difficulties that can occur when implementing distributed processes, as well as strategies for addressing them.
6 changes: 3 additions & 3 deletions docs/src/community/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ The funded project team includes:
- Jan Böhringer • [GitHub](https://github.com/jaboehri)
- Mathias Rühle • [GitHub](https://github.com/EmteZogaf)
- Mohamad Khalil Malla • [GitHub](https://github.com/khalilmalla95)
- Paul Maibach • [GitHub](https://github.com/javarum)
- Sylvester Baidoo-A.
- Tom Holler • [GitHub](https://github.com/H99-code)
- Serap Aydin • [GitHub](https://github.com/seay28)
Expand All @@ -24,6 +23,7 @@ We thank additional contributors, including:
- Simon Mödinger • [GitHub](https://github.com/simonmoedinger)
- Christoph Zilske • [GitHub](https://github.com/ZilskeC)
- Amir Kannout
- Paul Maibach • [GitHub](https://github.com/javarum)

## Funded Partners

Expand All @@ -48,11 +48,11 @@ The [LIFE Institute](https://www.uniklinikum-leipzig.de/einrichtungen/life/) of

![BMFTR Logo =228x158](/photos/learnmore/funding/bmftr.png)

The DSF Community connects the DSF competencies of the entire [Medical Informatics Initiative (MII)](https://www.medizininformatik-initiative.de/de/start) so that new use cases, in particular from Module 3 or the [Network University Medicine (NUM)](https://www.netzwerk-universitaetsmedizin.de/), are better supported in creating the respective DSF plugins. In the context of Module 2b, the DSF Community contributes to the further development of the common digital infrastructure of the MII together with the [FDPG+](https://forschen-fuer-gesundheit.de/) and [TRANSIT](https://www.gesundheitsforschung-bmbf.de/de/transit-medizininformatik-struktur-data-management-unit-16148.php) projects. [BMBF](https://www.gesundheitsforschung-bmbf.de/de/dsf-medizininformatik-struktur-data-sharing-framework-community-16133.php)
The DSF Community connects the DSF competencies of the entire [Medical Informatics Initiative (MII)](https://www.medizininformatik-initiative.de/de/start) so that new use cases, in particular from Module 3 or the [Network University Medicine (NUM)](https://www.netzwerk-universitaetsmedizin.de/), are better supported in creating the respective DSF plugins. In the context of Module 2b, the DSF Community contributes to the further development of the common digital infrastructure of the MII together with the [FDPG+](https://forschen-fuer-gesundheit.de/) and [TRANSIT](https://www.gesundheitsforschung-bmbf.de/de/transit-medizininformatik-struktur-data-management-unit-16148.php) projects. [BMFTR](https://www.gesundheitsforschung-bmftr.de/de/dsf-medizininformatik-struktur-data-sharing-framework-community-16133.php)

Heilbronn University (HHN) focuses on the connecting of DSF related topics and competencies in the MII with the community management. The quality assurance of new DSF plugins and further development of the application and core components aim at a scalable, stable and secure operation of the DSF (Funding code: 01ZZ2307A).

Heidelberg University is focusing on the further development of the DSF core components as well as the rollout of the DSF plugins, in particular also from the perspective of a data integration center in consultation with the FDGP+ and TRANSIT projects (Funding code: 01ZZ2307B).
Heidelberg University is focusing on the further development of the DSF core components as well as the rollout of the DSF plugins, in particular also from the perspective of a data integration center in consultation with the FDPG+ and TRANSIT projects (Funding code: 01ZZ2307B).

The University of Leipzig will further develop and adapt the DSF plugin for the Research Data Portal for Health FDPG according to specifications resulting from the FDPG+ project and enable Data Integration Centers (DIC) to operate the FDPG plugin (Funding code: 01ZZ2307C).

Expand Down
2 changes: 2 additions & 0 deletions docs/src/dsf-development/v2/readme.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
title: DSF v2
---
This section provides the technical documentation for the Data Sharing Framework.

## Overview
- [FHIR Implementation Guide](fhir-ig.md)
- [Maven](maven.md)
7 changes: 7 additions & 0 deletions docs/src/explore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,18 @@ title: Explore
icon: info
---
## Concepts
In this section, you will gain a deeper understanding of the fundamental concepts that form the foundation of the Data Sharing Framework (DSF). These concepts are essential if you want to be involved in the development, operation, or the implementation of process plugins for your own use case.

Each of the following topics dives into a specific aspect of the DSF:
- [Introduction](concepts/introduction.md)
- [Basics & Standards](concepts/basics.md)
- [Architecture](concepts/architecture.md)
- [Security](concepts/security.md)
- [Allow Lists](concepts/allow-list.md)
- [Process Plugins](concepts/process-plugins.md)

We also cover following topics in this section:
- [News](../news/)
- [Use-cases](../tag/awards/)
- [Publications and Talks](publications.md)
- [Awards](awards.md)
4 changes: 2 additions & 2 deletions docs/src/explore/concepts/allow-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ icon: share
The main objective is to allow only authorized organizations to do what "we" allow them to do (e.g. query data).
First, we need a list of organizations that we trust. Secondly, we need a way to ensure that the other party is a member of the parent organization. Thirdly, a list of actions we want to allow the organization to perform is needed. An organization can have different roles in different use cases.

The Allow List consists of Organization-, Endpoint- and OrganisationAffiliation- resources. With these resources the allow list defines communication partners and and parent organizations like research consortia and groups as well as the roles of each organization. Each DSF FHIR server stores their own allow list. To make sure that processes can be executed, parties must allow access via their allow list.
The Allow List consists of Organization-, Endpoint- and OrganisationAffiliation- resources. With these resources the allow list defines communication partners and parent organizations like research consortia and groups as well as the roles of each organization. Each DSF FHIR server stores their own allow list. To make sure that processes can be executed, parties must allow access via their allow list.

## Allow List Managment
## Allow List Management
[Here](/operations/latest/allowList-mgm.md) you can read all the information if you want to create or update an Allow List.

If you have the need for allowlist management feel free to contact us via <a href="mailto:dsf-gecko@hs-heilbronn.de"> E-Mail (dsf-gecko@hs-heilbronn.de)</a> and we will take care of your request as soon as possible.
Loading