From 90e435b158e95242065652229eccf7c64309be81 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 14 Jan 2025 15:39:32 +0100 Subject: [PATCH 1/3] Create proposal for removing custom state events --- ...m-state-events-fuer-strukturierte-daten.md | 71 +++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 proposals/xxx-entfernung-der-custom-state-events-fuer-strukturierte-daten.md diff --git a/proposals/xxx-entfernung-der-custom-state-events-fuer-strukturierte-daten.md b/proposals/xxx-entfernung-der-custom-state-events-fuer-strukturierte-daten.md new file mode 100644 index 00000000..5f072feb --- /dev/null +++ b/proposals/xxx-entfernung-der-custom-state-events-fuer-strukturierte-daten.md @@ -0,0 +1,71 @@ +# Entfernung der Custom State Events für strukturierte Daten + +TI-M Basis beschreibt in [Kapitel 5.5] die "TI-M spezifische Kommunikation". +Hierbei werden eigene State Events definiert, zu denen auch die Events +`de.gematik.tim.room.casereference.v1` und `de.gematik.tim.room.default.v1` +gehören. In diesen State Events sollen strukturierte Daten, wie z. B. +FHIR-Objekten zu einem Behandlungsfall gespeichert werden um damit spezielle +Anwendungsfälle zu unterstützen. + +Vorraussetzung hierfür ist allerdings State Events verschlüsseln zu können was +zum jetzigen Zeitpunkt noch nicht im Protokoll vorgesehen ist[^1]. Aus diesem +Grund ist das [Unterkapitel 5.5.2] vollständig von der Umsetzung +ausgenommen[^2]. Die Tatsache, dass dieses Kapitel trotzdem in der Spezifikation +auftaucht und konkrete Anforderungen enthält führt dabei vielfach zu +Irritationen und Nachfragen. + +Weiterhin müssen wegen [A_25756] und [A_25813] die State Events +`de.gematik.tim.room.casereference.v1` und `de.gematik.tim.room.default.v1` beim +Anlegen von Räumen gesendet werden, was auch im Rahmen der automatisierten +Zulassungstests geprüft wird. Auch dies verursacht wiederkehrend Verwirrung, +denn das zwangsweise Senden von Events, die gar nicht benutzt werden können +erscheint vollständig zwecklos. + +Dieses Proposal schlägt eine inkrementelle Verbesserung dieser Situation durch +Entfernung bestimmter nutzloser Teile der Spezifikation an. + +## Änderungsvorschlag + +Das [Unterkapitel 5.5.2] wird vollständig aus der Spezifikation entfernt. Damit +verschwinden [A_25756] und das State Event +`de.gematik.tim.room.casereference.v1`. + +Da dieses Unterkapitel bereits heute unverbindlich ist, ergeben sich dadurch +keine Auswirkungen auf die Zulassung oder bestehende Implementierungen. Der +einzige Mehrwert dieses Abschnittes ist, dass ein Ausblick auf zukünftige +Entwicklungen gegeben wird. Das ist aber zum einen nur bedingt Aufgabe der +Spezifikation und zum anderen funktioniert es an dieser Stelle nicht richtig. +Eine tatsächliche Verschlüsselung von State Events würde nämlich weitere +inkompatible Änderungen am Schema erfordern, z. B. durch die Verschlüsselung des +Event Typs. Durch die Entfernung dieses Unterkapitel wird die Spezifikation +vereinfacht und zukünftigen Missverständnissen vorgebeugt. Der zugehörige Text +kann unabhängig hiervon im Änderungsmanagementsystem der gematik verbleiben und +in Zukunft wiederverwendet werden. + +Des Weiteren wird das State Event `de.gematik.tim.room.default.v1` aus den +Pflichtparametern für [`/createRoom`] in [A_25813] entfernt. Das verpflichtende +Senden eines nicht benutzbaren Events erscheint sinnlos. Eine zukünftige +Verwendung des Events würde auch hier inkompatible Änderungen erfordern. Das +heutige Senden des Events erfüllt daher auch keinen vorbereitenden Zweck. Da das +Event nicht verwendet werden kann, bewirkt eine Entfernung aus [A_25813] zudem +keine Inkompatibilitäten. + +Abschließend wird [A_25816] mit derselben Argumentation gestrichen. + +Das [Kapitel 5.5] ist mit diesen Änderungen zwar nicht abschließend +bereinigt[^3] aber zumindest deutlich klarer und weniger anfällig für Nachfragen +als in seiner heutigen Form. + +[^1]: Eine mögliche Variante hierfür ist [MSC3414]. + +[^2]: Siehe hierzu den Hinweis ganz am Ende der Einleitung von [Kapitel 5.5]. + +[^3]: Siehe auch . + + [Kapitel 5.5]: https://gemspec.gematik.de/docs/gemSpec/gemSpec_TI-M_Basis/gemSpec_TI-M_Basis_V1.1.1/#5.5 + [Unterkapitel 5.5.2]: https://gemspec.gematik.de/docs/gemSpec/gemSpec_TI-M_Basis/gemSpec_TI-M_Basis_V1.1.1/#5.5.2 + [A_25756]: https://gemspec.gematik.de/docs/gemSpec/gemSpec_TI-M_Basis/gemSpec_TI-M_Basis_V1.1.1/#A_25756-01 + [A_25813]: https://gemspec.gematik.de/docs/gemSpec/gemSpec_TI-M_Basis/gemSpec_TI-M_Basis_V1.1.1/#A_25813-01 + [`/createRoom`]: https://spec.matrix.org/v1.13/client-server-api/#post_matrixclientv3createroom + [A_25816]: https://gemspec.gematik.de/docs/gemSpec/gemSpec_TI-M_Basis/gemSpec_TI-M_Basis_V1.1.1/#A_25816 + [MSC3414]: https://github.com/matrix-org/matrix-spec-proposals/pull/3414 From a4fb5c2d30e691f4c6303c1b4c8435fb38a6a298 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 14 Jan 2025 15:40:34 +0100 Subject: [PATCH 2/3] Rename proposal --- ...ntfernung-der-custom-state-events-fuer-strukturierte-daten.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename proposals/{xxx-entfernung-der-custom-state-events-fuer-strukturierte-daten.md => 292-entfernung-der-custom-state-events-fuer-strukturierte-daten.md} (100%) diff --git a/proposals/xxx-entfernung-der-custom-state-events-fuer-strukturierte-daten.md b/proposals/292-entfernung-der-custom-state-events-fuer-strukturierte-daten.md similarity index 100% rename from proposals/xxx-entfernung-der-custom-state-events-fuer-strukturierte-daten.md rename to proposals/292-entfernung-der-custom-state-events-fuer-strukturierte-daten.md From 7388e9a398c44180b98de24fe29c01fcdeb0b60c Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Tue, 14 Jan 2025 15:42:45 +0100 Subject: [PATCH 3/3] Fix typo --- ...tfernung-der-custom-state-events-fuer-strukturierte-daten.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/proposals/292-entfernung-der-custom-state-events-fuer-strukturierte-daten.md b/proposals/292-entfernung-der-custom-state-events-fuer-strukturierte-daten.md index 5f072feb..c6e932b5 100644 --- a/proposals/292-entfernung-der-custom-state-events-fuer-strukturierte-daten.md +++ b/proposals/292-entfernung-der-custom-state-events-fuer-strukturierte-daten.md @@ -21,7 +21,7 @@ Zulassungstests geprüft wird. Auch dies verursacht wiederkehrend Verwirrung, denn das zwangsweise Senden von Events, die gar nicht benutzt werden können erscheint vollständig zwecklos. -Dieses Proposal schlägt eine inkrementelle Verbesserung dieser Situation durch +Dieses Proposal strebt eine inkrementelle Verbesserung dieser Situation durch Entfernung bestimmter nutzloser Teile der Spezifikation an. ## Änderungsvorschlag