diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml deleted file mode 100644 index 37eba202..00000000 --- a/.github/workflows/pages.yml +++ /dev/null @@ -1,53 +0,0 @@ -name: Build and Deploy GitHub Pages - -on: - push: - branches: - - main - - develop - -permissions: - contents: read - pages: write - id-token: write - -jobs: - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - submodules: 'false' - - # Für Jekyll wird Ruby bzw. Bundler benötigt: - - name: Set up Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: '3.2' - - name: Install dependencies - run: bundle install - - # Hier kommen weitere Schritte hin, z.B. das Bauen deiner Seite - # Beispiel für Jekyll: - - name: Build site with Jekyll - run: bundle exec jekyll build - # - # Beispiel für reines HTML: - # - name: Copy files - # run: cp -r * ${{ github.workspace }}/_site - - # Deployment auf GitHub Pages: - - uses: actions/upload-pages-artifact@v3 - with: - path: './_site' - - deploy: - needs: build - runs-on: ubuntu-latest - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 diff --git a/Gemfile b/Gemfile deleted file mode 100644 index fe795096..00000000 --- a/Gemfile +++ /dev/null @@ -1,3 +0,0 @@ -source "https://rubygems.org" -gem "jekyll" -gem "jekyll-theme-primer" diff --git a/Install.md b/Install.md index 5654f63e..5c1c89d3 100644 --- a/Install.md +++ b/Install.md @@ -1,3 +1,7 @@ +--- +layout: default +title: Installationsanleitung +--- # Installationsanleitung bzw. Anleitung zur Einrichtung der CDS tool chain 1. Checkout des INTERPOLAR Repositories, z.B. mit einem dieser Befehle: \ diff --git a/Postgres-cds_hub/DB_description.md b/Postgres-cds_hub/DB_description.md index b8ad70bf..2a9d2e78 100644 --- a/Postgres-cds_hub/DB_description.md +++ b/Postgres-cds_hub/DB_description.md @@ -16,12 +16,12 @@ Man kann die verschiedenen Bereiche (Schemata) in Schnittstellenschemata und fun Funktionale Schemata dienen der inhaltlichen Gliederung der Daten innerhalb der Datenbank. Im Folgenden werden die verschiedenen Bereiche der CDS-HUB DB vorgestellt. ### cds2db_in / cds2db_out -Schnittstellen-Schema zum Importieren von FHIR-Daten (_in) sowie zur Umwandlung dieser Daten in typisierte relationale Datenbanktabellen. Die Umsetzung erfolgt in dieser Referenzimplementierung im Modul CDS2DB mithilfe von R-Skripten ([R-cds2db](../R-cds2db/cds2db/R) +Schnittstellen-Schema zum Importieren von FHIR-Daten (_in) sowie zur Umwandlung dieser Daten in typisierte relationale Datenbanktabellen. Die Umsetzung erfolgt in dieser Referenzimplementierung im Modul CDS2DB mithilfe von R-Skripten ([R-cds2db](../R-cds2db/cds2db) ). Die in diesem Schema angelegten Tabellen entsprechen den Strukturen der FHIR-Ressourcen. ### db2dataprocessor_in / db2dataprocessor_out -Schnittstellen-Schema, um zum einen Daten aus dem Kern dem Modul DataProcessor (_out) zur Verfügung zu stellen und zum anderen berechnete Daten von diesem entgegenzunehmen (_in) und wieder im Kern dauerhaft zu speichern. Sämtliche inhaltliche Logik und Berechnungen finden im Modul DataProcessor statt und können z. B. über R-Skripte implementiert werden ([R-dataprocessor](../R-dataprocessor/dataprocessor/R)). Die in diesem Schema angelegten Tabellen entsprechen den Strukturen der FHIR-Ressourcen (_out) sowie den Strukturen, die fürs Frontend benötigt werden. Weitere Tabellen können für zusätzliche Funktionalitäten erforderlich werden. +Schnittstellen-Schema, um zum einen Daten aus dem Kern dem Modul DataProcessor (_out) zur Verfügung zu stellen und zum anderen berechnete Daten von diesem entgegenzunehmen (_in) und wieder im Kern dauerhaft zu speichern. Sämtliche inhaltliche Logik und Berechnungen finden im Modul DataProcessor statt und können z. B. über R-Skripte implementiert werden ([R-dataprocessor](../R-dataprocessor/dataprocessor)). Die in diesem Schema angelegten Tabellen entsprechen den Strukturen der FHIR-Ressourcen (_out) sowie den Strukturen, die fürs Frontend benötigt werden. Weitere Tabellen können für zusätzliche Funktionalitäten erforderlich werden. ### db2frontend_in / db2frontend_out Schnittstellen-Schema, um Daten aus dem Kern an ein Frontend zu übergeben (_out) bzw. von diesem entgegenzunehmen (_in) und im Kern zu speichern. Die in diesem Schema angelegten Tabellen entsprechen den Strukturen des Frontends. @@ -66,9 +66,9 @@ Die CDS-HUB DB ist ein Bestandteil des Datenflusses. Daher ist der Beschreibung Um den Datenfluss zu gewährleisten und rückverfolgbar zu machen, werden zu allen Daten (Tabellen) immer datenbankinterne technische Primärschlüssel angelegt und gegebenenfalls bei der Verarbeitung weitergegeben. Diese technischen Primärschlüssel können redundant zu den in den Daten enthaltenen Primärschlüsseln sein (z. B. FHIR-IDs). ## Erzeugung der Datenbank -Zur Erzeugung der Strukturen und Funktionalität der Datenbank werden bei der Initialisierung Skripte in einer durch Nummerierung vorgegebenen Reihenfolge ausgeführt. Diese Skripte initialisieren die Datenbank zum aktuellen Entwicklungsstand und können zukünftigen Änderungen unterliegen. Der genaue Inhalt ist im jeweiligen SQL-Skript nachzulesen (siehe [Postgres-cds_hub/init (SQL-Skripte)](../Postgres-cds_hub/init)). +Zur Erzeugung der Strukturen und Funktionalität der Datenbank werden bei der Initialisierung Skripte in einer durch Nummerierung vorgegebenen Reihenfolge ausgeführt. Diese Skripte initialisieren die Datenbank zum aktuellen Entwicklungsstand und können zukünftigen Änderungen unterliegen. Der genaue Inhalt ist im jeweiligen SQL-Skript nachzulesen (siehe [Postgres-cds_hub/init (SQL-Skripte)](https://github.com/medizininformatik-initiative/INTERPOLAR/tree/main/Postgres-cds_hub/init)). -Teilweise werden diese Skripte mit Hilfe von Templates und Konfigurationsdateien erzeugt. Dies betrifft alle Skripte zum Anlegen von Tabellen und deren Spalten. Die Definition der Tabellen für das Modul 'cds2db' (insbesondere die Definition der Tabellen für die FHIR Ressourcen) finden sich in der Datei [Table_Description.xlsx](../R-cds2db/cds2db/inst/extdata/Table_Description.xlsx). Die Definition der Tabellen für das Modul 'frontend' sind in der Datei [Frontend_Table_Description.xlsx](../R-db2frontend/db2frontend/inst/extdata/Frontend_Table_Description.xlsx) angegeben. Zusätzlich dazu gibt es noch eine Definition der Tabellenschemata und Rechte, die im Generierungsprozess benötigt wird (siehe [User_Schema_Rights_Definition.xlsx](./init/template)) sowie die eigentlichen Templates im selben Ordner. Durch das R-Script [Init_02_Create_Database_Scripts.R](../R-cds2db/cds2db/R/Init_02_Create_Database_Scripts.R) wird der generierte Teil der SQL-Scripte erzeugt. +Teilweise werden diese Skripte mit Hilfe von Templates und Konfigurationsdateien erzeugt. Dies betrifft alle Skripte zum Anlegen von Tabellen und deren Spalten. Die Definition der Tabellen für das Modul 'cds2db' (insbesondere die Definition der Tabellen für die FHIR Ressourcen) finden sich in der Datei [Table_Description.xlsx](../R-cds2db/cds2db/inst/extdata/Table_Description.xlsx). Die Definition der Tabellen für das Modul 'frontend' sind in der Datei [Frontend_Table_Description.xlsx](../R-db2frontend/db2frontend/inst/extdata/Frontend_Table_Description.xlsx) angegeben. Zusätzlich dazu gibt es noch eine Definition der Tabellenschemata und Rechte, die im Generierungsprozess benötigt wird (siehe [User_Schema_Rights_Definition.xlsx](init/template/User_Schema_Rights_Definition.xlsx)) sowie die eigentlichen Templates im selben Ordner. Durch das R-Script [Init_02_Create_Database_Scripts.R](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/Postgres-cds_hub/R-initcdstoolchain/initcdstoolchain/R/Init_02_Create_Database_Scripts.R) wird der generierte Teil der SQL-Scripte erzeugt. Bei der Initalisierung der Datenbank ist darauf zu achten das alle Skripte fehlerfrei ausgeführt werden, um die Funktionalität zu gewährleisten. diff --git a/R-cds2db/README.md b/R-cds2db/README.md index 1a00dee7..c69d94c3 100644 --- a/R-cds2db/README.md +++ b/R-cds2db/README.md @@ -6,7 +6,7 @@ Die Ausleitung der FHIR-Daten in die Datenbank sollte möglichst 1 mal täglich ## Konfiguration -Der ETL-Prozess kann über die Datei [cds2db_config.toml](cds2db_config.toml) konfiguriert werden. Alle Parameter sind in der Datei durch Kommentare beschrieben. Hier werden u.a. sowohl die Logging-Parameter, als auch die Parameter zum Zugriff auf den FHIR-Server angegeben. Außerdem stehen Debug-Parameter zur Verfügung. Damit kann man für ältere Zeiträume Daten übertragen, falls für Tests keine aktuellen Daten vorliegen. +Der ETL-Prozess kann über die Datei [cds2db_config.toml](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/R-cds2db/cds2db_config.toml) konfiguriert werden. Alle Parameter sind in der Datei durch Kommentare beschrieben. Hier werden u.a. sowohl die Logging-Parameter, als auch die Parameter zum Zugriff auf den FHIR-Server angegeben. Außerdem stehen Debug-Parameter zur Verfügung. Damit kann man für ältere Zeiträume Daten übertragen, falls für Tests keine aktuellen Daten vorliegen. ### Extraktion relevanter Patienten @@ -14,7 +14,7 @@ Die Ermittlung der Patienten relevanter Stationen erfolgt über eine der beiden #### Variante 1: Die relevanten Patienten werden über Informationen aus den FHIR-Daten ermittelt -Bei dieser Variante ist es notwendig, dass die relevanten Stationen aus dem FHIR-Profil [Encounter](https://www.medizininformatik-initiative.de/Kerndatensatz/Modul_Fall/EncounterKontaktGesundheitseinrichtung.html) ausgelesen werden können.\ +Bei dieser Variante ist es notwendig, dass die relevanten Stationen aus dem FHIR-Profil Encounter ausgelesen werden können.\ Ziel ist es Patienten-IDs von Encountern zu finden, die bestimmte Eigenschaften in den FHIR-Daten aufweisen. Idealerweise sollte es so etwas sein wie, der Encounter ist noch nicht abgeschlossen und als ServiceProvider ist der gesuchte Stationsname angegeben oder der Encounter referenziert eine bestimmte Location.\ Die Encounter können also über beliebige Einträge identifiziert werden. Es ist frei konfigurierbar und auf die lokalen Gegebenheiten am DIZ einstellbar. Die Beschreibung der Einstellungsmöglichkeiten befinden sich direkt in der toml-Datei als Kommentar zu den ENCOUNTER_FILTER_PATTERN. @@ -23,11 +23,11 @@ Die Encounter können also über beliebige Einträge identifiziert werden. Es is #### Variante 2: Die relevanten Patienten werden über Informationen aus einer Textdatei mit Patientenliste ermittelt Diese Variante sollte genommen werden, wenn es keine Möglichkeit gibt, die aktuellen Fälle der Stationen über die Encounter zu ermitteln. -Bei dieser Variante muss das DIZ eine Textdatei erzeugen, die folgende Form hat: [source_PIDs](source_PIDs.txt). Diese Datei muss ständig aktualisiert werden. Wie ein DIZ diese Datei erzeugt, ist ihm selbst überlassen. Um diese Variante 2 zu aktivieren und damit die Variante 1 auszuschalten, muss der Parameter 'PATH_TO_PID_LIST_FILE' aktiviert werden und der Pfad auf die entsprechende Datei zeigen. +Bei dieser Variante muss das DIZ eine Textdatei erzeugen, die folgende Form hat: [source_PIDs.txt](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/R-cds2db/source_PIDs.txt). Diese Datei muss ständig aktualisiert werden. Wie ein DIZ diese Datei erzeugt, ist ihm selbst überlassen. Um diese Variante 2 zu aktivieren und damit die Variante 1 auszuschalten, muss der Parameter 'PATH_TO_PID_LIST_FILE' aktiviert werden und der Pfad auf die entsprechende Datei zeigen. ## Ausführung des Moduls -Das R-Skript [StartRetrieval.R](StartRetrieval.R) startet das Retrieval für den ETL-Prozess. +Das R-Skript [StartRetrieval.R](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/R-cds2db/StartRetrieval.R) startet das Retrieval für den ETL-Prozess. Dieses kann an der Console manuell über den folgenden Befehl ausgeführt werden: ```console @@ -36,4 +36,4 @@ docker compose run --rm --no-deps r-env Rscript R-cds2db/StartRetrieval.R ## Details der Implementierung -Weitere Details siehe [README](./README.md) des R Packages cds2db. +Weitere Details siehe [README](./cds2db/) des R Packages cds2db. diff --git a/R-cds2db/cds2db/README.md b/R-cds2db/cds2db/README.md index bb0528a4..fcc0ff88 100644 --- a/R-cds2db/cds2db/README.md +++ b/R-cds2db/cds2db/README.md @@ -16,8 +16,8 @@ Es gibt eines Excel Datei Namens [Table-Description](./inst/extdata/Table_Descr ### Herunterladen und verflachen der FHIR-Ressourcen -Auf Grundlage der relevanten Patienten werden die FHIR-Ressourcen, unter Verwendung der definierten Table-Description, heruntergeladen. Aus den JSON-Struktur der heruntergeladenen Ressourcen entstehen in einen nächsten Schritt flache Tabellen auf Basis der Table-Description. Für diese Schritte wird das [fhircrackr-Package]('https://cran.r-project.org/web/packages/fhircrackr/index.html') verwendet. +Auf Grundlage der relevanten Patienten werden die FHIR-Ressourcen, unter Verwendung der definierten Table-Description, heruntergeladen. Aus den JSON-Struktur der heruntergeladenen Ressourcen entstehen in einen nächsten Schritt flache Tabellen auf Basis der Table-Description. Für diese Schritte wird das fhircrackr-Package verwendet. ### Schreiben der Ressourcen-Tabellen in die Datenbank -Die flachen Tabellen werden in eine Postgres-Datenbank überführt, dazu wird eine Datenbankverbindung mit den angegebenen Anmeldeinformationen aus der [config-Datei](../../cds_hub_db_config.toml) für die Datenbankverbindungen erstellt. +Die flachen Tabellen werden in eine Postgres-Datenbank überführt, dazu wird eine Datenbankverbindung mit den angegebenen Anmeldeinformationen aus der [config-Datei](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/cds_hub_db_config.toml) für die Datenbankverbindungen erstellt. diff --git a/R-dataprocessor/README.md b/R-dataprocessor/README.md index 6c4e1379..26208da9 100644 --- a/R-dataprocessor/README.md +++ b/R-dataprocessor/README.md @@ -2,11 +2,11 @@ Generell ist das Modul "dataprocessor" dazu gedacht, Daten zu transformieren und für eine Ausgabe im Frontend oder für eine Ausleitung zur Verfügung zu stellen. -In Version [0.2.x](tags) nutzt es die im [Modul "cds2db"](R-cds2db) typisierten Daten aus der Postgres-Datenbank, um Tabellen mit relevanten Patienten und Fallinformationen zu erstellen. Diese werden auch zurück in die Postgres-Datenbank geschrieben und anschließend über das [Modul "db2frontend"](R-db2frontend) dem Frontend zur Verfügung gestellt. +Seit Version [0.2.x](https://github.com/medizininformatik-initiative/INTERPOLAR/releases) nutzt es die im [Modul "cds2db"](../R-cds2db) typisierten Daten aus der Postgres-Datenbank, um Tabellen mit relevanten Patienten und Fallinformationen zu erstellen. Diese werden auch zurück in die Postgres-Datenbank geschrieben und anschließend über das [Modul "db2frontend"](../R-db2frontend) dem Frontend zur Verfügung gestellt. ## Konfiguration -Der Data Processor kann über die Datei [dataprocessor_config.toml](dataprocessor_config.toml) konfiguriert werden. Alle Parameter sind in der Datei durch Kommentare beschrieben. +Der Data Processor kann über die Datei [dataprocessor_config.toml](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/R-dataprocessor/dataprocessor_config.toml) konfiguriert werden. Alle Parameter sind in der Datei durch Kommentare beschrieben. ### Anpassung der Codes für Körpergröße, -gewicht und BMI @@ -19,7 +19,7 @@ Weitere Informationen stehen direkt in diesem Abschnitt in der toml-Datei. ## Ausführung des Moduls -Das R-Skript [StartDataProcessor.R](StartDataProcessor.R) startet den Data Processor. +Das R-Skript [StartDataProcessor.R](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/R-dataprocessor/StartDataProcessor.R) startet den Data Processor. ```console docker compose run --rm --no-deps r-env Rscript R-dataprocessor/StartDataProcessor.R ``` diff --git a/README.md b/README.md index c0ddd9a6..c8836266 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # CDS tool chain -Dieses Repository enthält die Bestandteile der CDS tool chain zur Verarbeitung von [`MII KDS FHIR Ressourcen`](https://www.medizininformatik-initiative.de/de/basismodule-des-kerndatensatzes-der-mii). Es handelt sich um eine modular aufgebaute Referenzimplementierung, welche z.B. Datenintegrationszentren (DIZ) der MII eingesetzt werden kann. Hierbei werden FHIR-Ressourcen vom KDS (Kerndatensatz) FHIR Server / Endpunkt heruntergeladen, in eine Tabellenstruktur überführt ([CDS2DB](./README.md#cds2db)) und in eine Posgres-Datenbank (CDS_HUB) geschrieben. In einen nächsten Schritt werden die Daten geprüft, harmonisiert und können mit Hilfe von Algorithmen weiter verarbeitet werden (DataProcessor). Anschließend werden die Daten über ein Frontend (z.B. Redcap) auf einer Benutzeroberfläche sichtbar gemacht (DB2Frontend, Frontend). +Dieses Repository enthält die Bestandteile der CDS tool chain zur Verarbeitung von [`MII KDS FHIR Ressourcen`](https://www.medizininformatik-initiative.de/de/basismodule-des-kerndatensatzes-der-mii). Es handelt sich um eine modular aufgebaute Referenzimplementierung, welche z.B. Datenintegrationszentren (DIZ) der MII eingesetzt werden kann. Hierbei werden FHIR-Ressourcen vom KDS (Kerndatensatz) FHIR Server / Endpunkt heruntergeladen, in eine Tabellenstruktur überführt ([CDS2DB](#cds2db)) und in eine Posgres-Datenbank (CDS_HUB) geschrieben. In einen nächsten Schritt werden die Daten geprüft, harmonisiert und können mit Hilfe von Algorithmen weiter verarbeitet werden (DataProcessor). Anschließend werden die Daten über ein Frontend (z.B. Redcap) auf einer Benutzeroberfläche sichtbar gemacht (DB2Frontend, Frontend). ![CDS tool chain](https://github.com/medizininformatik-initiative/INTERPOLAR/assets/5671404/d8ee4fb8-c9fb-40f2-81cb-2adeda6d20b2) -Der detaillierte Datenfluss zwischen den und innerhalb der Module ist in der Datei [Dataflow.md](Dataflow.md) beschrieben. +Der detaillierte Datenfluss zwischen den und innerhalb der Module ist in der Datei [Dataflow](Dataflow) beschrieben. -Der gesamte Ablauf der CDS Toolchain ist in der Datei [full_toolchain_description.md](full_toolchain_description.md) beschrieben. +Der gesamte Ablauf der CDS Toolchain ist in der Datei [full_toolchain_description](full_toolchain_description) beschrieben. ## Bestandteile der CDS tool chain @@ -21,14 +21,14 @@ Dieses R-Modul dient zur Ausleitung Kerndatensatz-konformer Daten in eine Postgr Der Quellcode (R) dafür befindet sich im Ordner [R-cds2db](./R-cds2db). -Eine Beschreibung zur Konfiguration und Ausführung befindet sich in [R-cds2db/README.md](./R-cds2db/README.md). +Eine Beschreibung zur Konfiguration und Ausführung befindet sich in [R-cds2db](./R-cds2db/). ### CDS_HUB Beim CDS_HUB handelt es sich um eine relationale Datenbank (Postgres). Im Ordner [Postgres-cds_hub](./Postgres-cds_hub) befinden sich Dateien für die Konfiguration und Initialisierung. -Eine Beschreibung der Datenbankstruktur befindet sich unter [Postgres-cds_hub/DB_description.md](./Postgres-cds_hub/DB_description.md). \ -Eine Beschreibung, wie der Zugriff erfolgt befindet sich unter [Postgres-cds_hub/Readme.md](./Postgres-cds_hub/Readme.md) . +Eine Beschreibung der Datenbankstruktur befindet sich unter [Postgres-cds_hub/DB_description](./Postgres-cds_hub/DB_description). \ +Eine Beschreibung, wie der Zugriff erfolgt befindet sich unter [Postgres-cds_hub](./Postgres-cds_hub) . ### DataProcessor @@ -81,7 +81,7 @@ Es handelt sich dabei um eine Schätzung. Je nach Datenbestand kann es erforderl ## Installation -Folgende Anweisungen müssen ausgeführt werden, um die CDS tool chain zu verwenden: [Install.md](Install.md) +Folgende Anweisungen müssen ausgeführt werden, um die CDS tool chain zu verwenden: [Install](Install) ## Verwendung diff --git a/REDCap-app/Readme.md b/REDCap-app/Readme.md index afade4af..117d4ff1 100644 --- a/REDCap-app/Readme.md +++ b/REDCap-app/Readme.md @@ -3,17 +3,17 @@ In diesem Ordner wird für das Frontend ein minimales Redcap aufgesetzt. Dies erfolgt in 3 Schritten: -1. Docker-Image für die Ausführung von Redcap erzeugen (Ordner [build](build)) - * [build/Dockerfile](build/Dockerfile) beschreibt eine PHP-8 Umgebung inkl. Extensions, wie sie für REDCap benötigt werden - * Im Verzeichnis [build/config](build/config) liegen Konfigurationsdateien, die zur Build-Zeit verwendet werden. Diese können auch auch zur Laufzeit in der [../docker-compose.yml](../docker-compose.yml) mittels Volumes überschrieben werden. - * Optional: Für den Mailversand aus dem REDCap-Container heraus ist z.B. die Konfigurationsdatei [build/config/msmtprc](build/config/msmtprc) entspr. anzupassen (Mailadressen, Mailhost, etc.). -1. REDCap-(Installations)-Dateien zur Verfügung stellen (Ordner [html](html)) +1. Docker-Image für die Ausführung von Redcap erzeugen (Ordner [build](https://github.com/medizininformatik-initiative/INTERPOLAR/tree/main/REDCap-app/build)) + * [build/Dockerfile](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/REDCap-app/build/Dockerfile) beschreibt eine PHP-8 Umgebung inkl. Extensions, wie sie für REDCap benötigt werden + * Im Verzeichnis [build/config](https://github.com/medizininformatik-initiative/INTERPOLAR/tree/main/REDCap-app/build/config) liegen Konfigurationsdateien, die zur Build-Zeit verwendet werden. Diese können auch auch zur Laufzeit in der [../docker-compose.yml](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/docker-compose.yml) mittels Volumes überschrieben werden. + * Optional: Für den Mailversand aus dem REDCap-Container heraus ist z.B. die Konfigurationsdatei [build/config/msmtprc](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/REDCap-app/build/config/msmtprc) entspr. anzupassen (Mailadressen, Mailhost, etc.). +1. REDCap-(Installations)-Dateien zur Verfügung stellen (Ordner [html](https://github.com/medizininformatik-initiative/INTERPOLAR/tree/main/REDCap-app/html)) * Siehe Anweisungen in [html/Readme.md](html/Readme.md) 1. REDCap Konfiguration (Rechte und Rollen, etc.) \ Die REDCap Konfiguration ist abhängig von den Gegebenheiten am Standort, z.B. Anzahl und Namen der an INTERPOLAR teilnehmenden Stationen sowie der dort beteiligten Personen. REDCap enthält eine Benutzerverwaltung mit Rechten und Rollen. Die Einrichtung / Konfiguration ist in der REDCap Dokumentation beschrieben: - * [How to change and set up authentication in REDCap](https://redcap.vumc.org/community/post.php?id=691) - * [How do I create a customized report in REDCap?](https://confluence.research.cchmc.org/pages/viewpage.action?pageId=90966866) + * How to change and set up authentication in REDCap? + * How do I create a customized report in REDCap? 1. Cronjob für REDCap einrichten: \ Es gibt mehrere Möglichkeiten, den Cronjob für die regelmäßigen Aufgaben, welche vom REDCap durchgeführt werden müssen, einzurichten. Dies kann z.B. ein Script sein, dass per Cron des Host-System aufgerufen wird oder die Hinzunahme eines weiteren "Cron"-Eintrages/Services in der docker-compose.yml. \ Eine einfache Möglichkeit besteht darin, den folgenden Eintrag in die crontab des docker-Nutzers auf dem Host-System bzw. wenn dies root ist in der _/etc/crontab_ hinzuzufügen. Wenn die CDS Tool Chain auf dem Host-System im Verzeichnis _/opt/docker/INTERPOLAR_ ausgecheckt wurde, sieht der Eintrag beispielsweise so aus: diff --git a/REDCap-app/html/Readme.md b/REDCap-app/html/Readme.md index 03e80ad8..1e746519 100644 --- a/REDCap-app/html/Readme.md +++ b/REDCap-app/html/Readme.md @@ -1,4 +1,4 @@ - 1. Bitte laden Sie Redcap (Install, zip) herunter: [https://redcap.vumc.org/community/custom/download.php](https://redcap.vumc.org/community/custom/download.php) + 1. Bitte laden Sie Redcap (Install, zip) herunter: https://redcap.vumc.org/community/custom/download.php 1. Entpacken Sie die Zip-Datei, z.B. _redcap14.6.2.zip_ in den Ordner 'html'. \ ``` cd REDCap-app/html/ ``` \ ``` unzip redcap14.6.2.zip ``` @@ -25,22 +25,22 @@ cd ../.. docker compose up ``` - 1. Rufen Sie im Browser die REDCap Install-Seite auf: [http://127.0.0.1:8082/redcap/install.php](http://127.0.0.1:8082/redcap/install.php) (REDCap-URL) + 1. Rufen Sie im Browser die REDCap Install-Seite auf: http://127.0.0.1:8082/redcap/install.php (REDCap-URL) * Hinweis: _Sie können die REDCap-URL ggf. über einen Reverse-Proxy oder einen SSH-Tunnel auf dem Client-PC verfügbar machen._ * Sie sollten Install-Seite mit mehreren Schritten sehen:![image](https://github.com/medizininformatik-initiative/INTERPOLAR/assets/11329281/1b442942-cac8-4378-acc6-446d61956f8d) * STEP 1) Kann übersprungen werden. Diese SQL-Anweisungen wurde bereits beim Initialisieren ausgeführt * STEP 2) Diese Anpassungen haben Sie schon vorgenommen und es sollte in gründer Schrift folgendes zu lesen sein: "Connection to the MySQL database 'redcap' was successful!" * STEP 3) Nehmen Sie ggf. _optional_ Änderungen vor. Klicken Sie anschließend auf "Generate SQL Install Script" - * STEP 4) Kopieren Sie den Inhalt des SQL-Scripts und fügen Sie ihn in die Datei [REDCap-db/init/10_redcap_install-tables.sql](REDCap-db/init/10_redcap_install-tables.sql) ein. Gehen Sie anschließend zurück zur Console. Ersetzen Sie in der nachfolgenden Befehlszeile "_\_" durch das REDCap Datenbank **_root_** Passwort und starten sie den Befehl. Das REDCap Datenbank root Passwort finden Sie unter REDCap-db/.env_redcap_db_root.password. + * STEP 4) Kopieren Sie den Inhalt des SQL-Scripts und fügen Sie ihn in die Datei [REDCap-db/init/10_redcap_install-tables.sql](https://github.com/medizininformatik-initiative/INTERPOLAR/blob/main/REDCap-db/init/10_redcap_install-tables.sql) ein. Gehen Sie anschließend zurück zur Console. Ersetzen Sie in der nachfolgenden Befehlszeile "_\_" durch das REDCap Datenbank **_root_** Passwort und starten sie den Befehl. Das REDCap Datenbank root Passwort finden Sie unter REDCap-db/.env_redcap_db_root.password. ```console docker compose exec -T redcap_db mariadb -u root -p"" redcap < REDCap-db/init/10_redcap_install-tables.sql ``` - * STEP 5) Klicken Sie auf "REDCap Configuration Check". Es werden einige Rot gefärbte Meldungen erscheinen, die für eine produktive Umgebung noch behoben werden sollten. Dies kann zu einem späteren Zeitpunkt erfolgen. Ist im unteren Bereich "CONGRATULATIONS!" zu lesen, können Sie die REDCap mit Klick auf [http://127.0.0.1:8082/redcap/](http://127.0.0.1:8082/redcap/) starten. + * STEP 5) Klicken Sie auf "REDCap Configuration Check". Es werden einige Rot gefärbte Meldungen erscheinen, die für eine produktive Umgebung noch behoben werden sollten. Dies kann zu einem späteren Zeitpunkt erfolgen. Ist im unteren Bereich "CONGRATULATIONS!" zu lesen, können Sie die REDCap mit Klick auf http://127.0.0.1:8082/redcap/ starten. * Hinweis: Diese Schritte müssen nur wiederholt werden, wenn eine neue REDCap Version zum Einsazt kommen soll. Das Update kann auch über die REDCap Weboberfläche im "Control Center" eingespielt werden. 1. Setzen Sie im "Control Center" unter "File Upload Setting" (Left Menu) das Upload-Verzeichnis "Local Server File Storage" auf diesen Wert: ```/var/www/html/redcapdocs``` 1. Das INTERPOLAR-Projekt in REDCap importieren: - * Die INTERPOLAR REDCap Projekt Datei ist in INTERPOLAR erarbeitet worden und steht im MII SharePoint Ordner [Release v0.2.x](https://tmfev.sharepoint.com/:f:/r/sites/tmf/mi-i/Modul3Projekte/INTERPOLAR/5_Referenzarchitektur/eDataCapture/Release%20v0.2.x?csf=1&web=1&e=7bycOQ) verfügbar. Bitte laden Sie sich die Datei "INTERPOLARDev_*.**REDCap.xml**" herunter. + * Die INTERPOLAR REDCap Projekt Datei ist in INTERPOLAR erarbeitet worden und steht im MII SharePoint Ordner Release vx.y.z verfügbar. Bitte laden Sie sich die Datei "INTERPOLARDev_*.**REDCap.xml**" herunter. * Wechseln Sie im Browser zur REDCap Weboberfläche und klicken Sie auf "New Project" (Menu-Leiste oben). * Geben Sie dem Projekt einen Titel, z.B. INTERPOLAR-1a * Wählen Sie bei "Project's purpose" aus: "Quality Improvement" diff --git a/_config.yml b/_config.yml deleted file mode 100644 index 8c8e4d92..00000000 --- a/_config.yml +++ /dev/null @@ -1,14 +0,0 @@ -# URLs ohne Endungen wie .html oder .md -permalink: pretty -# Setup -# Themes: minima (taugt nicht, da fehlerhaft) -theme: jekyll-theme-primer -title: 'CDS Tool Chain' -#tagline: 'MII KDS FHIR -> DB -> Frontend' -#description: '' -#url: https://foo.de -#baseurl: '' - -#author: -# name: 'INTERPOLAR IT-Team' -# url: https://github.com/SebStaeubert , https://github.com/astruebi, https://github.com/Flow191, https://github.com/reuschem diff --git a/full_toolchain_description.md b/full_toolchain_description.md index 00c8b523..7b04cb3c 100644 --- a/full_toolchain_description.md +++ b/full_toolchain_description.md @@ -1,3 +1,8 @@ +--- +layout: default +title: CDS Tool Chain - Ablauf +--- + **Work in progress, Stand: 20.12.2024** # CDS Tool Chain - Ablauf: @@ -6,7 +11,7 @@ ## 1. Vorbereitung: -Eine Übersicht aller Module ist in der [Projekt README Datei](README.md) zu finden. +Eine Übersicht aller Module ist in der [Projekt README Datei](./) zu finden. ### 1.1 Konfigurationsdateien: @@ -20,7 +25,7 @@ Nach dem Start dieses Moduls werden alle gesetzten Konfigurationsparameter in R ### 2.1 Semaphore freigeben In einem ersten Schritt wird Status der Semaphore in der DB zurückgesetzt, falls zuvor ein fehlerhafter Durchlauf zum Abbruch der Pipeline geführt hat. Generell wird vor jedem Lese- und Schreibmodul geprüft, ob die Datenbank bereit ist Daten zu empfangen oder zu senden. Die Datenbank wird über einen Cron-Jobs gesteuert und über eine eingebaute Semaphore wird der aktuelle Status der Datenbank bekannt gegeben. -Die Datenbank kann für den Lese- und Schreibzugriff in R gesperrt und wieder freigegeben werden. Weitere Informationen zur Datenbank sind in der [DB_description.md](Postgres-cds_hub/DB_description.md) und dem [Dataflow.md](Dataflow.md) nachzulesen. +Die Datenbank kann für den Lese- und Schreibzugriff in R gesperrt und wieder freigegeben werden. Weitere Informationen zur Datenbank sind in der [DB_description](Postgres-cds_hub/DB_description) und dem [Dataflow](Dataflow) nachzulesen. ### 2.2 Laden der relevanten Patienten-IDs (PIDs) @@ -37,7 +42,7 @@ Diese beschriebenen Parameter sind jedoch nur für Test-Zwecke gedacht! ### 2.3 Einlesen der TableDescription -In diesen Schritt wird die [Table_Description.xlsx](R-cds2db/cds2db/inst/extdata/Table_Description.xlsx), welche alle abgefragten FHIR-Ressourcen (COI) sowie alle absoluten XML-Pfade dieser Ressourcen beinhaltet, eingelesen. Weitere Informationen zur Generierung und Funktionalität dieser Datei ist in dem Dokument [Dataflow.md](Dataflow.md#voraussetzungen--vorbereitung) nachzulesen. +In diesen Schritt wird die [Table_Description.xlsx](R-cds2db/cds2db/inst/extdata/Table_Description.xlsx), welche alle abgefragten FHIR-Ressourcen (COI) sowie alle absoluten XML-Pfade dieser Ressourcen beinhaltet, eingelesen. Weitere Informationen zur Generierung und Funktionalität dieser Datei ist in dem Dokument [Dataflow](Dataflow#voraussetzungen--vorbereitung) nachzulesen. ### 2.4 Herunterladen der FHIR Ressourcen