AllConsentsForTemplate
Unterstützt ab TTP-FHIR Gateway Version 2.1.0
Voraussetzung
- Spezifizierte Domäne muss angelegt sein
- Es muss eine gültige Einwilligung mit dem gegebenen personIdentifier existieren
- Das spezifizierte Template muss Grundlage einer gültigen Einwilligung sein
Aufruf und Rückgabe
Invocations
URL: [base]/$allConsentsForTemplate
This operation does NOT change content
Parameters (In)
| Name | Cardinality | Type | Documentation |
| template | 1..1 | string | Angabe der eindeutigen TemplateId in Form des TemplateFrame.Identifier.Value für das vorbelegte Template.Identifier.System "https://ths-greifswald.de/fhir/gics/" |
| domain | 1..1 | string | Angabe der Einwilligungsdomaene |
| _profile | 0..1 | canonical | Angabe um Ausgabeprofil festzulegen. Default ist die gics-Variante; alternativ das Profil aus dem IG Einwilligungsmanagement. |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
| return | 0..1 | Bundle | Bundle mit den beschriebenen Inhalten |
Liefert alle Consente eines spezifischen TemplateFrame unter Angabe des TemplateFrame-Identifiers (Vorlagenbezug) per POST-Request. Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält je Consent einen Bundle-Entry, der alle für den spezifischen Consent relevanten Ressourcen (z.B. TemplateFrame, QuestionnaireComposed, QuestionnaireResponse, Provenance) enthält. Details zu den verwendeten Profilen unter https://simplifier.net/guide/einwilligungsmanagement/igeinwilligungsmanagement
Paging entsprechend der FHIR Search API wird ab TTP-FHIR Gateway Version 2023.1.1 unterstützt, namentlich die Parameter
- _count: (maximale) Anzahl der im Bundle enthaltenen Ressourcen
- _offset: fortlaufende Nummer der ersten im Bundle enthaltenen Ressource
Der Default-Offset ist 0. Der Default-Count ist 100. Negative Werte für _offset und _count sind nicht erlaubt. Werden weder _count noch _offset angegeben, enthält das Bundle maximal 100 Ergebnisse (Default-Count=100, Default-Offset=0).
Im Erfolgsfall wird der HTTP Statuscode 200 zurückgegeben.
Im Fehlerfall wird einer der folgenden HTTP Statuscodes in Verbindung mit einer OperationOutcome-Ressource zurückgegeben:
- 400: Fehlende oder fehlerhafte Parameter.
- 401: Fehlende Authentifizierung oder Autorisierung.
- 404: Parameter mit unbekanntem Inhalt.
- 422: Fehlende oder falsche Patienten-Attribute.
Beispiel
Beispielhafter Request-Body:
<Parameters xmlns="http://hl7.org/fhir"> <id value="AllConsentsForTemplate-request-example-1" /> <parameter> <name value="template" /> <valueString value="MII;Patienteneinwilligung MII;1.6.f" /> </parameter> <parameter> <name value="domain" /> <valueString value="MII" /> </parameter> </Parameters>
Beispielhafte Rückmeldung: