queryPossibleMatches
Konzeptarbeit. Noch nicht implementiert
Zweck
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.
Invocations
URL: [base]/$queryPossibleMatches
This operation does NOT change content
Parameters (In)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| _offset | 0..1 | integer | Offset für Paging (Anzahl der zu überspringenden match-Parameter) |
| _count | 0..1 | string | Anzahl der zurück zu gebenden match-Parameter (Paging) |
| domain | 1..1 | string | Angabe der Matching-Domaene |
| 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. |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
|---|---|---|---|
| prev | 0..1 | uri | Bei Paging: URL der vorausgehenden Seite. |
| self | 0..1 | uri | Bei Paging: URL der aktuellen Seite. |
| next | 0..1 | uri | Bei Paging: URL der folgenden Seite. |
| match | 0..* | Match-Informationen zu zwei Identitäten. | |
| match.matchItem | 2..2 | Patient | Die beiden matchenden Identitäten. |
| match.matchScore | 1..1 | decimal | Matching-Score |
| match.matchResult | 1..1 | decimal | Matching-Ergebnis |
| match.linkId | 1..1 | integer | Link-ID des Matches |
| match.comment | 0..1 | string | Anmerkung zum Match |
Matchende Identitäts-Informationen sowie zugehörige Meta-Informationen ausgeben.
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:
Beispielhafte Response: