improved MS and short descriptions

gematik · Dec 4, 2024 · 380ed63 · 380ed63
1 parent 505e2d3
commit 380ed63
Show file tree

Hide file tree

Showing 15 changed files with 133 additions and 57 deletions.
diff --git a/Resources/fsh-generated/fsh-index.json b/Resources/fsh-generated/fsh-index.json
@@ -44,8 +44,8 @@
     "fshName": "ISiKBlutdruckSystemischArteriellExample",
     "fshType": "Instance",
     "fshFile": "ISiK-Blutdruck.fsh",
-    "startLine": 78,
-    "endLine": 106
+    "startLine": 71,
+    "endLine": 99
   },
   {
     "outputFile": "Observation-ISiKEKGExample.json",
@@ -485,7 +485,7 @@
     "fshType": "Profile",
     "fshFile": "ISiK-Blutdruck.fsh",
     "startLine": 1,
-    "endLine": 75
+    "endLine": 69
   },
   {
     "outputFile": "StructureDefinition-ISiKEKG.json",

diff --git a/Resources/fsh-generated/fsh-index.txt b/Resources/fsh-generated/fsh-index.txt
@@ -4,7 +4,7 @@ CapabilityStatement-ISiKCapabilityStatementVitalparameterServerPDMS.json
 Device-ExampleDevice.json                                                                 ExampleDevice                                                                 Instance  instances.fsh                                                                                  14 - 17
 Observation-Herzzeitvolumen.json                                                          Herzzeitvolumen                                                               Instance  mii-backport/SD_MII_ICU_Herzzeitvolumen.fsh                                                    17 - 29
 Observation-ISiKAtemfrequenzExample.json                                                  ISiKAtemfrequenzExample                                                       Instance  ISiK-Atemfrequenz.fsh                                                                          20 - 33
-Observation-ISiKBlutdruckSystemischArteriellExample.json                                  ISiKBlutdruckSystemischArteriellExample                                       Instance  ISiK-Blutdruck.fsh                                                                             78 - 106
+Observation-ISiKBlutdruckSystemischArteriellExample.json                                  ISiKBlutdruckSystemischArteriellExample                                       Instance  ISiK-Blutdruck.fsh                                                                             71 - 99
 Observation-ISiKEKGExample.json                                                           ISiKEKGExample                                                                Instance  ISiK-Ekg.fsh                                                                                   32 - 57
 Observation-ISiKGCSExample.json                                                           ISiKGCSExample                                                                Instance  ISiK-GCS.fsh                                                                                   51 - 67
 Observation-ISiKHerzfrequenzExample.json                                                  ISiKHerzfrequenzExample                                                       Instance  ISiK-Herzfrequenz.fsh                                                                          27 - 40
@@ -59,7 +59,7 @@ Observation-Systemischer-vaskulaerer-Widerstandsindex.json
 Observation-Zentralvenoeser-Blutdruck.json                                                Zentralvenoeser-Blutdruck                                                     Instance  mii-backport/SD_MII_ICU_Zentralvenoeser_Blutdruck.fsh                                          17 - 30
 Patient-PatientinMusterfrau.json                                                          PatientinMusterfrau                                                           Instance  instances.fsh                                                                                  1 - 12
 StructureDefinition-ISiKAtemfrequenz.json                                                 ISiKAtemfrequenz                                                              Profile   ISiK-Atemfrequenz.fsh                                                                          1 - 18
-StructureDefinition-ISiKBlutdruckSystemischArteriell.json                                 ISiKBlutdruckSystemischArteriell                                              Profile   ISiK-Blutdruck.fsh                                                                             1 - 75
+StructureDefinition-ISiKBlutdruckSystemischArteriell.json                                 ISiKBlutdruckSystemischArteriell                                              Profile   ISiK-Blutdruck.fsh                                                                             1 - 69
 StructureDefinition-ISiKEKG.json                                                          ISiKEKG                                                                       Profile   ISiK-Ekg.fsh                                                                                   1 - 30
 StructureDefinition-ISiKGCS.json                                                          ISiKGCS                                                                       Profile   ISiK-GCS.fsh                                                                                   1 - 49
 StructureDefinition-ISiKHerzfrequenz.json                                                 ISiKHerzfrequenz                                                              Profile   ISiK-Herzfrequenz.fsh                                                                          1 - 18

diff --git a/Resources/fsh-generated/resources/StructureDefinition-ISiKAtemfrequenz.json b/Resources/fsh-generated/resources/StructureDefinition-ISiKAtemfrequenz.json
@@ -21,7 +21,7 @@
         "id": "Observation.status",
         "path": "Observation.status",
         "short": "Untersuchungsstatus",
-        "comment": "Motivation MS: Observation.status ist bereits durch die Kardinalität der Basisklasse Observation erzwungen. Dieses Feld dient der Präzisierung des Status der Untersuchung",
+        "comment": "**WICHTIGER Hinweis für Implementierer:**  \n* Alle server-seitigen Implementierungen MÜSSEN in der Lage sein, die systemintern möglichen Statuswerte korrekt in FHIR abzubilden, mindestens jedoch `final`.\n* Alle client-seitigen Implementierungen MÜSSEN in der Lage sein, sämtliche Status-Codes zu interpretieren und dem Anwender in angemessener Form darstellen zu können, beispielsweise durch Ausblenden/Durchstreichen von Ressourcen mit dem status `entered-in-error` und Ausgrauen von Ressourcen, die einen Plan- oder Entwurfs-Status haben.",
         "mustSupport": true
       },
       {
@@ -88,16 +88,24 @@
         "id": "Observation.subject",
         "path": "Observation.subject",
         "short": "Patient",
-        "comment": "Motivation MS: Ein Vitalparameter hat immer einen Patientenbezug",
+        "comment": "Motivation MS: Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.",
         "mustSupport": true
       },
       {
         "id": "Observation.encounter",
         "path": "Observation.encounter",
-        "short": "Behandlungskontext",
+        "short": "Aufenthaltsbezug",
         "comment": "Motivation MS: Der Behandlungskontext ist für die Interpretation der Untersuchungsergebnisse relevant",
         "mustSupport": true
       },
+      {
+        "id": "Observation.encounter.reference",
+        "path": "Observation.encounter.reference",
+        "short": "Encounter-Link",
+        "comment": "**Begründung Pflichtfeld:** Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.  \n**WICHTIGER Hinweis für Implementierer:** Die Zuordnung MUSS auf auf einen Encounter der Ebene \"Abteilungskontakt\" (siehe hierzu Basismodul > UseCases > Abbildung des Konstruktes \"Fall\") erfolgen.  \nBei der Auswahl des Encounters ist zu beachten, dass unter einer (Abrechnungs-)\"Fallnummer\" (hier: `Encounter.account`) unter Umständen mehrere Encounter gruppiert sein können (z.B. stationärer Besuch mit mehreren vor- und nachstationären Aufenthalten.)",
+        "min": 1,
+        "mustSupport": true
+      },
       {
         "id": "Observation.effective[x]",
         "path": "Observation.effective[x]",

diff --git a/Resources/fsh-generated/resources/StructureDefinition-ISiKBlutdruckSystemischArteriell.json b/Resources/fsh-generated/resources/StructureDefinition-ISiKBlutdruckSystemischArteriell.json
@@ -21,7 +21,7 @@
         "id": "Observation.status",
         "path": "Observation.status",
         "short": "Untersuchungsstatus",
-        "comment": "Motivation MS: Observation.status ist bereits durch die Kardinalität der Basisklasse Observation erzwungen. Dieses Feld dient der Präzisierung des Status der Untersuchung",
+        "comment": "**WICHTIGER Hinweis für Implementierer:**  \n* Alle server-seitigen Implementierungen MÜSSEN in der Lage sein, die systemintern möglichen Statuswerte korrekt in FHIR abzubilden, mindestens jedoch `final`.\n* Alle client-seitigen Implementierungen MÜSSEN in der Lage sein, sämtliche Status-Codes zu interpretieren und dem Anwender in angemessener Form darstellen zu können, beispielsweise durch Ausblenden/Durchstreichen von Ressourcen mit dem status `entered-in-error` und Ausgrauen von Ressourcen, die einen Plan- oder Entwurfs-Status haben.",
         "mustSupport": true
       },
       {
@@ -84,16 +84,24 @@
         "id": "Observation.subject",
         "path": "Observation.subject",
         "short": "Patient",
-        "comment": "Motivation MS: Ein Vitalparameter hat immer einen Patientenbezug",
+        "comment": "Motivation MS: Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.",
         "mustSupport": true
       },
       {
         "id": "Observation.encounter",
         "path": "Observation.encounter",
-        "short": "Behandlungskontext",
+        "short": "Aufenthaltsbezug",
         "comment": "Motivation MS: Der Behandlungskontext ist für die Interpretation der Untersuchungsergebnisse relevant",
         "mustSupport": true
       },
+      {
+        "id": "Observation.encounter.reference",
+        "path": "Observation.encounter.reference",
+        "short": "Encounter-Link",
+        "comment": "**Begründung Pflichtfeld:** Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.  \n**WICHTIGER Hinweis für Implementierer:** Die Zuordnung MUSS auf auf einen Encounter der Ebene \"Abteilungskontakt\" (siehe hierzu Basismodul > UseCases > Abbildung des Konstruktes \"Fall\") erfolgen.  \nBei der Auswahl des Encounters ist zu beachten, dass unter einer (Abrechnungs-)\"Fallnummer\" (hier: `Encounter.account`) unter Umständen mehrere Encounter gruppiert sein können (z.B. stationärer Besuch mit mehreren vor- und nachstationären Aufenthalten.)",
+        "min": 1,
+        "mustSupport": true
+      },
       {
         "id": "Observation.effective[x]",
         "path": "Observation.effective[x]",
@@ -275,8 +283,6 @@
       {
         "id": "Observation.component:SystolicBP.dataAbsentReason",
         "path": "Observation.component.dataAbsentReason",
-        "short": "Grund für fehlendes Untersuchungsergebniss",
-        "comment": "Motivation MS: Dieses Feld erlaubt die Angabe von Gründen für fehlende Untersuchungsergebnisse",
         "mustSupport": true
       },
       {
@@ -491,8 +497,6 @@
       {
         "id": "Observation.component:meanBP.dataAbsentReason",
         "path": "Observation.component.dataAbsentReason",
-        "short": "Grund für fehlendes Untersuchungsergebniss",
-        "comment": "Motivation MS: Dieses Feld erlaubt die Angabe von Gründen für fehlende Untersuchungsergebnisse",
         "mustSupport": true
       }
     ]

diff --git a/Resources/fsh-generated/resources/StructureDefinition-ISiKEKG.json b/Resources/fsh-generated/resources/StructureDefinition-ISiKEKG.json
@@ -21,7 +21,7 @@
         "id": "Observation.status",
         "path": "Observation.status",
         "short": "Untersuchungsstatus",
-        "comment": "Motivation MS: Observation.status ist bereits durch die Kardinalität der Basisklasse Observation erzwungen. Dieses Feld dient der Präzisierung des Status der Untersuchung",
+        "comment": "**WICHTIGER Hinweis für Implementierer:**  \n* Alle server-seitigen Implementierungen MÜSSEN in der Lage sein, die systemintern möglichen Statuswerte korrekt in FHIR abzubilden, mindestens jedoch `final`.\n* Alle client-seitigen Implementierungen MÜSSEN in der Lage sein, sämtliche Status-Codes zu interpretieren und dem Anwender in angemessener Form darstellen zu können, beispielsweise durch Ausblenden/Durchstreichen von Ressourcen mit dem status `entered-in-error` und Ausgrauen von Ressourcen, die einen Plan- oder Entwurfs-Status haben.",
         "mustSupport": true
       },
       {
@@ -65,16 +65,24 @@
         "id": "Observation.subject",
         "path": "Observation.subject",
         "short": "Patient",
-        "comment": "Motivation MS: Ein Vitalparameter hat immer einen Patientenbezug",
+        "comment": "Motivation MS: Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.",
         "mustSupport": true
       },
       {
         "id": "Observation.encounter",
         "path": "Observation.encounter",
-        "short": "Behandlungskontext",
+        "short": "Aufenthaltsbezug",
         "comment": "Motivation MS: Der Behandlungskontext ist für die Interpretation der Untersuchungsergebnisse relevant",
         "mustSupport": true
       },
+      {
+        "id": "Observation.encounter.reference",
+        "path": "Observation.encounter.reference",
+        "short": "Encounter-Link",
+        "comment": "**Begründung Pflichtfeld:** Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.  \n**WICHTIGER Hinweis für Implementierer:** Die Zuordnung MUSS auf auf einen Encounter der Ebene \"Abteilungskontakt\" (siehe hierzu Basismodul > UseCases > Abbildung des Konstruktes \"Fall\") erfolgen.  \nBei der Auswahl des Encounters ist zu beachten, dass unter einer (Abrechnungs-)\"Fallnummer\" (hier: `Encounter.account`) unter Umständen mehrere Encounter gruppiert sein können (z.B. stationärer Besuch mit mehreren vor- und nachstationären Aufenthalten.)",
+        "min": 1,
+        "mustSupport": true
+      },
       {
         "id": "Observation.effective[x]",
         "path": "Observation.effective[x]",
@@ -148,28 +156,28 @@
         "id": "Observation.component.value[x].origin",
         "path": "Observation.component.value[x].origin",
         "short": "Ausgangswert",
-        "comment": "Motivation MS: Das Feld origin definiert den Referenzpunkt und die Einheit der Messreihe, um sicherzustellen, dass die gemessenen Werte im richtigen Kontext interpretiert werden können.",
+        "comment": "Motivation MS: Das Feld `origin` definiert den Referenzpunkt und die Einheit der Messreihe, um sicherzustellen, dass die gemessenen Werte im richtigen Kontext interpretiert werden können.",
         "mustSupport": true
       },
       {
         "id": "Observation.component.value[x].period",
         "path": "Observation.component.value[x].period",
         "short": "Messintervall",
-        "comment": "Motivation MS: Das Feld period definiert die zeitliche Distanz zwischen zwei aufeinanderfolgenden Messwerten.",
+        "comment": "Motivation MS: Das Feld `period` definiert die zeitliche Distanz zwischen zwei aufeinanderfolgenden Messwerten.",
         "mustSupport": true
       },
       {
         "id": "Observation.component.value[x].dimensions",
         "path": "Observation.component.value[x].dimensions",
         "short": "Dimensionen",
-        "comment": "Motivation MS: Das Feld dimensions gibt die Anzahl der Achsen oder Dimensionen an, die in der Messreihe enthalten sind, und ist notwendig, um die Struktur der Daten korrekt zu verstehen.",
+        "comment": "Motivation MS: Das Feld `dimensions` gibt die Anzahl der Achsen oder Dimensionen an, die in der Messreihe enthalten sind, und ist notwendig, um die Struktur der Daten korrekt zu verstehen.",
         "mustSupport": true
       },
       {
         "id": "Observation.component.value[x].data",
         "path": "Observation.component.value[x].data",
         "short": "Messwerte",
-        "comment": "Motivation MS: Das Feld data enthält die eigentlichen Messwerte der EKG-Daten.",
+        "comment": "Motivation MS: Das Feld `data` enthält die eigentlichen Messwerte der EKG-Daten.",
         "mustSupport": true
       }
     ]

diff --git a/Resources/fsh-generated/resources/StructureDefinition-ISiKGCS.json b/Resources/fsh-generated/resources/StructureDefinition-ISiKGCS.json
@@ -21,7 +21,7 @@
         "id": "Observation.status",
         "path": "Observation.status",
         "short": "Untersuchungsstatus",
-        "comment": "Motivation MS: Observation.status ist bereits durch die Kardinalität der Basisklasse Observation erzwungen. Dieses Feld dient der Präzisierung des Status der Untersuchung",
+        "comment": "**WICHTIGER Hinweis für Implementierer:**  \n* Alle server-seitigen Implementierungen MÜSSEN in der Lage sein, die systemintern möglichen Statuswerte korrekt in FHIR abzubilden, mindestens jedoch `final`.\n* Alle client-seitigen Implementierungen MÜSSEN in der Lage sein, sämtliche Status-Codes zu interpretieren und dem Anwender in angemessener Form darstellen zu können, beispielsweise durch Ausblenden/Durchstreichen von Ressourcen mit dem status `entered-in-error` und Ausgrauen von Ressourcen, die einen Plan- oder Entwurfs-Status haben.",
         "mustSupport": true
       },
       {
@@ -84,16 +84,24 @@
         "id": "Observation.subject",
         "path": "Observation.subject",
         "short": "Patient",
-        "comment": "Motivation MS: Ein Vitalparameter hat immer einen Patientenbezug",
+        "comment": "Motivation MS: Die Verlinkung auf eine Patienten-Ressource dient der technischen Zuordnung der Dokumentation zu einem Patienten und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.",
         "mustSupport": true
       },
       {
         "id": "Observation.encounter",
         "path": "Observation.encounter",
-        "short": "Behandlungskontext",
+        "short": "Aufenthaltsbezug",
         "comment": "Motivation MS: Der Behandlungskontext ist für die Interpretation der Untersuchungsergebnisse relevant",
         "mustSupport": true
       },
+      {
+        "id": "Observation.encounter.reference",
+        "path": "Observation.encounter.reference",
+        "short": "Encounter-Link",
+        "comment": "**Begründung Pflichtfeld:** Die Verlinkung auf eine Encounter-Ressource dient der technischen Zuordnung der Dokumentation zu einem Aufenthalt und ermöglicht wichtige API-Funktionen wie verkettete Suche, (Reverse-)Include etc.  \n**WICHTIGER Hinweis für Implementierer:** Die Zuordnung MUSS auf auf einen Encounter der Ebene \"Abteilungskontakt\" (siehe hierzu Basismodul > UseCases > Abbildung des Konstruktes \"Fall\") erfolgen.  \nBei der Auswahl des Encounters ist zu beachten, dass unter einer (Abrechnungs-)\"Fallnummer\" (hier: `Encounter.account`) unter Umständen mehrere Encounter gruppiert sein können (z.B. stationärer Besuch mit mehreren vor- und nachstationären Aufenthalten.)",
+        "min": 1,
+        "mustSupport": true
+      },
       {
         "id": "Observation.effective[x]",
         "path": "Observation.effective[x]",