CapabilityStatement für Rolle "FormularDatenQuelleRolle" - XML Representation - ISiK Formularmodul Implementation Guide v6.0.0-rc

: CapabilityStatement für Rolle "FormularDatenQuelleRolle" - XML Representation

Active as of 2025-12-17

<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="ISiKCapabilityStatementFormularDatenQuelleRolle"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement ISiKCapabilityStatementFormularDatenQuelleRolle</b></p><a name="ISiKCapabilityStatementFormularDatenQuelleRolle"> </a><a name="hcISiKCapabilityStatementFormularDatenQuelleRolle"> </a><h2 id="title">CapabilityStatement für Rolle &amp;quot;FormularDatenQuelleRolle&amp;quot;</h2><ul><li>Implementation Guide Version: 6.0.0-rc </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Published on: 2025-12-17 </li><li>Published by: gematik GmbH </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h3 id="shallIGs">SHALL Support the Following Implementation Guides</h3><ul><li>https://gematik.de/fhir/isik/ImplementationGuide/ISiK-Formularmodul</li></ul><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"/></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#QuestionnaireResponse1-1">QuestionnaireResponse</a></td><td>Supported Profiles<br/>  <a href="StructureDefinition-ISiKFormularDaten.html">Ausgefülltes ISiK-Formular</a></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"/><td>_id, _tag, _count, _has, identifier, questionnaire, status, patient, authored</td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="QuestionnaireResponse1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>QuestionnaireResponse</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-6"><span class="lead">Supported Profiles</span><p><a href="StructureDefinition-ISiKFormularDaten.html">Ausgefülltes ISiK-Formular</a></p></div></div><p/><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_id</a></td><td><code>token</code></td><td><div><p><strong>Beispiel:</strong>
<code>GET [base]/[Resourcetype]?_id=103270</code>
<strong>Anwendungshinweis:</strong>
Der Parameter <code>_id</code> wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource
anhand der <code>id</code>  die <code>READ</code>-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden,
um den Abruf einer Ressource bspw. mit einem <code>_include</code> weiterer Ressourcen zu verbinden,
z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
<code>GET [base]/Encounter?_id=103270&amp;_include=Encounter:patient</code>
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt <a href="https://hl7.org/fhir/R4/search.html#all">Parameters for all resources</a>.
Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/resource.html#search">_tag</a></td><td><code>token</code></td><td><div><p><strong>Beispiel:</strong>
<code>GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review</code>
<strong>Anwendungshinweis:</strong>
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt <a href="https://hl7.org/fhir/R4/search.html#all">Parameters for all resources</a>
sowie Abschnitt <a href="https://www.hl7.org/fhir/R4/resource.html#simple-tags">Tags</a>.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td>_count</td><td><code>number</code></td><td><div><p><strong>Beispiel:</strong>
<code>GET [base]/[Resourcetype]?_count=100</code>
<strong>Anwendungshinweis:</strong>
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt <a href="https://www.hl7.org/fhir/R4/search.html#count">Page Count</a>.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html#search">identifier</a></td><td><code>token</code></td><td><div><p><strong>Beispiel:</strong><br/>
<code>GET [base]/QuestionnaireResponse?identifier=http://example.org/fhir/sid/response|qr-001</code><br/>
<strong>Anwendungshinweis:</strong><br/>
Eindeutige Identifizierungsnummer für die Formularantwort. Weitere Details siehe <a href="https://hl7.org/fhir/R4/search.html#token">FHIR-Kernspezifikation</a>.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html#search">questionnaire</a></td><td><code>reference</code></td><td><div><p><strong>Beispiel:</strong><br/>
<code>GET [base]/QuestionnaireResponse?questionnaire=Questionnaire/ISiKFormularDefinition</code><br/>
<strong>Anwendungshinweis:</strong><br/>
Verweis auf die zugrunde liegende Formulardefinition. Weitere Details siehe <a href="https://hl7.org/fhir/R4/search.html#reference">FHIR-Kernspezifikation</a>.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html#search">status</a></td><td><code>token</code></td><td><div><p><strong>Beispiel:</strong><br/>
<code>GET [base]/QuestionnaireResponse?status=completed</code><br/>
<code>GET [base]/QuestionnaireResponse?status=in-progress</code><br/>
<strong>Anwendungshinweis:</strong><br/>
Gültige Werte: in-progress | completed | amended | entered-in-error | stopped. Weitere Details siehe <a href="https://hl7.org/fhir/R4/search.html#token">FHIR-Kernspezifikation</a>.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html#search">patient</a></td><td><code>reference</code></td><td><div><p><strong>Beispiel:</strong><br/>
<code>GET [base]/QuestionnaireResponse?patient=Patient/12345</code><br/>
<strong>Anwendungshinweis:</strong><br/>
Der Patient, für den das Formular ausgefüllt wurde. Weitere Details siehe <a href="https://hl7.org/fhir/R4/search.html#reference">FHIR-Kernspezifikation</a>.</p>
</div></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaireresponse.html#search">authored</a></td><td><code>date</code></td><td><div><p><strong>Beispiel:</strong><br/>
<code>GET [base]/QuestionnaireResponse?authored=2024-01-15</code><br/>
<code>GET [base]/QuestionnaireResponse?authored=ge2024-01-01&amp;authored=le2024-12-31</code><br/>
<strong>Anwendungshinweis:</strong><br/>
Zeitstempel wann die Formularantwort zuletzt bearbeitet wurde. Weitere Details siehe <a href="https://hl7.org/fhir/R4/search.html#date">FHIR-Kernspezifikation</a>.</p>
</div></td></tr><tr><td><b>MAY</b></td><td>_has</td><td><code>string</code></td><td><div><p><strong>Beispiel:</strong> Suche nach allen Patienten, die eine Observation  mit dem Code '1234-5' haben
<code>GET [base]/Patient?_has:Observation:patient:code=1234-5</code>
<strong>Beispiel:</strong> Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
<code>GET [base]/Encounter?_has:Condition:encounter:code=A12.3</code>
<strong>Anwendungshinweis:</strong>
Weitere Details siehe FHIR-Kernspezifikation, Abschnitt <a href="https://hl7.org/fhir/R4/search.html#has">Reverse Chaining</a>.</p>
</div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
  </text>
  <url
       value="https://gematik.de/fhir/isik/CapabilityStatement/ISiKCapabilityStatementFormularDatenQuelleRolle"/>
  <version value="6.0.0-rc"/>
  <name value="ISiKCapabilityStatementFormularDatenQuelleRolle"/>
  <title
         value="CapabilityStatement für Rolle &amp;quot;FormularDatenQuelleRolle&amp;quot;"/>
  <status value="active"/>
  <experimental value="false"/>
  <date value="2025-12-17"/>
  <publisher value="gematik GmbH"/>
  <contact>
    <name value="gematik GmbH"/>
    <telecom>
      <system value="url"/>
      <value value="https://gematik.de"/>
    </telecom>
  </contact>
  <description
               value="Dieses CapabilityStatement beschreibt alle Interaktionen, 
  die ein System unterstützen MUSS, welches diese Rolle implementiert.   
  
Die CapabilityStatements in dieser Spezifikation stellen die Anforderungen seitens der gematik dar (`kind = requirements`). 
Zur Unterscheidung von Anforderungen, die erfüllt werden MÜSSEN gegenüber jenen, die erfüllt werden KÖNNEN, 
wird die [CapabilityStatement-Expectation-Extension](https://hl7.org/fhir/R4/extension-capabilitystatement-expectation.html) mit den möglichen Werten `SHALL` (=MUSS) und `MAY` (=KANN) verwendet."/>
  <purpose
           value="
CapabilityStatement für die Rolle &amp;quot;ISiKCapabilityStatementFormularDatenQuelleRolle&amp;quot;.
Diese Rolle stellt Interaktionen zur Abfrage von FormularenDaten bereit. Hierbei liegt der Fokus auf der Bereitstellung von ausgefüllten Formularen und nicht aus den Extrahierten Ressourcen. Diese sind in Rollen der anderen Module bereitgestellt."/>
  <kind value="requirements"/>
  <fhirVersion value="4.0.1"/>
  <format value="application/fhir+xml"/>
  <format value="application/fhir+json"/>
  <implementationGuide
                       value="https://gematik.de/fhir/isik/ImplementationGuide/ISiK-Formularmodul"/>
  <rest>
    <mode value="server"/>
    <resource>
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
        <valueCode value="SHALL"/>
      </extension>
      <type value="QuestionnaireResponse"/>
      <supportedProfile
                        value="https://gematik.de/fhir/isik/StructureDefinition/ISiKFormularDaten">🔗 
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
      </supportedProfile>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
      </interaction>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="_id"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
        <type value="token"/>
        <documentation
                       value="**Beispiel:**
        `GET [base]/[Resourcetype]?_id=103270`
        **Anwendungshinweis:**
        Der Parameter `_id` wird selten alleinstehend verwendet, da sich zum Abruf einer Ressource
        anhand der `id`  die `READ`-Interaktion besser anbietet. Der Parameter kann jedoch verwendet werden,
        um den Abruf einer Ressource bspw. mit einem `_include` weiterer Ressourcen zu verbinden,
        z.B. zum Abruf eines Encounters in Verbindung mit dem zugehörigen Patienten:
        `GET [base]/Encounter?_id=103270&amp;_include=Encounter:patient`
        Weitere Details siehe FHIR-Kernspezifikation, Abschnitt [Parameters for all resources](https://hl7.org/fhir/R4/search.html#all).
        Dieser Suchparameter ist für die Umsetzung des IHE PDQm Profils verpflichtend."/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="_tag"/>
        <definition value="http://hl7.org/fhir/SearchParameter/Resource-tag"/>
        <type value="token"/>
        <documentation
                       value="**Beispiel:**
        `GET [base]/[Resourcetype]?_tag=https://example.org/codes|needs-review`
        **Anwendungshinweis:**
        Weitere Details siehe FHIR-Kernspezifikation, Abschnitt [Parameters for all resources](https://hl7.org/fhir/R4/search.html#all)
        sowie Abschnitt [Tags](https://www.hl7.org/fhir/R4/resource.html#simple-tags).  "/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="_count"/>
        <type value="number"/>
        <documentation
                       value="**Beispiel:**
        `GET [base]/[Resourcetype]?_count=100`
        **Anwendungshinweis:**
        Weitere Details siehe FHIR-Kernspezifikation, Abschnitt [Page Count](https://www.hl7.org/fhir/R4/search.html#count).  "/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <name value="_has"/>
        <type value="string"/>
        <documentation
                       value="**Beispiel:** Suche nach allen Patienten, die eine Observation  mit dem Code '1234-5' haben
        `GET [base]/Patient?_has:Observation:patient:code=1234-5`
        **Beispiel:** Suche nach allen Encountern, bei denen die Diagnose 'A12.3' gestellt wurde
        `GET [base]/Encounter?_has:Condition:encounter:code=A12.3`
        **Anwendungshinweis:**
        Weitere Details siehe FHIR-Kernspezifikation, Abschnitt [Reverse Chaining](https://hl7.org/fhir/R4/search.html#has).  "/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-identifier"/>
        <type value="token"/>
        <documentation
                       value="**Beispiel:**    
        `GET [base]/QuestionnaireResponse?identifier=http://example.org/fhir/sid/response|qr-001`    
        **Anwendungshinweis:**   
        Eindeutige Identifizierungsnummer für die Formularantwort. Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#token).  "/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="questionnaire"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-questionnaire"/>
        <type value="reference"/>
        <documentation
                       value="**Beispiel:**    
        `GET [base]/QuestionnaireResponse?questionnaire=Questionnaire/ISiKFormularDefinition`    
        **Anwendungshinweis:**   
        Verweis auf die zugrunde liegende Formulardefinition. Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#reference).  "/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-status"/>
        <type value="token"/>
        <documentation
                       value="**Beispiel:**    
        `GET [base]/QuestionnaireResponse?status=completed`  
        `GET [base]/QuestionnaireResponse?status=in-progress`    
        **Anwendungshinweis:**   
        Gültige Werte: in-progress | completed | amended | entered-in-error | stopped. Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#token).  "/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="patient"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-patient"/>
        <type value="reference"/>
        <documentation
                       value="**Beispiel:**    
        `GET [base]/QuestionnaireResponse?patient=Patient/12345`    
        **Anwendungshinweis:**   
        Der Patient, für den das Formular ausgefüllt wurde. Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#reference).  "/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="authored"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireResponse-authored"/>
        <type value="date"/>
        <documentation
                       value="**Beispiel:**    
        `GET [base]/QuestionnaireResponse?authored=2024-01-15`  
        `GET [base]/QuestionnaireResponse?authored=ge2024-01-01&amp;authored=le2024-12-31`    
        **Anwendungshinweis:**   
        Zeitstempel wann die Formularantwort zuletzt bearbeitet wurde. Weitere Details siehe [FHIR-Kernspezifikation](https://hl7.org/fhir/R4/search.html#date).  "/>
      </searchParam>
    </resource>
  </rest>
</CapabilityStatement>