2025.2.0 - ci-build
IGTTPFHIRGatewayWorkflowbasierteSchnittstellen - Local Development build (v2025.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
OperationDefinition: requestPsnFromBfWorkflow
| Official URL: https://ths-greifswald.de/fhir/OperationDefinition/dispatcher/requestPsnFromBfWorkflow | Version: 2025.2.0 | |||
| Active as of 2026-02-18 | Computable Name: RequestPsnFromBfWorkflow | |||
Personenregistrierung und Privacy-Preserving Record Linkage (PPRL) auf Basis von Bloomfiltern (BF) innerhalb eines Geltungsbereiches (Studie, Standort). Die Erzeugung eines standortspezifischen Pseudonyms erfolgt innerhalb der angegebenen Ziel-Domäne. Diese wird automatisch erzeugt, sofern noch nicht vorhanden. Die Rückgabe eines standortspezifischen Pseudonyms (z.B. DIZPseudonym) erfolgt als Parameter.
Zweck
Anlegen und Matching von Patienten rein auf Basis von Bloomfiltern (PPRL) für einen gegebenen Geltungsbereich (Studie und Standort). Rückgabe der generierten Pseudonyme (z.b. DIC-PSN(s)) als Parameter.
Voraussetzung
- API-Key: Der spezifizierte API-Key muss valide und zum Aufruf der Methode autorisiert sein. Der API-KEY wird im Request-Header übermittelt.
- Die spezifizierte Studie muss im Zielsystem bekannt und angelegt sein.
- Die übermittelten Bloomfilter müssen valide sein.
- Die standortspezifische Domäne (target) muss im Zielsystem bekannt und angelegt sein.
URL: [base]/$requestPsnFromBfWorkflow
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | study | 1..1 | string | Angabe der Studie | ||
| IN | bloomfilter | 1..* | base64Binary | Liste studien- und standortspezifischer Bloomfilter (base64-codiert) | ||
| IN | target | 1..1 | string | Angabe des Bloomfilter sendenden Standorts (Ziel-Domäne) | ||
| OUT | pseudonym-bf | 0..* | Ermitteltes bzw. generiertes studien- und standort-spezifisches Pseudonym | |||
| OUT | pseudonym-bf.bloomfilter | 1..1 | base64Binary | Bloomfilter | ||
| OUT | pseudonym-bf.target | 1..1 | Identifier | die verwendete Ziel-Domäne (im Request übergeben) | ||
| OUT | pseudonym-bf.pseudonym | 1..1 | Identifier | das in der Ziel-Domäne erzeugte Pseudonym. | ||
| OUT | error | 0..* | Fehlerrückgabe bei Teil-Fehlern | |||
| OUT | error.bloomfilter | 0..1 | base64Binary | Bloomfilter | ||
| OUT | error.target | 0..1 | Identifier | die verwendete Ziel-Domäne (im Request übergeben) | ||
| OUT | error.error-code | 1..1 | Coding | Fehlercode |
Personenregistrierung und Privacy-Preserving Record Linkage (PPRL) auf Basis von Bloomfiltern (BF) innerhalb eines Geltungsbereiches (Studie, Standort). Die Erzeugung eines standortspezifischen Pseudonyms erfolgt innerhalb der angegebenen Ziel-Domäne. Diese wird automatisch erzeugt, sofern noch nicht vorhanden. Die Rückgabe eines standortspezifischen Pseudonyms (z.B. DIZPseudonym) erfolgt als Parameter.
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/dispatcher/$requestPsnFromBfWorkflow
Der Funktionsaufruf liefert eine Parameters-Ressource bestehend aus multiplen Multi-Part-Parametern zurück.
Im Erfolgsfall wird der HTTP Statuscode 200 zurückgegeben.
Wenn einzelne übergebene Parameter fehlerhaft bzw. nicht valide sind, wird statt eines Pseudonyms ein Fehler-Parameter (error-Parameter) mit der Fehlerbeschreibung zurückgeliefert.
Ist der Request gänzlich ungültig, 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.
Hinweis zu zukünftigen Änderungen
Das Pseudonym wird künftig nur dann geliefert, wenn kein Clearing-Prozess angestoßen wird. Ist dieser erforderlich, muss dieser zunächst vollständig abgeschlossen sein und das Pseudonym kann über die Operation $requestTasks abgerufen werden.