Structured Data Capture 2.5.0 - Edition 3(STU), For Comment 2018Sep Ballot
This page is part of the Structured Data Capture FHIR IG (v2.5.0: STU 3 Ballot 1) based on FHIR v3.5.0. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions 
{
"resourceType" : "CapabilityStatement",
"id" : "sdc-form-response-manager",
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml">
<h2>SDC Form Response Manager</h2>
<p>(Requirements Definition)</p>
<p>http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-response-manager Published: 2014-07-06 (draft)</p>
<p>Published by: <b>HL7 International - FHIR Infrastructure</b>
</p>
<p>This profile defines the expected capabilities of the <i>SDC Form Response Manager</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 providing read/write access to QuestionnaireResponses. This is typically to support light-weight clients that want to be able to complete forms but don't have local storage to save work in progress.</p>
<h2>General</h2>
<div class="table-wrapper">
<table>
<tbody>
<tr>
<th>FHIR Version:</th>
<td>$ver$</td>
</tr>
<tr>
<th>Supported formats:</th>
<td>xml, json</td>
</tr>
</tbody>
</table>
</div>
<h2>REST behavior</h2>
<p>
<b>Security:</b>
</p>
<p>Implementations must meet the general security requirements documented in the <a href="security.html">SDC implementation guide</a>. Systems may wish to ensure that QuestionnaireResponse instances are only accessible to the user (or at least the organization) who was responsible for creating them.</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>
</tr>
</thead>
<tbody>
<tr>
<th>QuestionnaireResponse (<a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse.html">Profile</a>)</th>
<td>
<a href="#QuestionnaireResponse-search-type" title="This allows a user to find previously created responses - whether created by themselves or others. For thin clients without persistence, this feature is essential to allow them to find a draft of a previously created response">Yes</a>
</td>
<td>
<a href="#QuestionnaireResponse-read" title="This allows a user to retrieve a previously stored response by id. (Some thin clients may have limited persistence -e.g. cookies - that could be used to store an id and later retrieve a work-in-progress questionnaire response">Yes</a>
</td>
<td/>
<td>
<a href="#QuestionnaireResponse-history-instance" title="This allows a user to look at previous versions of a response. It supports identifying what changes were made and potentially retrieving an older version to use as a starting point in the event that data has accidentally been removed or changed">Yes</a>
</td>
<td/>
<td>
<a href="#QuestionnaireResponse-create" title="This creates an initial version of a QuestionnaireResponse - a completed form for a particular subject as of a particular point-in-time">Yes</a>
</td>
<td>
<a href="#QuestionnaireResponse-update" title="This allows revision of a QuestionnaireResponse. Typically this will happen while the response is still 'in-progress'. If it occurs after the response has been marked as 'final', the status should change to 'amended'. Updates can also be used to change the status to 'entered-in-error' or other values. Servers may choose to enforce business rules around what state transitions are supported and for which users.">Yes</a>
</td>
<td>
<a href="#QuestionnaireResponse-delete" title="This removes a previously submitted QuestionnaireResponse. In addition to (or instead of) supporting direct requests for deletion, some servers may automatically purge QuestionnaireResponses that have been in existence and unmodified for a period of time. Deletions may not be a physical delete and it may still be possible to access older versions of a deleted response">Yes</a>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/2018Sep/questionnaireresponse.html">QuestionnaireResponse</a>
</h3>
<p>Profile: <a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse.html">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>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th>
<a name="QuestionnaireResponse-create"> </a>
<span>create</span>
</th>
<td>
<p>This creates an initial version of a QuestionnaireResponse - a completed form for a particular subject as of a particular point-in-time</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-update"> </a>
<span>update</span>
</th>
<td>
<p>This allows revision of a QuestionnaireResponse. Typically this will happen while the response is still 'in-progress'. If it occurs after the response has been marked as 'final', the status should change to 'amended'. Updates can also be used to change the status to 'entered-in-error' or other values. Servers may choose to enforce business rules around what state transitions are supported and for which users.</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-delete"> </a>
<span>delete</span>
</th>
<td>
<p>This removes a previously submitted QuestionnaireResponse. In addition to (or instead of) supporting direct requests for deletion, some servers may automatically purge QuestionnaireResponses that have been in existence and unmodified for a period of time. Deletions may not be a physical delete and it may still be possible to access older versions of a deleted response</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-search-type"> </a>
<span>search-type</span>
</th>
<td>
<p>This allows a user to find previously created responses - whether created by themselves or others. For thin clients without persistence, this feature is essential to allow them to find a draft of a previously created response</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-read"> </a>
<span>read</span>
</th>
<td>
<p>This allows a user to retrieve a previously stored response by id. (Some thin clients may have limited persistence -e.g. cookies - that could be used to store an id and later retrieve a work-in-progress questionnaire response</p>
</td>
</tr>
<tr>
<th>
<a name="QuestionnaireResponse-history-instance"> </a>
<span>history-instance</span>
</th>
<td>
<p>This allows a user to look at previous versions of a response. It supports identifying what changes were made and potentially retrieving an older version to use as a starting point in the event that data has accidentally been removed or changed</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>"
},
"url" : "http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-response-manager",
"version" : "2.5.0",
"name" : "SDC Form Response Manager",
"status" : "draft",
"date" : "2014-07-06",
"publisher" : "HL7 International - FHIR Infrastructure",
"contact" : [
{
"telecom" : [
{
"system" : "other",
"value" : "http://wiki.siframework.org/Structured+Data+Capture+Initiative"
}
]
}
],
"description" : "This profile defines the expected capabilities of the ''SDC Form Response Manager'' role when conforming to the S&I Framework's [[index|Structured Data Capture FHIR implementation guide]]. This role is responsible for providing read/write access to QuestionnaireResponses. This is typically to support light-weight clients that want to be able to complete forms but don't have local storage to save work in progress.",
"kind" : "requirements",
"instantiates" : [
"http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-manager"
],
"fhirVersion" : "1.0.0",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "server",
"security" : {
"description" : "Implementations must meet the general security requirements documented in the [[security|SDC implementation guide]]. Systems may wish to ensure that QuestionnaireResponse instances are only accessible to the user (or at least the organization) who was responsible for creating them."
},
"resource" : [
{
"type" : "QuestionnaireResponse",
"profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse",
"documentation" : "This allows QuestionnaireResponses to be created, updated and retrieved. Note that storing a QuestionnaireResponse does not imply any execution of behavior on the basis of the stored data.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "This creates an initial version of a QuestionnaireResponse - a completed form for a particular subject as of a particular point-in-time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update",
"documentation" : "This allows revision of a QuestionnaireResponse. Typically this will happen while the response is still 'in-progress'. If it occurs after the response has been marked as 'final', the status should change to 'amended'. Updates can also be used to change the status to 'entered-in-error' or other values. Servers may choose to enforce business rules around what state transitions are supported and for which users."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "delete",
"documentation" : "This removes a previously submitted QuestionnaireResponse. In addition to (or instead of) supporting direct requests for deletion, some servers may automatically purge QuestionnaireResponses that have been in existence and unmodified for a period of time. Deletions may not be a physical delete and it may still be possible to access older versions of a deleted response"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "This allows a user to find previously created responses - whether created by themselves or others. For thin clients without persistence, this feature is essential to allow them to find a draft of a previously created response"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "This allows a user to retrieve a previously stored response by id. (Some thin clients may have limited persistence -e.g. cookies - that could be used to store an id and later retrieve a work-in-progress questionnaire response"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance",
"documentation" : "This allows a user to look at previous versions of a response. It supports identifying what changes were made and potentially retrieving an older version to use as a starting point in the event that data has accidentally been removed or changed"
}
]
}
]
}
]
}
© 2015+ HL7 International (OO work group). Based on FHIR version (3.5.0-14923). IG generated on Fri, Aug 31, 2018 16:04+1000.
Links: Version History |
Table of Contents |
|
Propose a change