Structured Data Capture
2.8.0 - CI Build

Structured Data Capture, published by HL7 International - FHIR Infrastructure Work Group. This is not an authorized publication; it is the continuous build for version 2.8.0). This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

: SDC Form Response Manager - XML Representation

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="sdc-form-response-manager"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>SDC Form Response Manager</h2>
      <p>(Requirements Definition Capability Statement)</p>
      <p>Canonical URL: 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&amp;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 do not have local storage to save work in progress.</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 server 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>
              <th>Operations</th>
            </tr>
          </thead>
          <tbody>
            <tr>
              <th>QuestionnaireResponse (<a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse">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">SHALL</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">SHALL</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">MAY</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">SHALL</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.">SHALL</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">SHOULD</a>
              </td>
              <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>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>SHALL</td>
              <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>SHOULD</td>
              <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>SHALL</td>
              <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>SHALL</td>
              <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>MAY</td>
              <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>
  </text>
  <url
       value="http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-response-manager"/>
  <version value="2.8.0"/>
  <name value="SDCFormResponseManager"/>
  <title value="SDC Form Response Manager"/>
  <status value="draft"/>
  <date value="2014-07-06"/>
  <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 &#39;&#39;SDC Form Response Manager&#39;&#39; role when conforming to the S&amp;I Framework&#39;s [[index.html|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 do not have local storage to save work in progress."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <instantiates
                value="http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-manager"/>
  <fhirVersion value="1.0.0"/>
  <format value="xml"/>
  <format value="json"/>
  <rest>
    <mode value="server"/>
    <security>
      <description
                   value="Implementations must meet the general security requirements documented in the [[security.html|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."/>
    </security>
    <resource>
      <type value="QuestionnaireResponse"/>
      <profile
               value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse"/>
      <documentation
                     value="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 value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation
                       value="This creates an initial version of a QuestionnaireResponse - a completed form for a particular subject as of a particular point-in-time"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation
                       value="This allows revision of a QuestionnaireResponse.  Typically this will happen while the response is still &#39;in-progress&#39;.  If it occurs after the response has been marked as &#39;final&#39;, the status should change to &#39;amended&#39;.  Updates can also be used to change the status to &#39;entered-in-error&#39; or other values.  Servers may choose to enforce business rules around what state transitions are supported and for which users."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="delete"/>
        <documentation
                       value="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"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="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"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="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"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="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"/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>