AllConsentsForTemplate
Unterstützt ab TTP-FHIR Gateway Version 2.1.0
Voraussetzung
- Spezifizierte Domäne muss angelegt sein
- Es muss eine gültige Einwilligung mit dem gegebenen personIdentifier existieren
- Das spezifizierte Template muss Grundlage einer gültigen Einwilligung sein
Aufruf und Rückgabe
Invocations
URL: [base]/$allConsentsForTemplate
This operation does NOT change content
Parameters (In)
| Name | Cardinality | Type | Documentation |
| template | 1..1 | string | Angabe der eindeutigen TemplateId in Form des TemplateFrame.Identifier.Value für das vorbelegte Template.Identifier.System "https://ths-greifswald.de/fhir/gics/" |
| domain | 1..1 | string | Angabe der Einwilligungsdomaene |
| _profile | 0..1 | canonical | Angabe um Ausgabeprofil festzulegen. Default ist das Consent-Profil der HL7-D AG Einwilligungsmanagement |
Return Values (Out)
| Name | Cardinality | Type | Documentation |
| return | 0..1 | Bundle | Bundle mit den beschriebenen Inhalten |
Liefert alle Consente eines spezifischen TemplateFrame unter Angabe des TemplateFrame-Identifiers (Vorlagenbezug) per POST-Request. Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält je Consent einen Bundle-Entry, 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
Paging entsprechend der FHIR Search API wird ab TTP-FHIR Gateway Version 2023.1.1 unterstützt, namentlich die Parameter
- _count: (maximale) Anzahl der im Bundle enthaltenen Ressourcen
- _offset: fortlaufende Nummer der ersten im Bundle enthaltenen Ressource
Der Default-Offset ist 0. Der Default-Count ist 100. Negative Werte für _offset und _count sind nicht erlaubt. Werden weder _count noch _offset angegeben, enthält das Bundle maximal 100 Ergebnisse (Default-Count=100, Default-Offset=0).
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="AllConsentsForTemplate-request-example-1" /> <parameter> <name value="template" /> <valueString value="MII;Patienteneinwilligung MII;1.6.f" /> </parameter> <parameter> <name value="domain" /> <valueString value="MII" /> </parameter> </Parameters>
Beispielhafte Rückmeldung:
<Bundle xmlns="http://hl7.org/fhir"> <id value="AllConsentsForTemplate-response-example-1" /> <type value="collection" /> <entry> <fullUrl value="urn:uuid:6ed0379b-478e-4db4-b226-3edb6897aec1" /> <resource> <Bundle> <id value="6ed0379b-478e-4db4-b226-3edb6897aec1" /> <type value="collection" /> <entry> <fullUrl value="urn:uuid:2814dd4c-98fe-49a2-9df9-8fd6e9752725" /> <resource> <QuestionnaireResponse> <id value="2814dd4c-98fe-49a2-9df9-8fd6e9752725" /> <meta> <lastUpdated value="2021-05-19T17:50:23.000+02:00" /> <profile value="http://fhir.de/ConsentManagement/StructureDefinition/QuestionnaireResponse" /> </meta> <language value="DE" /> <questionnaire value="https://ths-greifswald.de/fhir/gics/QuestionnaireComposed/MII/Patienteneinwilligung+MII|1.6.f" /> <status value="completed" /> <subject> <reference value="Patient/6a49f9c8-9986-4bbf-9bb6-17a083b85515" /> <display value="Pseudonym dic_1H51T" /> </subject> <authored value="2021-05-19T00:00:00+02:00" /> <author> <reference value="Patient/6a49f9c8-9986-4bbf-9bb6-17a083b85515" /> <display value="Pseudonym dic_1H51T" /> </author> <source> <reference value="Patient/6a49f9c8-9986-4bbf-9bb6-17a083b85515" /> <display value="Pseudonym dic_1H51T" /> </source> <item> <linkId value="PATDAT_erheben_speichern_nutzen|1.6" /> <answer> <valueCoding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.2" /> <code value="2.16.840.1.113883.3.1937.777.24.5.2.1" /> <display value="gültig" /> </valueCoding> </answer> </item> <item> <linkId value="KKDAT_retrospektiv_uebertragen_speichern_nutzen|1.6" /> <answer> <valueCoding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.2" /> <code value="2.16.840.1.113883.3.1937.777.24.5.2.2" /> <display value="ungültig" /> </valueCoding> </answer> </item> <item> <linkId value="KKDAT_prospektiv_uebertragen_speichern_nutzen|1.6" /> <answer> <valueCoding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.2" /> <code value="2.16.840.1.113883.3.1937.777.24.5.2.2" /> <display value="ungültig" /> </valueCoding> </answer> </item> <item> <linkId value="BIOMAT_erheben_lagern_nutzen|1.6" /> <answer> <valueCoding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.2" /> <code value="2.16.840.1.113883.3.1937.777.24.5.2.2" /> <display value="ungültig" /> </valueCoding> </answer> </item> <item> <linkId value="BIOMAT_Zusatzentnahme|1.6" /> <answer> <valueCoding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.2" /> <code value="2.16.840.1.113883.3.1937.777.24.5.2.2" /> <display value="ungültig" /> </valueCoding> </answer> </item> <item> <linkId value="Rekontaktierung_Ergaenzungen|1.6" /> <answer> <valueCoding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.2" /> <code value="2.16.840.1.113883.3.1937.777.24.5.2.1" /> <display value="gültig" /> </valueCoding> </answer> </item> <item> <linkId value="Rekontaktierung_Zusatzbefund|1.6" /> <answer> <valueCoding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.2" /> <code value="2.16.840.1.113883.3.1937.777.24.5.2.1" /> <display value="gültig" /> </valueCoding> </answer> </item> <item> <linkId value="Z1_GECCO83_Nutzung_NUM_CODEX|1.0" /> <answer> <valueCoding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.2" /> <code value="2.16.840.1.113883.3.1937.777.24.5.2.1" /> <display value="gültig" /> </valueCoding> </answer> </item> <item> <linkId value="Z1_GECCO83_Weitergabe_NUM_CODEX_EU_DSGVO_nonkonform|1.0" /> <answer> <valueCoding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.2" /> <code value="2.16.840.1.113883.3.1937.777.24.5.2.2" /> <display value="ungültig" /> </valueCoding> </answer> </item> </QuestionnaireResponse> </resource> </entry> <entry> <fullUrl value="urn:uuid:4638ac78-3d25-4610-a328-e4b145284573" /> <resource> <Consent> <id value="4638ac78-3d25-4610-a328-e4b145284573" /> <meta> <lastUpdated value="2021-05-19T17:50:23.000+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/593d66f3-3654-4e8a-9524-3bcd78a363bb" /> </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> <patient> <reference value="Patient/6a49f9c8-9986-4bbf-9bb6-17a083b85515" /> <display value="Pseudonym dic_1H51T" /> </patient> <dateTime value="2021-05-19T00:00:00+02:00" /> <organization> <display value="MII" /> </organization> <sourceReference> <reference value="QuestionnaireResponse/dfd5edc6-3a8a-4796-a9bb-f9572cf15c96" /> </sourceReference> <policy> <uri value="urn:oid:2.16.840.1.113883.3.1937.777.24.2.184" /> </policy> <provision> <type value="deny" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="IDAT_bereitstellen_EU_DSGVO_NIVEAU" /> <display value="Herausgabe identifizierender Daten (IDAT)[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.5" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="IDAT_erheben" /> <display value="Erfassung neuer identifizierender Daten (IDAT)" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.2" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="IDAT_speichern_verarbeiten" /> <display value="Speicherung und Verarbeitung identifizierender Daten (IDAT)[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.3" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="IDAT_zusammenfuehren_Dritte" /> <display value="Zusammenführung identifizierender Daten (IDAT)[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.4" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="MDAT_erheben" /> <display value="Erfassung medizinischer Daten" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.6" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="MDAT_speichern_verarbeiten" /> <display value="Speicherung_Verarbeitung von medizinischen Daten[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.7" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="MDAT_wissenschaftlich_nutzen_EU_DSGVO_NIVEAU" /> <display value="Bereitstellung medizinischer Daten (MDAT)[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.8" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="MDAT_zusammenfuehren_Dritte" /> <display value="Zusammenführung medizinischer Daten (MDAT)[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.9" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="Rekontaktierung_Verknuepfung_Datenbanken" /> <display value="Rekontaktierung zur Verknüpfung[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.27" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="Rekontaktierung_weitere_Erhebung" /> <display value="Rekontaktierung bezüglich Erhebung zusätzlicher Daten" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.28" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="Rekontaktierung_weitere_Studien" /> <display value="Rekontaktierung bezüglich Information[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.29" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="MDAT_GECCO83_bereitstellen_NUM_CODEX" /> <display value="Medizinische Daten des GECCO83 Datensatz[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.33" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy" /> <code value="MDAT_GECCO83_speichern_verarbeiten_NUM_CODEX" /> <display value="Medizinische Daten des GECCO83 Datensatz[...]" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.34" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy/MII" /> <code value="MDAT_GECCO83_wissenschaftlich_nutzen_COVID_19_Forschung_EU_DSGVO_konform" /> <display value="Nutzung des Covid-19-Datensatzes[...]" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy/MII" /> <code value="MDAT_GECCO83_wissenschaftlich_nutzen_Pandemie_Forschung_EU_DSGVO_konform" /> <display value="Nutzung des Covid-19-Datensatzes[...]" /> </coding> </code> </provision> <provision> <type value="permit" /> <period> <start value="2021-05-19T17:50:22+02:00" /> <end value="2051-05-19T17:50:23+02:00" /> </period> <code> <coding> <system value="https://ths-greifswald.de/fhir/CodeSystem/gics/Policy/MII" /> <code value="Rekontaktierung_Zusatzbefund" /> <display value="Rekontaktierung bezüglich Zusatzbefund" /> </coding> </code> <code> <coding> <system value="urn:oid:2.16.840.1.113883.3.1937.777.24.5.3" /> <code value="2.16.840.1.113883.3.1937.777.24.5.3.31" /> </coding> </code> </provision> </provision> </Consent> </resource> </entry> <entry> <fullUrl value="urn:uuid:16d0ca6d-1e36-4511-9bfe-f6e2a0606973" /> <resource> <Provenance> <id value="16d0ca6d-1e36-4511-9bfe-f6e2a0606973" /> <meta> <lastUpdated value="2021-05-19T17:50:23.000+02:00" /> <profile value="https://ths-greifswald.de/fhir/StructureDefinition/gics/Provenance" /> <profile value="http://fhir.de/ConsentManagement/StructureDefinition/Provenance" /> </meta> <target> <reference value="Consent/4638ac78-3d25-4610-a328-e4b145284573" /> </target> <recorded value="2021-05-19T17:50:23.000+02:00" /> <agent> <who> <display value="https://ths-greifswald.de/gics" /> </who> </agent> <signature> <extension url="https://ths-greifswald.de/fhir/StructureDefinition/gics/SignatureLocation"> <valueString value="Erlangen" /> </extension> <type> <system value="urn:iso-astm:E1762-95:2013" /> <code value="1.2.840.10065.1.12.1.7" /> <display value="Consent Signature" /> </type> <when value="2021-05-19T00:00:00.000+02:00" /> <who> <reference value="Patient/6a49f9c8-9986-4bbf-9bb6-17a083b85515" /> <display value="Pseudonym dic_1H51T" /> </who> <data value="ZHVtbXky" /> </signature> <signature> <extension url="https://ths-greifswald.de/fhir/StructureDefinition/gics/SignatureLocation"> <valueString value="Erlangen" /> </extension> <type> <system value="urn:iso-astm:E1762-95:2013" /> <code value="1.2.840.10065.1.12.1.5" /> <display value="Verification Signature" /> </type> <when value="2021-05-19T00:00:00.000+02:00" /> <who> <display value="arzt_12345" /> </who> <data value="ZHVtbXk=" /> </signature> </Provenance> </resource> </entry> <entry> <fullUrl value="urn:uuid:6a49f9c8-9986-4bbf-9bb6-17a083b85515" /> <resource> <Patient> <id value="6a49f9c8-9986-4bbf-9bb6-17a083b85515" /> <meta> <lastUpdated value="2021-05-19T17:50:23.000+02:00" /> <profile value="https://ths-greifswald.de/fhir/StructureDefinition/epix/Patient" /> <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="dic_1H51T" /> </identifier> </Patient> </resource> </entry> </Bundle> </resource> </entry> </Bundle>