2025.2.0 - ci-build
IGTTPFHIRGatewayEPIX - Local Development build (v2025.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
OperationDefinition: queryPossibleMatches
| Official URL: https://ths-greifswald.de/fhir/OperationDefinition/epix/QueryPossibleMatches | Version: 2025.2.0 | |||
| Draft as of 2026-02-05 | Computable Name: QueryPossibleMatches | |||
Gibt Matches zu einer Domäne oder zu einem bestimmten MPI-Eintrag aus.
Konzeptarbeit. Noch nicht implementiert
Zweck
Matchende Identitäts-Informationen sowie zugehörige Meta-Informationen ausgeben.
URL: [base]/$queryPossibleMatches
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | _offset | 0..1 | integer | Offset für Paging (Anzahl der zu überspringenden match-Parameter) | ||
| IN | _count | 0..1 | string | Anzahl der zurück zu gebenden match-Parameter (Paging) | ||
| IN | domain | 1..1 | string | Angabe der Matching-Domaene | ||
| IN | mpiId | 0..1 | Identifier | Identifikator eines MPI-Entrags (MPI-ID, Person.identifier). Ist dieser Parameter nicht angegeben, werden alle Matches zur Domäne zurück gegeben. | ||
| OUT | prev | 0..1 | uri | Bei Paging: URL der vorausgehenden Seite. | ||
| OUT | self | 0..1 | uri | Bei Paging: URL der aktuellen Seite. | ||
| OUT | next | 0..1 | uri | Bei Paging: URL der folgenden Seite. | ||
| OUT | match | 0..* | Match-Informationen zu zwei Identitäten. | |||
| OUT | match.matchItem | 2..2 | Patient | Die beiden matchenden Identitäten. | ||
| OUT | match.matchScore | 1..1 | decimal | Matching-Score | ||
| OUT | match.matchResult | 1..1 | decimal | Matching-Ergebnis | ||
| OUT | match.linkId | 1..1 | integer | Link-ID des Matches | ||
| OUT | match.comment | 0..1 | string | Anmerkung zum Match |
Matchende Identitäts-Informationen sowie zugehörige Meta-Informationen ausgeben.
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/$queryPossibleMatches
Paging wird mittels der optionalen In-Parameter _offset und _count sowie der optionalen Out-Parameter prev, self und next realisiert. Die Paging-Mechanismen folgen den Vorgaben unter http://www.hl7.org/fhir/r4/search.html - allerdings ist der komplexe Out-Parameter 'match' der Bezug für die Zählung.
Der Funktionsaufruf liefert eine Parameters-Ressource bestehend aus einem oder mehreren Multi-Part-Parametern zurück.
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.