Feature/update searchparam req stufe 3 ptdata1094 #456

f-peverali · 2024-10-14T09:50:19Z

Contributor Pull Request

Description

analogous to #452

Motivation and Context

solves PTDATA-1094

How has this been tested?

Snippets or Screenshots (if necessary):

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this IG / specification.
My change requires a change to the documentation or narrative (intend) of the IG.
I have already updated the documentation / narrative (intend) accordingly.

Reviewer / Quality Assurance Checklist

The Present PR does not need a thorough review process, due to brevity, low complexity or because it represents a rather minor change; otherwise go trough the list! ... and read the linked manual, if you did not do it yet!

content review steps (based on Best Practice IG Germany)

formal intellectual review steps of Implementation Guide

no formal review needed
proofreading for orthography
there are no (critical) validation Errors in the CI pipeline
- inspected and no critical errors found(In the "github action view" -> Option button -> "View raw logs") - possibly list non-critical below
skim reading for correct rendering of IG (possibly using IG-grep of string String like "Could not render")

automated review steps:

no formal review needed
check IG-pages for broken links (possibly using plug-in)
[ ]

For reviewers

You migh use this: https://conventionalcomments.org/

alexey-tschudnowsky · 2024-10-14T13:52:13Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

 ## Allgemeine Hinweise zu Suchparametern
+Originäre ISiK Use Cases sind versorgungsorientiert und patientenorientiert. Dies resultiert darin, dass in der Profilierung der ISiK-Datenobjekte das Vorhandensein einer Referenz auf ISiKPatient (Patient) und ISiKKontaktGesundheitseinrichtung (Encounter) wo möglich gefordert wird. Entsprechend sind Abfragen durch Clients auf Basis von bekannten Informationen aus *einer* Patient- und/oder Encounter-Ressource zu begrenzen (Abfragen auf Patientenkohorten oder sonstige Forschungsabfragen sind nicht im Fokus von ISiK).


question: "aus" einer Patient- und/oder Encounter-Ressource oder AUF eine Patient- und/oder Encounter-Ressource zu begrenzen?

comment: Gute Frage. "Aus" macht hier keinen Sinn. Die Formulierung ist allgemein unglücklich - es ging hier im Wesentliche darum klarzustellen, dass ISIK nicht primär den Use Case von Massenabfragen adressiert, sondern einzelne Patienten und einzelne Fälle.

FYI @simoneOnFhir - sollten wir ggf. auch noch in Stufe 4 überarbeiten.

Hier ist aus m.E. korrekt. Ich kenn den Identifier "123452 aus der Patienten-Ressource und suche jetzt die Diagnosen dazu:
/Condition?patient.identifier=12345

alexey-tschudnowsky · 2024-10-14T13:56:34Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

@@ -24,13 +30,19 @@ Für die im Rahmen dieses Leitfadens relevanten Typen gelten folgende allgemeine

 Die Präfixe `lt`,`le`,`gt`,`ge`,`eq` MÜSSEN für jeden Suchparameter vom Typ 'date/dateTime' unterstützt werden.

+Begründung: Die Funktionalität datums-eingeschränkt suchen zu können ist essentiell.


nitpick: dieser Satz liefert keinen Infromationsgehalt. Dafür aber der Hinweis unten, der m.M.n. als Begründung verwendet werden kann

alexey-tschudnowsky · 2024-10-14T13:57:31Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

-```[base]/Patient?birthDate=ge2000-01-01``` <br>
-Suche nach allen Patienten mit einem Geburtsdatum 2000-01-01T00:00 oder später.
+```[base]/Encounter?date=eq2024-01-01&patient=Patient/Test``` <br>
+Suche nach allen Kontakten mit einem Datum am 2024-01-01T00:00 im Patientenkontext "Test".


issue: "mit einem Datum am 2024-01-01T00:00" ist nicht korrekt. Die Uhrzeit spielt bei so einer Abfrage keine Rolle

alexey-tschudnowsky · 2024-10-14T14:01:59Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

-```[base]/Patient?birthDate=eq2000-01-01``` <br>
-Suche nach allen Patienten mit einem Geburtsdatum von 2000-01-01T00:00 bis (aber nicht einschließlich) 2000-02-01T00:00
+```[base]/Condition?recorded-date=eq2024-01-01&patient=Patient/Test``` <br>
+Suche nach allen Diagnosen mit einem Dokumentationsdatum von 2024-01-01T00:00 bis (aber nicht einschließlich) 2024-01-02T00:00 im Patientenkontext "Test".


suggestion: sollte das Beispiel nicht eher die Verwendung von ge und le demonstrieren? Muss man ja m.M.n. sonst im Text nicht erklären, dass ein eq2024-01-01 das Datum 2024-01-02 NICHT einschließt...

Ja, das Beispiel ist unglücklich gewählt, vor allem auch im Hinblick auf die Tatsache, dass
Condition?recorded-date=eq2024-01-01 gleichbedeutend ist mit der selben Query ohne jegliche Prefixes.

Vorschlag zur Verbesserung:

[base]/Condition?recorded-date=ge2024-01-01&recoded-date=lt2024-02-01&patient=Patient/Test

Suche nach allen Diagnosen mit einem Dokumentationsdatum Im Zeitraum Januar 2024 (von 2024-01-01T00:00 bis (aber nicht einschließlich) 2024-02-01T00:00 im Patientenkontext "Test".

alexey-tschudnowsky · 2024-10-14T15:39:52Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

-**Beispiele**:
+Dies gilt beispielsweise für Encounter.account - also die Referenz zwischen ISiKKontaktGesundheitseinrichtung und ISiKAbrechnungsfall. Encounter MÜSSEN anhand der Fallnummer gesucht werden können, ohne dass Clients Zugriffsberechtigungen auf Accounts haben müssen, bzw. ohne dass Account zwingend implementiert/referenziert werden muss. Der Suchabruf erfolgt entsprechend dann nur über die logische Referenz.
+
+Begründung: Die Unterstützung dieser Suchparameter-Typen ist essentiell für Abfragen mit [Chaining](https://hl7.org/fhir/r4/search.html#chaining) und [Reverse Chaining](https://hl7.org/fhir/r4/search.html#has). Innerhalb der Spezifikation ist für jedes Datenobjekt spezifiziert weshalb eine solche Abfrage versorgungsrelevant ist.


issue: m.M.n. hat der Suchparameter :identifier erstmals mit Chaining nichts zu tun - damit ist sogar kein Chaining möglich (cf. https://www.hl7.org/fhir/R4/search.html#reference) Der Modifier hat aus meiner SIcht eher den oben beschriebenen Zweck - also Suche nach Identifiern von assoziierten Ressourcen zu ermöglichen falls die assoziierten Ressourcen im System als eigenständige Entitäten nicht existieren

@simoneOnFhir , @alexey-tschudnowsky hat recht. Zumindest di Begründung an dieser Stelle ist einfach falsch.
Muss auch in Stufe 4 nochmal geändert werden.

alexey-tschudnowsky · 2024-10-14T15:42:54Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

+
+* ``Reverse Chaining``
+
+ - Beispiel für Reverse Chaining mit Referenz auf einen Patienten aus einem Observation-Kontext:GET [base]/Patient?_has:Observation:patient:code=1234-5


typo: fehlt hier eine geeignete Formattierung des Beispiels?

alexey-tschudnowsky · 2024-10-14T15:46:41Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

+* ``Reverse Chaining``
+
+ - Beispiel für Reverse Chaining mit Referenz auf einen Patienten aus einem Observation-Kontext:GET [base]/Patient?_has:Observation:patient:code=1234-5
+ - Hinweis: Diese Form der Suchanfrage dient im Wesentlichen dem Auffinden von Patienten (z.B. unter angabe einer BEsondern Diagnose, beobachtung Prozedur etc.) oder Fallkontakten (z.B. zum Ermitteln des Kontextes einer Prozedur)


typo: besonderen

alexey-tschudnowsky · 2024-10-14T15:51:22Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

- - Anwendungshinweise: Weitere Informationen zur Suche nach "_tag" finden sich in der [FHIR-Basisspezifikation - Abschnitt "Including other resources in result"](https://www.hl7.org/fhir/R4/search.html#revinclude).
- - Alle Referenzen für die ein Chaining unterstützt wird MUSS auch der _include-Parameter implementiert werden. Alle unterstützten Include-Referenzen MÜSSEN im CapabilityStatement unter ```CapabilityStatement.rest.resource.searchRevInclude``` angegeben werden. Siehe {{pagelink:ImplementationGuide/markdown/CapabilityStatement.md}}.
+ - Anwendungshinweise: Weitere Informationen zur Suche nach "_revinclude" finden sich in der [FHIR-Basisspezifikation - Abschnitt "Including other resources in result"](https://www.hl7.org/fhir/R4/search.html#revinclude).
+ - Alle Referenzen für die ein Chaining unterstützt wird MUSS auch der _revinclude-Parameter implementiert werden. Alle unterstützten Revinclude-Referenzen MÜSSEN im CapabilityStatement unter ```CapabilityStatement.rest.resource.searchRevInclude``` angegeben werden. Siehe {{pagelink:ImplementationGuide/markdown/CapabilityStatement.md}}.


question: "Alle Referenzen für die ein Chaining.." oder "Alle Referenzen für die ein Reverse Chaining..."?

alexey-tschudnowsky · 2024-10-14T15:52:31Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md


-Der [type] Modifier MUSS für alle spezifizierten Suchparameter vom Typ 'Reference' unterstützt werden.
+Der Modifier :identifier MUSS implementiert werden, wenn die entsprechende Reference eine 1..1-Kardinalität oder ein MS-Flag auf Reference.identifier hat.


typo: fehlende Formattierung vom :identifier --> :identifier

alexey-tschudnowsky · 2024-10-14T17:23:53Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

- Der ```:iterate``` Modifier KANN unterstützt werden.
+Für Suchparameter namens 'patient' und 'encounter' MÜSSEN die Festlegungen für [Chaining](https://hl7.org/fhir/R4/search.html#chaining) verpflichtend implementiert werden.
+
+* ``Chaining``


nitpick: Chaining und der nachfolgende Reverse Chanining sind keine Schlüsselwörter, die entsprechende Formattierung kann raus

alexey-tschudnowsky · 2024-10-14T17:27:16Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md


- Der ```:iterate``` Modifier KANN unterstützt werden.
+Für Suchparameter namens 'patient' und 'encounter' MÜSSEN die Festlegungen für [Chaining](https://hl7.org/fhir/R4/search.html#chaining) verpflichtend implementiert werden.


question: welche Tiefe geben wir vor? denkbar wäre ja sonst auch Tiefe 2: Condition.encounter.patient

question: für Suchparameter subject (beim Encounter) muss somit kein Chaining implementiert werden, richtig? nur 'patient'?

comment: nein, mMn auch "subject" z.B. beim Encounter - FYI @simoneOnFhir

alexey-tschudnowsky · 2024-10-14T17:31:08Z

...ntationGuide/markdown/UebergreifendeFestlegungen/UebergreifendeFestlegungen_Suchparameter.md

+
+ - Beispiele: ``GET [base]/Encounter?_include=Encounter:patient``
+ - Anwendungshinweise: Weitere Informationen zur Suche nach "_include" finden sich in der [FHIR-Basisspezifikation - Abschnitt "Including other resources in result"](https://www.hl7.org/fhir/R4/search.html#revinclude).
+ - Für alle Referenzen, für die ein Chaining unterstützt wird, MUSS auch der _include-Parameter implementiert werden. Alle unterstützten Include-Referenzen MÜSSEN im CapabilityStatement unter ```CapabilityStatement.rest.resource.searchInclude``` angegeben werden. Siehe {{pagelink:ImplementationGuide/markdown/CapabilityStatement.md}}.


thought: ich frage mich, wie viele Hersteller diese nicht triviale Funktionalität (include) umgesetzt haben...

FYI @simoneOnFhir

f-peverali added 2 commits October 14, 2024 11:48

update requirements

93489ed

update releasenotes

e3577ec

f-peverali requested a review from simoneOnFhir October 14, 2024 09:50

update releasenotes

13fb2c2

alexey-tschudnowsky reviewed Oct 14, 2024

View reviewed changes

f-peverali requested a review from leslieber October 15, 2024 11:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/update searchparam req stufe 3 ptdata1094 #456

Feature/update searchparam req stufe 3 ptdata1094 #456

f-peverali commented Oct 14, 2024

alexey-tschudnowsky Oct 14, 2024

f-peverali Oct 15, 2024

simoneOnFhir Oct 16, 2024

alexey-tschudnowsky Oct 14, 2024

alexey-tschudnowsky Oct 14, 2024

alexey-tschudnowsky Oct 14, 2024

simoneOnFhir Oct 16, 2024

alexey-tschudnowsky Oct 14, 2024

f-peverali Oct 15, 2024

alexey-tschudnowsky Oct 14, 2024

alexey-tschudnowsky Oct 14, 2024

alexey-tschudnowsky Oct 14, 2024

alexey-tschudnowsky Oct 14, 2024

alexey-tschudnowsky Oct 14, 2024

alexey-tschudnowsky Oct 14, 2024

alexey-tschudnowsky Oct 14, 2024

f-peverali Oct 15, 2024

alexey-tschudnowsky Oct 14, 2024

f-peverali Oct 15, 2024

		## Allgemeine Hinweise zu Suchparametern
		Originäre ISiK Use Cases sind versorgungsorientiert und patientenorientiert. Dies resultiert darin, dass in der Profilierung der ISiK-Datenobjekte das Vorhandensein einer Referenz auf ISiKPatient (Patient) und ISiKKontaktGesundheitseinrichtung (Encounter) wo möglich gefordert wird. Entsprechend sind Abfragen durch Clients auf Basis von bekannten Informationen aus einer Patient- und/oder Encounter-Ressource zu begrenzen (Abfragen auf Patientenkohorten oder sonstige Forschungsabfragen sind nicht im Fokus von ISiK).

		@@ -24,13 +30,19 @@ Für die im Rahmen dieses Leitfadens relevanten Typen gelten folgende allgemeine

		Die Präfixe `lt`,`le`,`gt`,`ge`,`eq` MÜSSEN für jeden Suchparameter vom Typ 'date/dateTime' unterstützt werden.

		Begründung: Die Funktionalität datums-eingeschränkt suchen zu können ist essentiell.


		* ``Reverse Chaining``

		- Beispiel für Reverse Chaining mit Referenz auf einen Patienten aus einem Observation-Kontext:GET [base]/Patient?_has:Observation:patient:code=1234-5


		Der [type] Modifier MUSS für alle spezifizierten Suchparameter vom Typ 'Reference' unterstützt werden.
		Der Modifier :identifier MUSS implementiert werden, wenn die entsprechende Reference eine 1..1-Kardinalität oder ein MS-Flag auf Reference.identifier hat.


		Der ```:iterate``` Modifier KANN unterstützt werden.
		Für Suchparameter namens 'patient' und 'encounter' MÜSSEN die Festlegungen für [Chaining](https://hl7.org/fhir/R4/search.html#chaining) verpflichtend implementiert werden.

Feature/update searchparam req stufe 3 ptdata1094 #456

Are you sure you want to change the base?

Feature/update searchparam req stufe 3 ptdata1094 #456

Conversation

f-peverali commented Oct 14, 2024

Contributor Pull Request

Description

Motivation and Context

How has this been tested?

Snippets or Screenshots (if necessary):

Types of changes

Checklist:

Reviewer / Quality Assurance Checklist

content review steps (based on Best Practice IG Germany)

formal intellectual review steps of Implementation Guide

automated review steps:

For reviewers

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment