IG TTP-FHIR Gateway

pseudonymize

Unterstützt ab TTP-FHIR Gateway Version 1.0.0

Suche von Pseudonymen

Abfrage je eines Pseudonym-Wertes für eine gegebene Liste von 1-n Originalwerten und eine spezifische Domäne.

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]/$pseudonymize

This operation does NOT change content

Parameters (In)

Name	Cardinality	Type	Documentation
target	1..1	string	Angabe der Domäne auf Basis derer für die angegebenen Originalwerte ein vorhandenens eindeutiges Pseudonym gesucht wird
original	1..*	string	Angabe der Originalwerte für die in der angegebenen Domäne nach vorhandenen zugeordneten Pseudonymen gesucht wird

Return Values (Out)

Name	Cardinality	Type	Documentation
pseudonym	0..*		Ermitteltes bzw. generiertes studien- und standort-spezifisches Pseudonym
pseudonym.original	1..1	Identifier	Original-Identifikator
pseudonym.target	1..1	Identifier	Target-Identifikator
pseudonym.pseudonym	1..1	Identifier	Pseudonym
error	0..*		Fehlerrückgabe bei Teil-Fehlern
error.target	0..1	Identifier	Target-Identifikator
error.original	0..1	Identifier	Original-Identifikator
error.error-code	1..1	Coding	Fehlercode

Abfrage je eines Pseudonym-Wertes für eine gegebene Liste von 1-n Originalwerten und eine spezifische Domäne.

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/$pseudonymize

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)
pseudonym = das erzeugte Pseudonym.

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.
422: Fehlende oder falsche Patienten-Attribute.

Beispiel

Beispielhafter Request-Body:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-Pseudonymize-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-Pseudonymize-response-example-1" />
    <parameter>
        <name value="pseudonym" />
        <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="pseudonym" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="mrcm_T0TYNV21" />
            </valueIdentifier>
        </part>
    </parameter>
    <parameter>
        <name value="pseudonym" />
        <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="pseudonym" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="mrcm_9GELEUVU" />
            </valueIdentifier>
        </part>
    </parameter>
</Parameters>

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

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-Pseudonymize-response-example-2" />
    <parameter>
        <name value="pseudonym" />
        <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="pseudonym" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="mrcm_T0TYNV21" />
            </valueIdentifier>
        </part>
    </parameter>
    <parameter>
        <name value="error" />
        <part>
            <name value="original" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="10010000000XX" />
            </valueIdentifier>
        </part>
        <part>
            <name value="error-code" />
            <valueCoding>
                <system value="http://hl7.org/fhir/issue-type" />
                <code value="not-found" />
                <display value="Not Found" />
            </valueCoding>
        </part>
    </parameter>
</Parameters>