AllConsentsForDomain
Unterstützt ab TTP-FHIR Gateway Version 2.0.0
Voraussetzung
- Spezifizierte Domäne muss angelegt sein
- Es muss eine gültige Einwilligung existieren
Aufruf und Rückgabe
Invocations
URL: [base]/$allConsentsForDomain
This operation does NOT change content
Parameters (In)
| Name | Cardinality | Type | Documentation |
| 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 einer spezifischen Einwilligungsdomaene. Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält je Consent jeweils ein Bundle mit allen für den spezifischen Consent relevanten Ressourcen (TemplateFrame, QuestionnaireComposed, QuestionnaireResponse, Provenance,Patient und i.a. DocumentReference). Details zu den verwendeten Profilen unter https://simplifier.net/guide/einwilligungsmanagement/igeinwilligungsmanagement
Die bereitgestellte Funktionalität kann per POST-Request aufgerufen werden. Die erforderlichen Angaben werden per POST-BODY in Form von FHIR Parameters übermittelt.
<HOST>:<PORT>/ttp-fhir/fhir/gics/$allConsentsForDomain
Der Funktionsaufruf liefert ein Bundle vom Typ "collection". Das Bundle enthält je Consent jeweils ein Bundle mit allen für den spezifischen Consent relevanten Ressourcen (TemplateFrame, QuestionnaireComposed, QuestionnaireResponse, Provenance,Patient und i.a. DocumentReference). 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="AllConsentsForDomain-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>
Eine beispielhafte Rückmeldung kann wie folgt aussehen: