Skip to content

Link and Image fix #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 30, 2025
Merged
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 docs/src/.vuepress/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import Layout from './layouts/PageLayout.vue'

export default defineClientConfig({
layouts: {
//ParentLayout,
ParentLayout,
Layout
},
})
2 changes: 1 addition & 1 deletion docs/src/.vuepress/layouts/PageLayout.vue
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ function navigateToNewVersion() {
<ParentLayout>
<template #sidebarTop>
<div class="version-selector" v-if="route.path.startsWith('/operations/')">
<label class="vp-sidebar-header" for="version-select">Version: </label>
<label class="vp-sidebar-header" for="version-select"><strong>Version:</strong> </label>
<select id="version-select" class="vp-sidebar-header" v-model="version" @change="navigateToNewVersion">
<option value="v2/latest">next (v2.0.0-M2)</option>
<option value="v1/latest">latest (v1.7.1)</option>
Expand Down
24 changes: 4 additions & 20 deletions docs/src/.vuepress/sidebar/operations-v1.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
export function generate_v1_latest_sidebar() {
return [
{
text: "Home",
icon: "home",
link: "/",
},

{
text: "Maintain a DSF instance",
icon: "tool",
Expand Down Expand Up @@ -79,11 +75,7 @@ export function generate_v1_latest_sidebar() {

export function generate_v1_gt_eq_1_7_0_sidebar() {
return [
{
text: "Home",
icon: "home",
link: "/",
},

{
text: "Maintain a DSF instance",
icon: "tool",
Expand Down Expand Up @@ -157,11 +149,7 @@ export function generate_v1_gt_eq_1_7_0_sidebar() {

export function generate_v1_gt_eq_1_5_0_sidebar() {
return [
{
text: "Home",
icon: "home",
link: "/",
},

{
text: "Maintain a DSF instance",
icon: "tool",
Expand Down Expand Up @@ -243,11 +231,7 @@ export function generate_v1_gt_eq_1_5_0_sidebar() {

export function generate_v1_gt_eq_1_0_0_sidebar() {
return [
{
text: "Home",
icon: "home",
link: "/",
},

{
text: "Maintain a DSF instance",
icon: "tool",
Expand Down
12 changes: 12 additions & 0 deletions docs/src/.vuepress/styles/index.scss
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,15 @@ h1, h2, h3, h4, h5 {
border-radius: 5%;
}

.vp-category {
color: black !important;
background: #63C7A6 !important;
}

.vp-category-count{
color: black !important;
}
.page-category-item {
color: black !important;
background: #63C7A6 !important;
}
30 changes: 20 additions & 10 deletions docs/src/.vuepress/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ export default hopeTheme({
{
text: "Explore",
icon: "info",
prefix: "",
children: ["/explore/concepts/introduction", "/explore/use-cases/", "/explore/publications/", "/security/"],
link: "/explore/",
prefix: "/explore/",
children: ["concepts/introduction", "use-cases/", "publications", "/security/"],
},
{
text: "Operations",
Expand Down Expand Up @@ -67,8 +68,8 @@ export default hopeTheme({
"communication",
"ecosystem",
"contribute/",
"consultation-hours",
"events/",
"consultation-hours"
],
},
{
Expand All @@ -91,7 +92,6 @@ export default hopeTheme({
icon: "news",
link: "tag/news/"
},

{
text: "Concepts",
icon: "info",
Expand All @@ -100,7 +100,7 @@ export default hopeTheme({
children: ["concepts/introduction.md", "concepts/basics", "concepts/architecture", "concepts/security", "concepts/allow-list", "concepts/process-plugins"],
},
{
text: "Security",
text: "Security Disclosure Policy",
icon: "safe",
link: "/security/",
},
Expand All @@ -109,15 +109,18 @@ export default hopeTheme({
icon: "any",
prefix: "explore/use-cases/",
link: "explore/use-cases/",
children: ["feasibility", "num"],
},
},
{
text: "Publications",
icon: "blog",
prefix: "explore/publications/",
link: "/explore/publications/",
children: ["publications", "awards"],
link: "explore/publications",
},
{
text: "Awards",
icon: "creative",
link: "explore/awards",
},

],
"/hackathon": [],
"/spring-school": [],
Expand Down Expand Up @@ -161,6 +164,13 @@ export default hopeTheme({
children: [ "fhir-ig", "javadoc", "maven"],
},
],
"/community":[
{
text: "Community",
icon: "",
children: ["team", "communication", "ecosystem", "contribute/", "consultation-hours", "events/",]
}
],
"/intro/use-cases/internal-mii-data-sharing.html": []
},

Expand Down
5 changes: 2 additions & 3 deletions docs/src/community/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@ title: Community
icon: creative
---


- [Consultation Hours](./consultation-hours.md)
- [Team](./team.md)
- [Communication](./communication.md)
- [Contribute](./contribute/README.md)
- [DSF Ecosystem](./ecosystem.md)
- [Contribute](./contribute/README.md)
- [Consultation Hours](./consultation-hours.md)
13 changes: 8 additions & 5 deletions docs/src/community/communication.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,19 @@ icon: call
## Contact the team
Feel free to contact us via <a href="mailto:[email protected]"> E-Mail ([email protected])</a> and we will take care of your request as soon as possible.

## Community
DSF's community is growing and we welcome anyone who would like to join! :rocket:

### Stay up to Date
- [GitHub](https://github.com/datasharingframework/dsf)
- Follow our [contributors](./team.md) on GitHub
- [Zulip Chat - MII](https://mii.zulipchat.com)

## Community
DSF's community is growing and we welcome anyone who would like to join! :rocket:

### Contribute Code
You can get familiar with the DSF code on GitHub. Branching follows the git-flow model, for the latest development version see branch [develop](https://github.com/datasharingframework/dsf/tree/develop). Additionally, you can find more information [here](/dsf-development/) in the documentation.
You can get familiar with the DSF code on GitHub. Branching follows the git-flow model, for the latest development version see branch [develop](https://github.com/datasharingframework/dsf/tree/develop).

### Share your Experience & Get support
You´re welcome to share your experience with the Community. If you have a bug to report or feature to request, that's what the [GitHub issues](https://github.com/datasharingframework/dsf/issues) are for.
You´re welcome to share your experience with the Community. If you have a bug to report or feature to request, that's what the [GitHub issues](https://github.com/datasharingframework/dsf/issues) are for.


In case of support needs you can join the weekly [DSF consultation hours](/community/consultation-hours).
11 changes: 11 additions & 0 deletions docs/src/community/events/GMDS2022-dev.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: GMDS 2022
icon: code
---
## GMDS Conference 2022

A tutorial on implementing Process Plugins for DSF version 0.9.x was presented at GMDS 2022. You can watch the recordings of the event [here](https://www.youtube.com/playlist?list=PLsHs7HOt6jDMe3PNevpo-uGsDTWVSMsYZ)

##### Implementing BPMN Processes as DSF Process-Plugins
This [repository](https://github.com/highmed/dsf-process-tutorial) contains exercises to learn how to implement process plugins for the [Data Sharing Framework (DSF)](https://github.com/highmed/highmed-dsf). The tutorial is divided into several exercises that build on each other. For each exercise, a sample solution is provided in a separate branch.
This tutorial was first executed at the [GMDS / TMF 2022](https://www.gmds.de/) conference. The slides of the opening remarks by H. Hund and R. Wettstein are available as a [PDF download](https://raw.githubusercontent.com/highmed/dsf-process-tutorial/main/exercises/figures/2022-08-21_GMDS_2022_DSF_Process_Tutorial.pdf).
7 changes: 7 additions & 0 deletions docs/src/community/events/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Events
icon: news
---
- [MIE 2023](MIE2023.md)
- [GMDS 2022](GMDS2022-dev.md)

8 changes: 0 additions & 8 deletions docs/src/community/events/tutorials/GMDS2022-dev.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/src/community/events/tutorials/README.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/src/community/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The [Institute of Medical Informatics](https://www.klinikum.uni-heidelberg.de/kl
The [LIFE Institute](https://www.uniklinikum-leipzig.de/einrichtungen/life/) of the University of Leipzig manages collaborative and follow-on projects in the fields of medicine, public health, medical informatics, and biobanking.

## Public Funding
### DSF - Medical Informatics Structure "Data Sharing Framework Community" (2023-2026)
### Medical Informatics Initiative: "Data Sharing Framework Community" (2023-2026)


![BMBF Logo =228x158](/photos/learnmore/funding/bmbf.png)
Expand All @@ -64,7 +64,7 @@ The [LIFE Institute](https://www.uniklinikum-leipzig.de/einrichtungen/life/) of

---

### Development of the DSF in the HiGHmed consortium -Contribution Heilbronn University and Heidelberg University (2018-2022)
### Medical Informatics Initiative: HiGHmed consortium (2018-2022)

[HiGHmed](https://www.highmed.org/en/home) aims to increase the efficiency of clinical research and improve patient care through new medical informatics solutions and cross-organizational data exchange. The concept will be developed on the basis of three defined prototypical use cases, which will ensure close integration with the requirements of patient care and medical research. The [GECKO Institute](https://www.hs-heilbronn.de/de/gecko) of HHN will establish a trusted third party with pseudonymization service to implement the goals of HiGHmed and is involved in the technical development of the DSF together with the partners (Funding code: 01ZZ1802E). Heidelberg University is in particular involved in the technical development of the DSF (Funding code: 01ZZ1802A).

Expand Down
5 changes: 4 additions & 1 deletion docs/src/dsf-development/v2/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
---
title: DSF v2
---
::: warning Work in progress

No content yet. Please visit this page later.
No content yet. Please visit this page later.

:::
17 changes: 8 additions & 9 deletions docs/src/explore/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
---
title: Overview
title: Explore
icon: info
---
## Overview
## Concepts

- Documentation
- [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)
- [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)

8 changes: 8 additions & 0 deletions docs/src/explore/awards.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Awards
icon: creative
---
## Awards

### Rolf Hansen Memorial Award 2023 goes to [Hauke Hund](https://github.com/hhund)
We are very pleased to have won the Rolf Hansen Memorial Award at [EFMI MIE 2023](https://www.mie23.org/) in Gothenburg. The Rolf Hansen Memorial Award is presented annually by the European Federation for Medical Informatics (EFMI) for an outstanding paper as well as for an excellent presentation. It is named after Rolf Hansen (1931-1993), a well-known Norwegian medical informatician and former president of EFMI. Hauke Hund presented his Paper: *No Transfer Without Validation: A Data Sharing Framework Use Case* in May at the EFMI MIE. [doi:10.3233/SHTI230066 ](https://ebooks.iospress.nl/doi/10.3233/SHTI230066)
2 changes: 1 addition & 1 deletion docs/src/explore/concepts/allow-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ The Allow List consists of Organization-, Endpoint- and OrganisationAffiliation-
## Allow List Managment
[Here](/operations/v1/latest/maintain/allowList-mgm.md) you can read all the information if you want to create or update an Allow List.

#### Feel free to contact us via <a href="mailto:[email protected]"> E-Mail ([email protected])</a> and we will take care of your request as soon as possible.
If you have the need for allowlist management feel free to contact us via <a href="mailto:[email protected]"> E-Mail ([email protected])</a> and we will take care of your request as soon as possible.
10 changes: 5 additions & 5 deletions docs/src/explore/concepts/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The following architecture diagram also shows three organisations, each of which

![DSF Architecture](/photos/info/architecture/architecture-dark.svg#dark)

## DSF FHIR Server :mailbox:
## DSF FHIR Server
As mentioned above, the externally accessible DSF FHIR server acts as a mailbox for communication. This means that an organisation creates a task resource in its DSF and drops the task resource (letters) into the mailbox of another organisation, requesting that something happen. Task resources have been explained in more detail in the section [Basics and Standards](basics).
It is important to understand that the DSF FHIR server is not used for persisting medical data.

Expand All @@ -25,7 +25,7 @@ It is important to understand that the DSF FHIR server is not used for persistin
The BPE located in the secure internal network executes the processes (BPMN/Java). The BPE is deployed in the internal network and has access to the local systems, such as the organisation's own FHIR server, on which medical data is stored. These FHIR servers are not to be confused with the DSF FHIR server, on which no medical data is persisted.
Different processes can be executed simultaneously. For this, only a new process plugin file has to be added and configured. More about this in the [Process Plugins](process-plugins).

![](/photos/info/architecture/bpe-light.svg#light)
![BPE](/photos/info/architecture/bpe-light.svg#light)

![BPE](/photos/info/architecture/bpe-dark.svg#dark)

Expand All @@ -34,9 +34,9 @@ The DSF BPE uses websocket (WSS) and webservice (HTTPS) connections to communica
## Flexible Deployment
The deployment of the architecture is flexible. The organisations can be deployed as a *star* schema (left) or as a *mesh* schema (right). In the Star schema (left), all Data Integration Centres (DIC) are connected to a central node (CRR - Central Research Repository), which transfers the information to all nodes (DIC). For security reasons, a data transfer hub (DTH) is connected upstream, which provides additional security so that the medical data is never transferred together with the authenticating data.

In the mesh scheme (right), the nodes (DIC) are all directly connected to each other and the information is transferred from node to node. Here in the FDPG (Forschungsdatenportal - Research Data Portal), the data can then be accessed for research purposes. More about this [here](/intro/use-cases/feasibility).
In the mesh scheme (right), the nodes (DIC) are all directly connected to each other and the information is transferred from node to node. Here in the FDPG (Forschungsdatenportal - Research Data Portal), the data can then be accessed for research purposes. More about this [here](/explore/use-cases/feasibility).

![Star schema](/photos/info/architecture/star.png =400x300) ![Mesh schema](/photos/info/architecture/mesh.png =350x300)
![Star schema =400x300](/photos/info/architecture/star.png) ![Mesh schema =350x300](/photos/info/architecture/mesh.png)

## Network Setup & Additional Reverse Proxy in external DMZ
You can find more information about the network setup [here](networkSetup)
You can find more information about the network setup [here](/explore/concepts/network-setup)
4 changes: 2 additions & 2 deletions docs/src/explore/concepts/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Interoperability is the ability of different systems to work together as seamles
- The final level, the *organizational level*, includes policy, social, legal and organizational aspects that enable secure, seamless and timely communication and use of data both within and between organizations. And importantly, these components enable shared consent, trust and integrated end-user processes and workflows.


![Levels of interoperability](/photos/info/basics/interoperability.png =600x)
![Levels of interoperability =600x](/photos/info/basics/interoperability.png )

## HL7 FHIR :fire:
[HL7 FHIR](https://www.hl7.org/fhir/) is a standard for data exchange that can be used as an information model for communication within and between systems. The standard is based on resources, references and profiles. With this concept, FHIR offers interoperability out of the box. The resources describe data formats. 150 specified resources cover the entire health system. An example of a resource would be a patient, which consists of data such as name or gender. These resources can refer to other resources by means of references. This connects the information units into a network. For seamless exchange of information, FHIR supports RESTful architectures and web standards such as XML or JSON, which makes it easier for developers to use FHIR.
Expand All @@ -34,4 +34,4 @@ In the following picture you can see parts of BPMN. These *Message Events* enabl

The *ActivityDefinition* is needed to publish what can be done in an instance. That means the *ActivityDefinition* contains the process description with the authorisation who is allowed to send a message.

![BPMN *MessageEvents*](/photos/info/basics/bpmn2.png =250x400)
![BPMN *MessageEvents* =250x400](/photos/info/basics/bpmn2.png )
6 changes: 3 additions & 3 deletions docs/src/explore/concepts/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
title: Introduction
icon: customize
---
The [German Federal Ministry of Education and Research](https://www.bmbf.de/bmbf/en/home/home_node.html) is funding the [Medical Informatics Initiative](https://www.medizininformatik-initiative.de/en/start) with the aim of making routine data available digitally, reliably and quickly for medical research. University hospitals have founded consortia with partners such as research institutions and other companies to create the conditions for research and patient care to share their data across sites. Data Integration Centers (DIC) have been established at the university hospitals and partner institutions to create the technical and organizational conditions for data exchange between patient care and medical research.
The [German Federal Ministry of Education and Research](https://www.bmbf.de) is funding the [Medical Informatics Initiative](https://www.medizininformatik-initiative.de/en/start) with the aim of making routine data available digitally, reliably and quickly for medical research. University hospitals have founded consortia with partners such as research institutions and other companies to create the conditions for research and patient care to share their data across sites. Data Integration Centers (DIC) have been established at the university hospitals and partner institutions to create the technical and organizational conditions for data exchange between patient care and medical research.

![](/photos/learnmore/funding/mii.png =300x150)
![MII =300x150](/photos/learnmore/funding/mii.png)

The **Data Sharing Framework (DSF)** was developed within the HiGHmed consortium of the Medical Informatics Initiative and is now funded as an independent project by the German Federal Ministry of Education and Research within the Medical Informatics structure as *[DSF Community](https://www.gesundheitsforschung-bmbf.de/de/dsf-medizininformatik-struktur-data-sharing-framework-community-16133.php)*.

Expand All @@ -14,6 +14,6 @@ The DSF is a concept for a secure middleware to distribute data sharing processe

The DSF is a secure communication infrastructure, that (1) scales with communication relationships, (2) orchestrates processes and instances, (3) separates execution logic from program code, (4) enables automated and user-centeric process steps ​(5) and can be used for heterogeny structures.

![Federated data exchange between distributed DICs (CRP=Central Research Portal, DMU=Data Management Unit)](/photos/info/introduction/dic-structure.png =500x320)
![Federated data exchange between distributed DICs (CRP=Central Research Portal, DMU=Data Management Unit) =500x320](/photos/info/introduction/dic-structure.png)


Loading