|
| 1 | +# Data Sharing Framework (DSF) |
| 2 | + |
| 3 | +> The Data Sharing Framework (DSF) is a secure middleware for distributing data sharing processes based on BPMN 2.0 and FHIR R4 standards. It enables biomedical researchers to extract, merge, pseudonymize, and share data across organizational boundaries. Funded by the German Federal Ministry of Research, Technology and Space within the Medical Informatics Initiative (MII). Latest version: DSF 2.0.2. Website: https://dsf.dev |
| 4 | + |
| 5 | +## Core Concepts |
| 6 | + |
| 7 | +- [Introduction](https://dsf.dev/explore/concepts/introduction.html): Overview of the DSF, the Medical Informatics Initiative, and Data Integration Centers |
| 8 | +- [Basics](https://dsf.dev/explore/concepts/basics.html): Fundamental concepts of the DSF architecture |
| 9 | +- [Architecture](https://dsf.dev/explore/concepts/architecture.html): Technical architecture of the DSF including FHIR endpoints and business process engines |
| 10 | +- [Security](https://dsf.dev/explore/concepts/security.html): Security model and concepts used by the DSF |
| 11 | +- [Allow List](https://dsf.dev/explore/concepts/allow-list.html): How the DSF manages trusted organizations via allow lists |
| 12 | +- [Process Plugins](https://dsf.dev/explore/concepts/process-plugins.html): How process plugins extend the DSF with new data sharing processes |
| 13 | +- [Network Setup](https://dsf.dev/explore/concepts/network-setup.html): How to set up a DSF network |
| 14 | + |
| 15 | +## Use Cases |
| 16 | + |
| 17 | +- [Feasibility](https://dsf.dev/explore/use-cases/feasibility.html): Feasibility queries across multiple sites |
| 18 | +- [NUM (Network University Medicine)](https://dsf.dev/explore/use-cases/num.html): Use in the German Network University Medicine |
| 19 | +- [Internal MII Data Sharing](https://dsf.dev/explore/use-cases/internal-mii-data-sharing.html): Data sharing within the Medical Informatics Initiative |
| 20 | + |
| 21 | +## Operations (v2.0.2 - Latest) |
| 22 | + |
| 23 | +- [Get Started](https://dsf.dev/operations/get-started.html): Getting started with DSF operations |
| 24 | +- [Installation Guide](https://dsf.dev/operations/latest/install.html): Step-by-step installation of DSF v2.0.2 |
| 25 | +- [Release Notes](https://dsf.dev/operations/latest/release-notes.html): What's new in DSF v2.0.2 |
| 26 | +- [FHIR Server Configuration](https://dsf.dev/operations/latest/fhir/configuration.html): Configuration options for the FHIR server component |
| 27 | +- [BPE Configuration](https://dsf.dev/operations/latest/bpe/configuration.html): Configuration options for the Business Process Engine |
| 28 | +- [FHIR Reverse Proxy](https://dsf.dev/operations/latest/fhir-reverse-proxy/configuration.html): Reverse proxy configuration for the FHIR endpoint |
| 29 | +- [BPE Reverse Proxy](https://dsf.dev/operations/latest/bpe-reverse-proxy/configuration.html): Reverse proxy configuration for the BPE |
| 30 | +- [Allow List Management](https://dsf.dev/operations/latest/allowList-mgm.html): Managing the allow list of trusted organizations |
| 31 | +- [Process Plugin Deployment](https://dsf.dev/operations/process-plugin-deployment.html): How to deploy process plugins |
| 32 | +- [Passwords and Secrets](https://dsf.dev/operations/latest/passwords-secrets.html): Managing passwords and secrets |
| 33 | +- [Root Certificates](https://dsf.dev/operations/latest/root-certificates.html): Certificate management |
| 34 | +- [Upgrade from DSF v1](https://dsf.dev/operations/latest/upgrade-from-1.html): Migration guide from DSF v1 to v2 |
| 35 | +- [Upgrade within DSF v2](https://dsf.dev/operations/latest/upgrade-from-2.html): Upgrading between DSF v2.x versions |
| 36 | +- [OIDC Configuration (FHIR)](https://dsf.dev/operations/latest/fhir/oidc.html): OpenID Connect setup for FHIR server |
| 37 | +- [OIDC Configuration (BPE)](https://dsf.dev/operations/latest/bpe/oidc.html): OpenID Connect setup for BPE |
| 38 | +- [Access Control (FHIR)](https://dsf.dev/operations/latest/fhir/access-control.html): Access control for the FHIR server |
| 39 | +- [Access Control (BPE)](https://dsf.dev/operations/latest/bpe/access-control.html): Access control for the Business Process Engine |
| 40 | + |
| 41 | +## Troubleshooting |
| 42 | + |
| 43 | +- [Common HTTP Status Codes](https://dsf.dev/operations/troubleshooting/common-http-status-codes.html): Common HTTP errors and solutions |
| 44 | +- [Connection Refused](https://dsf.dev/operations/troubleshooting/connection-refused.html): Troubleshooting connection refused errors |
| 45 | +- [Connection Timeout](https://dsf.dev/operations/troubleshooting/connection-timeout.html): Troubleshooting connection timeouts |
| 46 | +- [Read Timeout](https://dsf.dev/operations/troubleshooting/read-timeout.html): Troubleshooting read timeouts |
| 47 | +- [SSL Issues](https://dsf.dev/operations/troubleshooting/ssl.html): Troubleshooting SSL/TLS certificate problems |
| 48 | +- [Unknown Host](https://dsf.dev/operations/troubleshooting/unknown-host.html): Troubleshooting DNS resolution issues |
| 49 | + |
| 50 | +## Process Plugin Development (API v2 - Current) |
| 51 | + |
| 52 | +- [Concept](https://dsf.dev/process-development/api-v2/concept.html): Process plugin concept and design |
| 53 | +- [Get Started](https://dsf.dev/process-development/api-v2/get-started.html): Getting started with process plugin development |
| 54 | +- [Create a Process Plugin](https://dsf.dev/process-development/api-v2/create.html): Step-by-step guide to creating a process plugin |
| 55 | +- [Implementation](https://dsf.dev/process-development/api-v2/implementation.html): Implementation details |
| 56 | +- [Testing](https://dsf.dev/process-development/api-v2/testing.html): Testing process plugins |
| 57 | +- [Best Practices](https://dsf.dev/process-development/api-v2/best-practices.html): Best practices for process plugin development |
| 58 | +- [Migration from API v1](https://dsf.dev/process-development/api-v2/migration.html): Migrating process plugins from API v1 to v2 |
| 59 | +- [Javadoc](https://dsf.dev/process-development/api-v2/javadoc.html): Java API reference |
| 60 | +- [Publishing on DSF Hub](https://dsf.dev/process-development/api-v2/publishing/publish-on-dsfhub.html): How to publish process plugins |
| 61 | + |
| 62 | +### BPMN in DSF |
| 63 | + |
| 64 | +- [BPMN Overview](https://dsf.dev/process-development/api-v2/bpmn/): BPMN 2.0 elements supported by the DSF |
| 65 | +- [Service Tasks](https://dsf.dev/process-development/api-v2/bpmn/service-tasks.html): Using service tasks in DSF processes |
| 66 | +- [User Tasks](https://dsf.dev/process-development/api-v2/bpmn/user-tasks.html): User tasks for human interaction |
| 67 | +- [Messaging](https://dsf.dev/process-development/api-v2/bpmn/messaging.html): Cross-site messaging via BPMN |
| 68 | +- [Gateways](https://dsf.dev/process-development/api-v2/bpmn/gateways.html): BPMN gateways for process flow control |
| 69 | +- [Conditions](https://dsf.dev/process-development/api-v2/bpmn/conditions.html): Conditional flow in BPMN processes |
| 70 | +- [Execution Listeners](https://dsf.dev/process-development/api-v2/bpmn/execution-listeners.html): Execution listeners for process events |
| 71 | +- [Timer Events](https://dsf.dev/process-development/api-v2/bpmn/timer-intermediate-catching-events.html): Timer-based events |
| 72 | + |
| 73 | +### FHIR Resources |
| 74 | + |
| 75 | +- [FHIR Overview](https://dsf.dev/process-development/api-v2/fhir/): FHIR R4 resources used by DSF process plugins |
| 76 | +- [Task Resource](https://dsf.dev/process-development/api-v2/fhir/task.html): The FHIR Task resource in DSF |
| 77 | +- [ActivityDefinition](https://dsf.dev/process-development/api-v2/fhir/activitydefinition.html): Defining activities with FHIR ActivityDefinition |
| 78 | +- [CodeSystem](https://dsf.dev/process-development/api-v2/fhir/codesystem.html): Custom CodeSystems for DSF processes |
| 79 | +- [ValueSet](https://dsf.dev/process-development/api-v2/fhir/valueset.html): ValueSets in DSF processes |
| 80 | +- [Questionnaire](https://dsf.dev/process-development/api-v2/fhir/questionnaire-and-questionnaireresponse.html): Questionnaire and QuestionnaireResponse resources |
| 81 | + |
| 82 | +### DSF Internals |
| 83 | + |
| 84 | +- [Process Plugin API](https://dsf.dev/process-development/api-v2/dsf/process-plugin-api.html): The DSF Process Plugin API |
| 85 | +- [Process Plugin Definition](https://dsf.dev/process-development/api-v2/dsf/process-plugin-definition.html): Defining a process plugin |
| 86 | +- [BPMN Process Execution](https://dsf.dev/process-development/api-v2/dsf/bpmn-process-execution.html): How the DSF executes BPMN processes |
| 87 | +- [BPMN Process Variables](https://dsf.dev/process-development/api-v2/dsf/bpmn-process-variables.html): Available process variables |
| 88 | +- [Message Correlation](https://dsf.dev/process-development/api-v2/dsf/message-correlation.html): How messages are correlated between sites |
| 89 | +- [Spring Framework Integration](https://dsf.dev/process-development/api-v2/dsf/spring-framework-integration.html): Spring integration details |
| 90 | + |
| 91 | +### Developer Guides |
| 92 | + |
| 93 | +- [Starting a Process](https://dsf.dev/process-development/api-v2/guides/starting-a-process-via-task-resources.html): How to start a DSF process |
| 94 | +- [Accessing Process Variables](https://dsf.dev/process-development/api-v2/guides/accessing-bpmn-process-variables.html): Working with BPMN process variables |
| 95 | +- [Accessing Task Resources](https://dsf.dev/process-development/api-v2/guides/accessing-task-resources-during-execution.html): Accessing FHIR Task resources during execution |
| 96 | +- [Creating Activity Definitions](https://dsf.dev/process-development/api-v2/guides/creating-activity-definitions.html): Guide to creating ActivityDefinitions |
| 97 | +- [Creating CodeSystems](https://dsf.dev/process-development/api-v2/guides/creating-codesystems-for-dsf-processes.html): Guide to creating CodeSystems |
| 98 | +- [Creating ValueSets](https://dsf.dev/process-development/api-v2/guides/creating-valuesets-for-dsf-processes.html): Guide to creating ValueSets |
| 99 | +- [Creating Task Resources](https://dsf.dev/process-development/api-v2/guides/creating-task-resources-based-on-a-definition.html): Creating Task resources |
| 100 | +- [Read Access Tags](https://dsf.dev/process-development/api-v2/guides/configuring-read-access-tags.html): Configuring read access tags |
| 101 | +- [Task Parameters](https://dsf.dev/process-development/api-v2/guides/adding-task-parameters-to-task-profiles.html): Adding parameters to Task profiles |
| 102 | +- [User Tasks](https://dsf.dev/process-development/api-v2/guides/user-tasks-in-the-dsf.html): Implementing user tasks |
| 103 | +- [Managing Messages](https://dsf.dev/process-development/api-v2/guides/managing-mutiple-incoming-messages-and-missing-messages.html): Handling multiple and missing messages |
| 104 | + |
| 105 | +## Linter Tool |
| 106 | + |
| 107 | +- [Linter Tool](https://dsf.dev/process-development/linter-tool/linter-tool.html): Process plugin validation tool |
| 108 | +- [Validation Rules](https://dsf.dev/process-development/linter-tool/validation.html): Validation rules and checks |
| 109 | +- [Phases](https://dsf.dev/process-development/linter-tool/phases.html): Linter validation phases |
| 110 | +- [Troubleshooting](https://dsf.dev/process-development/linter-tool/troubleshooting.html): Linter troubleshooting |
| 111 | + |
| 112 | +## DSF Development |
| 113 | + |
| 114 | +- [FHIR Implementation Guide](https://dsf.dev/dsf-development/v2/fhir-ig.html): DSF FHIR Implementation Guide |
| 115 | +- [Maven Build](https://dsf.dev/dsf-development/v2/maven.html): Building the DSF with Maven |
| 116 | + |
| 117 | +## Community |
| 118 | + |
| 119 | +- [Team](https://dsf.dev/community/team.html): The team behind the DSF |
| 120 | +- [Communication](https://dsf.dev/community/communication.html): How to reach the DSF community |
| 121 | +- [Ecosystem](https://dsf.dev/community/ecosystem.html): Partner organizations and ecosystem |
| 122 | +- [Contributing Code](https://dsf.dev/community/contribute/code.html): How to contribute code |
| 123 | +- [Contributing Documentation](https://dsf.dev/community/contribute/documentation.html): How to contribute documentation |
| 124 | +- [Consultation Hours](https://dsf.dev/community/consultation-hours.html): Regular consultation hours for DSF users |
| 125 | + |
| 126 | +## Additional Resources |
| 127 | + |
| 128 | +- [Publications](https://dsf.dev/explore/publications.html): Research publications about and using the DSF |
| 129 | +- [Awards](https://dsf.dev/explore/awards.html): Awards received by the DSF project |
| 130 | +- [Security Policy](https://dsf.dev/security/): Security disclosure policy |
| 131 | +- [GitHub Repository](https://github.com/datasharingframework/dsf): Source code of the DSF |
| 132 | + |
| 133 | +## Optional |
| 134 | + |
| 135 | +- [Process Plugin Development API v1](https://dsf.dev/process-development/api-v1/): Legacy API v1 documentation (superseded by API v2) |
| 136 | +- [Old DSF Versions](https://dsf.dev/operations/old-versions.html): Documentation for older DSF versions (v1.x) |
| 137 | +- [News](https://dsf.dev/news/): News and blog posts about the DSF |
0 commit comments