RequestTasks

Zweck

Ein Standort kann seine offenen Aufgaben abrufen.

Voraussetzung

• Die spezifizierte Studie muss im Zielsystem bekannt und angelegt sein.
• Die standortspezifische Domäne (target) muss im Zielsystem bekannt und angelegt sein.
• Der spezifizierte API-KEY muss valide sein und über die nötigen Rechte zum Aufruf der Funktion verfügen.

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

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

Invocations

URL: [base]/$requestTasks

This operation changes content

Parameters (In)

Name	Cardinality	Type	Documentation
study	1..1	string	Angabe der Studie
target	1..1	string	Angabe der Pseudonymisierungsziel-Domain
apikey	1..1	string	Gültiger API-KEY zur Authentifizierung und Authorisierung des aufrufenden Systems gegenüber dem verarbeitenden Workflow-Manager

Das Coding des Parameters send_idat.element ist an das Value Set IdatElements gebunden.

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.

Beispiel

Beispielhafter Request-Body:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-RequestTasks-request-example-1" />
    <parameter>
        <name value="study" />
        <valueString value="num" />
    </parameter>
    <parameter>
        <name value="target" />
        <valueString value="codex" />
    </parameter>
    <parameter>
        <name value="apikey" />
        <valueString value="abcdef12345" />
    </parameter>
</Parameters>

Beispielhafte Rückmeldung:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-RequestTasks-response-example-1" />
    <parameter>
        <name value="dic_psn_available" />
        <part>
            <name value="bloomfilter" />
            <valueBase64Binary value="SWNoIGJpbiBlaW4gQmxvb21maWx0ZXIuIFZlcnNwcm9jaGVuLg==" />
        </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="send_idat" />
        <part>
            <name value="expires" />
            <valueInstant value="2021-05-28T13:00:00.00+02:00" />
        </part>
        <part>
            <name value="taskId" />
            <valueId value="064ddebf-b20e-468a-97fd-88097bcdbc11" />
        </part>
        <part>
            <name value="pseudonym" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="codex_1244Q2" />
            </valueIdentifier>
        </part>
        <part>
            <name value="element" />
            <valueCoding>
                <system value="https://ths-greifswald.de/fhir/CodeSystem/dispatcher/IdatElements" />
                <code value="given" />
            </valueCoding>
        </part>
        <part>
            <name value="element" />
            <valueCoding>
                <system value="https://ths-greifswald.de/fhir/CodeSystem/dispatcher/IdatElements" />
                <code value="family" />
            </valueCoding>
        </part>
        <part>
            <name value="element" />
            <valueCoding>
                <system value="https://ths-greifswald.de/fhir/CodeSystem/dispatcher/IdatElements" />
                <code value="birthdate" />
            </valueCoding>
        </part>
        <part>
            <name value="element" />
            <valueCoding>
                <system value="https://ths-greifswald.de/fhir/CodeSystem/dispatcher/IdatElements" />
                <code value="gender" />
            </valueCoding>
        </part>
        <part>
            <name value="element" />
            <valueCoding>
                <system value="https://ths-greifswald.de/fhir/CodeSystem/dispatcher/IdatElements" />
                <code value="birthplace" />
            </valueCoding>
        </part>
        <part>
            <name value="element" />
            <valueCoding>
                <system value="https://ths-greifswald.de/fhir/CodeSystem/dispatcher/IdatElements" />
                <code value="degree" />
            </valueCoding>
        </part>
    </parameter>
    <parameter>
        <name value="repeat_request" />
        <part>
            <name value="study" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="num" />
            </valueIdentifier>
        </part>
        <part>
            <name value="bloomfilter" />
            <valueBase64Binary value="SWNoIGJpbiBlaW4gQmxvb21maWx0ZXIuIFZlcnNwcm9jaGVuLg==" />
        </part>
        <part>
            <name value="target" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="codex" />
            </valueIdentifier>
        </part>
    </parameter>
</Parameters>