2025.2.0 - ci-build

IGTTPFHIRGatewaygICS - Local Development build (v2025.2.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

: AddConsent - XML Representation

Active as of 2025-06-12

Raw xml | Download


<OperationDefinition xmlns="http://hl7.org/fhir">
  <id value="AddConsent"/>
  <language value="de-DE"/>
  <text>
    <status value="generated"/>
    <div xml:lang="de-DE" xmlns="http://www.w3.org/1999/xhtml" lang="de-DE"><p class="res-header-id"><b>Generated Narrative: OperationDefinition AddConsent</b></p><a name="AddConsent"> </a><a name="hcAddConsent"> </a><div style="display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%"><p style="margin-bottom: 0px">Language: de-DE</p></div><p>URL: [base]/$addConsent</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/patient.html">Patient</a></td><td/><td><div><p>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.</p>
</div></td></tr><tr><td>IN</td><td>domain</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>Angabe der Einwilligungsdomaene</p>
</div></td></tr><tr><td>IN</td><td>questionnaireResponse</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a></td><td/><td><div><p>QuestionnaireResponse-Ressource zum Patienten, die sich auf ein entsprechendes QuestionnaireComposed bezieht. Entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/QuestionnaireComposed.</p>
</div></td></tr><tr><td>IN</td><td>documentReference</td><td/><td>0..*</td><td><a href="http://hl7.org/fhir/R4/documentreference.html">DocumentReference</a></td><td/><td><div><p>unstrukturiertes Originaldokument (entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/DocumentReference)</p>
</div></td></tr><tr><td>IN</td><td>provenance</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/provenance.html">Provenance</a></td><td/><td><div><p>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.</p>
</div></td></tr><tr><td>IN</td><td>_profile</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#canonical">canonical</a></td><td/><td><div><p>Angabe um Ausgabeprofil festzulegen.
Default ist die gics-Variante; alternativ das Profil aus dem IG Einwilligungsmanagement.</p>
</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a></td><td/><td><div><p>Bundle vom Typ collection, das die errechneten Consent-Ressourcen enthält.</p>
</div></td></tr></table><div><p>Liefert alle Consente einer Person einer spezifischen Einwilligungsdomaene, die sich aus den übermittelten Informationen ergeben. Die Rückgabe erfolgt als Bundle vom Typ &quot;collection&quot;. 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 unterhttps://ig.fhir.de/einwilligungsmanagement/stable/Home.html . Hinweis: gICS verwirft eventuell in den übermittelten Ressourcen gesetzte id-Werte und ersetzt sie durch eigene.</p>
</div></div>
  </text>
  <url
       value="https://ths-greifswald.de/fhir/OperationDefinition/gics/addConsent"/>
  <version value="2025.2.0"/>
  <name value="AddConsent"/>
  <title value="AddConsent"/>
  <status value="active"/>
  <kind value="operation"/>
  <date value="2025-06-12"/>
  <publisher
             value="Unabhängige Treuhandstelle der Universitätsmedizin Greifswald"/>
  <contact>
    <name
          value="Unabhängige Treuhandstelle der Universitätsmedizin Greifswald"/>
    <telecom>
      <system value="url"/>
      <value value="https://www.ths-greifswald.de/"/>
    </telecom>
  </contact>
  <description
               value="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 &quot;collection&quot;. Das Bundle enthält die errechnete FHIR Consent-Resource, sowie alle für diesen spezifischen Consent relevanten Ressourcen (z.B. QuestionnaireComposed, QuestionnaireResponse, Provenance, Patient). "/>
  <purpose
           value="Teil des FHIR Gateway für gICS. Weitere Infos unter https://ths-greifswald.de/gics"/>
  <affectsState value="true"/>
  <code value="addConsent"/>
  <comment
           value="Liefert alle Consente einer Person einer spezifischen Einwilligungsdomaene, die sich aus den übermittelten Informationen ergeben. Die Rückgabe erfolgt als Bundle vom Typ &quot;collection&quot;. 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 unterhttps://ig.fhir.de/einwilligungsmanagement/stable/Home.html . Hinweis: gICS verwirft eventuell in den übermittelten Ressourcen gesetzte id-Werte und ersetzt sie durch eigene."/>
  <system value="true"/>
  <type value="false"/>
  <instance value="false"/>
  <parameter>
    <name value="patient"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="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."/>
    <type value="Patient"/>
  </parameter>
  <parameter>
    <name value="domain"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation value="Angabe der Einwilligungsdomaene"/>
    <type value="string"/>
  </parameter>
  <parameter>
    <name value="questionnaireResponse"/>
    <use value="in"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="QuestionnaireResponse-Ressource zum Patienten, die sich auf ein entsprechendes QuestionnaireComposed bezieht. Entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/QuestionnaireComposed."/>
    <type value="QuestionnaireResponse"/>
  </parameter>
  <parameter>
    <name value="documentReference"/>
    <use value="in"/>
    <min value="0"/>
    <max value="*"/>
    <documentation
                   value="unstrukturiertes Originaldokument (entsprechend dem Profil http://fhir.de/ConsentManagement/StructureDefinition/DocumentReference)"/>
    <type value="DocumentReference"/>
  </parameter>
  <parameter>
    <name value="provenance"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="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."/>
    <type value="Provenance"/>
  </parameter>
  <parameter>
    <name value="_profile"/>
    <use value="in"/>
    <min value="0"/>
    <max value="1"/>
    <documentation
                   value="Angabe um Ausgabeprofil festzulegen.
Default ist die gics-Variante; alternativ das Profil aus dem IG Einwilligungsmanagement."/>
    <type value="canonical"/>
  </parameter>
  <parameter>
    <name value="return"/>
    <use value="out"/>
    <min value="1"/>
    <max value="1"/>
    <documentation
                   value="Bundle vom Typ collection, das die errechneten Consent-Ressourcen enthält."/>
    <type value="Bundle"/>
  </parameter>
</OperationDefinition>