IG TTP-FHIR Gateway

insertValuePseudonymPairs

Unterstützt ab TTP-FHIR Gateway Version 2024.3.0

Fügt ein Wertepaar bestehend aus Originalwert und Pseudonym in eine vorkonfigurierte Domäne ein, z.B. für die Migration von Bestandspseudonymen. Das Pseudonym muss den konfigurierten Vorgaben der Zieldomäne entsprechend und wird im Regelfall vor dem Einfügen durch den gPAS validiert.

Voraussetzung

Domäne muss konfiguriert sein
Pseudonym muss den Vorgaben der Domäne entsprechen und wird vor dem Einfügen im Regelfall validiert.

Aufruf und Rückgabe

Invocations

URL: [base]/$insertValuePseudonymPairs

This operation changes content

Parameters (In)

Name	Cardinality	Type	Documentation
pseudonym	1..*		Tripel mit den Angaben zu Original und zu setzendem Pseudonym.
pseudonym.target	1..1	string	Angabe der Domäne, in welche das Wertepaare Original-Wert & Pseudonym eingefügt werden soll. Ist bei allen Tripeln eines Requests der target-Parameter identisch, erfolgt die interne Verarbeitung mit erhöhter Performance.
pseudonym.original	1..1	string	Angabe des Originalwertes des Werte-Paares
pseudonym.value	1..1	string	Angabe des Pseudonyms des Werte-Paares. Das Pseudonym muss den konfigurierten Vorgaben der Zieldomäne entsprechend und wird im Regelfall vor dem Einfügen durch den gPAS validiert.

Return Values (Out)

Name	Cardinality	Type	Documentation
successStatus	0..*		Ermitteltes bzw. generiertes studien- und standort-spezifisches Pseudonym
successStatus.original	0..1	Identifier	Original-Identifikator
successStatus.target	0..1	Identifier	Target-Identifikator
successStatus.value	0..1	Identifier	Pseudonym
successStatus.result-code	1..1	Coding	Erfolgsstatus

Die bereitgestellte Funktionalität kann per POST-Request aufgerufen werden. Die erforderlichen Angaben werden per POST-BODY in Form von FHIR Parameters übermittelt.

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.

Beispiel

Beispielhafter Request-Body:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-InsertValuePseudonymPairs-request-example-1" />
    <parameter>
        <name value="pseudonym" />
        <part>
            <name value="target" />
            <valueString value="MIRACUM" />
        </part>
        <part>
            <name value="original" />
            <valueString value="1001000000022" />
        </part>
        <part>
            <name value="value" />
            <valueString value="mrcm_T0TYNV21" />
        </part>
    </parameter>
</Parameters>

Eine beispielhafte Rückmeldung kann wie folgt aussehen:

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-InsertValuePseudonymPairs-response-example-1" />
    <parameter>
        <name value="successStatus" />
        <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="value" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="mrcm_T0TYNV21" />
            </valueIdentifier>
        </part>
        <part>
            <name value="result-code" />
            <valueCoding>
                <system value="http://terminology.hl7.org/CodeSystem/operation-outcome" />
                <code value="MSG_CREATED" />
            </valueCoding>
        </part>
    </parameter>
</Parameters>

Auftretende Fehler (z.B. angegebene Domain ist unbekannt oder Pseudonym ist nicht valide) werden im Einzelnen entsprechend per Coding vom Typ Issue-Type signalisiert.

<Parameters xmlns="http://hl7.org/fhir">
    <id value="Parameters-InsertValuePseudonymPairs-response-example-2" />
    <parameter>
        <name value="successStatus" />
        <part>
            <name value="target" />
            <valueIdentifier>
                <system value="https://ths-greifswald.de/gpas" />
                <value value="DOMAINXY" />
            </valueIdentifier>
        </part>
        <part>
            <name value="result-code" />
            <valueCoding>
                <system value="http://hl7.org/fhir/issue-type" />
                <code value="not-found" />
                <display value="Not Found" />
            </valueCoding>
        </part>
    </parameter>
</Parameters>