AllConsentsForPerson
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
Aufruf und Rückgabe
Invocations
URL: [base]/$allConsentsForPerson
This operation does NOT change content
Parameters (In)
Name | Cardinality | Type | Documentation |
personIdentifier | 1..* | Identifier | Um den Bezug zwischen Person und Einwilligung herzustellen, ist die Angabe von mindestens einem eindeutigen Personenidentifikator erforderlich. Dies kann je nach Anforderungen die Fallnummer, ein Patienten-Identifikator, die Angabe eines Bevollmächtigten oder ein Studienpseudonym, o.ä. sein und erfolgt unter Verwendung des passenden Patienten-Profils der AG Einwilligungsmanagement: https://simplifier.net/guide/Einwilligungsmanagement/Patient. Bei Angabe von mehreren Identifikatoren werden diese ODER-verknüpft. |
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 Person einer spezifischen Einwilligungsdomaene. Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält je Consent einen BundleEntry, 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
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="AllConsentsForPerson-request-example-1" /> <parameter> <name value="personIdentifier" /> <valueIdentifier> <system value="https://ths-greifswald.de/fhir/gics/identifiers/Pseudonym" /> <value value="dic_1H51T" /> </valueIdentifier> </parameter> <parameter> <name value="domain" /> <valueString value="MII" /> </parameter> </Parameters>
Eine beispielhafte Rückmeldung kann wie folgt aussehen: