Dev/v2024 changes during commenting

.github/workflows/main.yml

@@ -0,0 +1,45 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI (FHIR Validation)
+
+# Controls when the action will run. 
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master, main ]
+  pull_request:
+    branches: [ master, main ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+
+  # Validate all resources using Firely Terminal 
+  CI_FHIR_VALIDATION:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # Java and .NET are already installed on ubuntu-latest
+
+      - name: Firely.Terminal (GitHub Actions)
+        uses: FirelyTeam/[email protected]
+        with:
+          PATH_TO_CONFORMANCE_RESOURCES: fsh-generated/resources
+          PATH_TO_EXAMPLES: fsh-generated/resources
+          PATH_TO_QUALITY_CONTROL_RULES: qc/custom
+          DOTNET_VALIDATION_ENABLED: true
+          JAVA_VALIDATION_ENABLED: true
+          EXPECTED_FAILS: VALIDATION_CONFORMANCE_DOTNET VALIDATION_CONFORMANCE_JAVA VALIDATION_EXAMPLES_JAVA
+          OUTPUT_FORMAT: RAW
+          JAVA_VALIDATION_OPTIONS: -allow-example-urls true -tx n/a
+          SIMPLIFIER_USERNAME: ${{ secrets.SIMPLIFIER_USERNAME }}
+          SIMPLIFIER_PASSWORD: ${{ secrets.SIMPLIFIER_PASSWORD }}
+          JAVA_VALIDATOR_VERSION: 6.3.2

.gitignore

@@ -204,6 +204,6 @@ fabric.properties
 /input-cache/*
 /node_modules/*
 package-lock.json
-package.json
+# package.json
 .idea/*
 .history

README.md

@@ -1,45 +1,38 @@
-# Erweiterungsmodul Bildgebung 
-_Erweiterungsmodul Diagnostik: Befunde bildgebender Verfahren_
+## Medizininformatik-Initiative - Kerndatensatz - Modul Diagnostik: Befunde bildgebender Verfahren 
 
-Subtask AG: 
-- [AG Befundtext](#teilmodul:-befundtext)
-- [AG Imaging Metadaten](#teilmodul:-imaging-metadaten)
+### Übersicht
 
-Dieses Begleitdokument dient als Vorschlag zum Vorgehen bezüglich der Implementierung und Datensatzbeschreibung.
+[![FHIR Project on GitHub.com](https://img.shields.io/badge/FHIR_project_on_GitHub.com-kerndatensatzmodul--bildgebung-green)](https://github.com/medizininformatik-initiative/kerndatensatz-bildgebung)
 
-Hiermit soll das Dokument für die **1. Ballotierungsphase** (_23.08.2024 – 04.10.2024_) freigegeben werden.
+[![CI (FHIR Validation)](https://github.com/medizininformatik-initiative/kerndatensatz-bildgebung/actions/workflows/main.yml/badge.svg)](https://github.com/medizininformatik-initiative/kerndatensatz-bildgebung/actions/workflows/main.yml)
 
----
+Das vorliegende Projekt beschreibt die FHIR-Spezifikation des Erweiterungsmoduls 'Diagnostik: Befunde bildgebender Verfahren', welches einen zentralen Teil des Kerndatensatzes der Medizininformatik-Initiative darstellt. Die hier veröffentlichten FHIR-Profile und ImplemenationGuides dienen als zentrale und verbindliche Spezifikation für die syntaktische und semantische Kodierung der Modulinhalte
 
-## Updates 
-2024.01.16 - Restrukturierung und Verschönerung des UML Diagramms von Lucas Scherer (UKER).
-
-2024.02.06 - UML-Anpassung an die Guidelines des EU Health Data Space (AG Befundtext).
+### Status
 
-2024.04.19 - Finale Überarbeitung UML für NSG-Beschlussvorlage
+Aktuelle Kommentierungsversion: [2025.0.0-ballot](https://simplifier.net/packages/de.medizininformatikinitiative.kerndatensatz.bildgebung/2025.0.0-ballot)
 
-2024.08.23 - Finale Überarbeitung der FHIR-Implementierung und des Implementation Guides für die 1. Ballotierungsphase
+Alle veröffentlichen FHIR-Artefakte innerhalb des Projektes verfügen über einen Status durch welchen der jeweilige Reifegrad abgeleitet werden kann. Profile mit dem Status 'Draft' wurden noch nicht ballotiert und können noch diversen und substantiellen Änderungen unterliegen. Verpflichtende und ballotierte Ergebnisse sind unter dem Tab 'Packages' zu finden.
 
+### Mitwirkungs- und Kommentierungsmöglichkeiten
 
-## Kurzbeschreibung
-Das Erweiterungsmodul Bildgebung umfasst sowohl ein Teilmodul zum _radiologischen_ **Befund** (z.B. Indikation, Beurteilung, Auffälligkeiten, Aufnahmequalität etc.) als auch ein Teilmodul zu den **Imaging-Metadaten**, welche im DICOM-Header enthalten sind (z.B. technische Parameter, Studiendetails, Modalitäten, Körperregionen und -seiten etc.).
+* Kommentareinreichung via [GitHub](https://github.com/medizininformatik-initiative/kerndatensatz-bildgebung/issues)
+* Diskussionsforum im int. [FHIR-Chat](https://chat.fhir.org/#narrow/stream/179307-german.2Fmi-initiative)
+* Teilnahme am [Interoperabilitätsforum](https://wiki.hl7.de/index.php?title=Interoperabilit%C3%A4tsforum)
 
-Eine detaillierte Version der Modulbeschreibung und Aufbau finden Sie im Sharepoint der MII unter: 
-- [Taskforce Kerndatensatz > 04_Erweiterungsmodule > Modul_Befunde_bildgebender_Verfahren > 02_Dokumente > Feedback_Round_1 ([Link](https://tmfev.sharepoint.com/:w:/r/sites/tmf/mi-i/_layouts/15/Doc.aspx?sourcedoc=%7B9AABAF04-58FC-44A7-A22C-0B2F47D79AFC%7D&file=2023-12-20_KDS_Modul_Befunde_bildgebender_Verfahren_Feedback.docx&action=default&mobileredirect=true&wdsle=0](https://tmfev.sharepoint.com/sites/tmf/mi-i/Taskforce%20Kerndatensatz/Forms/AllItems.aspxid=%2Fsites%2Ftmf%2Fmi%2Di%2FTaskforce%20Kerndatensatz%2F04%5FErweiterungsmodule%2FModul%5FBefunde%5Fbildgebender%5FVerfahren%2F02%5FDokumente%2FFeedback%5FRound%5F1)))
+### Zusammenfassung
 
----
+Das Erweiterungsmodul Bildgebung umfasst sowohl ein Teilmodul zum _radiologischen_ **Befund** (z.B. Indikation, Beurteilung, Auffälligkeiten, Aufnahmequalität etc.) als auch ein Teilmodul zu den **Imaging-Metadaten**, welche im DICOM-Header enthalten sind (z.B. technische Parameter, Studiendetails, Modalitäten, Körperregionen und -seiten etc.).
 
-## Teilmodul Befundtext
+#### Teilmodul Befundtext
 Das Teilmodul zum Befund berücksichtigt zwei Sichtweisen, deren gemeinsames Element die Entität Befundbericht ist: 
 1.	bereits hochstrukturierte Reports und deren Ergebnisse können über die generische Beobachtung abgebildet werden, 
 2.	un- bzw. semistrukturierte Befunde (i.e. historische Freitext-Befunde) können über die Entitäten semistrukturierter Befundbericht und Befundabschnitt abgebildet werden. Hier ist es zusätzlich möglich, einzelne strukturierte Beobachtungen auch als generische _Observations_ abzubilden.
 
 Dieses Konzept ermöglicht einerseits der Abbildung und Einschließung der bereits vorliegenden retrospektiven historischen Befunde (i.S.v. „backward compatibility“) der Standorte, andererseits bietet dies die Möglichkeit für die Berücksichtigung der neuen hochstrukturierten Befundtemplates von 
 Tools aus der Industrie (i.S.v. „foward compatibility“).
 
----
-
-## Teilmodul Imaging Metadaten 
+#### Teilmodul Imaging Metadaten 
 Die hier vorliegende Spezifikation des Informationsmodells bezieht sich auf die Metadaten. Dafür wurde sich an der FHIR Ressource „ImagingStudy“ aus der [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/imagingstudy.html) orientiert und überlegt, welche Elemente für die MII relevant sind und welche zusätzlichen Attribute der DICOM-Header abgebildet werden sollen.  
 
 Zur Modellierung wurde das Teilmodul „Metadaten“ analog zu der Hierarchie im DICOM-Standard und in der Imaging Study in drei Teilmodule strukturiert:
@@ -48,3 +41,33 @@ Zur Modellierung wurde das Teilmodul „Metadaten“ analog zu der Hierarchie im
 - Instanzebene 
 
 Zusätzlich gibt es modalitätsspezifische Metadaten, die sich je nach vorliegender Modalität unterscheiden. Im Moment werden die Modalitäten MR, CT, DX, CR, MG, NM und PET betrachtet und es ist geplant, in einem stufenweisen Verfahren, in Zukunft auch weitere modalitätsspezifische Attribute anderer Modalitäten zu spezifizieren.
+
+#### Updates 
+2024.01.16 - Restrukturierung und Verschönerung des UML Diagramms von Lucas Scherer (UKER).
+
+2024.02.06 - UML-Anpassung an die Guidelines des EU Health Data Space (AG Befundtext).
+
+2024.04.19 - Finale Überarbeitung UML für NSG-Beschlussvorlage
+
+2024.08.23 - Finale Überarbeitung der FHIR-Implementierung und des Implementation Guides für die 1. Ballotierungsphase
+
+### Wichtige Dokumente und Links
+
+* [Beschreibung des MII-Kerndatensatzes in der Version 1.0 vom 10.3.2017 (PDF)](https://www.medizininformatik-initiative.de/sites/default/files/inline-files/MII_04_Kerndatensatz_1-0.pdf)
+* [Datenmodellbeschreibung des MII-Kerndatensatzes in ART-DECOR](https://art-decor.org/ad/#/mide-/datasets/dataset/2.16.840.1.113883.3.1937.777.24.1.1/2018-06-05T12:44:12/concept/2.16.840.1.113883.3.1937.777.24.2.2795/2023-11-14T08:32:26)
+* [GitHub Repository](https://github.com/medizininformatik-initiative/kerndatensatz-bildgebung)
+
+### Autoren und Ansprechpartner
+
+#### Leitung des Moduls:
+
+* Máté Maros, Universitätsmedizin Mannheim
+
+#### Technische Umsetzung:
+
+* Steven Böhner (Technische Umsetzung FHIR Profile, Implementation Guides)
+* Viola Braunmüller (Technische Umsetzung FHIR Profile, Implementation Guides)
+* Noemi Deppenwiese (Technische Umsetzung FHIR Profile, Implementation Guides)
+* Alexa Iancu (Technische Umsetzung FHIR Profile, Implementation Guide, Logical Models)
+* Johannes Kast (Technische Umsetzung FHIR Profile)
+* Lucas Scherer (Technische Umsetzung FHIR Profile, Implementation Guides)