This is a pre-release of a future version of SDC (expected to be STU 2). The current version is STU 2.
For a full list of available versions, see the Directory of published versions .

6 SDC Form Receiver - xml

(back to narrative)

Raw xml

<Conformance xmlns="http://hl7.org/fhir">
  <id value="conformance-sdc-form-receiver"/>
  <text>
    <status value="generated"/>
    <div xmlns="http://www.w3.org/1999/xhtml">
      <h2>SDC Form Receiver</h2>
      <p>(Requirements Definition)</p>
      <p>Published: 2014-07-06 (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 Receiver</i> role when conforming to the S&amp;I Framework's <a href="sdc.html">Structured Data Capture FHIR implementation guide</a>.  This role is responsible for storing and returning completed and partially-completed forms.</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>
        <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/StructureDefinition/sdc-element">Profile</a>)</th>
            <td>
              <a href="#QuestionnaireResponse-search-type" title="Allows a user to search for existing completed or partially-completed forms.  Generally used to find partially-completed forms for update.">SHALL</a>
            </td>
            <td/>
            <td/>
            <td>
              <a href="#QuestionnaireResponse-history-instance" title="Allows review of prior versions of an answer set - allows reversion to previously recorded versions">SHALL</a>
            </td>
            <td/>
            <td>
              <a href="#QuestionnaireResponse-create" title="Allows recording a completed or partially-completed form">SHALL</a>
            </td>
            <td>
              <a href="#QuestionnaireResponse-update" title="Allows updating an existing completed or partially-completed form.  (Systems may place rules on who can update forms and under what circumstances.)">SHALL</a>
            </td>
            <td>
              <a href="#QuestionnaireResponse-delete" title="Allows removal of a completed form from a repository.  Note that the removal may be logical rather than physical.  Some systems may have rules for who can remove a completed form and under what circumstances.">SHALL</a>
            </td>
          </tr>
        </tbody>
      </table>
      <br/>
      <br/>
      <h3>
        <a href="http://hl7.org/fhir/2016Sep/questionnaireresponse.html">QuestionnaireResponse</a>
      </h3>
      <h4>Interactions</h4>
      <table class="list">
        <thead>
          <tr>
            <th>Name</th>
            <th>Conformance</th>
            <th>Description</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <th>
              <a name="QuestionnaireResponse-search-type"> </a>
              <span>search-type</span>
            </th>
            <td>SHALL</td>
            <td>
              <p>Allows a user to search for existing completed or partially-completed forms.  Generally used to find partially-completed forms for update.</p>
            </td>
          </tr>
          <tr>
            <th>
              <a name="QuestionnaireResponse-create"> </a>
              <span>create</span>
            </th>
            <td>SHALL</td>
            <td>
              <p>Allows recording a completed or partially-completed form</p>
            </td>
          </tr>
          <tr>
            <th>
              <a name="QuestionnaireResponse-update"> </a>
              <span>update</span>
            </th>
            <td>SHALL</td>
            <td>
              <p>Allows updating an existing completed or partially-completed 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>SHALL</td>
            <td>
              <p>Allows removal of a completed form from a repository.  Note that the removal may be logical rather than physical.  Some systems may have rules for who can remove a completed form and under what circumstances.</p>
            </td>
          </tr>
          <tr>
            <th>
              <a name="QuestionnaireResponse-history-instance"> </a>
              <span>history-instance</span>
            </th>
            <td>SHALL</td>
            <td>
              <p>Allows review of prior versions of an answer set - allows reversion to previously recorded versions</p>
            </td>
          </tr>
        </tbody>
      </table>
      <h4>Search</h4>
      <p>Supported Includes: QuestionnaireResponse.questionnaire Questionnaire.group.question.options</p>
      <table class="list">
        <thead>
          <tr>
            <th>Parameter</th>
            <th>Conformance</th>
            <th>Type</th>
            <th>Definition &amp; Chaining</th>
          </tr>
        </thead>
        <tbody>
          <tr>
            <th>author</th>
            <td>SHALL</td>
            <td>reference</td>
            <td/>
          </tr>
          <tr>
            <th>authored</th>
            <td>SHALL</td>
            <td>date</td>
            <td/>
          </tr>
          <tr>
            <th>identifier</th>
            <td>SHALL</td>
            <td>token</td>
            <td/>
          </tr>
          <tr>
            <th>patient</th>
            <td>SHALL</td>
            <td>reference</td>
            <td/>
          </tr>
          <tr>
            <th>questionnaire</th>
            <td>SHALL</td>
            <td>reference</td>
            <td/>
          </tr>
          <tr>
            <th>source</th>
            <td>SHOULD</td>
            <td>reference</td>
            <td/>
          </tr>
          <tr>
            <th>status</th>
            <td>SHALL</td>
            <td>token</td>
            <td/>
          </tr>
          <tr>
            <th>subject</th>
            <td>SHALL</td>
            <td>reference</td>
            <td/>
          </tr>
          <tr>
            <th>encounter</th>
            <td>SHOULD</td>
            <td>token</td>
            <td/>
          </tr>
        </tbody>
      </table>
    </div>
  </text>
  <name value="SDC Form Receiver"/>
  <status value="draft"/>
  <date value="2014-07-06"/>
  <publisher value="U.S. Office of the National Coordinator (ONC)"/>
  <contact>
    <telecom>
      <system value="other"/>
      <value
             value="http://wiki.siframework.org/Structured+Data+Capture+Initiative"/>
    </telecom>
  </contact>
  <description
               value="This profile defines the expected capabilities of the ''SDC Form Receiver'' role when conforming to the S&I Framework's [[sdc|Structured Data Capture FHIR implementation guide]].  This role is responsible for storing and returning completed and partially-completed forms."/>
  <kind value="requirements"/>
  <fhirVersion value="1.0.0"/>
  <acceptUnknown value="extensions"/>
  <format value="xml"/>
  <format value="json"/>
  <rest>
    <mode value="server"/>
    <security>
      <description
                   value="Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]."/>
    </security>
    <resource>
      <type value="QuestionnaireResponse"/>
      <profile>
        <reference value="http://hl7.org/fhir/StructureDefinition/sdc-element"/>
      </profile>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Allows a user to search for existing completed or partially-completed forms.  Generally used to find partially-completed forms for update."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation
                       value="Allows recording a completed or partially-completed form"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation
                       value="Allows updating an existing completed or partially-completed form.  (Systems may place rules on who can update forms and under what circumstances.)"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="delete"/>
        <documentation
                       value="Allows removal of a completed form from a repository.  Note that the removal may be logical rather than physical.  Some systems may have rules for who can remove a completed form and under what circumstances."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of prior versions of an answer set - allows reversion to previously recorded versions"/>
      </interaction>
      <searchInclude value="QuestionnaireResponse.questionnaire"/>
      <searchInclude value="Questionnaire.group.question.options"/>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="author"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireRespose-author"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="authored"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireRespose-authored"/>
        <type value="date"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="identifier"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireRespose-identifier"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="patient"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireRespose-patient"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="questionnaire"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireRespose-questionnaire"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="source"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireRespose-source"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="status"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireRespose-status"/>
        <type value="token"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <name value="subject"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireRespose-subject"/>
        <type value="reference"/>
      </searchParam>
      <searchParam>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/conformance-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <name value="encounter"/>
        <definition
                    value="http://hl7.org/fhir/SearchParameter/QuestionnaireRespose-encounter"/>
        <type value="token"/>
      </searchParam>
    </resource>
  </rest>
</Conformance>