addConsentOptOut

Unterstützt ab TTP-FHIR Gateway Version 2024.3.0

Legt eine neue Einwilligung im gICS für ein spezifisches Forschungsvorhaben (Domain) mit Opt-Out-Kontext auf Basis der übermittelten Informationen gemäß den Profil-Vorgaben der HL7 Deutschland Arbeitsgruppe "Einwilligungsmanagement" an:

Zurückgegeben wird der auf dieser Basis errechnete strukturierte Consent im Bundle gemäß der gICS-spezifischen Profilvorgaben.

Voraussetzung
  • Spezifizierte Einwilligungsdomäne muss angelegt sein
  • In der Patient-Resource verwendete Angaben des Identifier.system müssen in Form von SignerIdTypes, wie z.B. 'Pseudonym','CaseId','StudyPsn' in der entsprechenden Domäne im gICS konfiguriert sein
  • eventuell vorhandene IDs (UUIDs) werden während der Verarbeitung durch gICS-eigene UUIDs ersetzt.
Aufruf und Rückgabe

Invocations

URL: [base]/$addConsentOptOut

This operation changes content

Parameters (In)

NameCardinalityTypeDocumentation
patient1..1Patient

Patient-Ressource, entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/Patient. Für Identifier in dieser Ressource muss der Namensraum (identifier.system) mit der Zeichenfolge 'https://ths-greifswald.de/fhir/gics/identifiers/' beginnen. Angehängt hieran wird der Bezeichner eines im System konfigurierten SignerIDTypes. Abweichungen hiervon führen zu einem Fehler, indiziert durch HTTP Status 422.

domain1..1string

Angabe der Einwilligungsdomaene

questionnaire1..1canonical

Canonical URL des Questionnaire (entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/QuestionnaireComposed), das im Rahmen eines Opt-Out-Kontexts implizit gilt.

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1Bundle

Bundle vom Typ collection, das die errechneten Consent-Ressourcen enthält.

Liefert alle Consente einer Person einer spezifischen Einwilligungsdomaene, die sich aus den übermittelten Informationen ergeben. Die Rückgabe erfolgt als Bundle vom Typ "collection".

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-AddConsentOptOut-request-example-1" />
    <parameter>
        <name value="patient" />
        <resource>
            <Patient>
                <id value="1" />
                <meta>
                    <lastUpdated value="2022-12-20T10:10:54.889+01:00" />
                    <profile value="http://fhir.de/ConsentManagement/StructureDefinition/Patient" />
                </meta>
                <identifier>
                    <type>
                        <coding>
                            <system value="http://hl7.org/fhir/v2/0203/" />
                            <code value="ANON" />
                            <display value="Anonymous identifier" />
                        </coding>
                    </type>
                    <system value="https://ths-greifswald.de/fhir/gics/identifiers/Pseudonym" />
                    <value value="studypsn1" />
                </identifier>
            </Patient>
        </resource>
    </parameter>
    <parameter>
        <name value="domain" />
        <valueString value="MII" />
    </parameter>
    <parameter>
        <name value="questionnaire" />
        <valueCanonical value="https://ths-greifswald.de/fhir/gics/QuestionnaireComposed/MII/Patienteneinwilligung+MII|1.6.f" />
    </parameter>
</Parameters>

Eine beispielhafte Rückmeldung:

<Bundle xmlns="http://hl7.org/fhir">
    <id value="AddConsentOptOut-response-example-1" />
    <type value="collection" />
    <entry>
        <resource>
            <Consent>
                <id value="8821edd5-5bb7-11ef-9800-0242ac130002" />
                <meta>
                    <lastUpdated value="2024-08-16T12:08:49.282+02:00" />
                    <profile value="https://ths-greifswald.de/fhir/StructureDefinition/gics/Consent" />
                    <profile value="http://fhir.de/ConsentManagement/StructureDefinition/Consent" />
                </meta>
                <extension url="http://fhir.de/ConsentManagement/StructureDefinition/DomainReference">
                    <extension url="domain">
                        <valueReference>
                            <reference value="ResearchStudy/7fca337a-e69c-11ee-943e-0242ac1c0002" />
                        </valueReference>
                    </extension>
                    <extension url="status">
                        <valueCoding>
                            <system value="http://hl7.org/fhir/publication-status" />
                            <code value="active" />
                        </valueCoding>
                    </extension>
                </extension>
                <status value="active" />
                <scope>
                    <coding>
                        <system value="http://terminology.hl7.org/CodeSystem/consentscope" />
                        <code value="research" />
                    </coding>
                </scope>
                <category>
                    <coding>
                        <system value="http://loinc.org" />
                        <code value="57016-8" />
                    </coding>
                </category>
                <category>
                    <coding>
                        <system value="http://fhir.de/ConsentManagement/CodeSystem/ResultType" />
                        <code value="document" />
                    </coding>
                </category>
                <category>
                    <coding>
                        <system value="http://fhir.de/ConsentManagement/CodeSystem/TemplateType" />
                        <code value="CONSENT-OPT-OUT" />
                    </coding>
                </category>
                <patient>
                    <reference value="Patient/881fc35f-5bb7-11ef-9800-0242ac130002" />
                    <display value="studyPSN fhir_1" />
                </patient>
                <dateTime value="2024-08-16T12:08:49+02:00" />
                <organization>
                    <display value="opt-out" />
                </organization>
                <sourceReference>
                    <reference value="QuestionnaireResponse/8821edd5-5bb7-11ef-9800-0242ac130002" />
                </sourceReference>
                <policy>
                    <uri value="urn:uuid:7cbe82e6-3886-11ef-8dbb-0242ac130002" />
                </policy>
                <provision>
                    <type value="permit" />
                    <period>
                        <start value="2024-08-16T12:08:49+02:00" />
                        <end value="3000-01-01T00:00:00+01:00" />
                    </period>
                    <provision>
                        <type value="permit" />
                        <period>
                            <start value="2024-08-16T12:08:49+02:00" />
                            <end value="3000-01-01T00:00:00+01:00" />
                        </period>
                        <code>
                            <coding>
                                <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy/opt-out" />
                                <code value="p-opt-out" />
                            </coding>
                        </code>
                    </provision>
                </provision>
            </Consent>
        </resource>
    </entry>
</Bundle>