Merge pull request #202 from gematik/Capability-Refactoring

Übertragung sämtlicher instanzbezogener Doku aus dem IG in FSH

Resources/fsh-generated/fsh-index.json

@@ -0,0 +1,106 @@
+[
+  {
+    "outputFile": "Bundle-Suchergebnis-Beispiel.json",
+    "fshName": "Suchergebnis-Beispiel",
+    "fshType": "Instance",
+    "fshFile": "ISiKDokumentenSuchergebnisse.fsh",
+    "startLine": 18,
+    "endLine": 24
+  },
+  {
+    "outputFile": "CapabilityStatement-ISiKCapabilityStatementDokumentenaustauschServer.json",
+    "fshName": "ISiKCapabilityStatementDokumentenaustauschServer",
+    "fshType": "Instance",
+    "fshFile": "ISiKCapabilityStatementDokumentenaustauschServer.fsh",
+    "startLine": 1,
+    "endLine": 152
+  },
+  {
+    "outputFile": "DocumentReference-dok-beispiel-client-with-binary-jpeg-example-short.json",
+    "fshName": "dok-beispiel-client-with-binary-jpeg-example-short",
+    "fshType": "Instance",
+    "fshFile": "ISiKDokumentenMetadaten.fsh",
+    "startLine": 262,
+    "endLine": 281
+  },
+  {
+    "outputFile": "DocumentReference-dok-beispiel-client-with-binary-jpeg-example.json",
+    "fshName": "dok-beispiel-client-with-binary-jpeg-example",
+    "fshType": "Instance",
+    "fshFile": "ISiKDokumentenMetadaten.fsh",
+    "startLine": 283,
+    "endLine": 302
+  },
+  {
+    "outputFile": "DocumentReference-dok-beispiel-client-with-binary-pdf-example-short.json",
+    "fshName": "dok-beispiel-client-with-binary-pdf-example-short",
+    "fshType": "Instance",
+    "fshFile": "ISiKDokumentenMetadaten.fsh",
+    "startLine": 241,
+    "endLine": 260
+  },
+  {
+    "outputFile": "DocumentReference-dok-beispiel-client-with-binary-pdf-example.json",
+    "fshName": "dok-beispiel-client-with-binary-pdf-example",
+    "fshType": "Instance",
+    "fshFile": "ISiKDokumentenMetadaten.fsh",
+    "startLine": 304,
+    "endLine": 323
+  },
+  {
+    "outputFile": "DocumentReference-dok-beispiel-server.json",
+    "fshName": "dok-beispiel-server",
+    "fshType": "Instance",
+    "fshFile": "ISiKDokumentenMetadaten.fsh",
+    "startLine": 218,
+    "endLine": 239
+  },
+  {
+    "outputFile": "Encounter-BeispielBesuch.json",
+    "fshName": "BeispielBesuch",
+    "fshType": "Instance",
+    "fshFile": "referencedExamples.fsh",
+    "startLine": 53,
+    "endLine": 88
+  },
+  {
+    "outputFile": "OperationDefinition-UpdateMetadata.json",
+    "fshName": "UpdateMetadata",
+    "fshType": "Instance",
+    "fshFile": "OperationUpdateMetadata.fsh",
+    "startLine": 1,
+    "endLine": 32
+  },
+  {
+    "outputFile": "Patient-PatientinMusterfrau.json",
+    "fshName": "PatientinMusterfrau",
+    "fshType": "Instance",
+    "fshFile": "referencedExamples.fsh",
+    "startLine": 1,
+    "endLine": 51
+  },
+  {
+    "outputFile": "StructureDefinition-ISiKDokumentenMetadaten.json",
+    "fshName": "ISiKDokumentenMetadaten",
+    "fshType": "Profile",
+    "fshFile": "ISiKDokumentenMetadaten.fsh",
+    "startLine": 1,
+    "endLine": 214
+  },
+  {
+    "outputFile": "StructureDefinition-ISiKDokumentenSuchergebnisse.json",
+    "fshName": "ISiKDokumentenSuchergebnisse",
+    "fshType": "Profile",
+    "fshFile": "ISiKDokumentenSuchergebnisse.fsh",
+    "startLine": 1,
+    "endLine": 15
+  },
+  {
+    "outputFile": "ValueSet-ISiKConfidentialityCodes.json",
+    "fshName": "ISiKConfidentialityCodes",
+    "fshType": "ValueSet",
+    "fshFile": "terminologies.fsh",
+    "startLine": 1,
+    "endLine": 8
+  }
+]

Resources/fsh-generated/fsh-index.txt

@@ -0,0 +1,14 @@
+Output File                                                                Name                                                Type      FSH File                                              Lines
+Bundle-Suchergebnis-Beispiel.json                                          Suchergebnis-Beispiel                               Instance  ISiKDokumentenSuchergebnisse.fsh                      18 - 24
+CapabilityStatement-ISiKCapabilityStatementDokumentenaustauschServer.json  ISiKCapabilityStatementDokumentenaustauschServer    Instance  ISiKCapabilityStatementDokumentenaustauschServer.fsh  1 - 152
+DocumentReference-dok-beispiel-client-with-binary-jpeg-example-short.json  dok-beispiel-client-with-binary-jpeg-example-short  Instance  ISiKDokumentenMetadaten.fsh                           262 - 281
+DocumentReference-dok-beispiel-client-with-binary-jpeg-example.json        dok-beispiel-client-with-binary-jpeg-example        Instance  ISiKDokumentenMetadaten.fsh                           283 - 302
+DocumentReference-dok-beispiel-client-with-binary-pdf-example-short.json   dok-beispiel-client-with-binary-pdf-example-short   Instance  ISiKDokumentenMetadaten.fsh                           241 - 260
+DocumentReference-dok-beispiel-client-with-binary-pdf-example.json         dok-beispiel-client-with-binary-pdf-example         Instance  ISiKDokumentenMetadaten.fsh                           304 - 323
+DocumentReference-dok-beispiel-server.json                                 dok-beispiel-server                                 Instance  ISiKDokumentenMetadaten.fsh                           218 - 239
+Encounter-BeispielBesuch.json                                              BeispielBesuch                                      Instance  referencedExamples.fsh                                53 - 88
+OperationDefinition-UpdateMetadata.json                                    UpdateMetadata                                      Instance  OperationUpdateMetadata.fsh                           1 - 32
+Patient-PatientinMusterfrau.json                                           PatientinMusterfrau                                 Instance  referencedExamples.fsh                                1 - 51
+StructureDefinition-ISiKDokumentenMetadaten.json                           ISiKDokumentenMetadaten                             Profile   ISiKDokumentenMetadaten.fsh                           1 - 214
+StructureDefinition-ISiKDokumentenSuchergebnisse.json                      ISiKDokumentenSuchergebnisse                        Profile   ISiKDokumentenSuchergebnisse.fsh                      1 - 15
+ValueSet-ISiKConfidentialityCodes.json                                     ISiKConfidentialityCodes                            ValueSet  terminologies.fsh                                     1 - 8

Resources/fsh-generated/resources/CapabilityStatement-ISiKCapabilityStatementDokumentenaustauschServer.json

@@ -2,11 +2,12 @@
   "resourceType": "CapabilityStatement",
   "id": "ISiKCapabilityStatementDokumentenaustauschServer",
   "url": "https://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementDokumentenaustauschServer",
+  "description": "Jede Instanz eines bestätigungsrelevanten Systems MUSS an ihrem Endpunkt eine CapabilityStatement-Ressource bereitstellen.\r\nHierzu MUSS die [capabilities-Interaktion gemäß FHIR-Kernspezifikation](https://hl7.org/fhir/R4/http.html#capabilities) unterstützt werden. \r\nDer `MODE`-Parameter kann ignoriert werden.  \r\nDas CapabilityStatement in dieser Spezifikation stellt die Anforderungen seitens der gematik dar (`kind = requirements`). \r\nZur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, \r\nwird die [CapabilityStatement-Expectation-Extension](https://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html) mit den möglichen Werten `SHALL` (=MUSS) und `MAY` (=KANN) verwendet.  \r\n\r\nEine Server-Instanz MUSS ihrerseits ein CapabilityStatement vom `kind = instance` liefern und im Element `software` den Namen \r\nund die Versionsnummer angeben. \r\nDarüber hinaus MUSS in `CapabilityStatement.instantiates` die Canonical URL des nachfolgenden CapabilityStatements angegeben werden.  \r\n\r\nDas CapabilityStatement der Instanz MUSS alle Funktionalitäten auflisten, die im folgenden CapabilityStatement mit `SHALL` gekennzeichnet sind. \r\nDas CapabilityStatement KANN darüber hinaus die mit `MAY` gekennzeichneten Funktionalitäten, sowie weitere Funktionalitäten auflisten, \r\nsofern diese in der Instanz implementiert wurden.  \r\n\r\nDie Verwendung der CapabilityStatement-Expectation-Extension ist im CapabilityStatement der Server-Instanz nicht erforderlich.",
   "status": "active",
   "publisher": "gematik GmbH",
-  "date": "2024-09-09",
+  "date": "2024-09-23",
   "experimental": false,
-  "version": "4.0.0",
+  "version": "4.0.1",
   "implementationGuide": [
     "https://gematik.de/fhir/isik/ImplementationGuide/ISiK-Dokumentenaustausch"
   ],
@@ -22,7 +23,6 @@
       ]
     }
   ],
-  "description": "Das vorliegende CapabilityStatement beschreibt alle verpflichtenden Interaktionen die ein ISiK-konformes System unterstützen muss um das Bestätigungsverfahren des Moduls "Dokumentenaustausch" zu bestehen.",
   "jurisdiction": [
     {
       "coding": [
@@ -52,9 +52,20 @@
             }
           ],
           "type": "DocumentReference",
+          "documentation": "Für die Ressource DocumentReference MUSS die REST-Interaktion \r\n  `CREATE` implementiert werden, siehe Interaktion: Dokumentenbereitstellung. \r\n  Für die Ressource DocumentReference MUSS die REST-Interaktion `READ` implementiert werden, \r\n  siehe Interaktion: Dokumentenabfrage und -Zugriff.   \r\n  Die in IHE-MHD geltende Einschränkung, dass Clients bei allen Suchen mindestens \r\n  die Parameter patient oder patient.identifier sowie status verwenden müssen, gilt nicht. \r\n  Siehe dazu Kapitel {{pagelink:Kompatibilitaet}}.  \r\n  Folgende Suchparameter sind für das Bestätigungsverfahren relevant, auch in Kombination: ",
           "supportedProfile": [
             "https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten"
           ],
+          "_supportedProfile": [
+            {
+              "extension": [
+                {
+                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
+                  "valueCode": "SHALL"
+                }
+              ]
+            }
+          ],
           "interaction": [
             {
               "extension": [
@@ -94,7 +105,8 @@
               ],
               "name": "_id",
               "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
-              "type": "token"
+              "type": "token",
+              "documentation": "**Beispiel:**    \r\n        `GET [base]/DocumentReference?_id=103270`    \r\n        **Anwendungshinweis:**   \r\n        Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#all).  "
             },
             {
               "extension": [
@@ -105,7 +117,8 @@
               ],
               "name": "status",
               "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
-              "type": "token"
+              "type": "token",
+              "documentation": "**Beispiel:**    \r\n        `GET [base]/DocumentReference?status=final`    \r\n        **Anwendungshinweis:**   \r\n        Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#token).  \r\n        Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Clients und Server verpflichend."
             },
             {
               "extension": [
@@ -116,7 +129,8 @@
               ],
               "name": "patient",
               "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-patient",
-              "type": "reference"
+              "type": "reference",
+              "documentation": "**Beispiel:**    \r\n        `GET [base]/DocumentReference?patient=Patient/123`\r\n        `GET [base]/DocumentReference?patient.identifier=http://mein-krankenhaus.example/fhir/sid/patienten|1032702` \r\n        `GET [base]/DocumentReference?patient.identifier=1032702`  \r\n        **Anwendungshinweis:**   \r\n        Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#reference).  \r\n        Weitere Informationen zur Suche nach verketteten Parametern finden sich in der FHIR-Kernspezifikation - Abschnitt [Chained Parameters](https://hl7.org/fhir/R4/search.html#chaining).\r\n        Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Clients und Server verpflichend."
             },
             {
               "extension": [
@@ -127,7 +141,8 @@
               ],
               "name": "type",
               "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-type",
-              "type": "token"
+              "type": "token",
+              "documentation": "**Beispiel:**    \r\n        `GET [base]/DocumentReference?type=http://dvmd.de/fhir/CodeSystem/kdl|AD010101`    \r\n        **Anwendungshinweis:**   \r\n        Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#token).  \r\n        Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Server verpflichtend."
             },
             {
               "extension": [
@@ -138,7 +153,8 @@
               ],
               "name": "category",
               "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
-              "type": "token"
+              "type": "token",
+              "documentation": "**Beispiel:**    \r\n        `GET [base]/DocumentReference?category=http://ihe-d.de/CodeSystem/IHEXDSclassCode|BEF`    \r\n        **Anwendungshinweis:**   \r\n        Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#token).  \r\n        Dieser Suchparameter ist für die Umsetzung des IHE MHD Profils für Server verpflichtend."
             },
             {
               "extension": [
@@ -149,7 +165,8 @@
               ],
               "name": "creation",
               "definition": "http://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
-              "type": "date"
+              "type": "date",
+              "documentation": "**Beispiel:**    \r\n        `GET [base]/DocumentReference?creation=2021-11-05`    \r\n        **Anwendungshinweis:**   \r\n        Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#date).  \r\n        Dieser Suchparameter ist Teil der IHE-MHD-Spezifikation und für die Umsetzung des IHE MHD Profils für Server verpflichtend."
             },
             {
               "extension": [
@@ -160,7 +177,8 @@
               ],
               "name": "encounter",
               "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-encounter",
-              "type": "reference"
+              "type": "reference",
+              "documentation": "**Beispiel:**    \r\n        `GET [base]/DocumentReference?encounter=Encounter/123`    \r\n        **Anwendungshinweis:**   \r\n        Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#reference).  "
             }
           ]
         },
@@ -175,6 +193,16 @@
           "supportedProfile": [
             "https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKBinary"
           ],
+          "_supportedProfile": [
+            {
+              "extension": [
+                {
+                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
+                  "valueCode": "SHALL"
+                }
+              ]
+            }
+          ],
           "interaction": [
             {
               "extension": [

Resources/fsh-generated/resources/OperationDefinition-UpdateMetadata.json

@@ -3,7 +3,7 @@
   "id": "UpdateMetadata",
   "status": "active",
   "publisher": "gematik GmbH",
-  "date": "2024-09-09",
+  "date": "2024-09-23",
   "url": "https://gematik.de/fhir/isik/OperationDefinition/UpdateMetadata",
   "title": "Update document metadata",
   "kind": "operation",

Resources/fsh-generated/resources/StructureDefinition-ISiKDokumentenMetadaten.json

@@ -2,13 +2,14 @@
   "resourceType": "StructureDefinition",
   "id": "ISiKDokumentenMetadaten",
   "url": "https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "name": "ISiKDokumentenMetadaten",
   "title": "Erforderliche Metadaten für Dokumentenaustausch in ISiK",
   "status": "active",
   "experimental": false,
-  "date": "2024-09-09",
+  "date": "2024-09-23",
   "publisher": "gematik GmbH",
+  "description": "Dieses Profil spezifiziert die Minimalanforderungen für die Bereitstellung von Dokumentenmetadaten im Rahmen des Bestätigungsverfahrens der gematik.  \n\n  ### Motivation\nDie Ressource DocumentReference enthält die Metadaten, die für die Verwaltung von und die Suche nach Dokumenten benötigt werden. Der Inhalt des Dokumentes wird über DocumentReference.content beschrieben und über DocumentReference.content.attachment referenziert. Die Trennung von Dokument und Metadaten ermöglicht Clients die effiziente Suche und Auflistung von verfügbaren Dokumenten, ohne dass diese vollständig vom Server geladen werden müssen. Servern ermöglicht dieser Ansatz die Trennung zwischen den Metadaten in einer Datenbank und der Dokumentenablage in z.B. einem Dateisystem.\n\n  ### Kompatibilität\nDieses Profil basiert auf dem Profil [MHD DocumentReference Comprehensive UnContained References Option](https://profiles.ihe.net/ITI/MHD/StructureDefinition-IHE.MHD.UnContained.Comprehensive.DocumentReference.html) (Version 4.2.0) von IHE International.\n\n  #### Abweichungen vom IHE-Profil\nDie Verwendung von `DocumentReference.docStatus` ist im ISiK-Kontext gestattet.\n`DocumentReference.category` muss vom Client bei Vorhandensein eines KDL-Codes in `DocumentReference.type` nicht gefüllt werden. Bei der Verarbeitung auf dem Server im Rahmen der Interaktion {{pagelink: AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung}} wird `DocumentReference.category` anhand der [KDL-Mappings](https://simplifier.net/kdl/%7Eresources?category=ConceptMap&sortBy=RankScore_desc) ergänzt und damit die IHE-Kompatibilität hergestellt.\n`DocumentReference.sourcePatientInfo` muss im Rahmen von ISiK nicht gefüllt werden\n\n#### Einschränkungen des IHE-Profils\nElemente mit ValueSet-Bindings ohne verbindliche Vorgabe seitens IHE wurden auf die in Deutschland gebräuchlichen Terminologien (gemäß der Festlegungen von IHE Deutschland e.V.) eingeschränkt.",
   "fhirVersion": "4.0.1",
   "mapping": [
     {
@@ -489,7 +490,7 @@
       {
         "id": "DocumentReference.context.encounter",
         "path": "DocumentReference.context.encounter",
-        "comment": "Abweichend zu MHD V4.0.1 ist die Verwendung der Encounter-Referenz im ISiK-Kontext erlaubt.\n\n    Wird ein Encounter im ISIK-Kontext referenziert, so MUSS dieser konform zum Profil [ISIKKontaktGesundheitseinrichtung](https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKKontaktGesundheitseinrichtung) aus dem Basismodul sein. \nUpdate für Stufe 3: \nIn MHD 4.2.0 wurde das Verbot der Angabe einer Encounter-Referenz gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.\n    ",
+        "comment": "Abweichend zu MHD V4.0.1 ist die Verwendung der Encounter-Referenz im ISiK-Kontext erlaubt.  \n    Wird ein Encounter im ISIK-Kontext referenziert, so MUSS dieser konform zum Profil [ISIKKontaktGesundheitseinrichtung](https://gematik.de/fhir/isik/v3/Basismodul/StructureDefinition/ISiKKontaktGesundheitseinrichtung) aus dem Basismodul sein. \nUpdate für Stufe 3: \nIn MHD 4.2.0 wurde das Verbot der Angabe einer Encounter-Referenz gelockert, das ISiK-Profil ist damit in diesem Punkt wieder kompatibel zu IHE MHD.\n    ",
         "max": "1",
         "mustSupport": true,
         "mapping": [

Resources/fsh-generated/resources/StructureDefinition-ISiKDokumentenSuchergebnisse.json

@@ -2,12 +2,12 @@
   "resourceType": "StructureDefinition",
   "id": "ISiKDokumentenSuchergebnisse",
   "url": "https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "name": "ISiKDokumentenSuchergebnisse",
   "title": "Suchergebnisse einer Dokumentensuche",
   "status": "active",
   "experimental": false,
-  "date": "2024-09-09",
+  "date": "2024-09-23",
   "publisher": "gematik GmbH",
   "fhirVersion": "4.0.1",
   "kind": "resource",

Resources/fsh-generated/resources/ValueSet-ISiKConfidentialityCodes.json

@@ -6,10 +6,10 @@
   "title": "ISiKConfidentialityCodes",
   "description": "Vertraulichkeitsstufen",
   "url": "https://gematik.de/fhir/isik/ValueSet/ISiKConfidentialityCodes",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "experimental": false,
   "publisher": "gematik GmbH",
-  "date": "2024-09-09",
+  "date": "2024-09-23",
   "compose": {
     "include": [
       {