gematik/api-kim - Githubissues

:imagesdir: images = KIM - Dokumentation

image:gematik_logo.svg[width=70%]

== Allgemeines

Die folgende Dokumentation beschreibt KIM 1.5.3. An dieser Stelle werden insbesondere die Komponenten der Lösung sowie deren Schnittstellen dargestellt und erläutert. Die Version KIM 1.5.3 ist vollständig abwärtskompatibel. Dadurch wird gewährleistet, dass Teilnehmer mit einer früheren Version uneingeschränkt Nachrichten an Teilnehmer versenden können, die bereits KIM 1.5.3 verwenden.

Der Funktionsumfang der KIM Version 1.5 erweitert sich gegenüber KIM 1.0 wie folgt:

die Aufhebung der Größenbeschränkung von Nachrichten
die optionale Integration des Clientmoduls in das Primärsystem
ein Administrationsmodul für die Konfiguration des Nutzer-Accounts
das Einrichten von Abwesenheitsnotizen
das Einrichten von Anwendungskennzeichen
die Unterstützung syntaktischer Nachrichtenkategorien (Dienstkennungen)
die Unterstützung von Multikonnektor-Umgebungen

Hinweis: Seit März 2020 verwendet die gematik die Bezeichnung „KIM – Kommunikation im Medizinwesen“ für die Anwendung KOM-LE. Diese neue Benennung findet sich insbesondere in Informationsmaterialien für die Zielgruppe Leistungserbringer, sowie in Presseveröffentlichungen. Eine Umbenennung in den technisch-normativen Dokumenten wie Spezifikationen, Konzepten, Zulassungsdokumenten etc. mit Ausnahme von Angaben zu Domänen, E-Mail-Adressen, technischen Schnittstellen, Parametern u.ä. erfolgt schrittweise und an geeigneter Stelle.

== Systemarchitektur

Die folgende Abbildung gibt einen Überblick über die Systemarchitektur von KIM 1.5. Die Änderungen bei Komponenten und Schnittstellen von KIM 1.0 zu KIM 1.5 sind in der Abbildung rot dargestellt.

++++

link:docs/KIM_API.adoc[Clientsystem]

Clientmodul: + Das Clientmodul kann jetzt optional in das Clientsystem (z. B. Primärsystem) integriert werden.
Administrationsmodul: + Die Erweiterung des Clientmoduls um das Administrationsmodul ermöglicht die Kommunikation mit dem Account Manager des Fachdienstes zur Administration und Konfiguration des Accounts eines KIM-Teilnehmers.

link:docs/Fachdienst.adoc[Fachdienst]

Mail Server: + Der Mail Server stellt die Schnittstelle I_Message_Service bereit und wird über die Protokolle SMTP und POP3 angesprochen. In der KIM Version 1.5 wurden am Mail Server keine Änderungen vorgenommen.
Account Manager: + Für die einfache Verwaltung des Accounts, das Einrichten von Abwesenheitsnotizen eines KIM-Teilnehmers und für die Abfrage von Konfigurationsparametern des jeweiligen KIM Fachdienstes bietet der Account Manager ab der KIM Version 1.5 drei Webservices (I_AccountManager_Service, I_AccountLimit_Service und I_ServiceInformation) an.
KIM Attachment Service: + Der Fachdienst wird um die Komponente KIM Attachment Services (KAS) erweitert, der die sichere Speicherung größerer Client-Mails (E-Mail-Daten) ermöglicht. Die Komponente kann über die REST-Schnitstelle I_Attachment_Service erreicht werden.

link:docs/Verzeichnisdienst.adoc[Verzeichnisdienst]

Um die Kompatibilität von KIM 1.5 zu früheren Versionen zu gewährleisten, wird der Verzeichnisdienst um die zusätzlichen Datenstrukturen komLeData und kimData ergänzt.
Der Verzeichnisdienst wird um die REST-Schnittstelle I_Directory_Application_Maintenance erweitert.

== Ordnerstruktur

Im Folgenden ist die Organisation der Ordnerstruktur dargestellt.

KIM-API ├─ docs ├─ images ├─ samples | ├──── KAS │ └──── SMIME-Profil.zip ├─ src │ ├──── json │ │ └── badges.json | ├──── openapi │ │ ├── AccountLimit.yaml │ │ ├── AccountManager.yaml │ │ ├── AttachmentServices.yaml │ │ ├── CommonSchemas.yaml │ │ └── ServiceInformation.yaml │ ├──── plantuml │ │ └── Fachdienst │ └──── schema │ └── Attachment_schema.json ├── LICENSE ├── README.adoc ├── ReleaseNotes.md └── SECURITY.adoc

== Ausbaustufen

Mit der Einführung von KIM unterstützt die gematik das Gesundheitswesen durch einen sektorenübergreifenden, sicheren E-Maildienst. In mehreren Versionen wird der Funktionsumfang von KIM kontinuierlich erweitert. Aktuell existieren die folgenden Versionen mit ihren dazugehörigen aktuellen Releases.

|=== |KIM 1.0 |KIM 1.5

|https://fachportal.gematik.de/schnelleinstieg/downloadcenter/releases#c6557[R1.3.3-2] |https://fachportal.gematik.de/schnelleinstieg/downloadcenter/releases#c8094[KIM 1.6.3-0] |===

Weitere Informationen zu den Versionen finden Sie hier: https://fachportal.gematik.de/anwendungen/kommunikation-im-medizinwesen[KIM]

== Referenzierte Dokumente

Die nachfolgende Tabelle enthält die in der vorliegenden Online Dokumentation referenzierten Dokumente der gematik zur Telematikinfrastruktur. Deren zu diesem Dokument jeweils gültige Versionsnummer entnehmen Sie bitte der aktuellen, auf der Internetseite der gematik veröffentlichten, Dokumentenlandkarte, in der die vorliegende Version aufgeführt wird.

|=== |[Quelle] |Herausgeber: Titel

== Weiterführende Seiten Anwendungsfälle + link:docs/Anwendungsfaelle.adoc[- Anwendungsfälle]

Produkttypen + link:docs/KIM_API.adoc[- Clientsystem] + link:docs/Fachdienst.adoc[- Fachdienst] + link:docs/Verzeichnisdienst.adoc[- Verzeichnisdienst]

Leitfaden für Primärsystemhersteller + link:docs/Primaersystem.adoc[- Primärsystem]

Diverses + link:docs/Authentisierung.adoc[- Authentisierung] + link:docs/Versionierung.adoc[- Versionierung] + link:docs/Email_Verarbeitung.adoc[- Beispiel für große E-Mails] + link:docs/faq.adoc[- Fragen und Antworten zur aktuellen Spezifikation [FAQ]]

Referenz-Implementierungen + https://github.com/gematik/kim-attachment-service[- KIM-Attachment-Service] + https://github.com/gematik/app-thunderbird-kim-plugin[- KIM-Thunderbird Plugin]

== api-kim Branch Modell

Im GitHub gematik/api-kim Repository werden Branches verwendet um den Status der Weiterentwicklung und das Review von Änderungen abzubilden.

Folgende Branches werden verwendet

main (enthält den letzten freigegebenen Stand der Entwicklung; besteht permanent)
develop (enthält den Stand der fertig entwickelten Features und wird zum Review durch Industriepartner und Gesellschafter verwendet; basiert auf main; nach Freigabe erfolgt ein merge in main und ein Release wird erzeugt; besteht permanent)
feature/ (in feature branches werden neue Features entwickelt; basiert auf develop; nach Fertigstellung erfolgt ein merge in develop; wird nach dem merge gelöscht)
hotfix/ (in hotfix branches werden Hotfixes entwickelt; basiert auf main; nach Fertigstellung erfolgt ein merge in develop und in main; wird nach dem merge gelöscht)
concept/ (in feature branches werden neue Konzepte entwickelt; basiert auf develop; dient der Abstimmung mit Dritten; es erfolgt kein merge; wird nach Bedarf gelöscht)
misc/ (nur für internen Gebrauch der gematik; es erfolgt kein merge; wird nach Bedarf gelöscht)

== Lizenzbedingungen

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

gematik / api-kim

readme