IG TTP-FHIR Gateway

UpdateBf

Zweck

Aktualisierung eines bestehenden Bloomfilters (z.B. bei geänderter Konfiguration oder vorheriger fehlerhafter Übermittlung) bezogen auf ein bereits bekanntes Pseudonym.

Voraussetzung

Die spezifizierte Studie (study) muss im Zielsystem bekannt und angelegt sein.
Die spezifizierte Quell-Domäne (source) muss im Zielsystem bekannt und angelegt sein.
Das spezifizierte Pseudonym (pseudonym) muss im Zielsystem bekannt und angelegt sein.
API-KEY: Der spezifizierte API-KEY muss valide und zum Aufruf der Methode 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/$updateBf

Der Funktionsaufruf liefert eine OperationOutcome-Ressource mit codierter Statusinformationen zurück.

Invocations

URL: [base]/$updateBf

This operation changes content

Parameters (In)

Name	Cardinality	Type	Documentation
study	1..1	string	Angabe der Studie
bloomfilter	1..1	base64Binary	der hinzu zu fügende Bloomfilter (base64-codiert)
source	1..1	string	Angabe des Bloomfilter sendenden Standorts (Quell-Domäne)
pseudonym	1..1	string	Das Pseudonym, dessen Bloomfilter aktualisiert werden soll.
apikey	1..1	string	Gültiger API-Key zur Authentifizierung und Authorisierung des aufrufenden Systems gegenüber dem verarbeitenden Workflow-Manager
bfVersion	1..1	string	Bloomfilter-Version.

Return Values (Out)

Name	Cardinality	Type	Documentation
return	1..1	OperationOutcome	Rückinformation.

Im Erfolgsfall wird der HTTP Statuscode 200 zurückgegeben.

Im vollständigen 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-UpdateBf-request-example-1" />
    <parameter>
        <name value="study" />
        <valueString value="num" />
    </parameter>
    <parameter>
        <name value="bloomfilter" />
        <valueBase64Binary value="SWNoIGJpbiBlaW4gQmxvb21maWx0ZXIuIFZlcnNwcm9jaGVuLg==" />
    </parameter>
    <parameter>
        <name value="source" />
        <valueString value="dic_erlangen" />
    </parameter>
    <parameter>
        <name value="pseudonym" />
        <valueString value="dic_2Q42E" />
    </parameter>
    <parameter>
        <name value="apikey" />
        <valueString value="abcdef12345" />
    </parameter>
    <parameter>
        <name value="bfVersion" />
        <valueString value="2" />
    </parameter>
</Parameters>

Eine beispielhafte Rückmeldung:

<OperationOutcome xmlns="http://hl7.org/fhir">
    <id value="OperationOutcome-UpdateBf-response-example-1" />
    <issue>
        <severity value="information" />
        <code value="informational" />
        <details>
            <coding>
                <system value="http://terminology.hl7.org/CodeSystem/operation-outcome" />
                <code value="MSG_UPDATED" />
            </coding>
        </details>
        <diagnostics value="Bloomfilter updated." />
    </issue>
</OperationOutcome>