Structured Data Capture
3.0.0-preview - STU 3
Structured Data Capture
3.0.0-preview - STU 3
This page is part of the Structured Data Capture FHIR IG (v3.0.0-preview: STU 3 Draft) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions 
| Page standards status: Trial-use | Maturity Level: 3 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="sdc-form-designer"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml">
<h2>SDC Form Designer</h2>
<p>(Requirements Definition Capability Statement)</p>
<p>Canonical URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-designer 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 Designer</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 defining forms (<a href="http://hl7.org/fhir/R4/questionnaire.html">Questionnaire</a> resource instances) that include references to <a href="http://hl7.org/fhir/R4/structuredefinition.html">StructureDefinition</a> resouces containing data elements that define the meaning of particular questions and can be used to aid in pre-populating and auto-populating forms.</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 client behavior</h2>
<p>The <a href="http://hl7.org/fhir/R4/questionnaire.html">Questionnaire</a> resource is used to create and maintain SDC-compliant forms. The <a href="http://hl7.org/fhir/R4/structuredefinition.html">StructureDefinition</a> resource is used to look-up existing data elements that can be referenced in forms. Optionally, <a href="http://hl7.org/fhir/R4/structuredefinition.html">StructureDefinition</a>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 <a href="http://hl7.org/fhir/R4/valueset.html">ValueSet</a> and <a href="http://hl7.org/fhir/R4/codesystem.html">CodeSystem</a> 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 <a href="http://hl7.org/fhir/R4/questionnaire.html">Questionnaire</a> 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 <a href="http://hl7.org/fhir/R4/questionnaire.html">Questionnaire</a>.)</p>
<p>
<b>Security:</b>
</p>
<p>Implementations must meet the general security requirements documented in the <a href="security.html">SDC implementation guide</a>.</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>Questionnaire (<a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire">Profile</a>)</th>
<td>
<a href="#Questionnaire-search-type" title="Allows discovery of existing questionnaires for editing">SHALL</a>
</td>
<td>
<a href="#Questionnaire-read" title="Allows retrieval of a specific questionnaire by id">SHALL</a>
</td>
<td>
<a href="#Questionnaire-vread" title="Allows retrieval of a historical version of a questionnaire">SHOULD</a>
</td>
<td>
<a href="#Questionnaire-history-instance" title="Allows review of changes to questionnaire over time">SHOULD</a>
</td>
<td/>
<td>
<a href="#Questionnaire-create" title="Allows submission of a new form design">SHALL</a>
</td>
<td>
<a href="#Questionnaire-update" title="Allows revision of an existing form design. Note that certain types of updates may necessitate retiring the existing form and defining a new one.">SHALL</a>
</td>
<td>
<a href="#Questionnaire-delete" title="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.">MAY</a>
</td>
<td/>
</tr>
<tr>
<th>ValueSet (<a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset">Profile</a>)</th>
<td>
<a href="#ValueSet-search-type" title="Allows discovery of existing value sets for use by questions in a form">SHALL</a>
</td>
<td>
<a href="#ValueSet-read" title="Allows retrieval of a specific value set by id">SHALL</a>
</td>
<td>
<a href="#ValueSet-vread" title="Allows retrieval of a historical version of a value set">SHOULD</a>
</td>
<td>
<a href="#ValueSet-history-instance" title="Allows review of changes to a value set over time">SHOULD</a>
</td>
<td/>
<td>
<a href="#ValueSet-create" title="Allows definition of a new value set used by one or more questions">SHALL</a>
</td>
<td>
<a href="#ValueSet-update" title="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.">SHALL</a>
</td>
<td>
<a href="#ValueSet-delete" title="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.">MAY</a>
</td>
<td/>
</tr>
<tr>
<th>CodeSystem (<a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem">Profile</a>)</th>
<td>
<a href="#CodeSystem-search-type" title="Allows discovery of existing code systems for use by questions in a form">SHALL</a>
</td>
<td>
<a href="#CodeSystem-read" title="Allows retrieval of a specific code system by id">SHALL</a>
</td>
<td>
<a href="#CodeSystem-vread" title="Allows retrieval of a historical version of a code system">SHOULD</a>
</td>
<td>
<a href="#CodeSystem-history-instance" title="Allows review of changes to a code system over time">SHOULD</a>
</td>
<td/>
<td>
<a href="#CodeSystem-create" title="Allows definition of a new code system used by one or more questions">SHALL</a>
</td>
<td>
<a href="#CodeSystem-update" title="Allows existing code systems referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing code system and defining a new one.">SHALL</a>
</td>
<td>
<a href="#CodeSystem-delete" title="Not all servers will support deletion of code systems. Status change to 'retired' will be more typical, though deletion of draft value sets may keep repositories cleaner.">MAY</a>
</td>
<td/>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/questionnaire.html">Questionnaire</a>
</h3>
<p>Profile: <a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire</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="Questionnaire-search-type"> </a>
<span>search-type</span>
</th>
<td>SHALL</td>
<td>
<p>Allows discovery of existing questionnaires for editing</p>
</td>
</tr>
<tr>
<th>
<a name="Questionnaire-read"> </a>
<span>read</span>
</th>
<td>SHALL</td>
<td>
<p>Allows retrieval of a specific questionnaire by id</p>
</td>
</tr>
<tr>
<th>
<a name="Questionnaire-create"> </a>
<span>create</span>
</th>
<td>SHALL</td>
<td>
<p>Allows submission of a new form design</p>
</td>
</tr>
<tr>
<th>
<a name="Questionnaire-update"> </a>
<span>update</span>
</th>
<td>SHALL</td>
<td>
<p>Allows revision of an existing form design. Note that certain types of updates may necessitate retiring the existing form and defining a new one.</p>
</td>
</tr>
<tr>
<th>
<a name="Questionnaire-history-instance"> </a>
<span>history-instance</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows review of changes to questionnaire over time</p>
</td>
</tr>
<tr>
<th>
<a name="Questionnaire-vread"> </a>
<span>vread</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows retrieval of a historical version of a questionnaire</p>
</td>
</tr>
<tr>
<th>
<a name="Questionnaire-delete"> </a>
<span>delete</span>
</th>
<td>MAY</td>
<td>
<p>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.</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/valueset.html">ValueSet</a>
</h3>
<p>Profile: <a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset</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="ValueSet-search-type"> </a>
<span>search-type</span>
</th>
<td>SHALL</td>
<td>
<p>Allows discovery of existing value sets for use by questions in a form</p>
</td>
</tr>
<tr>
<th>
<a name="ValueSet-read"> </a>
<span>read</span>
</th>
<td>SHALL</td>
<td>
<p>Allows retrieval of a specific value set by id</p>
</td>
</tr>
<tr>
<th>
<a name="ValueSet-create"> </a>
<span>create</span>
</th>
<td>SHALL</td>
<td>
<p>Allows definition of a new value set used by one or more questions</p>
</td>
</tr>
<tr>
<th>
<a name="ValueSet-update"> </a>
<span>update</span>
</th>
<td>SHALL</td>
<td>
<p>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.</p>
</td>
</tr>
<tr>
<th>
<a name="ValueSet-history-instance"> </a>
<span>history-instance</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows review of changes to a value set over time</p>
</td>
</tr>
<tr>
<th>
<a name="ValueSet-vread"> </a>
<span>vread</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows retrieval of a historical version of a value set</p>
</td>
</tr>
<tr>
<th>
<a name="ValueSet-delete"> </a>
<span>delete</span>
</th>
<td>MAY</td>
<td>
<p>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.</p>
</td>
</tr>
</tbody>
</table>
</div>
<br/>
<br/>
<h3>
<a href="http://hl7.org/fhir/R4/codesystem.html">CodeSystem</a>
</h3>
<p>Profile: <a href="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem</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="CodeSystem-search-type"> </a>
<span>search-type</span>
</th>
<td>SHALL</td>
<td>
<p>Allows discovery of existing code systems for use by questions in a form</p>
</td>
</tr>
<tr>
<th>
<a name="CodeSystem-read"> </a>
<span>read</span>
</th>
<td>SHALL</td>
<td>
<p>Allows retrieval of a specific code system by id</p>
</td>
</tr>
<tr>
<th>
<a name="CodeSystem-create"> </a>
<span>create</span>
</th>
<td>SHALL</td>
<td>
<p>Allows definition of a new code system used by one or more questions</p>
</td>
</tr>
<tr>
<th>
<a name="CodeSystem-update"> </a>
<span>update</span>
</th>
<td>SHALL</td>
<td>
<p>Allows existing code systems referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing code system and defining a new one.</p>
</td>
</tr>
<tr>
<th>
<a name="CodeSystem-history-instance"> </a>
<span>history-instance</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows review of changes to a code system over time</p>
</td>
</tr>
<tr>
<th>
<a name="CodeSystem-vread"> </a>
<span>vread</span>
</th>
<td>SHOULD</td>
<td>
<p>Allows retrieval of a historical version of a code system</p>
</td>
</tr>
<tr>
<th>
<a name="CodeSystem-delete"> </a>
<span>delete</span>
</th>
<td>MAY</td>
<td>
<p>Not all servers will support deletion of code systems. Status change to 'retired' will be more typical, though deletion of draft value sets may keep repositories cleaner.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</text>
<url value="http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-designer"/>
<version value="3.0.0-preview"/>
<name value="SDCFormDesigner"/>
<title value="SDC Form Designer"/>
<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 ''SDC Form Designer'' role when conforming to the S&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"/>
</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>
<resource>
<type value="CodeSystem"/>
<profile
value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Allows discovery of existing code systems 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 code system 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 code system 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 code systems referenced by a form to be maintained. Note that certain types of updates may necessitate retiring the existing code system 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 code system 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 code system"/>
</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 code systems. Status change to 'retired' will be more typical, though deletion of draft value sets may keep repositories cleaner."/>
</interaction>
</resource>
</rest>
</CapabilityStatement>
IG © 2022+ HL7 International - FHIR Infrastructure Work Group. Package hl7.fhir.uv.sdc#3.0.0-preview based on FHIR 4.0.1. Generated 2022-02-16
Links: Table of Contents |
QA Report
| Version History |
Search |
|
Propose a change