IG TTP-FHIR Gateway

removePossibleMatches

Konzeptarbeit. Noch nicht implementiert

Zweck

Entfernt Matches aus einer Domäne.

Voraussetzung

Der angegebene Parameter zur Spezifikation der Matching-Domäne muss im E-PIX konfiguriert 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/epix/$removePossibleMatches

Der Funktionsaufruf liefert eine OperationOutcome-Ressource zurück.

Invocations

URL: [base]/$removePossibleMatches

This operation changes content

Parameters (In)

Name	Cardinality	Type	Documentation
domain	1..1	string	Angabe der Matching-Domaene
linkId	1..*	integer	Link-ID eines zu löschen Matches.
comment	0..1	string	Anmerkung zum Löschvorgang

Return Values (Out)

Name	Cardinality	Type	Documentation
return	1..1	OperationOutcome	Rückinformation zum Löschvorgang.

(Mögliche) Matches von Identitäten entfernen.

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-RemovePossibleMatches-request-example-1" />
    <parameter>
        <name value="domain" />
        <valueString value="MIRACUM" />
        <part>
            <name value="comment" />
            <valueString value="Dieser Match war v&#246;lliger Unsinn!" />
        </part>
    </parameter>
    <parameter>
        <name value="linkId" />
        <valueInteger value="5654986" />
    </parameter>
</Parameters>

Beispielhafte Response:

<OperationOutcome xmlns="http://hl7.org/fhir">
    <id value="OperationOutcome-RemovePossibleMatches-response-example-1" />
    <issue>
        <severity value="information" />
        <code value="informational" />
        <diagnostics value="removed 1 possible match(es)." />
    </issue>
</OperationOutcome>