IG TTP-FHIR Gateway

pseudonymizeAllowCreate

Unterstützt ab TTP-FHIR Gateway Version 1.0.0

Suche und ggf. Erzeugung von Pseudonymen

Generierung je eines Pseudonyms für eine Liste von 1-n Originalwerten und eine spezifische Domäne sofern es noch nicht vorhanden ist. Sofern die Zuordnung Originalwert und Domäne bereits bekannt ist, wird das zugeordnete vorhandene Pseudonym zurückgegeben.

Voraussetzung

Die angegebene Pseudonym-Domäne muss in gPAS konfiguriert sein.

Aufruf und Rückgabe

Invocations

URL: [base]/$pseudonymizeAllowCreate

This operation changes content

Parameters (In)

Name	Cardinality	Type	Documentation
target	1..1	string	Angabe der Domäne auf Basis derer für den angegebenen Originalwert ein vorhandenens eindeutiges Pseudonym gesucht wird
original	1..*	string	Angabe der Originalwerte auf Basis derer in der zusätzlich angegebenen Domäne eindeutige Pseudonym gesucht und sofern noch nicht vorhanden erzeugt werden

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

Generierung je eines Pseudonyms für eine Liste von 1-n Originalwerten und eine spezifische Domäne sofern es noch nicht vorhanden ist. Sofern die Zuordnung Originalwert und Domäne bereits bekannt ist, wird das zugeordnete vorhandene Pseudonym zurückgegeben.

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

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

target = die genutzte Ziel-Domäne (Teil des Requests)
original = der zu pseudonymisierende Werte (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.
404: Parameter mit unbekanntem Inhalt.
422: Fehlende oder falsche Patienten-Attribute.

Beispiel

Beispielhafter Request-Body:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-PseudonymizeAllowCreate-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-PseudonymizeAllowCreate-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>