IGTTPFHIRGatewaygICS - Local Development build (v2025.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Contents:
This page provides a list of the FHIR artifacts defined as part of this implementation guide.
These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide.
| AddConsent |
Nimmt die Einwilligungsinformationen einschließlich Nebeninformationen (Unterschrift, Scan) für einen (ggf. neuen) Patienten entgegen, um auf dieser Basis eine neue Einwilligung im gICS zu erzeugen. Liefert Bundle vom Typ "collection". Das Bundle enthält die errechnete FHIR Consent-Resource, sowie alle für diesen spezifischen Consent relevanten Ressourcen (z.B. QuestionnaireComposed, QuestionnaireResponse, Provenance, Patient). |
| AddConsentOptOut |
Erstellt die Einwilligungsinformationen in einem Opt-Out-Kontext für einen (ggf. neuen) Patienten, um auf dieser Basis eine neue Einwilligung im gICS zu erzeugen. Liefert Bundle vom Typ "collection". Das Bundle enthält die errechnete FHIR Consent-Resource. |
| AllConsentsForDomain |
Liefert alle Consente einer spezifischen Einwilligungsdomaene. Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält je Consent jeweils ein Bundle mit allen für den spezifischen Consent relevanten Ressourcen (TemplateFrame, QuestionnaireComposed, QuestionnaireResponse, Provenance,Patient und i.a. DocumentReference). Details zu den verwendeten Profilen unterhttps://ig.fhir.de/einwilligungsmanagement/stable/Home.html |
| AllConsentsForPerson |
Liefert alle Consente einer Person einer spezifischen Einwilligungsdomaene. 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 unterhttps://ig.fhir.de/einwilligungsmanagement/stable/Home.html |
| AllConsentsForTemplate |
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 unterhttps://ig.fhir.de/einwilligungsmanagement/stable/Home.html |
| AllPolicyStatesForPerson |
Liefert alle jemals unterzeichneten Policies einer Person einer spezifischen Einwilligungsdomaene. Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält ausschließlich Consent-Ressourcen zur Abbildung der Policies, d.h. je unterzeichneter Policy ist eine Consent-Ressource mit jeweils einer Policy (provision) enthalten. Es werden alle jemals von Patienten unterzeichneten Policies zurückgegeben (ConsentProvisionType: permit/deny). Policies mit gICS-internem Status UNKNOWN, NOT_ASKED, NOT_CHOSEN, WITHDRAWN, INVALIDATED, REFUSED oder EXPIRED werden mit ConsentProvisionType "deny" zurückgegeben. Sollen nur die jeweils neueste Policies angezeigt werden, ist clientseit eine Filterung anhand Datum, Policyversion etc. erforderlich oder alternativ die Operation currentPolicyStatesForPerson zu nutzen. |
| CurrentConsentForPersonAndTemplate |
Liefert den aktuellen Consent einer Person bezogen auf eine spezifische Einwilligungsvorlage (unter Angabe des TemplateFrame-Identifiers) per POST-Request. Aktuell bedeutet <b>"höchste Version der Einwilligungsvorlage" UND "jüngstes Datum"</b>. Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält alle für den spezifischen Consent relevanten Ressourcen (z.B. TemplateFrame, QuestionnaireComposed, QuestionnaireResponse, Provenance). Details zu den verwendeten Profilen unterhttps://ig.fhir.de/einwilligungsmanagement/stable/Home.html |
| CurrentPolicyStatesForPerson |
Liefert die aktuellen, gültigen Policies einer Person einer spezifischen Einwilligungsdomaene (Status: permit, deny). Die Rückgabe erfolgt als Bundle vom Typ "collection". Das Bundle enthält ausschließlich Consent-Ressourcen zur Abbildung der Policies, d.h. je unterzeichneter Policy ist eine Consent-Ressource mit jeweils einer Policy (provision) enthalten. Per default werden alle aktuell gültigen vom Patienten unterzeichneten Policies zurückgegeben (Accepted=Permit, Declined=Deny, Unknown=Deny). Sollen eingewilligte Policies mit Status "Unknown" ignoriert werden (mittels UNKNOWN können detailliertere Statusangaben wie UNKNOWN, NOT_ASKED, NOT_CHOSEN, WITHDRAWN, INVALIDATED, REFUSED und EXPIRED intern gruppiert werden) , kann dies parametrisiert werden (checkconsentconfig.unknownStateIsConsideredAsDecline=false). |
| GetAllConsentedIdsFor |
Abruf aller Identifier eines bestimmten benannten Identifier-Typs (z.b. studyPsn) für eine bestimmte Policy (Coding) und Domäne. Zurück geliefert wird eine Liste von eingewilligten Identifiern in Bezug auf die spezifizierte Policy. |
| IsConsented |
Liefert den Einwilligungsstatus eines Patienten für eine spezifische Policy per POST-Request. Die Rückgabe erfolgt als Parameters-Ressource. |
These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.
| ActivityDefinitionCode |
Eindeutiger Code der Consent Policy (ActivityDefiniton) |
| domain |
Eindeutiger Name (Identifikator) der referenzierten Consent Domain |
| useContextIdentifier |
Eindeutiger Name (Identifikator) der referenzierten Consent Domain |
These define constraints on FHIR resources for systems conforming to this implementation guide.
| Consent |
Angepasstes FHIR Consent Profil auf Basis des offiziellen Consent-Profils der Hl7 AG Einwilligungsmanagement erweitertet um ausgewählte gICS Eigenschaften. |
| Consent Domain |
Erweitertes Profil der Consent Management Domain Research Study (Arbeitsgruppe Einwilligungsmanagement) zur Abbildung aller relevanten Domänen-Infos für gICS über entsprechende Extensions |
| Consent Module |
Wiederverwendbares Consent Module auf Basis des ConsentManagementTemplateModules erweitertet um ausgewählte gICS Eigenschaften |
| Consent Quality Control |
Dokumentation des Status der Qualitätsprüfung einer ausgefüllten Einwilligung (QuestionnaireResponse) |
| Consent Template |
Einwilligungsvorlage auf Basis des ConsentManagementTemplateFrame erweitertet um ausgewählte gICS Eigenschaften |
| ConsentPolicy |
Abbildung aller relevanten Information zur Verwaltung wiederverwendbarer Einwilligungspolicies mit gICS |
| ExchangeFormatDefinition |
Die in diesem Bundle enthaltenen FHIR-Ressourcen definieren in ihrer Gesamtheit ein oder mehrere Einwiliigungs-Vorlagen (Templates, FHIR-Questionnaires) zu einem bestimmten Kontext. |
| Herkunftsinformationen und Signatur |
Erweitertes Profil der Provenance (Arbeitsgruppe Einwilligungsmanagement) zur Abbildung aller relevanten Informationen für gICS über entsprechende Extensions. |
| Patient pseudonymisiert |
Patienten-Profil im Kontext der Pseudonymisierung. |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Identifier-Profil für die Abbildung einer Bloomfilters |
Identifier-Profil für die Abbildung einer Bloomfilters |
These define constraints on FHIR data types for systems conforming to this implementation guide.
| Comment |
ergänzender Kommentar |
| ConfigurationProperties |
Configuration Properties (Parameters) in XML format, base64 encoded. |
| Consent Policy Reference |
Referenz auf eine Consent Policy zur Verwendung innerhalb eines Consent Moduls |
| Created |
Erstellungsdatum der Ressource/Information |
| Expiration Property |
Key Value Expiration Property Element zur Definition von Gültigkeitszeiträumen |
| External Property Element |
Key Value Property Element für External Properties zur Individualisierung von Domains, Policies, Modules und Templates |
| FreeTextDef Attributes |
gics-spezifische Attribute von frei definierten Eingaben |
| Module Version Format |
Versionierungsformat der Module einer Consent Domain, basierend auf Vorarbeiten der AG Einwilligungsmanagement des InteropForums |
| Policy Version Format |
Versionierungsformat der Policies einer Consent Domain, basierend auf Vorarbeiten der AG Einwilligungsmanagement des InteropForums |
| Position |
Position (Ordinate) eines Items im Questionnaire. Im Kontext von FHIR ist diese Angabe redundant, wird aber dennoch mitgeführt |
| Property Element |
Key Value Property Element für Properties zur Individualisierung von Domains, Policies, Modules und Templates |
| Questionnaire Label |
Label in einem Questionnaire |
| Short Text |
Kurztext zum Item |
| SupportedVersion |
unterstüzte Version |
| Template Version Format |
Versionierungsformat der Templates einer Consent Domain, basierend auf Vorarbeiten der AG Einwilligungsmanagement des InteropForums |
| ValidFromProperty |
Specifies the point in time from which the domain is valid. |
| Version Label |
Label für eine Zusatz-Version in einem Questionnaire |
These define sets of codes used by systems conforming to this implementation guide.
These define new code systems used by systems conforming to this implementation guide.
| BloomfilterType |
Types of Bloomfilters. |
| ConsentComponentType |
Typen der für gICS relevanten Consent-Componenten zur Unterscheidung als Suchkriterium |
| ConsentPolicyAction |
Extensible description of the permissible (data processing-) action resulting from consented module or policy. |
| ConsentPolicyActor |
Expandable categorisation of consumer/requestor of a consent enforcement request related to a specific consent component (e.g. policy or module) |
| ConsentPolicyClass |
Extensible description of the application perspective of a ConsentPolicy (e.g. selected data view 'IDAT') |
| ConsentPolicyPurpose |
Expandable specification of the application context and/or scope of a consent policy or module |
| ConsentStatus |
consent states are used to depict the participant’s will. Therefore, documentation should allow different status values. Further details from https://doi.org/10.1186/s12967-020-02457-y |
| DesignationUse |
Use codes (contexts) for terminology designations |
| Policy |
Policies used in consent management |
These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.