Structured Data Capture 2.0 (STU2)
{
"resourceType" : "CapabilityStatement",
"id" : "sdc-form-archiver",
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml">
<h2>SDC Form Archiver</h2>
<p>(Requirements Definition)</p>
<p>http://hl7.org/fhir/us/sdc/CapabilityStatement/sdc-form-archiver Published: 2015-09-03 (draft)</p>
<p>Published by: <b>U.S. Office of the National Coordinator (ONC)</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/stu3/questionnaireresponse.html">QuestionnaireResponse</a> resource instances). These instances may be submitted individually or in a bundle together with <a href="http://hl7.org/fhir/stu3/provenance.html">Provenance</a> information providing details about the completion of the questionnaire response. In some cases <a href="http://hl7.org/fhir/stu3/binary.html">Binary</a> or <a href="http://hl7.org/fhir/stu3/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>
<table>
<tbody>
<tr>
<th>FHIR Version:</th>
<td>$ver$</td>
</tr>
<tr>
<th>Supported formats:</th>
<td>xml, json</td>
</tr>
</tbody>
</table>
<h2>REST behavior</h2>
<p>The <a href="http://hl7.org/fhir/stu3/questionnaireresponse.html">QuestionnaireResponse</a> may be sent as a single instance or as a FHIR <a href="http://hl7.org/fhir/stu3/bundle.html">Bundle</a> also containing <a href="http://hl7.org/fhir/stu3/provenance.html">Provenance</a> resources providing details on the sources of information. A Bundle submission might also include <a href="http://hl7.org/fhir/stu3/binary.html">Binary</a> and/or <a href="http://hl7.org/fhir/stu3/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="sdc-security.html">SDC implementation guide</a>.</p>
<h3>Resource summary</h3>
<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>
</tr>
</thead>
<tbody>
<tr>
<th>QuestionnaireResponse (<a href="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaireresponse.html">Profile</a>)</th>
<td/>
<td/>
<td/>
<td/>
<td/>
<td>
<a href="#QuestionnaireResponse-create" title="Allows archiving (storing) a completed or partially-completed form">Yes</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).">Yes</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.">Yes</a>
</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.">Yes</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).">Yes</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.">Yes</a>
</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).">Yes</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).">Yes</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.">Yes</a>
</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.">Yes</a>
</td>
<td/>
<td/>
</tr>
</tbody>
</table>
<h3>General interactions</h3>
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="-transaction"> </a>
<span>transaction</span>
</th>
<td>
<p>Modes: </p>
<p>Allows submission of a <a href="http://hl7.org/fhir/stu3/questionnaireresponse.html">QuestionnaireResponse</a> together with <a href="http://hl7.org/fhir/stu3/provenance.html">Provenance</a> and other supporting resources as a single unit of work.</p>
</td>
</tr>
</tbody>
</table>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/stu3/questionnaireresponse.html">QuestionnaireResponse</a>
</h3>
<h4>Interactions</h4>
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="QuestionnaireResponse-create"> </a>
<span>create</span>
</th>
<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>
<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>
<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>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/stu3/binary.html">Binary</a>
</h3>
<h4>Interactions</h4>
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Binary-create"> </a>
<span>create</span>
</th>
<td>
<p>Allows storage of a binary (generally containing information used in the completion of a <a href="http://hl7.org/fhir/stu3/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>
<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>
<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>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/stu3/documentreference.html">DocumentReference</a>
</h3>
<h4>Interactions</h4>
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="DocumentReference-create"> </a>
<span>create</span>
</th>
<td>
<p>Allows storage of a document reference (generally containing information used in the completion of a <a href="http://hl7.org/fhir/stu3/questionnaireresponse.html">QuestionnaireResponse</a>).</p>
</td>
</tr>
<tr>
<th>
<a name="DocumentReference-update"> </a>
<span>update</span>
</th>
<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>
<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>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/stu3/provenance.html">Provenance</a>
</h3>
<h4>Interactions</h4>
<table class="list">
<thead>
<tr>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="Provenance-create"> </a>
<span>create</span>
</th>
<td>
<p>Allows submitting a Provenance record associated with a particular <a href="http://hl7.org/fhir/stu3/questionnaireresponse.html">QuestionnaireResponse</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>"
},
"url" : "http://hl7.org/fhir/us/sdc/CapabilityStatement/sdc-form-archiver",
"version" : "2.0",
"name" : "SDC Form Archiver",
"status" : "draft",
"date" : "2015-09-03",
"publisher" : "U.S. Office of the National Coordinator (ONC)",
"contact" : [
{
"telecom" : [
{
"system" : "other",
"value" : "http://wiki.siframework.org/Structured+Data+Capture+Initiative"
}
]
}
],
"description" : "This profile defines the expected capabilities of the ''SDC Form Archiver'' role when conforming to the S&I Framework's [[index|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.",
"kind" : "requirements",
"fhirVersion" : "1.0.0",
"acceptUnknown" : "extensions",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "client",
"documentation" : "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" : "Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]."
},
"resource" : [
{
"type" : "QuestionnaireResponse",
"profile" : {
"reference" : "http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaireresponse"
},
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "Allows archiving (storing) a completed or partially-completed form"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "update",
"documentation" : "Allows updating a previously archived form. (Systems may place rules on who can update forms and under what circumstances)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete",
"documentation" : "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."
}
]
},
{
"type" : "Binary",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Allows storage of a binary (generally containing information used in the completion of a [[QuestionnaireResponse]]). The data might be in a variety of forms."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Allows updating a previously submitted binary data. (Systems may place rules on who can update binary data and under what circumstances)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete",
"documentation" : "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."
}
]
},
{
"type" : "DocumentReference",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Allows storage of a document reference (generally containing information used in the completion of a [[QuestionnaireResponse]])."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "update",
"documentation" : "Allows updating a previously submitted document reference. (Systems may place rules on who can update document references and under what circumstances)."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "delete",
"documentation" : "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."
}
]
},
{
"type" : "Provenance",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "create",
"documentation" : "Allows submitting a Provenance record associated with a particular [[QuestionnaireResponse]]."
}
]
}
],
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "transaction",
"documentation" : "Allows submission of a [[QuestionnaireResponse]] together with [[Provenance]] and other supporting resources as a single unit of work."
}
]
}
]
}
© 2015+ HL7 International (OO work group). SDC v2.0, based on FHIR version 3.0.1. IG generated on Fri, Apr 21, 2017 09:19+1000.
Links: Version History |
Table of Contents |
|
Propose a change 