addPossibleMatch

Konzeptarbeit. Noch nicht implementiert

Zweck

Fügt manuell ein Match zu einer Domäne hinzu.

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

Der Funktionsaufruf liefert eine Parameters-Ressource bestehend aus einem Multi-Part-Parameter zurück.

Invocations

URL: [base]/$addPossibleMatch

This operation changes content

Parameters (In)

NameCardinalityTypeDocumentation
domain1..1string

Angabe der Matching-Domaene

mpiId1..1Identifier

Identifikator eines MPI-Entrags (MPI-ID, Person.identifier).

aliasMpiId1..1Identifier

Identifikator des matchenden MPI-Entrags.

Return Values (Out)

NameCardinalityTypeDocumentation
match1..1

Match-Informationen zu zwei Identitäten.

match.item2..2Patient

Die beiden matchenden Identitäten wie im Request übergeben.

match.score1..1decimal

Matching-Score

match.result1..1decimal

Matching-Ergebnis

match.linkId1..1integer

Link-ID des Matches

match.comment0..1string

Anmerkung zum Match

Fügt einen Match zu einem bestimmten MPI-Eintrag einer Domäne hinzu.

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-AddPossibleMatch-request-example-1" />
<name value="domain" />
<valueString value="MIRACUM" />
</parameter>
<name value="mpiId" />
<system value="https://ths-greifswald.de/fhir/epix/identifier/MPI" />
<value value="1001000000066" />
</valueIdentifier>
</parameter>
<name value="aliasMpiId" />
<system value="https://ths-greifswald.de/fhir/epix/identifier/MPI" />
<value value="1001000068944" />
</valueIdentifier>
</parameter>
</Parameters>

Beispielhafte Response:

<Parameters xmlns="http://hl7.org/fhir">
<id value="Parameters-AddPossibleMatch-response-example-1" />
<name value="match" />
<name value="item" />
<Patient>
<id value="52" />
<versionId value="1" />
<lastUpdated value="2021-06-17T08:28:03.200+02:00" />
<source value="dummy_safe_source" />
<profile value="https://ths-greifswald.de/fhir/StructureDefinition/epix/Patient" />
</meta>
<active value="true" />
<family value="xxxxx" />
<given value="Stefanie" />
</name>
<gender value="male" />
<birthDate value="1962-12-17" />
</Patient>
</resource>
</part>
<name value="item" />
<Patient>
<id value="53" />
<versionId value="1" />
<lastUpdated value="2021-06-17T08:28:24.180+02:00" />
<source value="dummy_safe_source" />
<profile value="https://ths-greifswald.de/fhir/StructureDefinition/epix/Patient" />
</meta>
<active value="true" />
<family value="xxxxx" />
<given value="Stefanie" />
</name>
<gender value="male" />
<birthDate value="1962-12-16" />
</Patient>
</resource>
</part>
<name value="score" />
<valueDecimal value="0.965" />
</part>
<name value="result" />
<valueDecimal value="0.952" />
</part>
<name value="linkId" />
<valueInteger value="5654986" />
</part>
<name value="comment" />
<valueString value="This match was added manually!" />
</part>
</parameter>
</Parameters>