dePseudonymize
Unterstützt ab TTP-FHIR Gateway Version 1.0.0
Suche von Originalwerten
Abfrage je eines Originalwertes für eine Liste von 1-n Pseudonymen und eine spezifische Domäne.
Voraussetzung
Die angegebene Pseudonym-Domäne muss in gPAS konfiguriert und das angegebene Pseudonym in dieser Domäne bereits vorhanden sein.
Aufruf und Rückgabe
Invocations
URL: [base]/$dePseudonymize
This operation does NOT change content
Parameters (In)
Name | Cardinality | Type | Documentation |
target | 1..1 | string | Angabe der Domäne auf Basis derer für das angegebene Pseudonym ein vorhandener eindeutiger Originalwert gesucht wird |
pseudonym | 1..* | string | Angabe einer Liste von 1-n Pseudonymen für die in der angegebenen Domäne zugeordnete eindeutige Originalwerte gesucht werden |
Return Values (Out)
Name | Cardinality | Type | Documentation |
original | 0..* | Original-Identifikation zum übermittelten Pseudonym | |
original.original | 1..1 | Identifier | Original-Identifikator |
original.target | 1..1 | Identifier | Target-Identifikator |
original.pseudonym | 1..1 | Identifier | Patient-Identifier |
error | 0..* | Fehlerrückgabe bei Teil-Fehlern | |
error.original | 0..1 | Identifier | Original-Identifikator |
error.target | 0..1 | Identifier | Target-Identifikator |
error.pseudonym | 0..1 | Identifier | Patient-Identifikator |
error.error-code | 1..1 | Coding | Fehlercode |
Abfrage je eines Originalwertes für eine Liste von 1-n Pseudonymen und eine spezifische Domäne.
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/gpas/$dePseudonymize
Der Funktionsaufruf liefert ein ParameterSet bestehend aus multiplen benannten Parametern zurück:
- target = die genutzte Ziel-Domäne (Teil des Requests)
- pseudonym = das angefragte Pseudonym (Teil des Requests)
- original = der ermittelte Originalwert
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:
<Parameters xmlns="http://hl7.org/fhir"> <id value="Parameters-DePseudonymize-request-example-1" /> <parameter> <name value="target" /> <valueString value="MIRACUM" /> </parameter> <parameter> <name value="pseudonym" /> <valueString value="mrcm_T0TYNV21" /> </parameter> <parameter> <name value="pseudonym" /> <valueString value="mrcm_9GELEUVU" /> </parameter> </Parameters>
Eine beispielhafte Rückmeldung kann wie folgt aussehen:
<Parameters xmlns="http://hl7.org/fhir"> <id value="Parameters-DePseudonymize-response-example-1" /> <parameter> <name value="original" /> <part> <name value="target" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="MIRACUM" /> </valueIdentifier> </part> <part> <name value="original" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="1001000000022" /> </valueIdentifier> </part> <part> <name value="pseudonym" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="mrcm_T0TYNV21" /> </valueIdentifier> </part> </parameter> <parameter> <name value="original" /> <part> <name value="target" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="MIRACUM" /> </valueIdentifier> </part> <part> <name value="original" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="1001000000033" /> </valueIdentifier> </part> <part> <name value="pseudonym" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="mrcm_9GELEUVU" /> </valueIdentifier> </part> </parameter> </Parameters>
Auftretende Fehler (z.B. angegebenes Pseudonym ist unbekannt) werden im Einzelnen entsprechend per Coding vom Typ Issue-Type signalisiert.
<Parameters xmlns="http://hl7.org/fhir"> <id value="Parameters-DePseudonymize-response-example-2" /> <parameter> <name value="pseudonym" /> <part> <name value="target" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="MIRACUM" /> </valueIdentifier> </part> <part> <name value="original" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="1001000000022" /> </valueIdentifier> </part> <part> <name value="pseudonym" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="mrcm_T0TYNV21" /> </valueIdentifier> </part> </parameter> <parameter> <name value="error" /> <part> <name value="pseudonym" /> <valueIdentifier> <system value="https://ths-greifswald.de/gpas" /> <value value="mrcm_UNKPSN123" /> </valueIdentifier> </part> <part> <name value="error-code" /> <valueCoding> <system value="http://hl7.org/fhir/issue-type" /> <code value="not-found" /> <display value="Not Found" /> </valueCoding> </part> </parameter> </Parameters>