Structured Data Capture 2.0 (STU2)
<CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="sdc-form-filler"/> <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"> <h2>SDC Form Filler</h2> <p>(Requirements Definition)</p> <p>http://hl7.org/fhir/us/sdc/CapabilityStatement/sdc-form-filler 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 Filler</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 retrieving pre-defined forms, requesting pre-population of forms and/or auto-populating forms, guiding the user through verifying populated data and submitting completed or partially-completed forms.</p> <p>Note that Form Fillers may also take on the role of <a href="sdc-form-archiver.html">Form Archiver</a> if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it).</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>The <a href="http://hl7.org/fhir/stu3/questionnaire.html">Questionnaire</a>, <a href="http://hl7.org/fhir/stu3/valueset.html">ValueSet</a> and <a href="http://hl7.org/fhir/stu3/codesystem.html">CodeSystem</a> resources are retrieved to allow the system to guide the user through the entry process. The <a href="http://hl7.org/fhir/stu3/binary.html">Binary</a> and <a href="http://hl7.org/fhir/stu3/documentreference.html">DocumentReference</a> resources allow the system to find existing clinical documents that can be within the pre-population process. (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the <i>Form Filler</i> itself.) Finally, the <a href="http://hl7.org/fhir/stu3/questionnaireresponse.html">QuestionnaireResponse</a> resource is used to record the populated form.</p> <p>Note: Form Fillers that support the 'populate' operation will need to be capable of consuming and rendering a partially completed QuestionnaireResponse in the same manner as if they had retrieved such a QuestionnaireResponse from a <i>Form Response Manager</i> </p> <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>Questionnaire (<a href="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire.html">Profile</a>)</th> <td> <a href="#Questionnaire-search-type" title="Allows discovery of existing questionnaires to be completed">Yes</a> </td> <td> <a href="#Questionnaire-read" title="Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.">Yes</a> </td> <td> <a href="#Questionnaire-vread" title="Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.">Yes</a> </td> <td> <a href="#Questionnaire-history-instance" title="Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.">Yes</a> </td> <td/> <td/> <td/> <td/> </tr> <tr> <th>ValueSet (<a href="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-valueset.html">Profile</a>)</th> <td/> <td> <a href="#ValueSet-read" title="Allows retrieval of a specific value set by id (as referenced in a Questionnaire)">Yes</a> </td> <td> <a href="#ValueSet-vread" title="Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)">Yes</a> </td> <td> <a href="#ValueSet-history-instance" title="Allows review of changes to a value set over time. Of interest to some systems, but probably not most.">Yes</a> </td> <td/> <td/> <td/> <td/> </tr> <tr> <th>CodeSystem (<a href="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-codesystem.html">Profile</a>)</th> <td/> <td> <a href="#CodeSystem-read" title="Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)">Yes</a> </td> <td> <a href="#CodeSystem-vread" title="Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)">Yes</a> </td> <td> <a href="#CodeSystem-history-instance" title="Allows review of changes to a code system over time. Of interest to some systems, but probably not most.">Yes</a> </td> <td/> <td/> <td/> <td/> </tr> <tr> <th>QuestionnaireResponse (<a href="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-dataelement.html">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.">Yes</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">Yes</a> </td> <td/> <td> <a href="#QuestionnaireResponse-create" title="Allows recording a completed or partially-completed form">Yes</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.)">Yes</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.">Yes</a> </td> </tr> <tr> <th>DocumentReference</th> <td> <a href="#DocumentReference-search-type" title="Allows discovery of existing documents that may be included in a form pre-population request">Yes</a> </td> <td/> <td/> <td/> <td/> <td/> <td/> <td/> </tr> <tr> <th>Binary</th> <td/> <td> <a href="#Binary-read" title="Allows retrieval of a specific binary (as pointed to by a DocumentReference)">Yes</a> </td> <td> <a href="#Binary-vread" title="Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference.">Yes</a> </td> <td/> <td/> <td/> <td/> <td/> </tr> </tbody> </table> <p> <b>Operations:</b> </p> <ul> <li> <a href="http://hl7.org/fhir/operationdefinition/valueset-expand">expand</a> - Generate expansion for specified value set</li> <li> <a href="http://hl7.org/fhir/operationdefinition/valueset-validate-code">expand</a> - Check to see whether a specific code is valid against a specified value set</li> <li> <a href="http://hl7.org/fhir/operationdefinition/questionnaire-populate">populate</a> - Populate Questionnaire returning QuestionnaireResponse to review/edit/submit</li> <li> <a href="http://hl7.org/fhir/operationdefinition/questionnaire-populatehtml">populatehtml</a> - Populate Questionnaire returning HTML page to render locally for reviewing/editing/submitting</li> <li> <a href="http://hl7.org/fhir/operationdefinition/questionnaire-populatelink">populatelink</a> - Populate questionnaire returning URL to page to review/edit/submit</li> </ul> <br/> <br/> <h3> <a href="http://hl7.org/fhir/stu3/questionnaire.html">Questionnaire</a> </h3> <h4>Interactions</h4> <table class="list"> <thead> <tr> <th>Name</th> <th>Description</th> </tr> </thead> <tbody> <tr> <th> <a name="Questionnaire-search-type"> </a> <span>search-type</span> </th> <td> <p>Allows discovery of existing questionnaires to be completed</p> </td> </tr> <tr> <th> <a name="Questionnaire-read"> </a> <span>read</span> </th> <td> <p>Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.</p> </td> </tr> <tr> <th> <a name="Questionnaire-history-instance"> </a> <span>history-instance</span> </th> <td> <p>Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.</p> </td> </tr> <tr> <th> <a name="Questionnaire-vread"> </a> <span>vread</span> </th> <td> <p>Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.</p> </td> </tr> </tbody> </table> <br/> <br/> <h3> <a href="http://hl7.org/fhir/stu3/valueset.html">ValueSet</a> </h3> <h4>Interactions</h4> <table class="list"> <thead> <tr> <th>Name</th> <th>Description</th> </tr> </thead> <tbody> <tr> <th> <a name="ValueSet-read"> </a> <span>read</span> </th> <td> <p>Allows retrieval of a specific value set by id (as referenced in a Questionnaire)</p> </td> </tr> <tr> <th> <a name="ValueSet-vread"> </a> <span>vread</span> </th> <td> <p>Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)</p> </td> </tr> <tr> <th> <a name="ValueSet-history-instance"> </a> <span>history-instance</span> </th> <td> <p>Allows review of changes to a value set over time. Of interest to some systems, but probably not most.</p> </td> </tr> </tbody> </table> <br/> <br/> <h3> <a href="http://hl7.org/fhir/stu3/codesystem.html">CodeSystem</a> </h3> <h4>Interactions</h4> <table class="list"> <thead> <tr> <th>Name</th> <th>Description</th> </tr> </thead> <tbody> <tr> <th> <a name="CodeSystem-read"> </a> <span>read</span> </th> <td> <p>Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)</p> </td> </tr> <tr> <th> <a name="CodeSystem-vread"> </a> <span>vread</span> </th> <td> <p>Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)</p> </td> </tr> <tr> <th> <a name="CodeSystem-history-instance"> </a> <span>history-instance</span> </th> <td> <p>Allows review of changes to a code system over time. Of interest to some systems, but probably not most.</p> </td> </tr> </tbody> </table> <br/> <br/> <h3> <a href="http://hl7.org/fhir/stu3/questionnaireresponse.html">QuestionnaireResponse</a> </h3> <h4>Interactions</h4> <table class="list"> <thead> <tr> <th>Name</th> <th>Description</th> </tr> </thead> <tbody> <tr> <th> <a name="QuestionnaireResponse-search-type"> </a> <span>search-type</span> </th> <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> <p>Allows recording a completed or partially-completed form</p> </td> </tr> <tr> <th> <a name="QuestionnaireResponse-update"> </a> <span>update</span> </th> <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> <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> <p>Allows review of prior versions of an answer set - allows reversion to previously recorded versions</p> </td> </tr> </tbody> </table> <br/> <br/> <h3> <a href="http://hl7.org/fhir/stu3/documentreference.html">DocumentReference</a> </h3> <h4>Interactions</h4> <table class="list"> <thead> <tr> <th>Name</th> <th>Description</th> </tr> </thead> <tbody> <tr> <th> <a name="DocumentReference-search-type"> </a> <span>search-type</span> </th> <td> <p>Allows discovery of existing documents that may be included in a form pre-population request</p> </td> </tr> </tbody> </table> <br/> <br/> <h3> <a href="http://hl7.org/fhir/stu3/binary.html">Binary</a> </h3> <h4>Interactions</h4> <table class="list"> <thead> <tr> <th>Name</th> <th>Description</th> </tr> </thead> <tbody> <tr> <th> <a name="Binary-read"> </a> <span>read</span> </th> <td> <p>Allows retrieval of a specific binary (as pointed to by a DocumentReference)</p> </td> </tr> <tr> <th> <a name="Binary-vread"> </a> <span>vread</span> </th> <td> <p>Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference.</p> </td> </tr> </tbody> </table> </div> </text> <url value="http://hl7.org/fhir/us/sdc/CapabilityStatement/sdc-form-filler"/> <version value="2.0"/> <name value="SDC Form Filler"/> <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 Filler'' role when conforming to the S&I Framework's [[index|Structured Data Capture FHIR implementation guide]]. This role is responsible for retrieving pre-defined forms, requesting pre-population of forms and/or auto-populating forms, guiding the user through verifying populated data and submitting completed or partially-completed forms.<br/>Note that Form Fillers may also take on the role of [[sdc-form-archiver|Form Archiver]] if they have a requirement to retain the completed version of a form (and potentially the source data that was used to complete it)."/> <kind value="requirements"/> <fhirVersion value="1.0.0"/> <acceptUnknown value="extensions"/> <format value="xml"/> <format value="json"/> <rest> <mode value="client"/> <documentation value="The [[Questionnaire]], [[ValueSet]] and [[CodeSystem]] resources are retrieved to allow the system to guide the user through the entry process. The [[Binary]] and [[DocumentReference]] resources allow the system to find existing clinical documents that can be within the pre-population process. (Support for retrieval operations on these resources is optional as the relevant CDA or FHIR structures may also be directly generated by the ''Form Filler'' itself.) Finally, the [[QuestionnaireResponse]] resource is used to record the populated form.<br/>Note: Form Fillers that support the 'populate' operation will need to be capable of consuming and rendering a partially completed QuestionnaireResponse in the same manner as if they had retrieved such a QuestionnaireResponse from a ''Form Response Manager''"/> <security> <description value="Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]."/> </security> <resource> <type value="Questionnaire"/> <profile> <reference value="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-questionnaire"/> </profile> <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 to be completed"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id."/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most."/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only."/> </interaction> </resource> <resource> <type value="ValueSet"/> <profile> <reference value="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-valueset"/> </profile> <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 (as referenced in a Questionnaire)"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to a value set over time. Of interest to some systems, but probably not most."/> </interaction> </resource> <resource> <type value="CodeSystem"/> <profile> <reference value="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-codesystem"/> </profile> <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 (as referenced by a ValueSet used in a Questionnaire)"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <code value="history-instance"/> <documentation value="Allows review of changes to a code system over time. Of interest to some systems, but probably not most."/> </interaction> </resource> <resource> <type value="QuestionnaireResponse"/> <profile> <reference value="http://hl7.org/fhir/us/sdc/StructureDefinition/sdc-dataelement"/> </profile> <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 completed or partially-completed forms. Generally used to find partially-completed forms for update."/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-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/capabilitystatement-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/capabilitystatement-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/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="history-instance"/> <documentation value="Allows review of prior versions of an answer set - allows reversion to previously recorded versions"/> </interaction> </resource> <resource> <type value="DocumentReference"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="search-type"/> <documentation value="Allows discovery of existing documents that may be included in a form pre-population request"/> </interaction> </resource> <resource> <type value="Binary"/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <code value="read"/> <documentation value="Allows retrieval of a specific binary (as pointed to by a DocumentReference)"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <code value="vread"/> <documentation value="Allows retrieval of a historical version of a binary. In general, the most recent version would be appropriate, but some may prefer to use the specific version referenced by a DocumentReference."/> </interaction> </resource> <operation> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="expand"/> <definition> <reference value="http://hl7.org/fhir/OperationDefinition/ValueSet-expand"/> <display value="Generate expansion for specified value set"/> </definition> </operation> <operation> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="expand"/> <definition> <reference value="http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"/> <display value="Check to see whether a specific code is valid against a specified value set"/> </definition> </operation> <operation> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <name value="populate"/> <definition> <reference value="http://hl7.org/fhir/OperationDefinition/Questionnaire-populate"/> <display value="Populate Questionnaire returning QuestionnaireResponse to review/edit/submit"/> </definition> </operation> <operation> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <name value="populatehtml"/> <definition> <reference value="http://hl7.org/fhir/OperationDefinition/Questionnaire-populatehtml"/> <display value="Populate Questionnaire returning HTML page to render locally for reviewing/editing/submitting"/> </definition> </operation> <operation> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <name value="populatelink"/> <definition> <reference value="http://hl7.org/fhir/OperationDefinition/Questionnaire-populatelink"/> <display value="Populate questionnaire returning URL to page to review/edit/submit"/> </definition> </operation> </rest> </CapabilityStatement>
© 2015+ HL7 International (OO work group). SDC v2.0, based on FHIR version 3.0.1. IG generated on Fri, Apr 21, 2017 09:19+1000.
Links: Version History |
Table of Contents |
|
Propose a change 