Skip to content

Commit

Permalink
restructure IG
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxMTheilig committed Feb 19, 2024
1 parent 1c42d1d commit e5f57f4
Show file tree
Hide file tree
Showing 15 changed files with 96 additions and 19 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
# Steps represent a sequence of tasks that will be executed as part of the job
steps:
- name: Checkout code
uses: actions/checkout@v2
uses: actions/checkout@v4

# Java and .NET are already installed on ubuntu-latest

Expand All @@ -47,7 +47,7 @@ jobs:
EXPECTED_FAILS: VALIDATION_CONFORMANCE_DOTNET VALIDATION_CONFORMANCE_JAVA VALIDATION_EXAMPLES_JAVA

- name: Add & Commit
uses: EndBug/add-and-commit@v7
uses: EndBug/add-and-commit@v9
with:
committer_name: GitHub Actions Bot
committer_email: [email protected]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
{
"resourceType": "ImplementationGuide",
"url": "https://gematik.de/fhir/isik/v3/Basismodul/ImplementationGuide/ISiK-Basismodul",
"url": "https://gematik.de/fhir/isik/v4/Basismodul/ImplementationGuide/ISiK-Basismodul",
"version": "4.0.0-rc",
"name": "Implementierungsleitfaden ISiK-Basismodul Stufe 3",
"name": "Implementierungsleitfaden ISiK-Basismodul",
"status": "draft",
"fhirVersion": [
"4.0.1"
],
"packageId": "de.gematik.isik-basismodul-stufe3",
"packageId": "de.gematik.isik-basismodul",
"definition": {
"resource": [
{
Expand All @@ -21,15 +21,44 @@
"title": "Einführung",
"generation": "markdown",
"page": [
{
"nameUrl": "ImplementationGuide/markdown/ReleaseNotes.md",
"title": "Release Notes",
"generation": "markdown"
},
{
"nameUrl": "ImplementationGuide/markdown/Motivation.md",
"title": "Motivation",
"generation": "markdown"
"generation": "markdown",
"page": [
{
"nameUrl": "ImplementationGuide/markdown/ReleaseNotes.md",
"title": "ReleaseNotes",
"generation": "markdown"
},
{
"nameUrl": "ImplementationGuide/markdown/DecisionLog.md",
"title": "Decision Log",
"generation": "markdown"
}
]
},
{
"nameUrl": "ImplementationGuide/markdown/Zusammenfassung.md",
"title": "Zusammenfassung",
"generation": "markdown",
"page": [
{
"nameUrl": "ImplementationGuide/markdown/Zusammenfassung/UseCases.md",
"title": "Anwendungsfälle (Use Cases)",
"generation": "markdown"
},
{
"nameUrl": "ImplementationGuide/markdown/Zusammenfassung/Informationsmodell.md",
"title": "Informationsmodell",
"generation": "markdown"
},
{
"nameUrl": "ImplementationGuide/markdown/Zusammenfassung/InteraktionenUndSearchTypes.md",
"title": "Interaktionen Und SearchTypes",
"generation": "markdown"
}
]
},
{
"nameUrl": "ImplementationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen.md",
Expand Down
2 changes: 1 addition & 1 deletion ImplementationGuide/markdown/Datenobjekte/Datenobjekte.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

In den folgenden Unterkapiteln werden die ISiK-Datenobjekte, die in dem vereinfachten Informationsmodell dargestellt sind, und ihre FHIR-Spezifikation beschrieben.

<img src="https://raw.githubusercontent.com/gematik/spec-ISiK-Basismodul/main-isik-stufe-3/Material/images/diagrams/Vereinfachtes_Infomodell.svg" alt="Vereinfachtes Infomodell" width="90%"/>
<img src="https://raw.githubusercontent.com/gematik/spec-ISiK-Basismodul/rc/main-stufe-4/Material/images/diagrams/Vereinfachtes_Infomodell.svg" alt="Vereinfachtes Infomodell" width="90%"/>
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Der stationäre Aufenthalt oder der ambulante Kontakt eines Patienten in einer G

* **Abrechnungsfall (Account):**
Der Fall, im Sinne einer Gruppierung von medizinischen Leistungen, die in einem gemeinsamen Kontext abgerechnet werden, sind in FHIR durch die Ressource Account repräsentiert. Ein Abrechnungsfall kann mehrere Encounter umfassen (z.B. vorstationärer Besuch, stationärer Aufenthalt und nachstationäre Besuche)
{{render:Material/Images/Encounter-Modell-Abrechnung.png}}
{{render:Material/Images/Encounter/Encounter-Modell-Abrechnung.png}}

* **Medizinischer Fall (EpisodeOfCare):**
Der medizinische Fall gruppiert Informationen, die im Kontext einer gemeinsamen (Dauer-)Diagnose stehen und wird in FHIR durch die EpisodeOfCare dargestellt.
{{render:Material/Images/Encounter-Modell-Medizinisch.png}}
{{render:Material/Images/Encounter/Encounter-Modell-Medizinisch.png}}

---

Expand All @@ -43,15 +43,15 @@ Als Kontakt des Patienten mit konkreten Servicestellen, wie z.B. Radiologie oder

Zur Unterscheidung der verschiedenen Kontaktebenen wird in der MI-I eine Codierung in `Encounter.type` verwendet. Die Hierarchie der Encounter wird über die `Encounter.partOf`-Relation hergestellt. Ambulante Besuche werden in dem Modell derzeit noch nicht berücksichtigt.

{{render:Material/Images/Encounter-Modell-MII.png}}
{{render:Material/Images/Encounter/Encounter-Modell-MII.png}}

---

#### Der Begriff "Fall" im Kontext der ISiK-Spezifikation

Für die Ausbaustufe 2 und 3 des ISiK Basismoduls werden alle zuvor genannten Sichtweise und Modelle berücksichtigt:

{{render:Material/Images/Encounter-Modelle.png}}
{{render:Material/Images/Encounter/Encounter-Modelle.png}}

Verpflichtend umzusetzen ist für die bestätigungsrelevanten Systeme der Account, im Sinne der Gruppierung einzelner Besuche, zu einem gemeinsamen (Abrechnungs-)Fall sowie der Encounter der Ebene "Abteilungskontakt" im Sinne des Modells der Medizininformatikinitiative.

Expand All @@ -61,7 +61,7 @@ Wichtig sind dabei jedoch folgende Punkte zu beachten:

* Encounter im ISiK-Kontext sind stets als "Abteilungskontakte, im Sinne der MI-I mit dem entsprechenden `Encounter.type`-Code, zu kennzeichnen.
* jegliche im ISiK-Basis-Modul, als auch in anderen ISiK-Modulen definierte Ressourcen, die über einen Encounter-Kontext verfügen, müssen auf einen ISiK-Encounter (Abteilungskontakt) referenzieren.
{{render:Material/Images/Encounter-Modell-ISiK.png}}
{{render:Material/Images/Encounter/Encounter-Modell-ISiK.png}}

---

Expand All @@ -80,6 +80,6 @@ Um insbesondere Subsysteme von der Pflicht zu entbinden, die Account-Ressource z
|---------|---------------------|
| {{render:Material/Images/IG_Warning}} | Die Abbildung der Fallnummer als Identifier des Accounts ist abweichend von der im Basismodul Stufe 1 festgelegten Abbildung der Fallnummer als Identifier des Encounters. Diese Änderung ist erforderlich, da die Fallnummer nicht geeignet ist, einen Encounter eindeutig zu identifizieren. Der Encounter kann weiterhin einen von der Abrechnungsfallnummer unabhänigen Identifier enthalten (z.B. "Aufnahmenummer", Bewegungsnummer). Dieser identifiziert eineindeutig den jeweiligen Kontakt.|

{{render:Material/Images/Encounter-Modell-Fallnummer.png}}
{{render:Material/Images/Encounter/Encounter-Modell-Fallnummer.png}}

---
17 changes: 17 additions & 0 deletions ImplementationGuide/markdown/Zusammenfassung/Informationsmodell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Übersicht
Im Folgenden wird ein grafischer Überblick über alle in diesem Modul profilierten Ressourcen gegeben.
Da es sich um eine Zusammenfassung handelt, werden nur folgende Profile und Felder dargestellt:
* Profile und Extenstion, die im Modul Terminplanung enstanden sind.
* Profile und Extenstion, die im Modul Terminplanung zwingend benötigt werden. In vereinfachter Form, mit Verweis auf den Ursprung.
* Felder, die unterstüzt werden MÜSSEN (Must Support).
* Die Elemente (Unterfelder) haben, die unterstüzt werden MÜSSEN (Must Support).
* Nur Unter-Elemente (MS) bis zu zweiten oder dritten Tiefe, abhängig von Umfang und Systematik. D.h. Keine bedingten Wiederholungen (repeat) oder Rekursionen (part-of).


## Ressourcen Diagramm

<img src="https://raw.githubusercontent.com/gematik/spec-ISiK-Basismodul/rc/main-stufe-4/Material/images/diagrams/resourcediagram.svg" alt="Ressourcen Diagram" width="90%"/>

## Informationsmodell Diagramm

<img src="https://raw.githubusercontent.com/gematik/spec-ISiK-Basismodul/rc/main-stufe-4/Material/images/diagrams/infomodell.svg" alt="Informationsmodell" width="90%"/>
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Interaktionen und Search Types

## Dokumentenserver
Das bestätigungsrelevante System nimmt die Rolle des Dokumentenservers ein. Ein Dokumentenserver nimmt Dokumente von Clients zur Speicherung/Archivierung/Verwaltung entgegen und erlaubt Clients die Suche nach und den Abruf von Dokumenten.

## (Webbasierter/Mobiler) Client
Clients können Dokumente von einem Dokumentenserver abfragen, um sie z.B. einem Anwender anzuzeigen. Dabei können sie die für die Server verpflichtend festgelegten Suchkriterien beliebig kombinieren.
Clients sind nicht verpflichtet, alle von den Servern geforderten Suchkriterien zu unterstützen.

# Search Includes and Reverse Includes

Damit diese Akteure sinnvoll miteinander kommunizieren, wird im Folgenden ein grafischer Überblick über die in diesem Modul zu inlduierenden Suchparameter und Operationen gegeben.
Da es sich um eine Zusammenfassung handelt, gelten Bedingungen für die gezeigten Inhalte:
* Alle Must-Support Elemente einer Componente müssen von den entsprechenden Systemen suchbar sein. Diese sind hier nicht erneut aufgezählt.
* Ein Doppelpunkt meint den Zugriff auf ein Element des beinhaltenden Profils.
* Das Elemente hinter einem Doppelpunkt besitzt wiederum die Sucharameter (alle Must-Support Elemente!), die hier in die Suchsyntax zu inkludieren sind.

<img src="https://raw.githubusercontent.com/gematik/spec-ISiK-Basismodul/rc/main-stufe-4/Material/images/diagrams/search_includes.svg" class="center" alt="Searchtypes" width="90%"/>
13 changes: 13 additions & 0 deletions ImplementationGuide/markdown/Zusammenfassung/UseCases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Übersicht
Im Folgenden wird ein grafischer Überblick über möglichst in diesem Modul abgedeckten Anwednungsfälle gegeben.
Da es sich um eine Zusammenfassung handelt, werden nur folgende Use Case und dafür hinreichende Funktionen dargestellt:
* Allgemeine und intuitiv verständliche Use Cases.
* * Kombinationen und weitere Details sind möglich.
* * Übergreifende Use Cases und und ihre Sub Use Cases können in einem separaten Diagram auf den entsprechenden Seiten gefunden werden.
* Allgemeine und intuitiv Adverse Use Cases. Diese gilt es zu vermeiden.
* In den Funktionen werde triviale Suchen einer Ressoruce anhand ihrer eigenen Properties nicht dargestelt, z.B. Suche einer Ressoruce anhand der ID, Name, Code usw.


## Use Case Diagramm

<img src="https://raw.githubusercontent.com/gematik/spec-ISiK-Basismodul/rc/main-stufe-4/Material/images/diagrams/usecases.svg" alt="Use Case Diagrams" width="90%"/>
Binary file removed Material/images/Composition-Bundle.png
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 1 addition & 1 deletion Resources/sushi-config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
canonical: https://gematik.de/fhir/isik/v3/Basismodul
canonical: https://gematik.de/fhir/isik/Basismodul
fhirVersion: 4.0.1
FSHOnly: true
applyExtensionMetadataToRoot: false
Expand Down

0 comments on commit e5f57f4

Please sign in to comment.