Merge pull request #261 from gematik/vzd_documentation

changed references to fhir-vzd documenation & removed our page

README.adoc

@@ -68,9 +68,9 @@ link:docs/Client/Client.adoc[*TI Messenger-Client*] +
 
 * Der *TI-Messenger-Client* basiert auf der `Matrix-Client-Server API`. Er wird durch weitere Funktionsmerkmale erweitert und ruft die Schnittstellen am *TI-Messenger-Fachdienst* sowie am *VZD-FHIR-Directory* auf.
 
-link:docs/FHIR-Directory/FHIR-Directory.adoc[*VZD-FHIR-Directory*] +
+link:https://github.com/gematik/api-vzd/blob/main/docs/Fachkonzept_FHIR-Directory.adoc[*VZD-FHIR-Directory*] +
 
-* Beim *VZD-FHIR-Directory* handelt es sich um einen zentralen Verzeichnisdient der TI, der die deutschlandweite Suche von Organisationen und Akteuren des *TI-Messenger-Dienstes* ermöglicht. Das *VZD-FHIR-Directory* basiert auf dem FHIR-Standard und bietet für den *TI-Messenger-Dienst* relevante Schnittstellen an. Die Schnittstelle `FHIRDirectoryTIMProviderAPI` wird vom *Registrierungs-Dienst* aufgerufen, um eine Föderationsliste herunterzuladen. Die Schnittstellen `FHIRDirectorySearchAPI` und `FHIRDirectoryOwnerAPI` werden von den *TI-Messenger-Clients* aufgerufen, um eine Suche bzw. einen Eintrag im *FHIR-Directory* zu ermöglichen.
+* Beim *VZD-FHIR-Directory* handelt es sich um einen zentralen Verzeichnisdient der TI, der die deutschlandweite Suche von Organisationen und Akteuren des *TI-Messenger-Dienstes* ermöglicht. Das *VZD-FHIR-Directory* basiert auf dem FHIR-Standard und bietet neben der Suche (`FHIRDirectorySearchAPI`) für den *TI-Messenger-Dienst* Schnittstellen zur Administration der link:docs/Foederationsliste/Foederationsliste.adoc[*Föderationsliste*] an (`FHIRDirectoryTIMProviderAPI`). Zusätzlich existiert für Organisaitonen und Practitioner eine Schnittstelle (`FHIRDirectoryOwnerAPI`), über die die Verwaltung des eigenen Eintrages im *VZD-FHIR-Directory* möglich ist. Details sind dem link:https://github.com/gematik/api-vzd/blob/gemILF_VZD_FHIR_Directory/1.2.2/docs/gemILF_VZD_FHIR_Directory.adoc[*Implementierungsleitfaden*] des *VZD-FHIR-Directory* zu entnehmen.
 
 link:docs/IDP/idp.adoc[*Zentraler IDP-Dienst*] +
 
@@ -89,7 +89,7 @@ TI-Messenger Dokumentation
 ├─ link:docs[docs] (weiterführende Informationen)
 |   ├──── link:docs/Authenticator[Authenticator]
 |   ├──── link:docs/Client[Client]
-|   ├──── link:docs/FHIR-Directory[FHIR-Directory]
+|   ├──── link:docs/Foederationsliste[Föderationsliste]
 |   ├──── link:docs/Fachdienst[Fachdienst]
 |   ├──── link:docs/IDP[IDP]
 |   ├──── link:docs/Primaersystem[Primaersystem]
@@ -135,7 +135,7 @@ Hersteller und Anbieter eines *TI-Messenger-Dienstes* können das von der gemati
 *Produkttypen* +
 link:docs/Fachdienst/Fachdienst.adoc[- TI-Messenger-Fachdienst] +
 link:docs/Client/Client.adoc[- TI-Messenger-Client] +
-link:docs/FHIR-Directory/FHIR-Directory.adoc[- VZD-FHIR-Directory] +
+link:https://github.com/gematik/api-vzd/blob/main/docs/Fachkonzept_FHIR-Directory.adoc[- VZD-FHIR-Directory] +
 link:docs/IDP/idp.adoc[- Zentraler IDP-Dienst] +
 
 *Leitfaden für Primärsystemhersteller* +

docs/Foederationsliste/Foederationsliste.adoc

@@ -0,0 +1,48 @@
+ifdef::env-github[]
+:tip-caption: :bulb:
+:note-caption: :information_source:
+:important-caption: :heavy_exclamation_mark:
+:caution-caption: :fire:
+:warning-caption: :warning:
+endif::[]
+
+:imagesdir: ../../images
+:toc: macro
+:toclevels: 5
+:toc-title: Table of Contents
+:numbered:
+
+image:meta/gematik_logo.svg[width=70%]
+
+toc::[]
+
+= Föderationsliste
+
+Um nicht zum TI-M Dienst gehörende Messenger-Services ausschließen zu können, werden die Domainnamen der Messenger-Services in einer Föderationsliste zusammengefasst. Diese wird durch das [gemSpec_VZD_FHIR_Directory] bereitgestellt und kann über die Schnittstelle `/tim-provider-services` von zugelassenen Anbietern verwaltet werden. In der Föderationsliste werden die folgenden Informationen zu den Messenger-Services gespeichert:
+
+[options="header"]
+|=================================================================================================================
+| Attribut                | Beschreibung
+| `domain`                | The TI-Messenger domain
+| `telematikID`           | The telematikID of the organization that uses the TI-Messenger domain
+| `isInsurance`           | Indicates if it is a domain of a health insurance for insured persons
+| `timProvider`           | The Zuweisungsgruppe im TI-ITSM-System of the TI-Messenger Provider, who added the domain
+|=================================================================================================================
+
+Das folgenden Beispiel zeigt exemplarisch die Einträge der gematiker Krankenkasse,  die einen *TI-M FD ePA* für die Versicherten und einen *TI-M FD Pro* für die eigenen Mitarbeiter betreibt:
+----
+{
+    "domain": "versicherte.tim.gematiker-kk.de",
+      "telematikID": "4711-gem",
+      "timAnbieter": "GEM-0815",
+      "isInsurance": yes
+    },
+    {
+      "domain": "mitarbeiter.tim.gematiker-kk.de",
+      "telematikID": "4711-gem",
+      "timAnbieter": GEM-0815,
+      "isInsurance": false
+    },
+}
+----
+