Suche

Unterstützt ab TTP-FHIR Gateway Version 2.2.0

Die Suche nach E-PIX-Personen bzw. den zugeordneten Patienten-Identitäten ist mittels der FHIR Search-API umgesetzt. Die Rückgabe erfolgt dementsprechend in Form eines Bundles vom Typ searchset.

Suchanfragen werden ausschließlich als GET-Requests akzeptiert. Bezüglich des Encodings der URL sei auf die Hinweise unter Technische Grundlagen verwiesen.

Unterstützt wird die logische UND-Verknüpfung gemäß FHIR Search API, nicht jedoch das logische ODER.

Paging entsprechend der FHIR Search API wird ab TTP-FHIR Gateway Version 2023.1.1 unterstützt, namentlich die Parameter

  • _count: (maximale) Anzahl der im Bundle enthaltenen Ressourcen
  • _offset: fortlaufende Nummer der ersten im Bundle enthaltenen Ressource

Der Default-Offset ist 0. Der Default-Count ist 100. Negative Werte für _offset und _count sind nicht erlaubt. Werden weder _count noch _offset angegeben, enthält das Bundle maximal 100 Ergebnisse (Default-Count=100, Default-Offset=0).

Bei Inklusion anderer Ressourcen in die Suche (_include bzw. _has) gilt:

  • Das Element total gibt die Gesamtzahl Suchergebnisse der Ressource an, auf deren Endpoint die Suche ausgeführt wird
  • Die jeweils inkludierten sekundären Ressourcen werden jeweils in der selben Bundle-Page wie die primäre Ressource zurück gegegeben (z.B. alle Patient-Ressourcen zur Person), wie in der FHIR-Spezifikation empfohlen
  • Die Angaben zu _count und _offset ("Pagesize") beziehen sich ebenfalls auf die jeweils primäre Ressource, um den vorgenannten Punkt jederzeit zu gewährleisten

Die Default-Sortierung im Bundle ist nach Person.id aufsteigend.

Eine PDQ/MPI Suche in Kombination mit Paging wird nicht unterstützt.

Suche zur Person (Person-Endpoint)

Eine Suche zur Person erfolgt mittels der folgenden Suchparameter der Person-Ressource bzw. der referenzierten Patient-Ressourcen (Chaining):

Hinweis: Die Angabe des Suchparameters "organization" ist verpflichtend. Existiert dieser nicht im Request, wird der HTTP-Statuscode 400 zurück gegeben.

Mit Hilfe der Include-Funktionalität der FHIR-Suche wird auch die gleichzeitige Rückgabe von Person- und Patient-Ressourcen unterstützt.

Suche zur Identität (Patient-Endpoint)

Unterstützt ab TTP-FHIR Gateway Version 2024.1.0

Eine Suche zur Identität erfolgt mittels der folgenden Suchparameter der Patient-Ressource bzw. der referenzierenden Person-Ressource (Reverse Chaining und Reverse Include):

  • _has:Person:link:organization:identifier: enthält die E-PIX-Domäne
  • identifier: (lokaler) Identifikator der Patient-Ressource (Identität)
  • Weitere Suchparameter auf Patient: birthdate, family, gender, give

Bei dieser Suche wird die gefundene Patient-Ressource (Identität) sowie die hierauf verweisende Person-Ressource zurück gegegeben, nicht jedoch weitere Patient-Ressourcen mit anderen Identitäten der Person.

Hinweis: Die Angabe des reverse chained Suchparameters "_has:Person:link:organization:identifier" ist verpflichtend. Existiert dieser nicht im Request, wird der HTTP-Statuscode 400 zurück gegeben.

Beispiele

Suche E-PIX-Personen (FHIR: Person) sowie zugeordnete Identitäten (FHIR: Patient) zu einer bestimmten Domäne:

GET [base]/Person?organization:identifier=MIRACUM&_include=Person:link

Suche E-PIX-Personen sowie zugeordnete Identitäten zu einer bestimmten MPI-ID:

GET [base]/Person?organization:identifier=MIRACUM&identifier=https://ths-greifswald.de/fhir/epix/identifier/MPI%7C1001000000066&_include=Person:link

Suche E-PIX-Personen sowie zugeordnete Identitäten zu bestimmten identifizierenden Patientendaten:

GET [base]/Person?organization:identifier=MIRACUM&patient.family=Mustermann&patient.given=Max&_include=Person:link

Suche auf 10 Ergebnisse beschränkt und ab der 11. Ressource der Ergebnisliste: GET [base]/Person?organization:identifier=MIRACUM&_include=Person:link&_count=10&_offset=10

Suche eine bestimmte E-PIX-Identität (FHIR: Patient) sowie die übergeordnete E-PIX-Person (FHIR: Person) zu einer bestimmten Domäne:

GET [base]/Patient?identifier=https://klinium-musterstadt.de/fhir/epix/identifier/SystemXY|ABC_12345&_has:Person:link:organization:identifier=MIRACUM&_revinclude=Person:link