From 8a5f324de8d3f6ab947b0855baba1054cfd490e9 Mon Sep 17 00:00:00 2001 From: Serap Aydin Date: Wed, 28 May 2025 14:40:57 +0200 Subject: [PATCH 1/3] Link and Image fix --- docs/src/explore/concepts/architecture.md | 4 ++-- docs/src/explore/concepts/basics.md | 4 ++-- docs/src/explore/concepts/introduction.md | 6 +++--- docs/src/explore/concepts/security.md | 8 ++++---- docs/src/explore/publications/awards.md | 2 +- docs/src/explore/use-cases/num.md | 2 +- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/src/explore/concepts/architecture.md b/docs/src/explore/concepts/architecture.md index 9de51ee82..1af4f6ba5 100644 --- a/docs/src/explore/concepts/architecture.md +++ b/docs/src/explore/concepts/architecture.md @@ -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) @@ -36,7 +36,7 @@ The deployment of the architecture is flexible. The organisations can be deploye 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). -![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) \ No newline at end of file diff --git a/docs/src/explore/concepts/basics.md b/docs/src/explore/concepts/basics.md index 2261d8776..9e835a8d9 100644 --- a/docs/src/explore/concepts/basics.md +++ b/docs/src/explore/concepts/basics.md @@ -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. @@ -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) \ No newline at end of file +![BPMN *MessageEvents* =250x400](/photos/info/basics/bpmn2.png ) \ No newline at end of file diff --git a/docs/src/explore/concepts/introduction.md b/docs/src/explore/concepts/introduction.md index c27ef5f62..659dd9c2a 100644 --- a/docs/src/explore/concepts/introduction.md +++ b/docs/src/explore/concepts/introduction.md @@ -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/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. -![](/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)*. @@ -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) diff --git a/docs/src/explore/concepts/security.md b/docs/src/explore/concepts/security.md index 7323a7372..124896e38 100644 --- a/docs/src/explore/concepts/security.md +++ b/docs/src/explore/concepts/security.md @@ -3,19 +3,19 @@ title: Security by Design icon: safe --- ## Basics Security -The open-source Data Sharing Framework is EU-GDPR compliant and meets the highest security standards by design. DSF FHIR servers only accept certain FHIR resources from internal systems/administrators (e.g. tasks, binary resources...). In addition, the communication partners are defined via Allow Lists. This means that an organisation can only communicate with organisations that are included in the allow list of approved organisations of the participating organisations. More information about allow lists can be found in the [next chapter](allowList). +The open-source Data Sharing Framework is EU-GDPR compliant and meets the highest security standards by design. DSF FHIR servers only accept certain FHIR resources from internal systems/administrators (e.g. tasks, binary resources...). In addition, the communication partners are defined via Allow Lists. This means that an organisation can only communicate with organisations that are included in the allow list of approved organisations of the participating organisations. More information about allow lists can be found in the [next chapter](allow-list). For transport encryption, the TLS protocol is used. Secure Web Socket (WSS) connections provide security for the connection between the DSF FHIR server (DMZ) and the BPE (internal network). In addition, the DSF is being actively developed and there is an excellent community, both of which guarantee fast security patches. -![](/photos/info/security/certificates-light.svg#light) +![Certificates](/photos/info/security/certificates-light.svg#light) -![](/photos/info/security/certificates-dark.svg#dark) +![Certificates](/photos/info/security/certificates-dark.svg#dark) ## Authentication Authentication of organizations within the DSF is handled by the use of X.509 client and server certificates. Currently the certificate authorities run by [DFN-PKI Global G2](https://www.pki.dfn.de/ueberblick-dfn-pki/), [D-Trust via TMF e.V.](https://www.tmf-ev.de) and [GÉANT TCS via DFN](https://doku.tid.dfn.de/de:dfnpki:start) are supported. All participating organizations are entered in a distributed and synchronized allow-list of valid organizations and certificates. A webserver certificate is needed to run the FHIR endpoint and a 802.1X client certificate is used to authenticate against other organizations endpoints and as a server certificate for the business process engine. For available certificate profiles see [DFN-PKI-Zertifikatprofile_Global.pdf](https://www.pki.dfn.de/fileadmin/PKI/anleitungen/DFN-PKI-Zertifikatprofile_Global.pdf) -More information about client and server certificates can be found [here](/stable/maintain/install#client-server-certificates). +More information about client and server certificates can be found [here](/operations/v1/latest/maintain/install#client-server-certificates). ### Certificate Requests :lock: #### FHIR Endpoint diff --git a/docs/src/explore/publications/awards.md b/docs/src/explore/publications/awards.md index b9ee33c43..7a8139dad 100644 --- a/docs/src/explore/publications/awards.md +++ b/docs/src/explore/publications/awards.md @@ -5,4 +5,4 @@ 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.mie2023.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) +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) diff --git a/docs/src/explore/use-cases/num.md b/docs/src/explore/use-cases/num.md index 762f1daf9..59ba7f35f 100644 --- a/docs/src/explore/use-cases/num.md +++ b/docs/src/explore/use-cases/num.md @@ -4,7 +4,7 @@ icon: map --- The [Network University Medicine](https://www.netzwerk-universitaetsmedizin.de/) was established in April 2020 as part of the COVID-19 pandemic crisis management. The aim of the NUM is to better coordinate COVID-19 research at all 36 university hospitals in Germany.' ::: center -![](/photos/learnmore/projects/num.png =370x220) +![NUM =370x220](/photos/learnmore/projects/num.png ) ::: As part of the *[CODEX | COVID-19 Data Exchange Platform](https://www.netzwerk-universitaetsmedizin.de/projekte/codex#c599)* project, a nationwide, uniform, privacy-compliant infrastructure for storing and providing COVID-19 research datasets was established. Since 2022, the work continues within the project [NUM RDP](https://www.netzwerk-universitaetsmedizin.de/projekte/num-rdp). All 36 university hospitals have installed the DSF to share Covid-19 research data. From 5bb3a688044950240d840f82038ff9833afee15a Mon Sep 17 00:00:00 2001 From: Simon Schweizer Date: Wed, 28 May 2025 16:32:38 +0200 Subject: [PATCH 2/3] added hero view to homepage --- docs/src/.vuepress/client.ts | 2 +- docs/src/index.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/src/.vuepress/client.ts b/docs/src/.vuepress/client.ts index eb21d4003..279ebf478 100644 --- a/docs/src/.vuepress/client.ts +++ b/docs/src/.vuepress/client.ts @@ -5,7 +5,7 @@ import Layout from './layouts/PageLayout.vue' export default defineClientConfig({ layouts: { - //ParentLayout, + ParentLayout, Layout }, }) \ No newline at end of file diff --git a/docs/src/index.md b/docs/src/index.md index 95d71995d..d385f06ba 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -4,6 +4,7 @@ icon: home title: Data Sharing Framework heroImage: /photos/home/logo.svg heroText: Data Sharing Framework +layout: ParentLayout tagline: A performant, secure, and innovative framework that enables biomedical researchers to extract value from routine data. # A performant, secure and innovative framework that enables healthcare data exchange across organizational boundaries. From 0f32adce451df938b421f3ef5d4c700bb8e2ff85 Mon Sep 17 00:00:00 2001 From: Serap Aydin Date: Wed, 28 May 2025 21:38:13 +0200 Subject: [PATCH 3/3] - Links, Sidebar, Navigation were fixed - added the old Tutorials to Process development - tag color look at to do's in wiki for comprehensive list --- docs/src/.vuepress/layouts/PageLayout.vue | 2 +- docs/src/.vuepress/sidebar/operations-v1.ts | 24 ++-------- docs/src/.vuepress/styles/index.scss | 12 +++++ docs/src/.vuepress/theme.ts | 30 ++++++++----- docs/src/community/README.md | 5 +-- docs/src/community/communication.md | 13 +++--- docs/src/community/events/GMDS2022-dev.md | 11 +++++ .../events/{tutorials => }/MIE2023.md | 0 docs/src/community/events/README.md | 7 +++ .../events/tutorials/GMDS2022-dev.md | 8 ---- docs/src/community/events/tutorials/README.md | 7 --- docs/src/community/team.md | 4 +- docs/src/dsf-development/v2/readme.md | 5 ++- docs/src/explore/README.md | 17 ++++--- docs/src/explore/{publications => }/awards.md | 0 docs/src/explore/concepts/allow-list.md | 2 +- docs/src/explore/concepts/architecture.md | 6 +-- docs/src/explore/concepts/introduction.md | 2 +- docs/src/explore/concepts/process-plugins.md | 9 ++-- docs/src/explore/concepts/security.md | 27 +----------- .../{publications => }/publications.md | 2 +- docs/src/explore/publications/README.md | 7 --- docs/src/explore/use-cases/README.md | 9 +++- docs/src/explore/use-cases/feasibility.md | 7 ++- docs/src/explore/use-cases/num.md | 5 +++ docs/src/index.md | 12 ++--- docs/src/news/fhir-devdays-2025/index.md | 2 + docs/src/news/index.md | 2 + docs/src/news/spring-school-2025/index.md | 1 + .../v1/v1.0.0/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.0.0/maintain/install.md | 2 +- .../v1/v1.1.0/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.1.0/maintain/install.md | 2 +- .../v1/v1.2.0/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.2.0/maintain/install.md | 2 +- .../v1/v1.3.0/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.3.0/maintain/install.md | 2 +- .../v1/v1.3.1/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.3.1/maintain/install.md | 2 +- docs/src/operations/v1/v1.3.2/index.md | 6 ++- .../v1/v1.3.2/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.3.2/maintain/install.md | 2 +- docs/src/operations/v1/v1.4.0/index.md | 4 +- .../v1/v1.4.0/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.4.0/maintain/install.md | 2 +- docs/src/operations/v1/v1.5.0/index.md | 4 +- .../v1/v1.5.0/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.5.0/maintain/install.md | 2 +- docs/src/operations/v1/v1.5.1/index.md | 5 +-- .../v1/v1.5.1/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.5.1/maintain/install.md | 2 +- docs/src/operations/v1/v1.5.2/index.md | 6 ++- .../v1/v1.5.2/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.5.2/maintain/install.md | 2 +- docs/src/operations/v1/v1.6.0/index.md | 4 +- .../v1/v1.6.0/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.6.0/maintain/install.md | 2 +- docs/src/operations/v1/v1.7.0/index.md | 5 ++- .../v1/v1.7.0/maintain/allowList-mgm.md | 2 +- .../operations/v1/v1.7.0/maintain/install.md | 2 +- docs/src/operations/v1/v1.7.1/index.md | 5 +-- .../v1/v1.7.1/maintain/allowList-mgm.md | 2 +- .../v1/v1.7.1/maintain/fhir/oidc.md | 2 +- .../operations/v1/v1.7.1/maintain/install.md | 4 +- .../posts/2025-04-23-spring-school-2025.md | 3 +- .../src/posts/2025-05-07-fhir-devdays-2025.md | 2 + .../src/process-development/api-v1/concept.md | 44 +++++++++++++++++++ docs/src/process-development/api-v1/create.md | 3 +- .../api-v1/publishing/publish-on-dsfhub.md | 9 +++- .../api-v1/tooling/README.md | 10 +++++ .../api-v1/tooling/empty-process-plugin.md | 5 ++- .../process-development/api-v1/tooling/ide.md | 3 +- .../api-v1/tooling/maven.md | 3 +- .../api-v1/tooling/pipeline-testing.md | 3 +- .../api-v1/tooling/validator.md | 3 +- .../api-v1/tutorials/README.md | 14 +++++- .../api-v2/best-practices.md | 3 +- .../src/process-development/api-v2/concept.md | 5 ++- docs/src/process-development/api-v2/create.md | 3 +- .../process-development/api-v2/get-started.md | 1 + .../api-v2/implementation.md | 1 + .../process-development/api-v2/migration.md | 2 +- .../api-v2/publishing/publish-on-dsfhub.md | 9 +++- .../src/process-development/api-v2/testing.md | 1 + .../api-v2/tooling/README.md | 10 +++++ .../api-v2/tooling/empty-process-plugin.md | 9 +++- .../process-development/api-v2/tooling/ide.md | 7 ++- .../api-v2/tooling/maven.md | 7 ++- .../api-v2/tooling/pipeline-testing.md | 3 +- .../api-v2/tooling/validator.md | 2 + .../api-v2/tutorials/README.md | 15 ++++++- docs/src/security/readme.md | 2 +- 92 files changed, 331 insertions(+), 184 deletions(-) create mode 100644 docs/src/community/events/GMDS2022-dev.md rename docs/src/community/events/{tutorials => }/MIE2023.md (100%) create mode 100644 docs/src/community/events/README.md delete mode 100644 docs/src/community/events/tutorials/GMDS2022-dev.md delete mode 100644 docs/src/community/events/tutorials/README.md rename docs/src/explore/{publications => }/awards.md (100%) rename docs/src/explore/{publications => }/publications.md (97%) delete mode 100644 docs/src/explore/publications/README.md create mode 100644 docs/src/process-development/api-v1/tooling/README.md create mode 100644 docs/src/process-development/api-v2/tooling/README.md diff --git a/docs/src/.vuepress/layouts/PageLayout.vue b/docs/src/.vuepress/layouts/PageLayout.vue index 20e966a79..c13d2d8c3 100644 --- a/docs/src/.vuepress/layouts/PageLayout.vue +++ b/docs/src/.vuepress/layouts/PageLayout.vue @@ -46,7 +46,7 @@ function navigateToNewVersion() {