Skip to content

Commit

Permalink
Merge branch 'rc/main-stufe-4' into feature/PTDATA-1053-TC-Stufe-3-zu…
Browse files Browse the repository at this point in the history
…-Stufe-4
  • Loading branch information
f-peverali authored Jun 25, 2024
2 parents ac9b346 + c692ccc commit 1a4f85b
Show file tree
Hide file tree
Showing 15 changed files with 30 additions and 30 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
@```from
StructureDefinition
where
url = 'https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/Profile: ISiKDokumentenSuchergebnisse'
url = 'https://gematik.de/fhir/isik/StructureDefinition/Profile: ISiKDokumentenSuchergebnisse'
for differential.element
where mustSupport = true
select
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
1. siehe Dokumentenabfrage: {{pagelink:ImplementationGuide/markdown/AkteureUndInteraktionen-Dokumentenabfrage.md}}
1. siehe Dokumentenabfrage: {{pagelink:ImplementationGuide/markdown/UebergreifendeFestlegungen/AkteureUndInteraktionen/AkteureUndInteraktionen-Dokumentenabfrage.md}}


Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Bundle-Profil für Suchergebnisse
**Canonical URL**: https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenSuchergebnisse
**Canonical URL**: https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse

{{tree:https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenSuchergebnisse, hybrid}}
{{tree:https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse, hybrid}}

[Link Simplifier Profil Übersicht](https://simplifier.net/spec-isik-dokumentenaustausch/isikdokumentensuchergebnisse)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## ISiKBinary [(Binary)](https://hl7.org/fhir/R4/binary.html)

ISiKBinary dient im Kontext des Dokumentenaustauschs dazu entsprechende Binärdateien über einen Dokumentenserver bereitzustellen (siehe {{pagelink:ImplementationGuide/markdown/AkteureUndInteraktionen-Dokumentenabfrage.md, text:Akteure und Interaktionen}}).
ISiKBinary dient im Kontext des Dokumentenaustauschs dazu entsprechende Binärdateien über einen Dokumentenserver bereitzustellen (siehe {{pagelink:ImplementationGuide/markdown/UebergreifendeFestlegungen/AkteureUndInteraktionen/AkteureUndInteraktionen-Dokumentenabfrage.md, text:Akteure und Interaktionen}}).

### FHIR-Profil

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
@```from
StructureDefinition
where
url = 'https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenMetadaten'
url = 'https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten'
for differential.element
where mustSupport = true
select
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### Interaktionen

Für die Ressource DocumentReference MUSS die REST-Interaktion "CREATE" implementiert werden, siehe {{pagelink:ImplementationGuide/markdown/AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung.md}}.
Für die Ressource DocumentReference MUSS die REST-Interaktion "READ" implementiert werden, siehe {{pagelink:ImplementationGuide/markdown/AkteureUndInteraktionen-Dokumentenabfrage.md}}.
Für die Ressource DocumentReference MUSS die REST-Interaktion "CREATE" implementiert werden, siehe {{pagelink:ImplementationGuide/markdown/UebergreifendeFestlegungen/AkteureUndInteraktionen/AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung.md}}.
Für die Ressource DocumentReference MUSS die REST-Interaktion "READ" implementiert werden, siehe {{pagelink:ImplementationGuide/markdown/UebergreifendeFestlegungen/AkteureUndInteraktionen/AkteureUndInteraktionen-Dokumentenabfrage.md}}.

Folgende Suchparameter sind für das Bestätigungsverfahren relevant, auch in Kombination:

Die in IHE-MHD geltende Einschränkung, dass Clients bei allen Suchen mindestens die Parameter `patient` oder `patient.identifier` sowie `status` verwenden müssen, gilt nicht. Siehe dazu Kapitel {{pagelink:ImplementationGuide/markdown/Kompatibilitaet.md}}
Die in IHE-MHD geltende Einschränkung, dass Clients bei allen Suchen mindestens die Parameter `patient` oder `patient.identifier` sowie `status` verwenden müssen, gilt nicht. Siehe dazu Kapitel {{pagelink:ImplementationGuide/markdown/UebergreifendeFestlegungen/Kompatibilitaet.md}}

1. Der Suchparameter "_id" MUSS unterstützt werden:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
### FHIR-Profil

#### DocumentReference
**Canonical URL**: https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenMetadaten
**Canonical URL**: https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten

{{tree:https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenMetadaten, hybrid}}
{{tree:https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten, hybrid}}

[Link Simplifier Profil Übersicht](https://simplifier.net/spec-isik-dokumentenaustausch/isikdokumentenmetadaten)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
## Dokumentenabfrage und -zugriff

### Dokumentenabfrage (IHE MHD ITI-67 (Find DocumentReferences))
Dokumente können anhand ihrer Metadaten gesucht werden. Im Rahmen der ISiK-Spezifikation müssen mindestens die im Kapitel {{pagelink:ImplementationGuide/markdown/DocumentReference_Interaktionen.md}}
Dokumente können anhand ihrer Metadaten gesucht werden. Im Rahmen der ISiK-Spezifikation müssen mindestens die im Kapitel {{pagelink:ImplementationGuide/markdown/Datenobjekte/DocumentReference/DocumentReference_Interaktionen.md}}
mit `MUSS` gekennzeichneten Suchparameter unterstützt werden. Einzelnen Systemen steht es frei, darüber hinaus weitere FHIR-konforme Suchparameter zu implementieren.

Die Ergebnisse einer Suchanfrage werden in Form eines Bundles zurückgegeben:
{{tree:https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenSuchergebnisse, hybrid}}
{{tree:https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse, hybrid}}

Suchergebnisse können zahlreich sein. Server MÜSSEN daher [FHIR-konformes Paging](https://hl7.org/fhir/R4/http.html#paging) unterstützen. Server KÖNNEN im SearchSet-Bundle auch Ressourcen vom Typ [OperationOutcome](https://hl7.org/fhir/R4/operationoutcome.html) mit Informationen über die Suchergebnisse zurückgeben. Diese müssen in `Bundle.entry.search.mode` mit dem Wert `outcome` gekennzeichnet sein. Die Issues im OperationOutcome dürfen nur dem Schweregrad `information` oder `warning` entsprechen.
Issues vom Schweregrad `error` oder `fatal` sind unzulässig.
Expand All @@ -23,7 +23,7 @@ Die Vereinbarungen gelten uneingeschränkt.
Es gelten darüber hinaus die allgemeinen Festlegungen zu Suchparametern gemäß [ISiK Basisprofil Stufe 4](https://simplifier.net/guide/isik-basis-v4/UebergreifendeFestlegungen-UebergreifendeFestlegungen-Suchparameter?version=current)

##### [2:3.67.4.1.2.1 Query Search Parameters](https://profiles.ihe.net/ITI/MHD/ITI-67.html#23674121-query-search-parameters)
Im Rahmen der ISiK-Spezifikation müssen mindestens die im Kapitel {{pagelink:ImplementationGuide/markdown/DocumentReference_Interaktionen.md}}
Im Rahmen der ISiK-Spezifikation müssen mindestens die im Kapitel {{pagelink:ImplementationGuide/markdown/Datenobjekte/DocumentReference/DocumentReference_Interaktionen.md}}
mit `MUSS` gekennzeichneten Suchparameter unterstützt werden. Einzelnen Systemen steht es frei, darüber hinaus weitere FHIR-konforme bzw in IHE MHD geforderte Suchparameter zu implementieren.

Die in IHE bestehende Verpflichtung für Clients, bei jeder Query mindestens einen der Parameter `patient` oder `patient.identifier` verwenden zu müssen, besteht im ISiK-Kontext nicht. Patientenübergreifende Suchanfragen sind zulässig.
Expand All @@ -43,7 +43,7 @@ Die Implementierung der "XDS on FHIR"-Option ist im ISiK-Kontext nicht gefordert
Die Vereinbarungen gelten uneingeschränkt.
##### [2:3.67.4.2.2 Message Semantics](https://profiles.ihe.net/ITI/MHD/ITI-67.html#2367422-message-semantics)
* Suchergebnisse können zahlreich sein. Server MÜSSEN daher [FHIR-konformes Paging](https://hl7.org/fhir/R4/http.html#paging) unterstützen. Server KÖNNEN im * SearchSet-Bundle auch Ressourcen vom Typ [OperationOutcome](https://hl7.org/fhir/R4/operationoutcome.html) mit Informationen über die Suchergebnisse zurückgeben. Diese müssen in `Bundle.entry.search.mode` mit dem Wert `outcome` gekennzeichnet sein. Die Issues im OperationOutcome dürfen nur dem Schweregrad `information` oder `warning` entsprechen. Issues vom Schweregrad `error` oder `fatal` sind unzulässig.
* Das Ergebnis-Bundle der Suche muss konform sein zum Profil "ISiKDokumentenSuchergebnisse"{{tree:https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenSuchergebnisse, hybrid}}
* Das Ergebnis-Bundle der Suche muss konform sein zum Profil "ISiKDokumentenSuchergebnisse"{{tree:https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenSuchergebnisse, hybrid}}

##### [2:3.67.4.2.2.1 DocumentReference Resource Contents](https://profiles.ihe.net/ITI/MHD/ITI-67.html#23674221-documentreference-resource-contents)
* Die DocumentReference-Ressoucen müssen im ISiK-Kontext auf Basis des Profils "ISiKDokumentenMetadaten" und den dort vereinbarten Kardinalitäten bzw. MustSupport-Flags erstellt werden.
Expand All @@ -58,7 +58,7 @@ Die Vereinbarungen gelten uneingeschränkt.

#### [2:3.67.4.4 CapabilityStatement Resource](https://profiles.ihe.net/ITI/MHD/ITI-67.html#236744-capabilitystatement-resource)

Es gelten die Vereinbarungen gemäß {{pagelink:ImplementationGuide/markdown/CapabilityStatement.md}}
Es gelten die Vereinbarungen gemäß {{pagelink:ImplementationGuide/markdown/Datenobjekte/CapabilityStatement.md}}

#### [2:3.67.5 Security Considerations](https://profiles.ihe.net/ITI/MHD/ITI-67.html#23675-security-considerations)
Für Hinweise zur Implementierung von Autorisation und Authentifikation im ISiK-Kontext, siehe [Modul ISiK-Sicherheit](https://simplifier.net/isik-sicherheit-v3).
Expand Down Expand Up @@ -100,7 +100,7 @@ Die Vereinbarungen gelten uneingeschränkt.
Die Vereinbarungen gelten uneingeschränkt.

##### [2:3.68.4.4 CapabilityStatement Resource](https://profiles.ihe.net/ITI/MHD/ITI-67.html#236843-capabilitystatement-resource)
Es gelten die Vereinbarungen gemäß {{pagelink:ImplementationGuide/markdown/CapabilityStatement.md}}
Es gelten die Vereinbarungen gemäß {{pagelink:ImplementationGuide/markdown/Datenobjekte/CapabilityStatement.md}}

#### [2:3.68.5 Security Considerations](https://profiles.ihe.net/ITI/MHD/ITI-68.html#23685-security-considerations)
Für Hinweise zur Implementierung von Autorisation und Authentifikation im ISiK-Kontext, siehe [Modul ISiK-Sicherheit](https://simplifier.net/isik-sicherheit-v3)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Die Vereinbarungen gelten uneingeschränkt.
Die Vereinbarungen gelten uneingeschränkt.

#### [2:3.106.4.3 CapabilityStatement Resource](https://profiles.ihe.net/ITI/MHD/ITI-106.html#2310643-capabilitystatement-resource)
Es gelten die Vereinbarungen gemäß {{pagelink:ImplementationGuide/markdown/CapabilityStatement.md}}
Es gelten die Vereinbarungen gemäß {{pagelink:ImplementationGuide/markdown/Datenobjekte/CapabilityStatement.md}}

#### [2:3.106.5 Security Considerations](https://profiles.ihe.net/ITI/MHD/ITI-106.html#231065-security-considerations)
Für Hinweise zur Implementierung von Autorisation und Authentifikation im ISiK-Kontext, siehe [Modul ISiK-Sicherheit](https://simplifier.net/isik-sicherheit-v3)
Expand All @@ -41,7 +41,7 @@ Für Hinweise zur Implementierung von Autorisation und Authentifikation im ISiK-
### ISiK-Spezifisches Mapping Composition -> DocumentReference
@```
from StructureDefinition
where url = 'https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenMetadaten'
where url = 'https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten'
for differential.element
select
Path: id,
Expand All @@ -67,22 +67,22 @@ Der Empfänger eines Subsystem-Berichtes gem. Modul "Basis" möchte vor der Vera

Empfohlenes Vorgehen:
1. Erzeugen einer DocumentReference-Ressource (siehe dazu $generate-metadata)
2. Übermittlung der DocumentReference sowie des Base64-codierten Bundles gemäß {{pagelink:ImplementationGuide/markdown/AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung.md, text:Interaktion ISiK Modul Dokumentenaustausch Stufe 2: Dokumentenbereitstellung}}
2. Übermittlung der DocumentReference sowie des Base64-codierten Bundles gemäß {{pagelink:ImplementationGuide/markdown/UebergreifendeFestlegungen/AkteureUndInteraktionen/AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung.md, text:Interaktion ISiK Modul Dokumentenaustausch Stufe 2: Dokumentenbereitstellung}}
3. Extraktion der verarbeitbaren Ressourcen aus dem Bundle
4. Verlinkung zwischen den extrahierten Ressourcen und dem Original-Dokument mittels einer [`Provenance`-Ressource](https://hl7.org/fhir/R4/provenance.html).

Der Sender eines Subsystem-Berichtes gem. Modul "Basis" möchte parallel zur Übermittlung an z.B. ein KIS zur Weiterverarbeitung der Informationen das Dokument ebenfalls im Original archivieren lassen.

Empfohlenes Vorgehen:
1. Erzeugen einer DocumentReference-Ressource (siehe dazu $generate-metadata)
2. Übermittlung der DocumentReference sowie des Base64-codierten Bundles gemäß {{pagelink:ImplementationGuide/markdown/AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung.md, text:Interaktion ISiK Modul Dokumentenaustausch Stufe 2: Dokumentenbereitstellung}}
2. Übermittlung der DocumentReference sowie des Base64-codierten Bundles gemäß {{pagelink:ImplementationGuide/markdown/UebergreifendeFestlegungen/AkteureUndInteraktionen/AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung.md, text:Interaktion ISiK Modul Dokumentenaustausch Stufe 2: Dokumentenbereitstellung}}
3. Übermittlung des Dokumentes zur Verarbeitung gemäß [Interaktion ISiK Modul Basis Stufe 4: Bericht aus Subsystem](https://simplifier.net/guide/isik-basis-v4jek/ImplementationGuide-markdown-Datenobjekte-Datenobjekte_BerichtSubsystem?version=current)


Der Empfänger eines Dokumentes gem. Modul "Dokumentenaustausch" möchte neben der Archivierung des Dokumentes auch dessen Inhalte weiterverarbeiten.

Empfohlenes Vorgehen:
1. Entgegennahme und Persistierung des Original-Dokumentes gemäß {{pagelink:ImplementationGuide/markdown/AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung.md, text:Interaktion ISiK Modul Dokumentenaustausch Stufe 2: Dokumentenbereitstellung}}
1. Entgegennahme und Persistierung des Original-Dokumentes gemäß {{pagelink:ImplementationGuide/markdown/UebergreifendeFestlegungen/AkteureUndInteraktionen/AkteureUndInteraktionen-Interaktion-Dokumentenbereitstellung.md, text:Interaktion ISiK Modul Dokumentenaustausch Stufe 2: Dokumentenbereitstellung}}
1. Extraktion des Bundles aus den eingebetten Binärdaten
2. Extraktion der verarbeitbaren Ressourcen aus dem Bundle
3. Verlinkung zwischen den extrahierten Ressourcen und dem Original-Dokument mittels einer [`Provenance`-Ressource](https://hl7.org/fhir/R4/provenance.html).
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Die Vereinbarungen gelten uneingeschränkt.
Die Vereinbarungen gelten uneingeschränkt.

#### [2:3.105.4.3 CapabilityStatement Resource](https://profiles.ihe.net/ITI/MHD/ITI-105.html#2310543-capabilitystatement-resource)
Es gelten die Vereinbarungen gemäß {{pagelink:ImplementationGuide/markdown/CapabilityStatement.md}}
Es gelten die Vereinbarungen gemäß {{pagelink:ImplementationGuide/markdown/Datenobjekte/CapabilityStatement.md}}

### [2:3.105.5 Security Considerations](https://profiles.ihe.net/ITI/MHD/ITI-105.html#231055-security-considerations)
Für Hinweise zur Implementierung von Autorisation und Authentifikation im ISiK-Kontext, siehe [Modul ISiK-Sicherheit](https://simplifier.net/isik-sicherheit-v3)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
## Interaktion: Update von Metadaten

### Herstellung von Dokumentenkontext
Der Client muss zunächst die URL der DocumentReference ermitteln, auf die das Update angewendet werden soll. Hierzu kann die Interaktion {{pagelink:ImplementationGuide/markdown/AkteureUndInteraktionen-Dokumentenabfrage.md, text:Dokumentenabfrage}} verwendet werden.
Der Client muss zunächst die URL der DocumentReference ermitteln, auf die das Update angewendet werden soll. Hierzu kann die Interaktion {{pagelink:ImplementationGuide/markdown/UebergreifendeFestlegungen/AkteureUndInteraktionen/AkteureUndInteraktionen-Dokumentenabfrage.md, text:Dokumentenabfrage}} verwendet werden.

### Metadatenupdate
Das Update der Metadaten erfolgt mittels der `$update-metadata` Operation.
Expand All @@ -15,7 +15,7 @@ Daher spezifiziert ISiK eine geeignete Operation, die das gezielte Ändern des D

### OperationDefinition `$update-metadata`

{{render:https://gematik.de/fhir/isik/v3/Dokumentenaustausch/OperationDefinition/UpdateMetadata}}
{{render:https://gematik.de/fhir/isik/OperationDefinition/UpdateMetadata}}

### Beispiel

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
],
"type": "DocumentReference",
"supportedProfile": [
"https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenMetadaten"
"https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten"
],
"interaction": [
{
Expand Down Expand Up @@ -197,7 +197,7 @@
}
],
"name": "update-metadata",
"definition": "https://gematik.de/fhir/isik/v3/Dokumentenaustausch/OperationDefinition/UpdateMetadata"
"definition": "https://gematik.de/fhir/isik/OperationDefinition/UpdateMetadata"
},
{
"extension": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"status": "draft",
"publisher": "gematik GmbH",
"date": "2024-04-01",
"url": "https://gematik.de/fhir/isik/v3/Dokumentenaustausch/OperationDefinition/UpdateMetadata",
"url": "https://gematik.de/fhir/isik/OperationDefinition/UpdateMetadata",
"title": "Update document metadata",
"kind": "operation",
"name": "update-metadata",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Usage: #definition
* extension.url = "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
* extension.valueCode = #SHALL
* type = #DocumentReference
* supportedProfile = "https://gematik.de/fhir/isik/v3/Dokumentenaustausch/StructureDefinition/ISiKDokumentenMetadaten"
* supportedProfile = "https://gematik.de/fhir/isik/StructureDefinition/ISiKDokumentenMetadaten"
* interaction[+]
* extension.url = "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"
* extension.valueCode = #SHALL
Expand Down
2 changes: 1 addition & 1 deletion Resources/input/fsh/OperationUpdateMetadata.fsh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ InstanceOf: OperationDefinition
Usage: #example
Title: "update-metadata"
* insert Meta-Inst
* url = "https://gematik.de/fhir/isik/v3/Dokumentenaustausch/OperationDefinition/UpdateMetadata"
* url = "https://gematik.de/fhir/isik/OperationDefinition/UpdateMetadata"
* title = "Update document metadata"
//* status = #draft
* kind = #operation
Expand Down

0 comments on commit 1a4f85b

Please sign in to comment.