Structured Data Capture
3.0.0 - STU 3
Structured Data Capture
3.0.0 - STU 3
This page is part of the Structured Data Capture FHIR IG (v3.0.0: STU 3) based on FHIR R4. This is the current published version. For a full list of available versions, see the Directory of published versions 
| Page standards status: Trial-use | Maturity Level: 3 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="sdc-form-archiver"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<h2>SDC Form Archiver</h2>
<p>(Requirements Definition Capability Statement)</p>
<p>Canonical URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-archiver Published: 2015-09-03 (draft)</p>
<p>Published by: <b>HL7 International - FHIR Infrastructure</b>
</p>
<p>This profile defines the expected capabilities of the <i>SDC Form Archiver</i> role when conforming to the S&I Framework's <a href="index.html">Structured Data Capture FHIR implementation guide</a>. This role is responsible for persisting (archiving) completed or partially completed forms (<a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a> resource instances). These instances may be submitted individually or in a bundle together with <a href="http://hl7.org/fhir/R4/provenance.html">Provenance</a> information providing details about the completion of the questionnaire response. In some cases <a href="http://hl7.org/fhir/R4/binary.html">Binary</a> or <a href="http://hl7.org/fhir/R4/documentreference.html">DocumentReference</a> resources might also be submitted to convey source information used in the population of the questionnaire response.</p>
<p>The purpose of this role is to capture "work in progress" for archival reasons. There is no expectation that submitted form data is subsequently made available for retrieval (at least not in the same format), though it might be made available through out-of-band mechanisms.</p>
<h2>General</h2>
<div class="table-wrapper">
<table class="grid">
<tbody>
<tr>
<th>FHIR Version:</th>
<td>1.0.0</td>
</tr>
<tr>
<th>Supported formats:</th>
<td>xml, json</td>
</tr>
</tbody>
</table>
</div>
<h2>REST client behavior</h2>
<p>The <a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a> may be sent as a single instance or as a FHIR <a href="http://hl7.org/fhir/R4/bundle.html">Bundle</a> also containing <a href="http://hl7.org/fhir/R4/provenance.html">Provenance</a> resources providing details on the sources of information. A Bundle submission might also include <a href="http://hl7.org/fhir/R4/binary.html">Binary</a> and/or <a href="http://hl7.org/fhir/R4/documentreference.html">DocumentReference</a> instances referring to the data used to populate the form. A Form Archiver must support persisting, searching and retrieving those resources.</p>
<p>
<b>Security:</b>
</p>
<p>Implementations must meet the general security requirements documented in the <a href="security.html">SDC implementation guide</a>.</p>
<h3>Resource summary</h3>
<div class="table-wrapper">
<table class="grid">
<thead>
<tr>
<th>Resource</th>
<th>Search</th>
<th>Read</th>
<th>Read Version</th>
<th>Instance History</th>
<th>Resource History</th>
<th>Create</th>
<th>Update</th>
<th>Delete</th>
<th>Operations</th>
</tr>
</thead>
<tbody>
<tr>
<th>QuestionnaireResponse (<a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse">Profile</a>)</th>
<td/>
<td/>
<td/>
<td/>
<td/>
<td>
<a href="#QuestionnaireResponse-create" title="Allows archiving (storing) a completed or partially-completed form">SHALL</a>
</td>
<td>
<a href="#QuestionnaireResponse-update" title="Allows updating a previously archived form. (Systems may place rules on who can update forms and under what circumstances).">SHOULD</a>
</td>
<td>
<a href="#QuestionnaireResponse-delete" title="Allows removal of an archived form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a submitted response and under what circumstances.">MAY</a>
</td>
<td/>
</tr>
<tr>
<th>Binary</th>
<td/>
<td/>
<td/>
<td/>
<td/>
<td>
<a href="#Binary-create" title="Allows storage of a binary (generally containing information used in the completion of a QuestionnaireResponse). The data might be in a variety of forms.">SHOULD</a>
</td>
<td>
<a href="#Binary-update" title="Allows updating a previously submitted binary data. (Systems may place rules on who can update binary data and under what circumstances).">MAY</a>
</td>
<td>
<a href="#Binary-delete" title="Allows removal of binary data from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove binary data and under what circumstances.">MAY</a>
</td>
<td/>
</tr>
<tr>
<th>DocumentReference</th>
<td/>
<td/>
<td/>
<td/>
<td/>
<td>
<a href="#DocumentReference-create" title="Allows storage of a document reference (generally containing information used in the completion of a QuestionnaireResponse).">SHOULD</a>
</td>
<td>
<a href="#DocumentReference-update" title="Allows updating a previously submitted document reference. (Systems may place rules on who can update document references and under what circumstances).">MAY</a>
</td>
<td>
<a href="#DocumentReference-delete" title="Allows removal of document references from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove document references and under what circumstances.">MAY</a>
</td>
<td/>
</tr>
<tr>
<th>Provenance</th>
<td/>
<td/>
<td/>
<td/>
<td/>
<td>
<a href="#Provenance-create" title="Allows submitting a Provenance record associated with a particular QuestionnaireResponse.">SHOULD</a>
</td>
<td/>
<td/>
<td/>
</tr>
</tbody>
</table>
</div>
<h3>General interactions</h3>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Capability Statement</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="-transaction"> </a>
<span>transaction</span>
</th>
<td>SHOULD</td>
<td>
<p>Modes: </p>
<p>Allows submission of a <a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a> together with <a href="http://hl7.org/fhir/R4/provenance.html">Provenance</a> and other supporting resources as a single unit of work.</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a>
</h3>
<p>Profile: <a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse</a>
</p>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="QuestionnaireResponse-create"> </a>
<span>create</span>
</th>
<td>SHALL</td>
<td>
<p>Allows archiving (storing) a completed or partially-completed form</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-update"> </a>
<span>update</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows updating a previously archived form. (Systems may place rules on who can update forms and under what circumstances).</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-delete"> </a>
<span>delete</span>
</th>
<td>MAY</td>
<td>
<p>Allows removal of an archived form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a submitted response and under what circumstances.</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/binary.html">Binary</a>
</h3>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Binary-create"> </a>
<span>create</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows storage of a binary (generally containing information used in the completion of a <a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a>). The data might be in a variety of forms.</p>
</td>
</tr>
<tr>
<th>
<a name="Binary-update"> </a>
<span>update</span>
</th>
<td>MAY</td>
<td>
<p>Allows updating a previously submitted binary data. (Systems may place rules on who can update binary data and under what circumstances).</p>
</td>
</tr>
<tr>
<th>
<a name="Binary-delete"> </a>
<span>delete</span>
</th>
<td>MAY</td>
<td>
<p>Allows removal of binary data from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove binary data and under what circumstances.</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/documentreference.html">DocumentReference</a>
</h3>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="DocumentReference-create"> </a>
<span>create</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows storage of a document reference (generally containing information used in the completion of a <a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a>).</p>
</td>
</tr>
<tr>
<th>
<a name="DocumentReference-update"> </a>
<span>update</span>
</th>
<td>MAY</td>
<td>
<p>Allows updating a previously submitted document reference. (Systems may place rules on who can update document references and under what circumstances).</p>
</td>
</tr>
<tr>
<th>
<a name="DocumentReference-delete"> </a>
<span>delete</span>
</th>
<td>MAY</td>
<td>
<p>Allows removal of document references from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove document references and under what circumstances.</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/provenance.html">Provenance</a>
</h3>
<h4>Interactions</h4>
<div class="table-wrapper">
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Conformance</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Provenance-create"> </a>
<span>create</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows submitting a Provenance record associated with a particular <a href="http://hl7.org/fhir/R4/questionnaireresponse.html">QuestionnaireResponse</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</text>
<url value="http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-archiver"/>
<version value="3.0.0"/>
<name value="SDCFormArchiver"/>
<title value="SDC Form Archiver"/>
<status value="draft"/>
<date value="2015-09-03"/>
<publisher value="HL7 International - FHIR Infrastructure Work Group"/>
<contact>
<telecom>
<system value="url"/>
<value value="http://hl7.org/Special/committees/fiwg"/>
</telecom>
</contact>
<description
value="This profile defines the expected capabilities of the ''SDC Form Archiver'' role when conforming to the S&I Framework's [[index.html|Structured Data Capture FHIR implementation guide]]. This role is responsible for persisting (archiving) completed or partially completed forms ([[QuestionnaireResponse]] resource instances). These instances may be submitted individually or in a bundle together with [[Provenance]] information providing details about the completion of the questionnaire response. In some cases [[Binary]] or [[DocumentReference]] resources might also be submitted to convey source information used in the population of the questionnaire response.<br/>The purpose of this role is to capture "work in progress" for archival reasons. There is no expectation that submitted form data is subsequently made available for retrieval (at least not in the same format), though it might be made available through out-of-band mechanisms."/>
<jurisdiction>
<coding>
<system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
<code value="001"/>
</coding>
</jurisdiction>
<kind value="requirements"/>
<fhirVersion value="1.0.0"/>
<format value="xml"/>
<format value="json"/>
<rest>
<mode value="client"/>
<documentation
value="The [[QuestionnaireResponse]] may be sent as a single instance or as a FHIR [[Bundle]] also containing [[Provenance]] resources providing details on the sources of information. A Bundle submission might also include [[Binary]] and/or [[DocumentReference]] instances referring to the data used to populate the form. A Form Archiver must support persisting, searching and retrieving those resources."/>
<security>
<description
value="Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]]."/>
</security>
<resource>
<type value="QuestionnaireResponse"/>
<profile
value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="create"/>
<documentation
value="Allows archiving (storing) a completed or partially-completed form"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="update"/>
<documentation
value="Allows updating a previously archived form. (Systems may place rules on who can update forms and under what circumstances)."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
<documentation
value="Allows removal of an archived form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a submitted response and under what circumstances."/>
</interaction>
</resource>
<resource>
<type value="Binary"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="create"/>
<documentation
value="Allows storage of a binary (generally containing information used in the completion of a [[QuestionnaireResponse]]). The data might be in a variety of forms."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
<documentation
value="Allows updating a previously submitted binary data. (Systems may place rules on who can update binary data and under what circumstances)."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
<documentation
value="Allows removal of binary data from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove binary data and under what circumstances."/>
</interaction>
</resource>
<resource>
<type value="DocumentReference"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="create"/>
<documentation
value="Allows storage of a document reference (generally containing information used in the completion of a [[QuestionnaireResponse]])."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="update"/>
<documentation
value="Allows updating a previously submitted document reference. (Systems may place rules on who can update document references and under what circumstances)."/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="delete"/>
<documentation
value="Allows removal of document references from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove document references and under what circumstances."/>
</interaction>
</resource>
<resource>
<type value="Provenance"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="create"/>
<documentation
value="Allows submitting a Provenance record associated with a particular [[QuestionnaireResponse]]."/>
</interaction>
</resource>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<code value="transaction"/>
<documentation
value="Allows submission of a [[QuestionnaireResponse]] together with [[Provenance]] and other supporting resources as a single unit of work."/>
</interaction>
</rest>
</CapabilityStatement>
IG © 2022+ HL7 International - FHIR Infrastructure Work Group. Package hl7.fhir.uv.sdc#3.0.0 based on FHIR 4.0.1. Generated 2022-03-08
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change