GAO Ballot Package
This page is part of the FHIR Specification (v1.1.0: STU 3 Ballot 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
This is a frozen snapshot of the FHIR specification created for the purpose of balloting the GAO implementation Guide. It includes draft changes that may be part of the future DSTU 2.1 release but further change is expected. Readers should focus solely on the GAO implementation content, and FHIR DSTU 2 for other purposes.
SDC Repository for completed forms
{
"resourceType": "Conformance",
"id": "conformance-sdc-form-receiver",
"text": {
"status": "generated",
"div": "<div>\n \n <h2>SDC Form Receiver</h2>\n \n <p>(Requirements Definition)</p>\n \n <p>Published: 2014-07-06 (draft)</p>\n \n <p>Published by: \n <b>U.S. Office of the National Coordinator (ONC)</b>\n \n </p>\n \n <p>This profile defines the expected capabilities of the \n <i>SDC Form Receiver</i> role when conforming to the S&I Framework's \n <a href=\"sdc.html\">Structured Data Capture FHIR implementation guide</a>. This role is responsible for storing and returning completed and partially-completed forms.\n </p>\n \n <h2>General</h2>\n \n <table>\n \n <tbody>\n \n <tr>\n \n <th>FHIR Version:</th>\n \n <td>1.1.0</td>\n \n </tr>\n \n <tr>\n \n <th>Supported formats:</th>\n \n <td>xml, json</td>\n \n </tr>\n \n </tbody>\n \n </table>\n \n <h2>REST behavior</h2>\n \n <p>\n \n <b>Security:</b>\n \n </p>\n \n <p>Implementations must meet the general security requirements documented in the \n <a href=\"sdc-security.html\">SDC implementation guide</a>.\n </p>\n \n <h3>Resource summary</h3>\n \n <table class=\"grid\">\n \n <thead>\n \n <tr>\n \n <th>Resource</th>\n \n <th>Search</th>\n \n <th>Read</th>\n \n <th>Read Version</th>\n \n <th>Instance History</th>\n \n <th>Resource History</th>\n \n <th>Create</th>\n \n <th>Update</th>\n \n <th>Delete</th>\n \n </tr>\n \n </thead>\n \n <tbody>\n \n <tr>\n \n <th>QuestionnaireResponse (\n <a href=\"http://hl7.org/fhir/StructureDefinition/sdc-element\">Profile</a>)\n </th>\n \n <td>\n \n <a title=\"Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.\" href=\"#QuestionnaireResponse-search-type\">SHALL</a>\n \n </td>\n \n <td/>\n \n <td/>\n \n <td>\n \n <a title=\"Allows review of prior versions of an answer set - allows reversion to previously recorded versions\" href=\"#QuestionnaireResponse-history-instance\">SHALL</a>\n \n </td>\n \n <td/>\n \n <td>\n \n <a title=\"Allows recording a completed or partially-completed form\" href=\"#QuestionnaireResponse-create\">SHALL</a>\n \n </td>\n \n <td>\n \n <a title=\"Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)\" href=\"#QuestionnaireResponse-update\">SHALL</a>\n \n </td>\n \n <td>\n \n <a 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.\" href=\"#QuestionnaireResponse-delete\">SHALL</a>\n \n </td>\n \n </tr>\n \n </tbody>\n \n </table>\n \n <br/>\n \n <br/>\n \n <h3>\n \n <a href=\"../questionnaireresponse.html\">QuestionnaireResponse</a>\n \n </h3>\n \n <h4>Interactions</h4>\n \n <table class=\"list\">\n \n <thead>\n \n <tr>\n \n <th>Name</th>\n \n <th>Conformance</th>\n \n <th>Description</th>\n \n </tr>\n \n </thead>\n \n <tbody>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-search-type\"> </a>\n \n <span>search-type</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-create\"> </a>\n \n <span>create</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows recording a completed or partially-completed form</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-update\"> </a>\n \n <span>update</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-delete\"> </a>\n \n <span>delete</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <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>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-history-instance\"> </a>\n \n <span>history-instance</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows review of prior versions of an answer set - allows reversion to previously recorded versions</p>\n \n </td>\n \n </tr>\n \n <tr>\n \n <th>\n \n <a name=\"QuestionnaireResponse-validate\"> </a>\n \n <span>validate</span>\n \n </th>\n \n <td>SHALL</td>\n \n <td>\n \n <p>Allows checking an answer set for validity against submission rules without persisting any data</p>\n \n </td>\n \n </tr>\n \n </tbody>\n \n </table>\n \n <h4>Search</h4>\n \n <p>Supported Includes: QuestionnaireResponse.questionnaire Questionnaire.group.question.options</p>\n \n <table class=\"list\">\n \n <thead>\n \n <tr>\n \n <th>Parameter</th>\n \n <th>Conformance</th>\n \n <th>Type</th>\n \n <th>Definition & Chaining</th>\n \n </tr>\n \n </thead>\n \n <tbody>\n \n <tr>\n \n <th>author</th>\n \n <td>SHALL</td>\n \n <td>token</td>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <th>authored</th>\n \n <td>SHALL</td>\n \n <td>date</td>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <th>questionnaire</th>\n \n <td>SHALL</td>\n \n <td>token</td>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <th>status</th>\n \n <td>SHALL</td>\n \n <td>token</td>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <th>subject</th>\n \n <td>SHALL</td>\n \n <td>token</td>\n \n <td/>\n \n </tr>\n \n <tr>\n \n <th>encounter</th>\n \n <td>SHOULD</td>\n \n <td>token</td>\n \n <td/>\n \n </tr>\n \n </tbody>\n \n </table>\n \n </div>"
},
"name": "SDC Form Receiver",
"status": "draft",
"publisher": "U.S. Office of the National Coordinator (ONC)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://wiki.siframework.org/Structured+Data+Capture+Initiative"
}
]
}
],
"date": "2014-07-06",
"description": "This profile defines the expected capabilities of the ''SDC Form Receiver'' role when conforming to the S&I Framework's [[sdc|Structured Data Capture FHIR implementation guide]]. This role is responsible for storing and returning completed and partially-completed forms.",
"kind": "requirements",
"fhirVersion": "1.1.0",
"acceptUnknown": "extensions",
"format": [
"xml",
"json"
],
"rest": [
{
"mode": "server",
"security": {
"description": "Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]."
},
"resource": [
{
"type": "QuestionnaireResponse",
"profile": {
"reference": "http://hl7.org/fhir/StructureDefinition/sdc-element"
},
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "search-type",
"documentation": "Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "create",
"documentation": "Allows recording a completed or partially-completed form"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "update",
"documentation": "Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "delete",
"documentation": "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."
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "history-instance",
"documentation": "Allows review of prior versions of an answer set - allows reversion to previously recorded versions"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"code": "validate",
"documentation": "Allows checking an answer set for validity against submission rules without persisting any data"
}
],
"searchInclude": [
"QuestionnaireResponse.questionnaire",
"Questionnaire.group.question.options"
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"name": "author",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireresponse#author",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"name": "authored",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireresponse#authored",
"type": "date"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"name": "questionnaire",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireresponse#questionnaire",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireresponse#status",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHALL"
}
],
"name": "subject",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireresponse#subject",
"type": "token"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
"valueCode": "SHOULD"
}
],
"name": "encounter",
"definition": "http://hl7.org/fhir/SearchParameter/questionnaireresponse#encounter",
"type": "token"
}
]
}
]
}
]
}
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU2 (v1.1.0-7375) generated on Thu, Dec 3, 2015 10:00+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change