diff --git a/README.adoc b/README.adoc index 132f1dea..8ca5e722 100644 --- a/README.adoc +++ b/README.adoc @@ -94,6 +94,7 @@ TI-Messenger Dokumentation | ├──── link:docs/IDP[IDP] | ├──── link:docs/Primaersystem[Primaersystem] | ├──── link:docs/anwendungsfaelle[Anwendungsfälle] +| ├──── link:docs/anwendungsfaelle/COM-chatbot.adoc[Chatbot] | ├──── link:docs/Test/Test.adoc[Testkonzept] | └──── link:docs/FAQ[FAQ] ├─ link:images[images] (Bildarchiv) diff --git a/docs/anwendungsfaelle/COM-AF10057-anmeldung-am-messenger-service.adoc b/docs/anwendungsfaelle/COM-AF10057-anmeldung-am-messenger-service.adoc deleted file mode 100644 index 4bb123cb..00000000 --- a/docs/anwendungsfaelle/COM-AF10057-anmeldung-am-messenger-service.adoc +++ /dev/null @@ -1,46 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10057 - Anmeldung eines Akteurs am Messenger-Service -Mit diesem Anwendungsfall meldet sich ein Akteur an einem in der TI-Föderation zuständigen *Messenger-Service* an und registriert seinen *TI-Messenger-Client* als Endgerät. Der Akteur muss die Matrix-Domain des gewünschten *Messenger-Service* direkt im *TI-Messenger-Client* eingeben können. Die Eingabe kann dabei automatisiert oder durch andere Hilfsmittel wie beispielweise durch ein QR-Code-Scan unterstützt werden. Die Authentifizierung erfolgt hierbei nach den Vorgaben der jeweiligen Organisation. Nach der erfolgreichen Anmeldung eines Akteurs am *Messenger-Service* können die von ihm angebotenen Dienste verwendet werden. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Anmeldung eines Akteurs am Messenger-Service -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Leistungserbringer, Mitarbeiter einer Organisation im Gesundheitswesen in der "Rolle User / User-HBA" -|*Auslöser* |Ein Akteur möchte sich mit seinem TI-Messenger-Client bei einem Messenger-Service anmelden. -|*Komponenten* a| - * TI-Messenger-Client, - * Messenger-Proxy, - * Messenger-Homeserver, - * FHIR-Proxy, - * FHIR-Directory. -|*Vorbedingungen* a| - * Der Akteur verfügt über einen vom Anbieter unterstützen TI-Messenger-Client. - * Der Akteur kennt die URL des Messenger-Services oder die URL ist bereits in seinem TI-Messenger-Client konfiguriert. - * Der Akteur kann sich durch ein beim Matrix-Homeserver unterstütztes Authentisierungsverfahren identifizieren. Wird durch die Organisation ein eigenes Authentifizierungsverfahren verwendet MUSS eine Anbindung an den Matrix-Homeserver erfolgt sein. - * Der verwendete Matrix-Homeserver ist in die Föderation integriert (valider Messenger-Service). -|*Eingangsdaten*|URL des Matrix-Homeservers -|*Ergebnis* | Es wurde ein TI-Messenger Account für einen Akteur in der Rolle "User / User-HBA" erzeugt. -|*Ausgangsdaten* |Matrix-ACCESS_TOKEN, MXID, device_id, Matrix-OpenID-Token, Status -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_10057_Seq.svg[align="center",width="80%"] -==== diff --git a/docs/anwendungsfaelle/COM-AF10061-einladung-ausserhalb.adoc b/docs/anwendungsfaelle/COM-AF10061-einladung-ausserhalb.adoc deleted file mode 100644 index dc39ceb7..00000000 --- a/docs/anwendungsfaelle/COM-AF10061-einladung-ausserhalb.adoc +++ /dev/null @@ -1,47 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10061 - Einladung von Akteuren außerhalb einer Organisation -In diesem Anwendungsfall wird ein Akteur außerhalb einer Organisation eingeladen. Für die Suche von Akteuren außerhalb der Organisation kann das *VZD-FHIR-Directory* verwendet werden. Ist die `MXID` des gesuchten Akteurs dort nicht vorhanden muss es die Möglichkeit geben, die Kontaktaufnahme auch auf andere Wege zu ermöglichen. Es muss mindestens die Kontaktaufnahme mit Hilfe eines QR-Code Scans angeboten werden. Weitere Optionen zur Eingabe der `MXID` (z. B. manuelle Eingabe) sind zulässig. Im Gegensatz zu einer Einladung von Akteuren innerhalb einer Organisation (link:/docs/anwendungsfaelle/COM-AF10104-einladung-innerhalb.adoc[AF_10104 - Einladung von Akteuren innerhalb einer Organisation]), prüft in diesem Anwendungsfall der *Messenger-Proxy* zusätzlich die in *[gemSpec_TI-Messenger-Dienst#3.5]* festgelegten Kriterien der Server-Server Kommunikation (Stufe 1 - 3). - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Einladung von Akteuren außerhalb einer Organisation -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Leistungserbringer, Mitarbeiter einer Organisation im Gesundheitswesen in der "Rolle User / User-HBA" -|*Auslöser* |Akteur A möchte mit Akteur B außerhalb einer Organisation einen gemeinsamen Chatraum einrichten. -|*Komponenten* a| - * TI-Messenger-Client A + B, - * Messenger-Proxy A + B, - * Messenger-Homeserver A + B, - * VZD-FHIR-Directory, - * Push-Gateway B -|*Vorbedingungen* a| - * Die Akteure verfügen über einen zugelassenen TI-Messenger-Client. - * Die Akteure kennen die URL ihres Messenger-Service oder die URL ist bereits in ihren TI-Messenger-Clients konfiguriert. - * Die Akteure sind am Messenger-Services angemeldet - * Die verwendeten Messenger-Services sind Bestandteile der TI-Messenger-Föderation. -|*Eingangsdaten* | Matrix Invite Event -|*Ergebnis* a|Actor A and actor B are both in a shared chat room. -Optionally, a notification is sent to actor B about the invitation to the chat room. -|*Ausgangsdaten* |status -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_10061_Seq.svg[width="100%"] -==== diff --git a/docs/anwendungsfaelle/COM-AF10062-events-ausserhalb.adoc b/docs/anwendungsfaelle/COM-AF10062-events-ausserhalb.adoc deleted file mode 100644 index f4214db8..00000000 --- a/docs/anwendungsfaelle/COM-AF10062-events-ausserhalb.adoc +++ /dev/null @@ -1,43 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10062 - Austausch von Events zwischen Akteuren außerhalb einer Organisation -In diesem Anwendungsfall können Akteure welche sich in einem gemeinsamen Raum befinden Nachrichten austauschen und andere durch die Matrix-Spezifikation festgelegte Aktionen ausführen. Dieser Anwendungsfall setzt ein erfolgreiches `Invite`-Event eines oder mehrerer beteiligter Akteure voraus. Die Prüfung auf Domainzugehörigkeit findet jedoch bei jedem `Event` der Server-Server Kommunikation statt. In diesem Anwendungsfall sind die beteiligten Akteure in einem gemeinsamen Chatraum und auf unterschiedlichen *Messenger-Services* verteilt. - -.AF_10062 Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Austausch von Events zwischen Akteuren außerhalb einer Organisation -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Leistungserbringer, Mitarbeiter einer Organisation im Gesundheitswesen in der Rolle "User / User-HBA" -|*Auslöser* |Alle Matrix-Events die zwischen Messenger-Services unterschiedlicher Organisationen ausgeführt werden. -|*Komponenten* a| - * TI-Messenger-Client A + B, - * Messenger-Proxy A + B, - * Messenger-Homeserver A + B, - * Push-Gateway B -|*Vorbedingungen* a| - * Beide Akteure sind Teilnehmer eines gemeinsamen Raumes - * Die Messenger Proxies verfügen über eine aktuelle Föderationsliste -|*Eingangsdaten* | Matrix-Event -|*Ergebnis* a|Matrix-Event wurde erfolgreich verarbeitet -|*Ausgangsdaten* data |Abhängig vom Matrix-Event, Status -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_10062_Seq.svg[width="100%"] -==== diff --git a/docs/anwendungsfaelle/COM-AF10063-events-innerhalb.adoc b/docs/anwendungsfaelle/COM-AF10063-events-innerhalb.adoc deleted file mode 100644 index 8e1b2c08..00000000 --- a/docs/anwendungsfaelle/COM-AF10063-events-innerhalb.adoc +++ /dev/null @@ -1,44 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10063 - Austausch von Events zwischen Akteuren innerhalb einer Organisation -Dieser Anwendungsfall ermöglicht es Akteuren, welche sich in einem gemeinsamen Raum innerhalb eines *Messenger-Service* befinden, Nachrichten auszutauschen und weitere durch die Matrix-Spezifikation festgelegte Aktionen (`Events`) auszuführen. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Austausch von Events zwischen Akteuren innerhalb einer Organisation -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Aktuer* |Leistungserbringer, Mitarbeiter einer Organisation im Gesundheitswesen in der Rolle "User / User-HBA" -|*Auslöser* |Alle Matrix-Events die innerhalb eines Messenger-Service einer Organisation ausgeführt werden -|*Komponenten* a| - * TI-Messenger-Client A + B, - * Messenger-Proxy, - * Messenger-Homeserver, - * Push-Gateway -|*Vorbedingungen* a| - * Die Akteure sind am selben Messenger-Service angemeldet. - * Jeder Akteur hat einen zugelassenen TI-Messenger-Client. - * Die Teilnehmer sind einem gemeinsamen Raum beigetreten. -|*Eingangsdaten* | Matrix-Event -|*Ergebnis* a|Matrix-Event wurde erfolgreich verarbeitet -|*Ausgangsdaten* |Abhängig vom Matrix-Event -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_10063_Seq.svg[width="100%"] -==== diff --git a/docs/anwendungsfaelle/COM-AF10104-einladung-innerhalb.adoc b/docs/anwendungsfaelle/COM-AF10104-einladung-innerhalb.adoc deleted file mode 100644 index bc6110bd..00000000 --- a/docs/anwendungsfaelle/COM-AF10104-einladung-innerhalb.adoc +++ /dev/null @@ -1,45 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10104 - Einladung von Akteuren innerhalb einer Organisation -In diesem Anwendungsfall wird ein Akteur der zu einer gemeinsamen Organisation gehört in einen Raum eingeladen um Aktionen auszuführen. Für die Suche von Akteuren innerhalb einer gemeinsamen Organisation durchsucht ein *TI-Messenger-Client* das Nutzerverzeichnis seiner Organisation auf dem *Matrix-Homeserver*. In diesem Anwendungsfall prüft der *Messenger-Proxy* gemäß *[gemSpec_TI-Messenger-Dienst#3.5]* der Client-Server Kommunikation, ob die im `Invite`-Event enthaltenen Matrix-Domains Teil der TI-Föderation sind. Ist dies der Fall erfolgt die Weiterleitung an den *Matrix-Homeserver* des Einladenden. Dieser prüft ob die beteiligten Akteure bei ihm registriert sind. Ist dies nicht der Fall, handelt es sich bei dem einzuladenden Akteur nicht um einen Akteur innerhalb der Organisation und das `Invite`-Event wird für die externe Zustellung weitergeleitet. Der Anwendungsfall link:/docs/anwendungsfaelle/COM-AF10061-einladung-ausserhalb.adoc[AF_10061 - Einladung von Akteuren außerhalb einer Organisation] zeigt den sich daraus ergebenden Verlauf. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Einladung von Akteuren innerhalb einer Organisation -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Leistungserbringer, Mitarbeiter einer Organisation im Gesundheitswesen in der Rolle "User / User-HBA" -|*Auslöser* |Akteur A möchte Akteur B seiner Organisation in einen gemeinsamen Raum einladen. -|*Komponenten* a| - * TI-Messenger-Client A + B, - * Messenger-Proxy, - * Messenger-Homeserver, - * Push-Gateway -|*Vorbedingungen* a| - * Die Akteure sind am selben Messenger-Service angemeldet. - * Jeder Akteur hat einen zugelassenen TI-Messenger-Client. - * Ein Chatraum wurde durch den Einladenden eingerichtet. -|*Eingangsdaten* | Matrix Invite-Event -|*Ergebnis* a| Akteur A und Akteur B sind beide in einem gemeinsamen Chatraum. - Optional erfolgt eine Benachrichtigung an Akteur B über die Einladung in den Chatraum. -|*Ausgangsdaten* |status -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_10104_Seq.svg[width="100%"] -==== diff --git a/docs/anwendungsfaelle/MS-AF10060-bereitstellung-messenger-service.adoc b/docs/anwendungsfaelle/MS-AF10060-bereitstellung-messenger-service.adoc deleted file mode 100644 index c3e4d63c..00000000 --- a/docs/anwendungsfaelle/MS-AF10060-bereitstellung-messenger-service.adoc +++ /dev/null @@ -1,48 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10060 - Bereitstellung eines Messenger-Service für eine Organisation -Mit diesem Anwendungsfall wird einer zuvor am *Registrierungs-Dienst* authentifizierten Organisation ein *Messenger-Service* für diese Organisation durch einen Akteur in der Rolle "Org-Admin" bereitgestellt. Die Beantragung zur Bereitstellung eines *Messenger-Service* wird durch den Akteur in der Rolle "Org-Admin" am *Frontend des Registrierungs-Dienstes* vorgenommen. Dieser MUSS sich zuvor mit dem Admin-Account der Organisation am *Registrierungs-Dienst* anmelden. Für eine zeitnahe Adaption des *TI-Messenger-Dienstes* MUSS eine schnelle Bereitstellung von *Messenger-Services* gewährleistet sein. Anbieter eines *TI-Messenger-Fachdienstes* sind verpflichtet, Prozesse zu etablieren, damit *Messenger-Services* für Organisationen schnell und ggf. automatisiert bereitgestellt werden können. Nach erfolgreicher Bereitstellung eines *Messenger-Service* wird dieser in die Föderation des *TI-Messenger-Dienstes* aufgenommen. Werden mehrere *Messenger-Services* für eine Organisation benötigt kann dieser Anwendungsfall mehrfach ausgeführt werden. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Bereitstellung eines Messenger-Service für eine Organisation -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Beauftragter Mitarbeiter einer Organisation in der Rolle "Org-Admin" -|*Auslöser* |Eine Organisation des deutschen Gesundheitswesen möchte am TI-Messenger-Dienst teilnehmen und benötigt die Bereitstellung eines oder mehrerer Messenger-Services -|*Komponenten* a| - * Frontend des Registrierungs-Dienstes, - * Registrierungs-Dienst, - * VZD-FHIR-Directory, - * Messenger-Service -|*Vorbedingungen* a| - * Es besteht ein Vertragsverhältnis mit einem TI-Messenger-Anbieter. - * Der Akteur verfügt über ein Frontend des Registrierungs-Dienstes für die Kommunikation mit dem Registrierungs-Dienst. - * Das verwendete Frontend des Registrierungs-Dienstes ist beim zentralen IDP-Dienst registriert. - * Die Organisation ist erfolgreich beim Registrierungs-Dienst authentifiziert und ein Admin-Account ist vorhanden. - * Der Registrierungs-Dienst kann sich beim VZD-FHIR-Directory Server für Schreibzugriffe mit OAuth2 authentisieren. -|*Eingangsdaten* |Admin-Account, Identität der Organisation (SMC-B) -|*Ergebnis* a| - * Der Messenger-Service für die Organisation wurde erstellt. - * Die Matrix-Domain des neuen Messenger-Services wurde als Endpunkt im VZD-FHIR-Directory eingetragen und in die Föderation aufgenommen. -|*Ausgangsdaten* |Neuer Messenger-Service für die Organisation, Status -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_10060_Seq.svg[width="100%"] -==== diff --git a/docs/anwendungsfaelle/MS-AF10064-foederation-pruefen.adoc b/docs/anwendungsfaelle/MS-AF10064-foederation-pruefen.adoc deleted file mode 100644 index 7a7caed0..00000000 --- a/docs/anwendungsfaelle/MS-AF10064-foederation-pruefen.adoc +++ /dev/null @@ -1,39 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10064 - Föderationszugehörigkeit eines Messenger-Service prüfen -Dieser Anwendungsfall prüft gemäß *[gemSpec_TI-Messenger-Dienst#3.5]* die im Berechtigungskonzept festgelegten Kriterien für die Stufe 1 der Client-Server und Server-Server Kommunikation, ob ein *Messenger-Service* zugehörig zur TI-Messenger-Föderation ist und gilt für alle Anwendungsfälle, welche die Matrix-Domain eines *Messenger-Services* überprüfen müssen. Für die Prüfung der Zugehörigkeit der Matrix-Domain zur TI-Messenger-Föderation, verwendet der *Messenger-Proxy* eine Föderationsliste, die vom *Registrierungs-Dienst* seines *TI-Messenger-Fachdienstes* bereitgestellt wird. Die Speicherdauer der Föderationsliste des *Messenger-Proxies* ist limitiert. Die Aktualisierung der Föderationsliste erfolgt gemäß *[gemSpec_TI-Messenger-Dienst#8.2]*. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Föderationszugehörigkeit eines Messenger-Service prüfen -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |- -|*Auslöser* |Der Messenger-Proxy empfängt oder sendet ein Matrix-Event und MUSS die im Request enthaltenen MXIDs auf Domain-Zugehörigkeit zur TI-Messenger-Föderation prüfen. -|*Komponenten* a| - * Messenger-Proxy, - * Matrix-Homeserver -|*Vorbedingungen* a| keine -|*Eingangsdaten* |Matrix-Event -|*Ergebnis* a|Der Messenger-Proxy ermittelt mittels der Föderationsliste, ob die Matrix-Domain des anderen Messenger-Service Teil der TI-Messenger-Föderation ist. -|*Ausgangsdaten* |Status vom Matrix-Homeserver und Weiterleitung -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_10064_Seq.svg[align="center",width="80%"] -==== diff --git a/docs/anwendungsfaelle/MS-AF10103-authentisieren-organisation.adoc b/docs/anwendungsfaelle/MS-AF10103-authentisieren-organisation.adoc deleted file mode 100644 index 3ab90b3e..00000000 --- a/docs/anwendungsfaelle/MS-AF10103-authentisieren-organisation.adoc +++ /dev/null @@ -1,55 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10103 - Authentisieren einer Organisation am TI-Messenger-Dienst -Mit diesem Anwendungsfall authentisiert ein Akteur, in der Rolle "Org-Admin", seine Organisation bei einem Anbieter eines *TI-Messenger-Dienestes*. Für die Authentisierung einer Organisation stellt der *TI-Messenger-Fachdienst* die Schnittstelle `I_Registration` an seinem *Registrierungs-Dienst* bereit. Diese wird über das *Frontend des Registrierungs-Dienstes* für die Authentisierung verwendet. Die Authentisierung der Organisation erfolgt individuell und nutzungsabhängig durch einen Akteur in der Rolle "Org-Admin". Durch die Authentifizierung MUSS der Besitz einer gültigen SMC-B nachgewiesen werden, da nur Organisationen des Gesundheitswesens berechtigt sind einen *Messenger-Service* zu erhalten. Als Nachweis MUSS eins der folgenden Verfahren verwendet werden. Für die Verifizierung der Organisation MUSS - -* Verfahren 1: bei der Authentisierung am *zentralen IDP-Dienst* eine freigeschaltete SMC-B verwendet werden oder -* Verfahren 2: eine KIM-Nachricht an die Adresse der Organisation mit der freigeschalteten SMC-B gesendet werden. - -Als Nachweis zur Prüfung auf eine gültige Organisation MUSS der *Registrierungs-Dienst* in beiden Verfahren prüfen, ob die `ProfessionOID` zu einer Organisation des Gesundheitswesens gehört. Bei erfolgreicher Verifizierung der Organisation wird ein Administrator-Account für die Organisation am *Registrierungs-Dienst* angelegt. Dies ermöglicht es einem Administrator *Messenger-Services* zu registrieren und seiner Organisation am *TI-Messenger-Dienst* teilzunehmen. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Authentisieren einer Organisation am TI-Messenger-Dienst -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Beauftragter Mitarbeiter einer Organisation in der Rolle "Org-Admin" -|*Auslöser* |Eine Organisation des deutschen Gesundheitswesens möchte am TI-Messenger-Dienst teilnehmen und benötigt die Berechtigung einen Messenger-Service zu registrieren -|*Komponenten* a| - * Frontend des Registrierungs-Dienstes, - * Authenticator (Optional bei Verfahren 2), - * Konnektor, - * eHealth Kartenterminal mit gesteckter SMC-B, - * Registrierungs-Dienst, - * zentraler IDP-Dienst (Optional bei Verfahren 2) - * KIM-Clientmodul und Mailclient (Optional bei Verfahren 1) -|*Vorbedingungen* a| - * Der Akteur kann über ein Frontend des Registrierungs-Dienstes für die Kommunikation auf den Registrierungs-Dienst zugreifen. - * Verifizierung der Organisation: - ** Verfahren 1: Der Akteur kann den Authenticator verwenden sowie das verwendete Frontend des Registrierungs-Dienstes, welches beim zentralen IDP-Dienst registriert ist. - ** Verfahren 2: Der Anbieter des TI-Messenger verfügt über eine SMC-B Org und eine KIM-Adresse sowie ein eHealth Kartenterminal und einen Konnektor mit TI-Zugang. Der Akteur verfügt über eine SMC-B und eine KIM-Adresse sowie ein eHealth Kartenterminal und einen Konnektor mit TI-Zugang. - * Die im eHealth Kartenterminal gesteckte SMC-B ist freigeschaltet. -|*Eingangsdaten* |Identität der Organisation, SMC-B, Alternativ KIM-Adresse -|*Ergebnis* a|Die Organisation wurde am Registrierungs-Dienst des TI-Messenger-Fachdienstes verifiziert -|*Ausgangsdaten* |Admin-Account, Status -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_10103_Seq.svg[width="100%"] -==== - diff --git a/docs/anwendungsfaelle/MS-aktualisierung-foederationsliste.adoc b/docs/anwendungsfaelle/MS-aktualisierung-foederationsliste.adoc deleted file mode 100644 index 00477cef..00000000 --- a/docs/anwendungsfaelle/MS-aktualisierung-foederationsliste.adoc +++ /dev/null @@ -1,74 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== A 8.2 - Aktualisierung der Föderationsliste -Die folgende Sequenz beschreibt, wie der *Messenger-Proxy* seine lokal vorgehaltene Föderationsliste aktualisiert. Für die Aktualisierung der Föderationsliste MUSS der *Messenger-Proxy* diese beim *Registrierungs-Dienst* seines *TI-Messenger-Fachdienstes* anfragen. Die Häufigkeit der Anfrage einer neuen Liste wird durch den Anbieter festgelegt, Ziel sollte eine möglichst aktuelle Föderationsliste sein. Hierbei übergibt der *Messenger-Proxy* die durch ihn gespeicherte Version der Föderationsliste im Aufruf an den *Registrierungs-Dienst*. Bei Übereinstimmung der Version wird für den *Messenger-Proxy* keine neue Föderationsliste durch den *Registrierungs-Dienst* bereitgestellt. Ist die Version größer als die vom *Messenger-Proxy* übergebene, dann wird durch den *Registrierungs-Dienst* eine aktualisierte Föderationsliste zur Verfügung gestellt. Bei jeder Anfrage eines *Messenger-Proxys* beim *Registrierungs-Dienst* nach einer aktuellen Föderationsliste muss der *Registrierungs-Dienst* die Aktualität der durch ihn ausgelieferten Liste sicherstellen, indem er die von ihm gespeicherte Version der Föderationsliste im Bedarfsfall mit einer aktuelleren Version, die vom *FHIR-Proxy* bezogen wurde, überschreibt. Ein Download der Föderationsliste ist nur notwendig, wenn eine neuere Version auf dem *FHIR-Proxy* existiert. Die Struktur der Föderationsliste ist in https://github.com/gematik/api-vzd/blob/develop/src/schema/FederationList.json[JSON-Schemadefinition] beschrieben. Nach dem Abruf der Föderationsliste vom *Registrierungs-Dienst*, durch den *Messenger-Proxy*, muss dieser die Signatur der Föderationsliste prüfen. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Aktualisierung der Föderationsliste -[%header, cols="1,2"] -|=== -| |Beschreibung -|*Akteur* |System -|*Auslöser* a| - * Scheduler - * Schnittstellenaufruf -|*Komponenten* a| - * Messenger-Proxy, - * Registrierungs-Dienst, - * FHIR-Proxy, - * Auth-Service -|*Vorbedingungen* a| keine -|*Eingangsdaten* | Versionsnummer -|*Ergebnis* | Der Messenger-Proxy erhält die Information eine aktuelle Liste zu besitzen oder eine neue Föderationsliste, sofern eine aktuellere Version vorliegt. -|*Ausgangsdaten* |status, Föderationsliste, x5c-Zertifikatsliste -|=== -==== - -.Sequenzdiagramm "Föderationsliste aktualisieren" -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_Update_Federationlist_Seq.svg[width="100%"] -==== - -[caption=] -Variablen, die vom Registrierungsdienst unterstützt werden. -[%header, cols="1,1,2,1"] -|=== -|Name|Type|Beschreibung|Wertebereich -|`HealthState_VZD`|state|Hält den Gesundheitsstatus von Komponenten des VZD-FHIR-Directory in Abhängigkeit vom erhaltenen Antwortverhalten|[gesund, ungesund] -|`HealthStateCheck_VZD`|Counter|Hält die Anzahlt der Versuche den Gesundheitsstatus des VZD-FHIR-Directory zu ermitteln|0\<= `HealthStateCheck_VZD`\<=3 -|`Alter_Föderationsliste`|Time in s |Hält das aktuelle Alter der Föderationsliste in Sekunden seit der letzten erfolgreichen Aktualisierung. -|min: 0s -|`TTL_Föderationsliste`|Time in h|Beschreibt das maximal erlaubte Alter der Föderationsliste.|Fester Wert: 72h -|=== - -Das in der Abbildung "Laufzeitansicht - Aktualisierung der Föderationsliste" referenzierte -Sequenzdiagramm "Provider authentifizieren und Föderationsliste abrufen": - -.Sequenzdiagramm "Provider authentifizieren und Föderationsliste abrufen" -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_Update_Federationlist_auth_retrieve.svg[width="100%"] -==== - -Das in der Abbildung "Laufzeitansicht - Aktualisierung der Föderationsliste" referenzierte -Sequenzdiagramm "Signatur der Föderationsliste prüfen": - -.Sequenzdiagramm "Signatur der Föderationsliste prüfen" -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_Update_Federationlist_SignCheck.svg[align="center",width="60%"] -==== diff --git a/docs/anwendungsfaelle/MS-stufen-berechtigungspruefung.adoc b/docs/anwendungsfaelle/MS-stufen-berechtigungspruefung.adoc deleted file mode 100644 index 5e211ed6..00000000 --- a/docs/anwendungsfaelle/MS-stufen-berechtigungspruefung.adoc +++ /dev/null @@ -1,65 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== A 8.3 - Stufen der Berechtigungsprüfung -Die folgende Sequenz beschreibt, wie die Berechtigungsprüfung eingehender und ausgehender `Matrix-Events` am *Messenger-Proxy* erfolgen muss. Das Berechtigungskonzept basiert auf einer dreistufigen Prüfung. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Stufen der Berechtigungsprüfung -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Messenger-Proxy -|*Auslöser* | Matrix-Event -|*Komponenten* a| - * TI-Messenger-Client - * Messenger-Proxy A+B, - * Matrix-Homeserver A+B, - * Registrierungs-Dienst, - * VZD-FHIR-Directory -|*Vorbedingungen* a| Der Akteur ist bei seinem Homeserver angemeldet. -|*Eingangsdaten* |Matrix Event -|*Ergebnis* a|Der TI-Messenger-Client erhält die Information, ob die Einladung erfolgreich prozessiert werden konnte. -|*Ausgangsdaten* |status -==== -.sequence diagram -[%collapsible%open] -==== -image:generated/TI-M_Basis/UC_Approvel_List_Seq.svg[width="100%"] -==== - -== Ablauf -=== Prüfregeln Client-Server Kommunikation -==== Stufe 1 - Prüfung der TI-Föderationszugehörigkeit -* Bei der Client-Server Kommunikation prüft der *Messenger-Proxy* im `Invite`- und `createRoom`-Event enthaltene Matrix-Domains auf Föderationszugehörigkeit. Hierbei ist zu beachten, dass beim `createRoom`-Event das Attribut `invite` nur mit maximal einem Element befüllt sein darf. Nach erfolgreicher Prüfung wird das Event an den *Matrix-Homeserver* des Einladenden weitergeleitet. Der *Matrix-Homeserver* prüft daraufhin, ob die beteiligten Akteure auf demselben *Matrix-Homeserver* registriert sind. Ist dies nicht der Fall, wird das `Invite`-Event an den zuständigen *Messenger-Proxy* des Einzuladenden gerichtet, wobei die Regeln der Server-Server Kommunikation durchzuführen sind. - -=== Prüfregeln Server-Server Kommunikation -Der *Messenger-Proxy* muss Prüfregeln für Server-Server Anfragen unterstützen und bei jedem `Event` den Inhalt der Anfrage prüfen. Im Folgenden werden die Prüfregeln beschrieben. - -==== Stufe 1 - Prüfung der TI-Föderationszugehörigkeit -* In der 1. Stufe der Server-Server Kommunikation muss der *Messenger-Proxy* für alle `Events` eine Prüfung durchführen, die feststellt, ob die im `Event` enthaltenen Matrix-Domains zur TI-Föderation gehören. Zur Prüfung der Föderationszugehörigkeit muss der *Messenger-Proxy* im `Authorization-Header` die im Attribut `origin` enthaltene Domain (bei eingehender Kommunikation) und die im Attribut `destination` enthaltene Domain (bei ausgehender Kommunikation) gegen die Domains in der Föderationsliste prüfen. Bei erfolgreicher Prüfung erfolgt dann die Weiterverarbeitung gemäß der Stufe 2. - -==== Stufe 2 - Prüfung der Freigabeliste -* In dieser Stufe prüft der *Messenger-Proxy* des Einzuladenden auf eine vorliegende Freigabe. Hierbei handelt es sich um eine Lookup-Table, in der alle erlaubten Akteure hinterlegt sind, von denen man eine Einladung in einen Chatraum akzeptiert. Ist ein Eintrag vom einladenden Akteur vorhanden, dann muss die beabsichtigte Einladung des Akteurs zugelassen werden. Ist dies nicht der Fall, muss die weitere Überprüfung gemäß der 3. Stufe erfolgen. - -==== Stufe 3 - Prüfung auf existierenden VZD-FHIR-Directory Eintrag -* In der letzten Stufe erfolgt die Prüfung ausgehend von den Einträgen der beteiligten Akteure im *VZD-FHIR-Directory*. Die Einladung muss zugelassen werden, wenn: - -* die `MXID` des einzuladenden Akteurs im Organisationsverzeichnis hinterlegt und seine Sichtbarkeit in diesem Verzeichnis nicht eingeschränkt ist oder -* der einladende sowie der einzuladende Akteur im Personenverzeichnis hinterlegt sind und der einzuladende Akteur seine Sichtbarkeit in diesem Verzeichnis nicht eingeschränkt hat. - -Ist die Prüfung nicht erfolgreich, dann muss die beabsichtigte Einladung des Akteurs vom *Messenger-Proxy* abgelehnt werden. - - diff --git a/docs/anwendungsfaelle/TI-M_ePA/MS-AF10233-versicherteneinladung-unterbinden.adoc b/docs/anwendungsfaelle/TI-M_ePA/MS-AF10233-versicherteneinladung-unterbinden.adoc deleted file mode 100644 index 329eed9e..00000000 --- a/docs/anwendungsfaelle/TI-M_ePA/MS-AF10233-versicherteneinladung-unterbinden.adoc +++ /dev/null @@ -1,37 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10233 - Versicherteneinladung unterbinden -Dieser Anwendungsfall erweitert die in der TI-M_Basis definierte Prüflogik für den Messenger-Proxy, neben der Föderationsprüfung ist zusätzlich zu prüfen, dass der Einladende und der Eingeladene nicht der Gruppe Versicherte zuzuordnen sind. Für die Prüfung der Zugehörigkeit verwendet der Messenger-Proxy die Information isInsurance aus der Föderationsliste. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Versicherteneinladung unterbinden -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Auslöser* |Anfrage am Messenger Proxy -|*Komponenten* a| - * Messenger-Proxy -|*Vorbedingungen* a| Die Domain wurde in die Föderationsliste eingetragen und als Versichertendomain markiert. -|*Eingangsdaten* |Matrix-Invite-Event -|*Ergebnis* a|Ablehnung der Einladung, wenn Sender und der Empfänger beide Akteure in der Rolle Versicherter sind. -Weiterleitung der Einladung, wenn der Sender oder der Empfänger kein Akteur in der Rolle Versicherter ist. -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_ePA/UC_10233_Seq.svg[align="center",width="80%"] -==== diff --git a/docs/anwendungsfaelle/TI-Messenger-Anwendungsfaelle.adoc b/docs/anwendungsfaelle/TI-Messenger-Anwendungsfaelle.adoc index 2c163fe7..014a1ab4 100644 --- a/docs/anwendungsfaelle/TI-Messenger-Anwendungsfaelle.adoc +++ b/docs/anwendungsfaelle/TI-Messenger-Anwendungsfaelle.adoc @@ -17,43 +17,10 @@ image:meta/gematik_logo.svg[width=70%] toc::[] = Anwendungsfälle -Die folgende Seite gibt einen Überblick über die Anwendungsfälle des *TI-Messenger-Dienstes* die in *[gemSpec_TI-Messenger-Dienst]* beschrieben sind. Neben einer Einleitung enthält jedes Kapitel einen Link zu einer detaillierten Anwendungsfallbeschreibung und einem Sequenzdiagramm, das die Interaktion zwischen den beteiligten Komponenten visualisiert. +Die folgende Seite gibt einen Überblick über die Anwendungsfälle des *TI-Messengers* aus den Spezifikationen für die Produkte *TI-M ePA*, *TI-M Pro* und *TI-M Connect*. -TIP: Die Serviceaufrufe in den Sequenzdiagrammen enthalten möglicherweise nicht alle für den Aufruf erforderlichen Parameter. Die Sequenzdiagramme umfassen möglicherweise auch nicht alle Fehlerfälle. Sie konzentrieren sich auf die häufigsten Fehler für jeden einzelnen Anwendungsfall. +== Anwendungsfälle TI-M ePA -== Bereitstellung und Administration eines Messenger-Service -Um mit anderen Akteuren Nachrichten austauschen zu können, benötigt die Organisation einen *Messenger-Service* von einem Anbieter eines *TI-Messenger-Fachdienstes*. Die folgenden Anwendungsfälle erläutern die Bereitstellung eines: *Messenger-Service*, die Föderations-Prüfungen, die Verwaltung der Föderationsliste sowie die verschiedenen Ebenen der Berechtigungsprüfungen. +== Anwendungsfälle TI-M Pro -* link:MS-AF10103-authentisieren-organisation.adoc[AF_10103 - Authentisieren einer Organisation am TI-Messenger-Dienst] - -* link:MS-AF10060-bereitstellung-messenger-service.adoc[AF_10060 - Bereitstellung eines Messenger-Service für eine Organisation] - -* link:COM-AF10057-anmeldung-am-messenger-service.adoc[AF_10057 - Anmeldung eines Akteurs am Messenger-Service] - -* link:MS-AF10064-foederation-pruefen.adoc[AF_10064 - Föderationszugehörigkeit eines Messenger-Service prüfen] - -* link:MS-aktualisierung-foederationsliste.adoc[A 8.2 - Aktualisierung der Föderationsliste] - -* link:MS-stufen-berechtigungspruefung.adoc[A 8.3 - Stufen der Berechtigungsprüfung] - -== Interaktion mit dem VZD-FHIR-Directory -Das *VZD-FHIR-Directory* ist das zentrale Adressbuch für Organisationen und Personen im deutschen Gesundheitswesen. In den folgenden Anwendungsfällen wird detailliert erläutert, was erforderlich ist, um die Organisations- oder Practitioner-Informationen im *VZD-FHIR-Directory* - im Kontext des *TI-Messenger-Dienstes* - zu ändern bzw. um FHIR-Ressourcen zu suchen. - -* link:VZD-AF10059-organisation-hinzufuegen.adoc[AF_10059 - Organisationsressourcen im Verzeichnisdienst hinzufügen] - -* link:VZD-AF10058-practitioner-hinzufuegen.adoc[AF_10058 - Akteur (User-HBA) im Verzeichnisdienst hinzufügen] - -* link:VZD-suche.adoc[A 8.1 - Einträge im VZD-FHIR-Directory suchen] - -== Interaktion zwischen Akteuren -Die folgenden Anwendungsfälle beschreiben den Anmeldevorgang, die Einladung anderer Akteure sowie den Austausch von Nachrichten. Sowohl die Einladungen als auch der Nachrichtenaustausch werden aus zwei Perspektiven erklärt. Die erste Perspektive konzentriert sich auf die Kommunikation innerhalb einer Organisation, die zweite Perspektive zeigt die Abläufe für eine Kommunikation mit mehr als einem beteiligten *Matrix-Homeserver*. - -* link:COM-AF10104-einladung-innerhalb.adoc[AF_10104 - Einladung von Akteuren innerhalb einer Organisation] - -* link:COM-AF10063-events-innerhalb.adoc[AF_10063 - Austausch von Events zwischen Akteuren innerhalb einer Organisation] - -* link:COM-AF10061-einladung-ausserhalb.adoc[AF_10061 - Einladung von Akteuren außerhalb einer Organisation] - -* link:COM-AF10062-events-ausserhalb.adoc[AF_10062 - Austausch von Events zwischen Akteuren ausserhalb einer Organisation] - -* link:COM-chatbot.adoc[Kommunikation mit einem Chatbot] +== Anwendungsfälle TI-M Connect diff --git a/docs/anwendungsfaelle/VZD-AF10058-practitioner-hinzufuegen.adoc b/docs/anwendungsfaelle/VZD-AF10058-practitioner-hinzufuegen.adoc deleted file mode 100644 index 6874b10e..00000000 --- a/docs/anwendungsfaelle/VZD-AF10058-practitioner-hinzufuegen.adoc +++ /dev/null @@ -1,47 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10058 Akteur - (User-HBA) im Verzeichnisdienst hinzufügen -Mit diesem Anwendungsfall wird ein Akteur in der Rolle "User-HBA" für andere Akteure anderer *Messenger-Services* auffindbar und erreichbar. Dafür werden FHIR-Ressourcen mit ihrer jeweiligen `MXID` im Personenverzeichnis (`PractitionerRole`) des *VZD-FHIR-Directory* hinterlegt. Zusätzlich besteht die Möglichkeit die Sichtbarkeit für andere Akteure einzuschränken. Dieser Anwendungsfall kann direkt mit dem initialen Anmeldevorgang eines Akteurs am *Messenger-Service* (siehe Anwendungsfall: link:/docs/anwendungsfaelle/COM-AF10057-anmeldung-am-messenger-service.adoc[AF_10057 - Anmeldung eines Akteurs am Messenger-Service]) kombiniert werden. Hierfür wird der Akteur in der Rolle "User-HBA" während des Anmeldevorgangs durch den *TI-Messenger-Client* gefragt, ob dieser im Besitz eines HBAs ist. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Akteur (User-HBA) im Verzeichnisdienst hinzufügen -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Leistungserbringer, Mitarbeiter einer Organisation im Gesundheitswesen in der Rolle "User-HBA" -|*Auslöser* |Ein Akteur in der Rolle "User-HBA" möchte sich im Personenverzeichnis erreichbar machen, indem er seine MXID im seinen Practitioner-Datensatz im VZD-FHIR-Directory hinterlegt. -|*Komponenten* a| - * TI-Messenger-Client, - * Authenticator, - * zentraler IDP-Dienst, - * FHIR-Proxy, - * Auth-service, - * VZD-FHIR-Directory, -|*Vorbedingungen* a| - * Der Akteur ist bei einem gültigen Messenger-Service angemeldet. - * Der Akteur verfügt über einen zugelassenen TI-Messenger-Client. - * Das VZD-FHIR-Directory ist beim zentralen IDP-Dienst registriert. - * Der Akteur kann sich am zentralen IDP-Dienst authentisieren. -|*Eingangsdaten* |HBA, FHIR-Practitioner-Ressourcen -|*Ergebnis* |FHIR-Practitioner-Ressourcen aktualisiert, Status -|*Ausgangsdaten* |aktualisierter Practitioner-Datensatz -|=== -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/Other/UC_10058_Seq.svg[width="100%"] -==== diff --git a/docs/anwendungsfaelle/VZD-AF10059-organisation-hinzufuegen.adoc b/docs/anwendungsfaelle/VZD-AF10059-organisation-hinzufuegen.adoc deleted file mode 100644 index 1198ad8c..00000000 --- a/docs/anwendungsfaelle/VZD-AF10059-organisation-hinzufuegen.adoc +++ /dev/null @@ -1,47 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== AF_10059 - Organisationsressourcen im Verzeichnisdienst hinzufügen -Mit diesem Anwendungsfall macht ein Akteur in der Rolle "Org-Admin" Akteure seiner Organisation im *TI-Messenger-Dienst* für andere Akteure auffindbar und erreichbar. Dafür werden Endpoint-Ressourcen mit ihrer jeweiligen `MXID` im Organisationsverzeichnis (`HealthcareService`) des *VZD-FHIR-Directory* hinterlegt. Organisationen können mehrere FHIR-Ressourcen pro Organisation administrieren und somit eingehende Kommunikationsprozesse organisatorisch und thematisch strukturieren (siehe *[gemSpec_VZD_FHIR_Directory]*). - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Organisationsressourcen im Verzeichnisdienst hinzufügen -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Beauftragter Mitarbeiter einer Organisation in der Rolle "Org-Admin" -|*Auslöser* |Der Administrator der Organisation (Org-Admin) möchte seine Organisation erreichbar machen indem die MXIDs der Akteure der Organisation im VZD-FHIR-Directory hinterlegt werden. -|*Komponenten* a| - * TI-Messenger-Client (mit erweiterter Org-Admin Funktionalität), - * TI-Messenger Registrierungs-Dienst - * Auth-Service - * FHIR-Proxy - * FHIR-Directory -|*Vorbedingungen* a| - * Für die Organisation wurde ein Messenger-Service bereitgestellt und es existiert ein Eintrag der Organisation im FHIR-Directory. - * Der Administrator der Organisation verfügt über einen TI-Messenger-Client (mit erweiterter Org-Admin Funktionalität). - * Es existiert eine Vertrauensbeziehung zwischen dem TI-Messenger Registrierungs-Dienst und dem VZD-FHIR-Directory (Übergabe des Zertifikates) - * Der Administrator der Organisation wurde vom Registrierungs-Dienst authentifiziert. -|*Eingangsdaten* | Org-Admin-Credentials, zweiter Faktor, FHIR-Organisations-Ressourcen -|*Ergebnis* | FHIR-Organisations-Ressourcen aktualisiert, Status -|*Ausgangsdaten* | Aktualisierte VZD-FHIR-Directory-Datensätze -|=== -==== - -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/TI-M_Pro/UC_10059_Seq.svg[width="100%"] -==== diff --git a/docs/anwendungsfaelle/VZD-suche.adoc b/docs/anwendungsfaelle/VZD-suche.adoc deleted file mode 100644 index dd81da8a..00000000 --- a/docs/anwendungsfaelle/VZD-suche.adoc +++ /dev/null @@ -1,48 +0,0 @@ -ifdef::env-github[] -:tip-caption: :bulb: -:note-caption: :information_source: -:important-caption: :heavy_exclamation_mark: -:caution-caption: :fire: -:warning-caption: :warning: -endif::[] - -:imagesdir: ../../images - -image:meta/gematik_logo.svg[width=70%] - -=== A 8.1 - Einträge im VZD-FHIR-Directory suchen -Die folgende Sequenz beschreibt, wie ein Akteur im *VZD-FHIR-Directory* nach `HealthcareService`- und `PractitionerRole`-Ressourcen sucht. Dies setzt eine erfolgreiche Anmeldung des Akteurs an einem *Messenger-Service* voraus. Der dargestellte Ablauf zeigt alle prinzipiell notwendigen Kommunikationsbeziehungen. Weitergehende Informationen zum Ablauf sind in der *[gemSpec_VZD_FHIR_Directory]* zu finden. Für die Prüfung des `Matrix-OpenID-Tokens` muss der Zugriff auf den Endpunkt `/_matrix/federation/v1/openid/userinfo` ermöglicht werden. - -.Anwendungsfallbeschreibung -[%collapsible%open] -==== -[caption=] -Einträge im VZD-FHIR-Directory suchen -[%header, cols="1,1"] -|=== -| |Beschreibung -|*Akteur* |Anwender in der Rolle "User/User-HBA" -|*Auslöser* |Ein Akteur in der Rolle "User"/"User-HBA" setzt eine Suche ab. -|*Komponenten* a| - * TI-Messenger-Client, - * Messenger-Proxy, - * Matrix-Homeserver - * FHIR-Proxy, - * Auth-Service, - * VZD-FHIR-Directory, -|*Vorbedingungen* a| - * Der Akteuer ist bei seinem Homeserver eingeloggt. - * Dem Matrix Homeserver wird vom VZD-FHR-Directory vertraut. - * Der Aktuer darf sich mit seinem Matrix-OpenID-Token authentisieren. - * Der Messenger-Proxy erlaubt dem VZD-FHIR-Directory Zugriff auf /_matrix/federation/v1/openid/userinfo, um den Token prüfen zu lassen. -|*Eingangsdaten* |Search, Matrix OpenID Token -|*Ergebnis* | Die gesuchten FHIR-Resourcen. -|*Ausgangsdaten* | FHIR Datensätze -|=== - -==== -.Sequenzdiagramm -[%collapsible%open] -==== -image:generated/Other/UC_Directory_search_Seq.svg[width="100%"] -====