Structured Data Capture
3.0.0 - STU 3 International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. 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 Designer - XML Representation

Page standards status: Trial-use Maturity Level: 3

Raw xml | Download



<CapabilityStatement xmlns="http://hl7.org/fhir">
  <id value="sdc-form-designer"/>
  <text>
    <status value="extensions"/>
    <div xmlns="http://www.w3.org/1999/xhtml"><h2 id="title">SDC Form Designer</h2><ul><li>Implementation Guide Version: 3.0.0</li><li>FHIR Version: 1.0.0</li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: Sun Jul 06 00:00:00 UTC 2014</li><li>Published by: HL7 International / FHIR Infrastructure</li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as &quot;SHALL NOT&quot;. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>client</code></h3></div><div class="panel-body"><div><p>The [[Questionnaire]] resource is used to create and maintain SDC-compliant forms.  The [[StructureDefinition]] resource is used to look-up existing data elements that can be referenced in forms.  Optionally, [[StructureDefinition]]s can also be created and maintained in conjunction with form editing.  This is an optional feature as not all environments will provide support for data element definitions from form authors.  The [[ValueSet]] and [[CodeSystem]] resources are used to capture allowed values for questions that are to be answered from a pre-defined list of values.  For some forms, some or all of the referenced value sets (and possibly code systems) will be handled as 'contained' resources, meaning the value set exists only in the context of the [[Questionnaire]] and cannot be referenced or maintained without also updating the form.  However, systems should support value set and code system re-use across questionnaires.  (Version-specific referencing can be used to avoid value sets from changing independent of the referencing [[Questionnaire]].)</p>
</div><div class="lead"><em>Security</em></div><blockquote><div><p>Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]].</p>
</div></blockquote><div class="lead"><em>Summary of System-wide Interactions</em></div></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET past versions of resources (vread interaction)">V-R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th class="text-center"><b title="DELETE a resource (delete interaction)">D</b></th><th class="text-center"><b title="GET changes to a resource (history interaction on instance)">H-I</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Questionnaire1-1">Questionnaire</a></td><td><a href="StructureDefinition-sdc-questionnaire.html">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire</a></td><td>y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr><tr><td><a href="#ValueSet1-2">ValueSet</a></td><td><a href="StructureDefinition-sdc-valueset.html">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset</a></td><td>y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center">y</td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Questionnaire1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL</span>Questionnaire</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-sdc-questionnaire.html">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>, <code>create</code>, <code>update</code>.</li><li><strong>SHOULD</strong> support <code>history-instance</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>delete</code>.</li></ul></div></div><p/></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="ValueSet1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHALL</span>ValueSet</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-sdc-valueset.html">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>, <code>create</code>, <code>update</code>.</li><li><strong>SHOULD</strong> support <code>history-instance</code>, <code>vread</code>.</li><li><strong>MAY</strong> support <code>delete</code>.</li></ul></div></div><p/></div></div></div></div>
  </text>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="fhir"/>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="3">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"/>
      </extension>
    </valueInteger>
  </extension>
  <extension
             url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="trial-use">
      <extension
                 url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
        <valueCanonical
                        value="http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"/>
      </extension>
    </valueCode>
  </extension>
  <url
       value="http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-designer"/>
  <version value="3.0.0"/>
  <name value="SDCFormDesigner"/>
  <title value="SDC Form Designer"/>
  <status value="draft"/>
  <date value="2014-07-06"/>
  <publisher value="HL7 International / FHIR Infrastructure"/>
  <contact>
    <name value="HL7 International / FHIR Infrastructure"/>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <contact>
    <telecom>
      <system value="url"/>
      <value value="http://www.hl7.org/Special/committees/fiwg"/>
    </telecom>
  </contact>
  <description
               value="This profile defines the expected capabilities of the ''SDC Form Designer'' role when conforming to the S&amp;I Framework's [[index.html|Structured Data Capture FHIR implementation guide]].  This role is responsible for defining forms ([[Questionnaire]] resource instances) that include references to [[StructureDefinition]] resouces containing data elements that define the meaning of particular questions and can be used to aid in pre-populating and auto-populating forms."/>
  <jurisdiction>
    <coding>
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/>
      <code value="001"/>
      <display value="World"/>
    </coding>
  </jurisdiction>
  <kind value="requirements"/>
  <fhirVersion value="1.0.0"/>
  <format value="xml"/>
  <format value="json"/>
  <rest>
    <mode value="client"/>
    <documentation
                   value="The [[Questionnaire]] resource is used to create and maintain SDC-compliant forms.  The [[StructureDefinition]] resource is used to look-up existing data elements that can be referenced in forms.  Optionally, [[StructureDefinition]]s can also be created and maintained in conjunction with form editing.  This is an optional feature as not all environments will provide support for data element definitions from form authors.  The [[ValueSet]] and [[CodeSystem]] resources are used to capture allowed values for questions that are to be answered from a pre-defined list of values.  For some forms, some or all of the referenced value sets (and possibly code systems) will be handled as 'contained' resources, meaning the value set exists only in the context of the [[Questionnaire]] and cannot be referenced or maintained without also updating the form.  However, systems should support value set and code system re-use across questionnaires.  (Version-specific referencing can be used to avoid value sets from changing independent of the referencing [[Questionnaire]].)"/>
    <security>
      <description
                   value="Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]]."/>
    </security>
    <resource>
      <type value="Questionnaire"/>
      <profile
               value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Allows discovery of existing questionnaires for editing"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Allows retrieval of a specific questionnaire by id"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation value="Allows submission of a new form design"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation
                       value="Allows revision of an existing form design.  Note that certain types of updates may necessitate retiring the existing form and defining a new one."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to questionnaire over time"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
        <documentation
                       value="Allows retrieval of a historical version of a questionnaire"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
        <documentation
                       value="Not all servers will support deletion of forms.  Status change to 'retired' will be more typical, though deletion of draft profiles may keep repositories cleaner."/>
      </interaction>
    </resource>
    <resource>
      <type value="ValueSet"/>
      <profile
               value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset"/>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="search-type"/>
        <documentation
                       value="Allows discovery of existing value sets for use by questions in a form"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="read"/>
        <documentation
                       value="Allows retrieval of a specific value set by id"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="create"/>
        <documentation
                       value="Allows definition of a new value set used by one or more questions"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
        <code value="update"/>
        <documentation
                       value="Allows existing value sets referenced by a form to be maintained.  Note that certain types of updates may necessitate retiring the existing value set and defining a new one."/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="history-instance"/>
        <documentation
                       value="Allows review of changes to a value set over time"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHOULD"/>
        </extension>
        <code value="vread"/>
        <documentation
                       value="Allows retrieval of a historical version of a value set"/>
      </interaction>
      <interaction>
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="MAY"/>
        </extension>
        <code value="delete"/>
        <documentation
                       value="Not all servers will support deletion of value sets.  Status change to 'retired' will be more typical, though deletion of draft value sets may keep repositories cleaner."/>
      </interaction>
    </resource>
  </rest>
</CapabilityStatement>