AllPolicyStatesForPerson
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
- Unterstützt ab TTP FHIR Gateway Version 2.1.0 (gICS 2.13.4)
Aufruf und Rückgabe
Invocations
URL: [base]/$allPolicyStatesForPerson
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. 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 jemals unterzeichneten Policies einer Person einer spezifischen Einwilligungsdomaene. Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält ausschließlich Consent-Ressourcen zur Abbildung der Policies, d.h. je unterzeichneter Policy ist eine Consent-Ressource mit jeweils einer Policy (provision) enthalten. Es werden alle jemals von Patienten unterzeichneten Policies zurückgegeben (ConsentProvisionType: permit/deny). Policies mit gICS-internem Status UNKNOWN, NOT_ASKED, NOT_CHOSEN, WITHDRAWN, INVALIDATED, REFUSED oder EXPIRED werden mit ConsentProvisionType "deny" zurückgegeben.
Sollen nur die jeweils neueste Policies angezeigt werden, ist clientseit eine Filterung anhand Datum, Policyversion etc. erforderlich oder alternativ die Operation currentPolicyStatesForPerson zu nutzen.
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="AllPolicyStatesForPerson-request-example-1" /> <parameter> <name value="personIdentifier" /> <valueIdentifier> <system value="https://ths-greifswald.de/fhir/gics/identifiers/Pseudonym" /> <value value="dic_GCC83" /> </valueIdentifier> </parameter> <parameter> <name value="domain" /> <valueString value="MII" /> </parameter> </Parameters>
Beispielhafte Rückmeldung: