addConsent

Unterstützt ab TTP-FHIR Gateway Version 2023.1.0

Legt eine neue Einwilligung im gICS für ein spezifisches Forschungsvorhaben (Domain) 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 mit zugehörigen Ressourcen (z.B. zum Qualitätsstatus) 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
  • übermittelte Ressourcen müssen untereinander konsistent referenziert werden.
  • eventuell vorhandene IDs (UUIDs) werden während der Verarbeitung durch gICS-eigene UUIDs ersetzt.
  • Aktuell werden nur deutschsprachige Einwilligungsvorlagen unterstützt

Hinweise

Nachfolgend werden Konkretisierungen in Bezug auf die Vorgaben der HL7 Deutschland Arbeitsgruppe "Einwilligungsmanagement" erläutert

FHIR-Element Erklärung
QuestionnaireResponse.questionnaire Bezug zur verwendeten Einwilligungsvorlage in der Form https://ths-greifswald.de/fhir/gics/QuestionnaireComposed/<domain>/<templateName> |<templateVersion| wie zum Beispiel: https://ths-greifswald.de/fhir/gics/QuestionnaireComposed/MII/Patienteneinwilligung+MII|1.6.d Dabei muss der referenzierte TemplateType vom Typ Consent (LOINC 59284-0) sein.
QuestionnaireResponse.item.answer.value.valueCoding Unterstützte Systeme zur Codierung der Antworten sind https://ths-greifswald.de/fhir/CodeSystem/gics/ConsentStatus sowie urn:oid:2.16.840.1.113883.3.1937.777.24.5.2
QuestionnaireResponse.item.linkId Die item.linkId wird verwendet um den Bezug zum versionierten Einwilligungsmodul (z.B. Modul KKDAT_prospektiv_uebertragen_speichern_nutzen in der Version 1.8, Verwendung von Pipe als Trenner ist verpflichtend) oder zum eindeutig bezeichneten Freitextfeld einer Einwilligungsvorlage herzustellen.

Beispiel item.linkId für versioniertes Einwilligungsmodul
<linkId value="KKDAT_prospektiv_uebertragen_speichern_nutzen&#124;1.8"/>

Beispiel item.linkId für Freitextfeld
<linkId value="freitextFeld1"/>
Patient.idenfifier.system Die Zuordnung der Einwilligung zu einem Patienten erfolgt im gICS über SignerIds. Dazu wird das Patient-Profil der HL7 AG Einwilligungsmanagement genutzt. Die Art der SignerId (SIGNER_ID_TYPE) wird innerhalb der Domain konfiguriert (z.B. "Pseudonym") und in Patient.identifier.system entsprechend der Vorgabe <system value="https://ths-greifswald.de/fhir/gics/identifiers/[BEZEICHNER_SIGNER_ID_TYPE]>"/> erwartet. Die Angabe der SignerId erfolgt per Patient.identifier.value
Aufruf und Rückgabe

Invocations

URL: [base]/$addConsent

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

questionnaireResponse1..1QuestionnaireResponse

QuestionnaireResponse-Ressource zum Patienten, die sich auf ein entsprechendes QuestionnaireComposed bezieht. Entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/QuestionnaireComposed.

documentReference0..*DocumentReference

unstrukturiertes Originaldokument (entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/DocumentReference)

provenance0..1Provenance

Herkunftsinformationen (entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/Provenance). Umsetzungshinweis: mehrere Unterschriften für ein Dokument sind ggf. als mehrere signature-Elemente in der selben Provenance-Ressource abzubilden.

_profile0..1canonical

Angabe um Ausgabeprofil festzulegen. Default ist die gics-Variante; alternativ das Profil aus dem IG Einwilligungsmanagement.

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". Das Bundle enthält je Consent einen BundleEntry, der alle für den spezifischen Consent relevanten Ressourcen (z.B. TemplateFrame, QuestionnaireComposed, QuestionnaireResponse, Provenance) enthält. Details zu den verwendeten Profilen unter https://simplifier.net/guide/einwilligungsmanagement/igeinwilligungsmanagement . Hinweis: gICS verwirft eventuell in den übermittelten Ressourcen gesetzte id-Werte und ersetzt sie durch eigene.

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:

Aufgrund von Darstellungsproblemen bei Simplifier, ist das Example derzeit nur als Link verfügbar:

https://simplifier.net/ths-greifswald/fsh-generated-resources-parameters-parameters-addconsent-request-example-1

Eine beispielhafte Rückmeldung:

Aufgrund von Darstellungsproblemen bei Simplifier, ist das Example derzeit nur als Link verfügbar:

https://simplifier.net/ths-greifswald/addconsent-response-example-1