IG TTP-FHIR Gateway

RequestPsnWorkflow

Zweck

Abfragen bzw. Anlegen von Pseudonymen auf Basis eines vorkonfigurierten Pseudonymisierungsablaufs (Workflow) für einen gegebenen Geltungsbereich (Studie und Standort).

Dabei wird stets ein oder mehrere Originalwerte einer Quell-Domäne in ein oder mehrere Pseudonyme der Ziel-Domäne pseudonymisiert. Ist der Originalwert bereits bekannt, wird das bereits zuvor generierte Pseudonym der Ziel-Domäne geliefert.

Diese Methode überführt Pseudonyme einer Stufe in eine andere Stufe. Dabei werden entweder bekannte Pseudonyme zurückgeliefert (Um-Pseudonymisierung) oder neue Pseudonyme generiert (Dritt-Pseudonymisierung).

Die Rückgabe der generierten standort- und studienspezifischen Pseudonyme erfolgt als Parameter.

Voraussetzung

Die spezifizierte Studie muss im Zielsystem bekannt und angelegt sein.
Die spezifizierte Quell-Domäne (source) muss im Zielsystem bekannt und angelegt sein.
Die standortspezifische Domäne (target) muss im Zielsystem bekannt und angelegt sein.
API-Key: Der spezifizierte API-Key muss valide und zum Aufruf der Methode autorisiert sein.
Das angegebene Event muss bekannt sein und der API-Key dafür autorisiert sein.

Aufruf und Rückgabe

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/dispatcher/$requestPsnWorkflow

Der Funktionsaufruf liefert eine Parameters-Ressource bestehend aus multiplen Multi-Part-Parametern zurück.

Invocations

URL: [base]/$requestPsnWorkflow

Parameters (In)

Name	Cardinality	Type	Documentation
original	1..*	string	Liste studien- und standortspezifischer Originalwerte für die entsprechende Pseudonyme ermittelt bzw. erstellt werden.
study	1..1	string	Angabe der Studie
source	1..1	string	Angabe der Quell-Domäne (Herkunft des Originalwertes)
target	1..1	string	Angabe der Ziel-Domäne
apikey	1..1	string	Gültiger API-Key zur Authentifizierung und Authorisierung des aufrufenden Systems gegenüber dem verarbeitenden Workflow-Manager
event	0..1	string	Optionaler Parameter. Auszulösendes, vorkonfiguriertes Pseudonymisierungsevents innerhalb des Workflow-Managers.

Return Values (Out)

Name	Cardinality	Type	Documentation
pseudonym	0..*		Ermitteltes bzw. generiertes studien- und standort-spezifisches Pseudonym
pseudonym.original	1..1	Identifier	der zu pseudonymisierende Wert (im Request übergeben)
pseudonym.target	1..1	Identifier	die verwendete Ziel-Domäne (im Request übergeben)
pseudonym.pseudonym	1..1	Identifier	das in der Ziel-Domäne erzeugte Pseudonym.
error	0..*		Wenn einzelne übergebene Parameter fehlerhaft bzw. nicht valide sind, wird statt eines Pseudonyms ein Fehler-Parameter (error-Parameter) mit der Fehlerbeschreibung zurückgeliefert.
error.original	0..1	Identifier	der zu pseudonymisierende Wert (im Request übergeben)
error.target	0..1	Identifier	die verwendete Ziel-Domäne (im Request übergeben)
error.error-code	1..1	Coding	Fehlercode

Abfragen bzw. anlegen von Pseudonymen auf Basis eines vorkonfigurierten Pseudonymisierungsablaufs (Workflow) für einen gegebenen Geltungsbereich (Studie und Standort). Die Rückgabe der generierten standort- und studienspezifischen-Pseudonyme erfolgt als Parameter.

Im Erfolgsfall wird ein pseudonym-Parameter pro übergebenen Originalwert zurückgegeben, welcher folgende Parameter enthält:

original = der zu pseudonymisierende Wert (im Request übergeben)
target = die verwendete Ziel-Domäne (im Request übergeben)
pseudonym = Das in der Ziel-Domäne erzeugte Pseudonym.

Im Erfolgsfall wird der HTTP Statuscode 200 zurückgegeben.

Wenn einzelne übergebene Parameter fehlerhaft bzw. nicht valide sind, wird statt eines Pseudonyms ein Fehler-Parameter (error-Parameter) mit der Fehlerbeschreibung zurückgeliefert.

Ist der Request gänzlich ungültig, 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.

Beispiele

Beispielhafter Request-Body:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-RequestPsnWorkflow-request-example-1" />
    <parameter>
        <name value="study" />
        <valueString value="num" />
    </parameter>
    <parameter>
        <name value="original" />
        <valueString value="dic_1H51T" />
    </parameter>
    <parameter>
        <name value="source" />
        <valueString value="dic_erlangen" />
    </parameter>
    <parameter>
        <name value="target" />
        <valueString value="codex" />
    </parameter>
    <parameter>
        <name value="apikey" />
        <valueString value="abcdef12345" />
    </parameter>
    <parameter>
        <name value="event" />
        <valueString value="num.getCodexPsn_codex" />
    </parameter>
</Parameters>

Eine beispielhafte Rückmeldung:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-RequestPsnWorkflow-response-example-1" />
    <parameter>
        <name value="pseudonym" />
        <part>
            <name value="original" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="dic_1H51T" />
            </valueIdentifier>
        </part>
        <part>
            <name value="target" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="codex" />
            </valueIdentifier>
        </part>
        <part>
            <name value="pseudonym" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="codex_6348Q7" />
            </valueIdentifier>
        </part>
    </parameter>
    <parameter>
        <name value="error" />
        <part>
            <name value="original" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="dic_2Q42E" />
            </valueIdentifier>
        </part>
        <part>
            <name value="target" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="codex" />
            </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>