Merge pull request #171 from gematik/feature/devopsautomation

devops and workflow improvement

.devcontainer/Dockerfile

@@ -0,0 +1,59 @@
+FROM mcr.microsoft.com/devcontainers/base:alpine-3.18
+
+# Setzen der Umgebungsvariablen
+ENV FIRELY_TERMINAL_VERSION=3.1.0
+ENV JAVA_VALIDATOR_VERSION=6.0.11
+ENV SUSHI_VERSION=3.5.0
+
+# Installieren der notwendige Tools
+# Add Microsoft's .NET SDK repository and install .NET SDK
+RUN wget https://dot.net/v1/dotnet-install.sh \
+    && chmod +x dotnet-install.sh \
+    && ./dotnet-install.sh --channel 6.0 --install-dir /usr/share/dotnet \
+    && ln -s /usr/share/dotnet/dotnet /usr/local/bin \
+    && rm dotnet-install.sh
+
+# Install ICU libraries
+RUN apk add --no-cache icu-libs
+
+# Install Node.js and npm
+RUN apk add --no-cache nodejs npm
+
+# Install Java (OpenJDK)
+RUN apk add --no-cache openjdk11
+
+# Install Firely Terminal as vscode user
+# Switch to the vscode user
+USER vscode
+
+# Install Firely Terminal
+RUN dotnet tool install --global Firely.Terminal --version $FIRELY_TERMINAL_VERSION
+
+# Add .NET tools to PATH for vscode user
+ENV PATH="/home/vscode/.dotnet/tools:${PATH}"
+
+# Switch back to root user to perform remaining installations
+USER root
+
+RUN npm install -g fsh-sushi@$SUSHI_VERSION
+
+# Installieren der zusätzliche Abhängigkeiten
+RUN apk update && apk add --no-cache jq findutils curl ca-certificates
+
+# Setup for FHIR Validator
+RUN mkdir -p /home/vscode/.fhir/validators/
+RUN wget -q https://github.com/hapifhir/org.hl7.fhir.core/releases/download/$JAVA_VALIDATOR_VERSION/validator_cli.jar -O /home/vscode/.fhir/validators/validator_cli.jar
+
+# Set ownership
+RUN mkdir -p /home/vscode/.fhir/packages && \
+    chown -R vscode:vscode /home/vscode/.fhir/packages
+
+RUN mkdir -p /home/vscode/.fhir/settings/
+COPY codfsh-config.yaml /home/vscode/.fhir/settings/codfsh-config.yaml
+
+# Setzen des Arbeitsverzeichnis
+WORKDIR /workspace
+
+COPY . /workspace
+
+CMD [ "/bin/bash" ]

.devcontainer/codfsh-config.yaml

@@ -0,0 +1,9 @@
+sushi:
+  min_version: "3.5.0"
+hapi:
+  min_version: "3.0.0"
+  parameters: 
+    jurisdiction: DE
+    locale: de-DE
+    tx: "n/a"
+    debug: true

.devcontainer/devcontainer.json

@@ -0,0 +1,34 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/alpine
+{
+	"name": "FHIR Development Container",
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"gematikde.codfsh",
+				"MITRE-Health.vscode-language-fsh",
+				"ms-azuretools.vscode-docker"
+			],
+			"settings": {
+				"codfsh.HapiValidator.Executable": "/home/vscode/.fhir/validators/validator_cli.jar",
+				"codfsh.HapiValidator.Settings.SettingsFile": "/home/vscode/.fhir/settings/codfsh-config.yaml"
+			}
+		}
+	}
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": "uname -a",
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.github/workflows/RenderAllDiagrams.yml

@@ -0,0 +1,102 @@
+name: Render All Diagrams
+
+on:
+  push:
+    paths:
+    - '**/Material/images/src/**/*.puml'
+    - '**/Material/images/src/**/*.drawio'
+    branches-ignore:
+    - 'main**'
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Installs Java distribution for running the plantUML jar
+      - name: Install Java
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'temurin'
+          java-version: '17'
+          check-latest: true
+
+      # Install graphviz for plantuml     
+      - name: Setup Graphviz
+        uses: ts-graphviz/setup-graphviz@v1
+
+      # Download plantUML jar 
+      - name: Download plantuml file
+        run: |
+          wget -O plantuml.jar "https://github.com/plantuml/plantuml/releases/latest/download/plantuml.jar" 
+                                
+       # Clean Folder
+      - name: Ensure and clean folder
+        run: |
+          img_dir=Material/images/diagrams
+          mkdir -p $img_dir
+          rm -rf Material/images/diagrams/*.svg
+
+      # Generate the SVGs from PUML
+      - name: Render PUML to SVG and Move files
+        run: |
+          FileNamePaths=$(find . -path "*/images/src/*/*.puml" -exec dirname {} \; | sort -u)
+          for dir in $FileNamePaths
+          do
+            # Render SVGs from PUMLs
+            find $dir -name "*.puml" -exec java -jar plantuml.jar -tsvg {} \;
+          done
+      
+      # Remove plantUML jar 
+      - name: remove plantuml file
+        run: |
+          rm -f plantuml.jar
+
+      # Generate the SVGs from DrawIO
+      - name: Render DrawIO to SVG with predefined action
+        uses: rlespinasse/drawio-export-action@v2
+        with:
+          path: ./Material/images/src/drawio/ 
+          remove-page-suffix: true
+          output: .
+          format: svg
+          action-mode: all
+
+      # copies the created SVG files to the images/diagrams folder and deletes the drawio files
+      - name: Move SVGs to target image folder
+        run: |
+          img_dir=Material/images/diagrams
+          # Find all unique directories containing *.SVGs files under any /imgsrc/ folder
+          FileNamePaths=$(find . -path "*/images/src/*/*.svg" -exec dirname {} \; | sort -u)
+          for dir in $FileNamePaths
+          do
+            # Move SVGs to out directory
+            find $dir -name "*.svg" -exec mv {} $img_dir \;
+          done
+      
+      ## add and commit the new generated files
+      #- name: Create Pull Request
+      #  uses: peter-evans/create-pull-request@v5
+      #  with:
+      #    branch: auto/images-generation
+      #    commit-message: Generated Images from source Code by GitHub Action
+      #    title: Generated Images from GitHub Action
+      #    assignees: ${{ github.actor }}
+      #    reviewers: ${{ github.actor }}
+      #    delete-branch: true
+      #    labels: automated pr
+
+      - name: Commit rendered files
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_user_name: GitHub Actions Bot
+          commit_user_email: [email protected]
+          commit_message: auto-generated diagrams by GitHub Action after source code change

.github/workflows/main.yml

@@ -6,7 +6,13 @@ name: CI (FHIR Validation)
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
+    paths:
+    - 'Resources/**'
+    branches-ignore:
+    - 'main**'
   pull_request:
+    branches:
+    - 'main**'
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -46,4 +52,7 @@ jobs:
       - name: Add & Commit
         uses: EndBug/add-and-commit@v7
         with:
+          committer_name: GitHub Actions Bot
+          committer_email: [email protected]
           add: 'Resources/fsh-generated/resources/'
+          message: auto-generated FHIR files by GitHub Actions (CI FSH to FHIR Validation)

.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

ImplementationGuide/markdown/AkteureUndInteraktionen-Akteure.md

@@ -20,4 +20,4 @@ Der Client nimmt im IHE-MHD-Kontext die Rollen [Document Source](https://profile
 * Find Document References [ITI-67] (optional)
 * Retrieve Document [ITI-68] (optional)
 
-{{render:isikprimrscope}} 
+{{render:Material-Images-isikprimaerscope}} 

ImplementationGuide/markdown/AkteureUndInteraktionen-ErzeugenVonMetadaten.md

@@ -2,7 +2,7 @@
 
 | Hinweis | Breaking Change!|
 |---------|---------------------|
-| {{render:ImplementationGuide-Images-ig-bilder-Warning}} | Die in dieser Version erfolgte Umstellung der Definition von $generate-metadata von der in ISiK Stufe 2 spezifizierten OperationDefinition auf die in [IHE MHD ITI-106](https://profiles.ihe.net/ITI/MHD/ITI-106.html) spezifizierte Fassung ist nicht kompatibel zu den Festlegungen dieses Moduls in Stufe 2! Die Änderung dient dem Zweck der Harmonisierung mit der IHE-MHD-Interaktion ITI-106 (Generate Metadata), die zum Zeitpunkt des Releases von Stufe 2 noch nicht zur Verfügung stand.  |
+| {{render:Material-Images-ig-bilder-Warning}} | Die in dieser Version erfolgte Umstellung der Definition von $generate-metadata von der in ISiK Stufe 2 spezifizierten OperationDefinition auf die in [IHE MHD ITI-106](https://profiles.ihe.net/ITI/MHD/ITI-106.html) spezifizierte Fassung ist nicht kompatibel zu den Festlegungen dieses Moduls in Stufe 2! Die Änderung dient dem Zweck der Harmonisierung mit der IHE-MHD-Interaktion ITI-106 (Generate Metadata), die zum Zeitpunkt des Releases von Stufe 2 noch nicht zur Verfügung stand.  |
 
 ### Hinweise und Anmerkungen zur Implementierung von IHE MHD ITI-106 (Generate Metadata)
 Für die Implementierung der Interaktion "Erzeugen von Dokumentenmetadaten" gelten die in IHE MHD festgelegten Vereinbarungen zu ITI-106 (Generate Metadata) gemäß der unten aufgelisteten Kapitel. Abweichungen bzw. zusätzliche Festlegungen im Kontext von ISiK sind im Folgenden zu den einzelnen Kapiteln vermerkt.

ImplementationGuide/markdown/AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung.md

@@ -10,7 +10,7 @@ Zur Herstellung des Kontextes sind folgende Verfahren möglich:
 
 | Hinweis | Gefahr fehlerhafter Zuordnung!|
 |---------|---------------------|
-| {{render:ImplementationGuide-Images-ig-bilder-Warning}} | Die manuelle Auswahl von Patienten- und Fallkontext durch einen Benutzer ist fehleranfällig. Clients müssen geeignete Vorkehrungen und Plausibilitätsprüfungen implementieren um Falschzuordnungen zu verhindern.|
+| {{render:Material-Images-ig-bilder-Warning}} | Die manuelle Auswahl von Patienten- und Fallkontext durch einen Benutzer ist fehleranfällig. Clients müssen geeignete Vorkehrungen und Plausibilitätsprüfungen implementieren um Falschzuordnungen zu verhindern.|
 
 ### Dokumentenübermittlung (IHE MHD ITI-105 (Simplified Publish))
 
@@ -20,7 +20,7 @@ Die Übermittlung des Dokumentes vom Client an den Server erfolgt mittels einer
 
 | Hinweis | Breaking Change!|
 |---------|---------------------|
-| {{render:ImplementationGuide-Images-ig-bilder-Warning}} | Die in dieser Version erfolgte Umstellung der Interaktion von der $submit-document-Operation auf eine REST-basierte CREATE-Interaktion ist nicht kompatibel zu den Festlegungen dieses Moduls in Stufe 2! Die Änderung dient dem Zweck der Harmonisierung mit der IHE-MHD-Interaktion ITI-105 (Simplified Publish), die zum Zeitpunkt des Releases von Stufe 2 noch nicht zur Verfügung stand.  |
+| {{render:Material-Images-ig-bilder-Warning}} | Die in dieser Version erfolgte Umstellung der Interaktion von der $submit-document-Operation auf eine REST-basierte CREATE-Interaktion ist nicht kompatibel zu den Festlegungen dieses Moduls in Stufe 2! Die Änderung dient dem Zweck der Harmonisierung mit der IHE-MHD-Interaktion ITI-105 (Simplified Publish), die zum Zeitpunkt des Releases von Stufe 2 noch nicht zur Verfügung stand.  |
 
 #### Maßgebliche Änderungen gegenüber Stufe 2 für den Client
 * Der Client muss das eigentliche Dokument (PDF, JPEG o.ä.) base64-codiert in `DocumentReference.content.attachment.data` einbetten und den Mime-Type des Dokumentes in `DocumentReference.content.attachment.contentType` adäquat setzen

ImplementationGuide/markdown/AkteureUndInteraktionen-Update.md

@@ -22,4 +22,4 @@ Daher spezifiziert ISiK eine geeignete Operation, die das gezielte Ändern des D
 
 | Hinweis | Work in Progress!|
 |---------|---------------------|
-| {{render:ImplementationGuide-Images-ig-bilder-Warning}} | Die hier vorliegende Definition der Operation dient als Vorschlag, der auf Basis von Implementierungserfahrungen weiterentwickelt werden soll. Kritik, Feedback und Verbesserungsvorschläge, insbesondere UseCases für das Update weiterer Metadaten-Elemente bitte im [ISiK-Community-Chat](https://chat.fhir.org/#narrow/stream/287581-german.2Fisik) diskutieren! |
+| {{render:Material-Images-ig-bilder-Warning}} | Die hier vorliegende Definition der Operation dient als Vorschlag, der auf Basis von Implementierungserfahrungen weiterentwickelt werden soll. Kritik, Feedback und Verbesserungsvorschläge, insbesondere UseCases für das Update weiterer Metadaten-Elemente bitte im [ISiK-Community-Chat](https://chat.fhir.org/#narrow/stream/287581-german.2Fisik) diskutieren! |

ImplementationGuide/markdown/Einfuehrung.md

@@ -1,4 +1,4 @@
-<img src="https://raw.githubusercontent.com/gematik/spec-ISiK-Basismodul/master-isik-stufe-2/Material/Gematik_Logo_Flag.png" alt="gematik logo" width="400"/>
+<img src="https://raw.githubusercontent.com/gematik/spec-ISiK-Dokumentenaustausch/main-stufe-3/Material/images/Gematik_Logo_Flag.svg" alt="gematik logo" width="400"/>
 
 ----
 Version: 3.0.1

ImplementationGuide/markdown/Motivation.md

@@ -10,4 +10,4 @@ Bei der Festlegung dieser Spezifikation findet das IHE-MHD-Profil eine besondere
 
 Der Fokus dieser Spezifikation liegt zunächst auf den Festlegungen zum Datenaustausch *innerhalb* einer Einrichtung, soll künftig jedoch auch Best Practice-Empfehlungen zur Einstellung von Dokumenten in die EPA eines Patienten, der Weiterleitung an andere Leistungserbringer via KIM oder dem einrichtungsübergreifenden Dokumentenaustausch via MHD/XDS enthalten.
 
-{{render:isikkontextunderwscope}}
+{{render:Material-Images-isikkontextunderwscope}}