gematik / api-kim

API specification for gematik's KIM - a secure Email standard, which enables the exchange of information and payload in the German healthcare sector.
Other
33 stars 12 forks source link
gematik kim openapi-specification smime telematikinfrastruktur

:imagesdir: images = KIM - Dokumentation

image:gematik_logo.svg[width=70%]

image:https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgematik%2Fapi-kim%2Fdevelop%2Fsrc%2Fjson%2Fbadges.json&query=%24.badges.releaseNotes.version&prefix=%20&style=plastic&logo=github&logoColor=blue&label=ReleaseNotes&labelColor=%24.badges.releaseNotes.color&color=blue[link="ReleaseNotes.adoc"] + image:https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgematik%2Fapi-kim%2Fdevelop%2Fsrc%2Fjson%2Fbadges.json&query=%24.badges.kimClientmodulSpec.version&style=plastic&logo=adobeacrobatreader&logoColor=red&label=Spezifikation%20KIM%20Clientmodul&color=red&[link=https://fachportal.gematik.de/Fanwendungen/kommunikation-im-medizinwesen] image:https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgematik%2Fapi-kim%2Fdevelop%2Fsrc%2Fjson%2Fbadges.json&query=%24.badges.kimFachdienstSpec.version&style=plastic&logo=adobeacrobatreader&logoColor=red&label=Spezifikation%20KIM%20Fachdienst&color=red&[link=https://fachportal.gematik.de/Fanwendungen/kommunikation-im-medizinwesen] + image:https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgematik%2Fapi-kim%2Fdevelop%2Fsrc%2Fopenapi%2FAccountManager.yaml&query=%24.info.version&style=plastic&logo=openapiinitiative&logoColor=green&label=AccountManager&color=green[link="src/openapi/AccountManager.yaml"] image:https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgematik%2Fapi-kim%2Fdevelop%2Fsrc%2Fopenapi%2FAttachmentService.yaml&query=%24.info.version&style=plastic&logo=openapiinitiative&logoColor=green&label=AttachmentService&color=green[link="src/openapi/attachmentService.yaml"] image:https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgematik%2Fapi-kim%2Fdevelop%2Fsrc%2Fopenapi%2FAccountLimit.yaml&query=%24.info.version&style=plastic&logo=openapiinitiative&logoColor=green&label=AccountLimit&color=green[link="src/openapi/AccountLimit.yaml"] image:https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgematik%2Fapi-kim%2Fdevelop%2Fsrc%2Fopenapi%2FServiceInformation.yaml&query=%24.info.version&style=plastic&logo=openapiinitiative&logoColor=green&label=ServiceInformation&color=green[link="src/openapi/ServiceInformation.yaml"] image:https://img.shields.io/badge/dynamic/yaml?url=https%3A%2F%2Fraw.githubusercontent.com%2Fgematik%2Fapi-kim%2Fdevelop%2Fsrc%2Fopenapi%2FCommonSchemas.yaml&query=%24.info.version&style=plastic&logo=openapiinitiative&logoColor=green&label=CommonSchemas&color=green[link="src/openapi/CommonSchemas.yaml"]

== 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:

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]

link:docs/Fachdienst.adoc[Fachdienst]

link:docs/Verzeichnisdienst.adoc[Verzeichnisdienst]

== 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

|[gemSysL_KOMLE] |gematik: Systemspezifisches Konzept Kommunikation Leistungserbringer (KOM-LE) |[gemSMIME_KOMLE] |gematik: S/MIME-Profil Kommunikation Leistungserbringer (KOM-LE) |[gemSpec_CM] |gematik: Spezifikation KOM-LE-Clientmodul |[gemSpec_FD] |gematik: Spezifikation Fachdienst KOM-LE |[gemSpec_VZD] |gematik: Spezifikation Verzeichnisdienst |[gemSpec_OM] |gematik: Übergreifende Spezifikation Operations und Maintenance |[gemProdT_CM_KOMLE_PTV] |gematik: Produkttypsteckbrief Prüfvorschrift KOM-LE-Clientmodul |[gemProdT_iCM_KIM] |gematik: Produkttypsteckbrief Prüfvorschrift Integriertes Clientmodul KIM |===

== 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

== Lizenzbedingungen

Copyright (c) 2022 gematik GmbH

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.