Structured Data Capture
4.0.0 - STU 4
Structured Data Capture
4.0.0 - STU 4
Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.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
| Page standards status: Trial-use | Maturity Level: 4 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="sdc-form-fill-manager"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement sdc-form-fill-manager</b></p><a name="sdc-form-fill-manager"> </a><a name="hcsdc-form-fill-manager"> </a><h2 id="title">SDC Form Fill Manager</h2><ul><li>Implementation Guide Version: 4.0.0 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Published on: 2014-07-06 </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 'SHALL NOT'. 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>server</code></h3></div><div class="panel-body"><div><p>The primary focus of the repository is providing access to <a href="http://hl7.org/fhir/R4/questionnaire.html#Questionnaire">Questionnaire</a>s. However, <a href="http://hl7.org/fhir/R4/valueset.html#ValueSet">ValueSet</a>s, <a href="http://hl7.org/fhir/R4/codesystem.html#CodeSystem">CodeSystem</a>s, <a href="http://hl7.org/fhir/R4/library.html#Library">Library</a>s, <a href="http://hl7.org/fhir/R4/conceptmap.html#ConceptMap">ConceptMap</a>s and other resources are also relevant in their support of Questionnaire functionality. Some forms will opt to have some or all of these additional resources managed as 'contained' resources, meaning there won't be a need for them to be independently managed on the Form Fill Manager. However, systems should support resource re-use across forms, meaning that support for maintenance of these ancillary resources is still helpful. (Version-specific referencing can be used to avoid referenced resources from changing independent of the referencing <a href="http://hl7.org/fhir/R4/questionnaire.html#Questionnaire">Questionnaire</a>.)</p>
</div><div class="lead"><em>Security</em></div><blockquote><div><p>Implementations must meet the <a href="security.html">general security requirements</a> documented in this implementation guide.html.</p>
</div></blockquote></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 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><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 class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"/><td>url, version, status, experimental, context-type-quantity, context-type-value, date, description, identifier, publisher, questionnaire-code, subject-type, title, effective, jurisdiction, assemble-expectation</td><td/><td/><td><code>$next-question</code>, <code>$populate</code></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 class="text-center"><span title="MAY">y?</span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"/><td>url, version</td><td/><td/><td><code>$expand</code>, <code>$validate code</code></td></tr><tr><td><a href="#CodeSystem1-3">CodeSystem</a></td><td><a href="StructureDefinition-sdc-codesystem.html">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem</a></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"/><td>url, version</td><td/><td/><td/></tr><tr><td><a href="#Library1-4">Library</a></td><td><a href="StructureDefinition-sdc-library.html">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-library</a></td><td class="text-center"><span title="MAY">y?</span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"/><td>url, version</td><td/><td/><td/></tr><tr><td><a href="#StructureMap1-5">StructureMap</a></td><td><a href="http://hl7.org/fhir/R4/structuremap.html">http://hl7.org/fhir/StructureDefinition/StructureMap</a></td><td class="text-center"><span title="MAY">y?</span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"/><td>url, version</td><td/><td/><td/></tr><tr><td><a href="#StructureDefinition1-6">StructureDefinition</a></td><td><a href="http://hl7.org/fhir/R4/structuredefinition.html">http://hl7.org/fhir/StructureDefinition/StructureDefinition</a></td><td class="text-center"><span title="MAY">y?</span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"/><td>url, version</td><td/><td/><td/></tr><tr><td><a href="#ConceptMap1-7">ConceptMap</a></td><td><a href="http://hl7.org/fhir/R4/conceptmap.html">http://hl7.org/fhir/StructureDefinition/ConceptMap</a></td><td class="text-center"><span title="MAY">y?</span></td><td class="text-center"><span title="SHALL"><b>Y</b></span></td><td class="text-center"/><td class="text-center"/><td>experimental, url, version, status, source-system, target-system, source-uri, target-uri</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">SDC Base 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 <br/><code>search-type</code><div><p>Allows a user to search for existing forms</p>
</div><code>read</code><div><p>Allows retrieval of a detailed Questionnaire if search only returns summary</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Form mamagers are responsible for handling forms.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">version</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">status</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-canonical-experimental.html">experimental</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">context-type-quantity</a></td><td><code>composite</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">context-type-value</a></td><td><code>composite</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">date</a></td><td><code>date</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">description</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">publisher</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="SearchParameter-Questionnaire-questionnaire-code.html">questionnaire-code</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="SearchParameter-Questionnaire-subject-type.html">subject-type</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">title</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">effective</a></td><td><code>date</code></td><td><div/></td></tr><tr><td><b>MAY</b></td><td><a href="http://hl7.org/fhir/R4/questionnaire.html#search">jurisdiction</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>MAY</b></td><td><a href="SearchParameter-questionnaire-assemble-expectation.html">assemble-expectation</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td><a href="OperationDefinition-Questionnaire-next-question.html">$next-question</a></td><td><div><p>Needed for adaptive forms</p>
</div></td></tr><tr><td><b>MAY</b></td><td><a href="OperationDefinition-Questionnaire-populate.html">$populate</a></td><td><div><p>Usefulness depends on whether fillers tend to perform population themselves</p>
</div></td></tr></tbody></table></div></div></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">SDC Value Set</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 <br/><code>search-type</code><div><p>Allows discovery of existing value sets for use in authoring questionnaires</p>
</div></li><li><strong>MAY</strong> support <br/><code>read</code><div><p>Needed if a server's default search behavior doesn't return the full resource</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Needed if Questionnaire valuesets will be stored on the form server as opposed to a separate terminology service.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/valueset.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/valueset.html#search">version</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div><div class="row"><div class="col-12"><span class="lead">Extended Operations</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHOULD</b></td><td>$expand</td><td><div><p>Needed if expansion isn't handled locally or via independent terminology servers</p>
</div></td></tr><tr><td><b>SHOULD</b></td><td>$validate code</td><td><div><p>Needed if expansion isn't handled locally or via independent terminology servers</p>
</div></td></tr></tbody></table></div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="CodeSystem1-3" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD </span>CodeSystem</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-codesystem.html">SDC Code System</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 <br/><code>search-type</code><div><p>Allows discovery of existing code systems for use in authoring questionnaires</p>
</div><code>read</code><div><p>Allows retrieval of a specific code system referenced within a questionnaire</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Needed if Questionnaire codes will be stored on the form server as opposed to a separate terminology service.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/codesystem.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/codesystem.html#search">version</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Library1-4" class="panel-title"><span style="float: right;">Resource Conformance: SHOULD </span>Library</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-library.html">SDC Library</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 <br/><code>search-type</code><div><p>Needed to retrieve library based on canonical reference</p>
</div></li><li><strong>MAY</strong> support <br/><code>read</code><div><p>Useful if a server doesn't return full data in a search</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Needed for certain types of population and extraction</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/library.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/library.html#search">version</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="StructureMap1-5" class="panel-title"><span style="float: right;">Resource Conformance: MAY </span>StructureMap</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="http://hl7.org/fhir/R4/structuremap.html">StructureMap</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 <br/><code>search-type</code><div><p>Needed to retrieve structure map based on canonical reference</p>
</div></li><li><strong>MAY</strong> support <br/><code>read</code><div><p>Useful if a server doesn't return full data in a search</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Needed if performing map-based population or extraction</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/structuremap.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/structuremap.html#search">version</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="StructureDefinition1-6" class="panel-title"><span style="float: right;">Resource Conformance: MAY </span>StructureDefinition</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="http://hl7.org/fhir/R4/structuredefinition.html">StructureDefinition</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 <br/><code>search-type</code><div><p>Needed to retrieve structure definition based on canonical reference</p>
</div></li><li><strong>MAY</strong> support <br/><code>read</code><div><p>Useful if a server doesn't return full data in a search</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>Needed if performing map-based population or map or definition-based extraction</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/structuredefinition.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/structuredefinition.html#search">version</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="ConceptMap1-7" class="panel-title"><span style="float: right;">Resource Conformance: MAY </span>ConceptMap</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="http://hl7.org/fhir/R4/conceptmap.html">ConceptMap</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 <br/><code>search-type</code><div><p>Needed to retrieve concept map based on various criteria</p>
</div></li><li><strong>MAY</strong> support <br/><code>read</code><div><p>Useful if a server doesn't return full data in a search</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>May be needed for code conversion during population or extraction</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-canonical-experimental.html">experimental</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/conceptmap.html#search">url</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/conceptmap.html#search">version</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/conceptmap.html#search">status</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/conceptmap.html#search">source-system</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/conceptmap.html#search">target-system</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/conceptmap.html#search">source-uri</a></td><td><code>reference</code></td><td><div/></td></tr><tr><td><b>SHOULD</b></td><td><a href="http://hl7.org/fhir/R4/conceptmap.html#search">target-uri</a></td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></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="4">
<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-fill-manager"/>
<version value="4.0.0"/>
<name value="SDCFormFillManager"/>
<title value="SDC Form Fill Manager"/>
<status value="active"/>
<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 Fill Manager* role when conforming to this implementation guide. This role is responsible for maintaining a repository of form definitions for retrieval by form fillers possibly also supporting pre-population of form data."/>
<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="4.0.1"/>
<format value="xml"/>
<format value="json"/>
<rest>
<mode value="server"/>
<documentation
value="The primary focus of the repository is providing access to [[[Questionnaire]]]s. However, [[[ValueSet]]]s, [[[CodeSystem]]]s, [[[Library]]]s, [[[ConceptMap]]]s and other resources are also relevant in their support of Questionnaire functionality. Some forms will opt to have some or all of these additional resources managed as 'contained' resources, meaning there won't be a need for them to be independently managed on the Form Fill Manager. However, systems should support resource re-use across forms, meaning that support for maintenance of these ancillary resources is still helpful. (Version-specific referencing can be used to avoid referenced resources from changing independent of the referencing [[[Questionnaire]]].)"/>
<security>
<description
value="Implementations must meet the [general security requirements](security.html) documented in this implementation guide.html."/>
</security>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Questionnaire"/>
<profile
value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire"/>
<documentation
value="Form mamagers are responsible for handling forms."/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation value="Allows a user to search for existing forms"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="read"/>
<documentation
value="Allows retrieval of a detailed Questionnaire if search only returns summary"/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-url"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-version"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-status"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="experimental"/>
<definition
value="http://hl7.org/fhir/uv/sdc/SearchParameter/canonical-experimental"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="context-type-quantity"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-context-type-quantity"/>
<type value="composite"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="context-type-value"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-context-type-value"/>
<type value="composite"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="date"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-date"/>
<type value="date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="description"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-description"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-identifier"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="publisher"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-publisher"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="questionnaire-code"/>
<definition
value="http://hl7.org/fhir/uv/sdc/SearchParameter/Questionnaire-questionnaire-code"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="subject-type"/>
<definition
value="http://hl7.org/fhir/uv/sdc/SearchParameter/Questionnaire-subject-type"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="title"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-title"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="effective"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-effective"/>
<type value="date"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="jurisdiction"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Questionnaire-jurisdiction"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="assemble-expectation"/>
<definition
value="http://hl7.org/fhir/uv/sdc/SearchParameter/questionnaire-assemble-expectation"/>
<type value="token"/>
</searchParam>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="next-question"/>
<definition
value="http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-next-question"/>
<documentation value="Needed for adaptive forms"/>
</operation>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="populate"/>
<definition
value="http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populate"/>
<documentation
value="Usefulness depends on whether fillers tend to perform population themselves"/>
</operation>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="ValueSet"/>
<profile
value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset"/>
<documentation
value="Needed if Questionnaire valuesets will be stored on the form server as opposed to a separate terminology service."/>
<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 in authoring questionnaires"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
<documentation
value="Needed if a server's default search behavior doesn't return the full resource"/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-url"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-version"/>
<type value="token"/>
</searchParam>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="expand"/>
<definition
value="http://hl7.org/fhir/OperationDefinition/ValueSet-expand"/>
<documentation
value="Needed if expansion isn't handled locally or via independent terminology servers"/>
</operation>
<operation>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="validate code"/>
<definition
value="http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"/>
<documentation
value="Needed if expansion isn't handled locally or via independent terminology servers"/>
</operation>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="CodeSystem"/>
<profile
value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem"/>
<documentation
value="Needed if Questionnaire codes will be stored on the form server as opposed to a separate terminology service."/>
<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 in authoring questionnaires"/>
</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 referenced within a questionnaire"/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-url"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-version"/>
<type value="token"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<type value="Library"/>
<profile
value="http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-library"/>
<documentation
value="Needed for certain types of population and extraction"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
<documentation
value="Useful if a server doesn't return full data in a search"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Needed to retrieve library based on canonical reference"/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="url"/>
<definition value="http://hl7.org/fhir/SearchParameter/Library-url"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Library-version"/>
<type value="token"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<type value="StructureMap"/>
<profile value="http://hl7.org/fhir/StructureDefinition/StructureMap"/>
<documentation
value="Needed if performing map-based population or extraction"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
<documentation
value="Useful if a server doesn't return full data in a search"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Needed to retrieve structure map based on canonical reference"/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-url"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-version"/>
<type value="token"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<type value="StructureDefinition"/>
<profile
value="http://hl7.org/fhir/StructureDefinition/StructureDefinition"/>
<documentation
value="Needed if performing map-based population or map or definition-based extraction"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
<documentation
value="Useful if a server doesn't return full data in a search"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Needed to retrieve structure definition based on canonical reference"/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-url"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-version"/>
<type value="token"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<type value="ConceptMap"/>
<profile value="http://hl7.org/fhir/StructureDefinition/ConceptMap"/>
<documentation
value="May be needed for code conversion during population or extraction"/>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<code value="read"/>
<documentation
value="Useful if a server doesn't return full data in a search"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<code value="search-type"/>
<documentation
value="Needed to retrieve concept map based on various criteria"/>
</interaction>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="experimental"/>
<definition
value="http://hl7.org/fhir/uv/sdc/SearchParameter/canonical-experimental"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="url"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-url"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="version"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-version"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/conformance-status"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="source-system"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ConceptMap-source-system"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="target-system"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ConceptMap-target-system"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="source-uri"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ConceptMap-source-uri"/>
<type value="reference"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD"/>
</extension>
<name value="target-uri"/>
<definition
value="http://hl7.org/fhir/SearchParameter/ConceptMap-target-uri"/>
<type value="reference"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>
IG © 2022+ HL7 International / FHIR Infrastructure. Package hl7.fhir.uv.sdc#4.0.0 based on FHIR 4.0.1. Generated 2025-09-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change