IG TTP-FHIR Gateway

deletePseudonyms

Unterstützt ab TTP-FHIR Gateway Version 2024.2.0

Löscht eine gegebene Liste von 1-n Einträgen (identifiziert durch den Originalwert) in der angegebenen Domäne, sofern die Konfiguration dieser Domäne dies erlaubt.

Voraussetzung

Die angegebene Pseudonym-Domäne muss in gPAS konfiguriert und der angegebene Originalwert in dieser Domäne bereits vorhanden sein.

Aufruf und Rückgabe

Invocations

URL: [base]/$deletePseudonyms

This operation changes content

Parameters (In)

Name	Cardinality	Type	Documentation
target	1..1	string	Angabe der Domäne innerhalb derer die angegebenen Originalwerte gelöscht werden.
original	1..*	string	Angabe der Originalwerte für die in der angegebenen Domäne eine Löschung durchgeführt werden soll.

Return Values (Out)

Name	Cardinality	Type	Documentation
successStatus	1..*		Status-Rückgabe der einzelnen durchgeführten Löschungen
successStatus.target	0..1	Identifier	Target-Identifikator
successStatus.original	1..1	Identifier	Original-Identifikator
successStatus.result-code	1..1	Coding	Erfolgs- bzw. Fehlercode

Löscht eine gegebene Liste von 1-n Einträgen (identifiziert durch den Originalwert) in der angegebenen Domäne, sofern die Konfiguration dieser Domäne dies erlaubt.

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/gpas/$deletePseudonyms

Der Funktionsaufruf liefert ein ParameterSet bestehend aus multiplen benannten Parametern zurück:

original = der zu pseudonymisierende Werte (Teil des Requests)
target = die genutzte Ziel-Domäne (Teil des Requests)
result-code = Ergebnisstatus (Erfolg oder Fehler).

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.
500: Löschen von Pseudonymen in der Domain (target) nicht gestattet.

Beispiel

Beispielhafter Request-Body:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-DeletePseudonyms-request-example-1" />
    <parameter>
        <name value="target" />
        <valueString value="MIRACUM" />
    </parameter>
    <parameter>
        <name value="original" />
        <valueString value="1001000000022" />
    </parameter>
    <parameter>
        <name value="original" />
        <valueString value="1001000000033" />
    </parameter>
</Parameters>

Eine beispielhafte Rückmeldung kann wie folgt aussehen:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-DeletePseudonyms-response-example-1" />
    <parameter>
        <name value="successStatus" />
        <part>
            <name value="target" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="MIRACUM" />
            </valueIdentifier>
        </part>
        <part>
            <name value="original" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="1001000000022" />
            </valueIdentifier>
        </part>
        <part>
            <name value="result-code" />
            <valueCoding>
                <system value="http://terminology.hl7.org/CodeSystem/operation-outcome" />
                <code value="MSG_DELETED" />
            </valueCoding>
        </part>
    </parameter>
    <parameter>
        <name value="successStatus" />
        <part>
            <name value="target" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="MIRACUM" />
            </valueIdentifier>
        </part>
        <part>
            <name value="original" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="1001000000033" />
            </valueIdentifier>
        </part>
        <part>
            <name value="result-code" />
            <valueCoding>
                <system value="http://hl7.org/fhir/issue-type" />
                <code value="not-found" />
                <display value="Not Found" />
            </valueCoding>
        </part>
    </parameter>
</Parameters>

Auftretende Fehler (z.B. angegebenes Pseudonym ist unbekannt) werden im Einzelnen entsprechend per Coding vom Typ Issue-Type signalisiert.