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: requestPsnWorkflow
| Official URL: https://ths-greifswald.de/fhir/OperationDefinition/dispatcher/requestPsnWorkflow | Version: 2025.2.0 | |||
| Active as of 2026-02-18 | Computable Name: RequestPsnWorkflow | |||
Abfragen bzw. anlegen von Pseudonymen auf Basis eines vorkonfigurierten Pseudonymisierungsablaufs (Workflow) für einen gegebenen Geltungsbereich (Studie und Standort). Die Rückgabe der generierten standort- und studienspezifischen-Pseudonyme erfolgt als Parameter.
Zweck
Abfragen bzw. Anlegen von Pseudonymen auf Basis eines vorkonfigurierten Pseudonymisierungsablaufs (Workflow) für einen gegebenen Geltungsbereich (Studie und Standort).
Dabei wird stets ein oder mehrere Originalwerte einer Quell-Domäne in ein oder mehrere Pseudonyme der Ziel-Domäne pseudonymisiert. Ist der Originalwert bereits bekannt, wird das bereits zuvor generierte Pseudonym der Ziel-Domäne geliefert.
Diese Methode überführt Pseudonyme einer Stufe in eine andere Stufe. Dabei werden entweder bekannte Pseudonyme zurückgeliefert (Um-Pseudonymisierung) oder neue Pseudonyme generiert (Dritt-Pseudonymisierung).
Die Rückgabe der generierten standort- und studienspezifischen Pseudonyme erfolgt 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 spezifizierte Quell-Domäne (source) muss im Zielsystem bekannt und angelegt sein.
- Die standortspezifische Domäne (target) muss im Zielsystem bekannt und angelegt sein.
- Das angegebene Event muss bekannt sein und der API-Key dafür autorisiert sein.
URL: [base]/$requestPsnWorkflow
Parameters
| Use | Name | Scope | Cardinality | Type | Binding | Documentation |
| IN | original | 1..* | string | Liste studien- und standortspezifischer Originalwerte für die entsprechende Pseudonyme ermittelt bzw. erstellt werden. | ||
| IN | study | 1..1 | string | Angabe der Studie | ||
| IN | source | 1..1 | string | Angabe der Quell-Domäne (Herkunft des Originalwertes) | ||
| IN | target | 1..1 | string | Angabe der Ziel-Domäne | ||
| IN | event | 0..1 | string | Optionaler Parameter. Auszulösendes, vorkonfiguriertes Pseudonymisierungsevents innerhalb des Workflow-Managers. | ||
| OUT | pseudonym | 0..* | Ermitteltes bzw. generiertes studien- und standort-spezifisches Pseudonym | |||
| OUT | pseudonym.original | 1..1 | Identifier | der zu pseudonymisierende Wert (im Request übergeben) | ||
| OUT | pseudonym.target | 1..1 | Identifier | die verwendete Ziel-Domäne (im Request übergeben) | ||
| OUT | pseudonym.pseudonym | 1..1 | Identifier | das in der Ziel-Domäne erzeugte Pseudonym. | ||
| OUT | error | 0..* | Wenn einzelne übergebene Parameter fehlerhaft bzw. nicht valide sind, wird statt eines Pseudonyms ein Fehler-Parameter (error-Parameter) mit der Fehlerbeschreibung zurückgeliefert. | |||
| OUT | error.original | 0..1 | Identifier | der zu pseudonymisierende Wert (im Request übergeben) | ||
| OUT | error.target | 0..1 | Identifier | die verwendete Ziel-Domäne (im Request übergeben) | ||
| OUT | error.error-code | 1..1 | Coding | Fehlercode |
Abfragen bzw. anlegen von Pseudonymen auf Basis eines vorkonfigurierten Pseudonymisierungsablaufs (Workflow) für einen gegebenen Geltungsbereich (Studie und Standort). Die Rückgabe der generierten standort- und studienspezifischen-Pseudonyme 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/$requestPsnWorkflow
Der Funktionsaufruf liefert eine Parameters-Ressource bestehend aus multiplen Multi-Part-Parametern zurück.
Im Erfolgsfall wird ein pseudonym-Parameter pro übergebenen Originalwert zurückgegeben, welcher folgende Parameter enthält:
- original = der zu pseudonymisierende Wert (im Request übergeben)
- target = die verwendete Ziel-Domäne (im Request übergeben)
- pseudonym = Das in der Ziel-Domäne erzeugte Pseudonym.
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.