{
  "resourceType": "Conformance",
  "id": "core-examples-sdcformfiller3",
  "meta": {
    "versionId": "1",
    "lastUpdated": "2016-09-08T12:11:03.706+00:00"
  },
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><h2>SDC Form Filler</h2><p>(Requirements Definition)</p><p>Published: 2014-07-06 (draft)</p><p>Published by: \r\n        <b>U.S. Office of the National Coordinator (ONC)</b></p><p>This profile defines the expected capabilities of the \r\n        <i>SDC Form Filler</i> role when conforming to the S&amp;I Framework's \r\n        <a href=\"sdc.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.\r\n      </p><p>Note that Form Fillers may also take on the role of \r\n        <a href=\"conformance-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).\r\n      </p><h2>General</h2><table><tbody><tr><th>FHIR Version:</th><td>1.0.2</td></tr><tr><th>Supported formats:</th><td>xml, json</td></tr></tbody></table><h2>REST  behavior</h2><p>The \r\n        <a href=\"../questionnaire.html\">Questionnaire</a> and \r\n        <a href=\"../valueset.html\">ValueSet</a> resources are retrieved to allow the system to guide the user through the entry process.  The \r\n        <a href=\"../binary.html\">Binary</a> and \r\n        <a href=\"../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 \r\n        <i>Form Filler</i> itself.)  Finally, the \r\n        <a href=\"../questionnaireresponse.html\">QuestionnaireResponse</a> resource is used to record the populated form.\r\n      </p><p><b>Security:</b></p><p>Implementations must meet the general security requirements documented in the \r\n        <a href=\"sdc-security.html\">SDC implementation guide</a>.\r\n      </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 (\r\n              <a href=\"http://hl7.org/fhir/StructureDefinition/sdc-questionnaire\">Profile</a>)\r\n            </th><td><a title=\"Allows discovery of existing questionnaires to be completed\" href=\"#Questionnaire-search-type\">SHALL</a></td><td><a title=\"Allows retrieval of a specific questionnaire by id.  Allows systems to maintain a 'favorites' list of forms and retrieve them by id.\" href=\"#Questionnaire-read\">SHOULD</a></td><td><a title=\"Allows retrieval of a historical version of a questionnaire.  Most systems will make use of the current version only.\" href=\"#Questionnaire-vread\">MAY</a></td><td><a title=\"Allows review of changes made to a questionnaire over time.  Of interest to some systems, but probably not most.\" href=\"#Questionnaire-history-instance\">MAY</a></td><td /><td /><td /><td /></tr><tr><th>ValueSet (\r\n              <a href=\"http://hl7.org/fhir/StructureDefinition/sdc-valueset\">Profile</a>)\r\n            </th><td /><td><a title=\"Allows retrieval of a specific value set by id (as referenced in a Questionnaire)\" href=\"#ValueSet-read\">SHALL</a></td><td><a title=\"Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)\" href=\"#ValueSet-vread\">SHOULD</a></td><td><a title=\"Allows review of changes to a value set over time.  Of interest to some systems, but probably not most.\" href=\"#ValueSet-history-instance\">MAY</a></td><td /><td /><td /><td /></tr><tr><th>QuestionnaireResponse (\r\n              <a href=\"http://hl7.org/fhir/StructureDefinition/sdc-element\">Profile</a>)\r\n            </th><td><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></td><td /><td /><td><a title=\"Allows review of prior versions of an answer set - allows reversion to previously recorded versions\" href=\"#QuestionnaireResponse-history-instance\">SHOULD</a></td><td /><td><a title=\"Allows recording a completed or partially-completed form\" href=\"#QuestionnaireResponse-create\">SHALL</a></td><td><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></td><td><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></td></tr><tr><th>DocumentReference</th><td><a title=\"Allows discovery of existing documents that may be included in a form pre-population request\" href=\"#DocumentReference-search-type\">SHOULD</a></td><td /><td /><td /><td /><td /><td /><td /></tr><tr><th>Binary</th><td /><td><a title=\"Allows retrieval of a specific binary (as pointed to by a DocumentReference)\" href=\"#Binary-read\">SHOULD</a></td><td><a 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.\" href=\"#Binary-vread\">MAY</a></td><td /><td /><td /><td /><td /></tr></tbody></table><p><b>Operations:</b><a title=\"Populate Questionnaire\" href=\"http://hl7.org/fhir/OperationDefinition#questionnaire-populate\">populate</a> MAY\r\n      </p><br /><br /><h3><a href=\"../questionnaire.html\">Questionnaire</a></h3><h4>Interactions</h4><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 to be completed</p></td></tr><tr><th><a name=\"Questionnaire-read\"> </a><span>read</span></th><td>SHOULD</td><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>MAY</td><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>MAY</td><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=\"../valueset.html\">ValueSet</a></h3><h4>Interactions</h4><table class=\"list\"><thead><tr><th>Name</th><th>Conformance</th><th>Description</th></tr></thead><tbody><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 (as referenced in a Questionnaire)</p></td></tr><tr><th><a name=\"ValueSet-vread\"> </a><span>vread</span></th><td>SHOULD</td><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>MAY</td><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=\"../questionnaireresponse.html\">QuestionnaireResponse</a></h3><h4>Interactions</h4><table class=\"list\"><thead><tr><th>Name</th><th>Conformance</th><th>Description</th></tr></thead><tbody><tr><th><a name=\"QuestionnaireResponse-search-type\"> </a><span>search-type</span></th><td>SHALL</td><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>SHALL</td><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>SHALL</td><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>SHALL</td><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>SHOULD</td><td><p>Allows review of prior versions of an answer set - allows reversion to previously recorded versions</p></td></tr><tr><th><a name=\"QuestionnaireResponse-validate\"> </a><span>validate</span></th><td>SHOULD</td><td><p>Allows checking an answer set for validity against submission rules without persisting any data</p></td></tr></tbody></table><br /><br /><h3><a href=\"../documentreference.html\">DocumentReference</a></h3><h4>Interactions</h4><table class=\"list\"><thead><tr><th>Name</th><th>Conformance</th><th>Description</th></tr></thead><tbody><tr><th><a name=\"DocumentReference-search-type\"> </a><span>search-type</span></th><td>SHOULD</td><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=\"../binary.html\">Binary</a></h3><h4>Interactions</h4><table class=\"list\"><thead><tr><th>Name</th><th>Conformance</th><th>Description</th></tr></thead><tbody><tr><th><a name=\"Binary-read\"> </a><span>read</span></th><td>SHOULD</td><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>MAY</td><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>"
  },
  "name": "SDC Form Filler",
  "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 Filler'' role when conforming to the S&I Framework's [[sdc|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 [[conformance-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": "requirements",
  "fhirVersion": "1.0.2",
  "acceptUnknown": "extensions",
  "format": [
    "xml",
    "json"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "The [[Questionnaire]] and [[ValueSet]] 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.",
      "security": {
        "description": "Implementations must meet the general security requirements documented in the [[sdc-security|SDC implementation guide]]."
      },
      "resource": [
        {
          "type": "Questionnaire",
          "profile": {
            "reference": "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Allows discovery of existing questionnaires to be completed"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific questionnaire by id.  Allows systems to maintain a 'favorites' list of forms and retrieve them by id."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "history-instance",
              "documentation": "Allows review of changes made to a questionnaire over time.  Of interest to some systems, but probably not most."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a historical version of a questionnaire.  Most systems will make use of the current version only."
            }
          ]
        },
        {
          "type": "ValueSet",
          "profile": {
            "reference": "http://hl7.org/fhir/StructureDefinition/sdc-valueset"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific value set by id (as referenced in a Questionnaire)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "vread",
              "documentation": "Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "history-instance",
              "documentation": "Allows review of changes to a value set over time.  Of interest to some systems, but probably not most."
            }
          ]
        },
        {
          "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": "SHOULD"
                }
              ],
              "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": "SHOULD"
                }
              ],
              "code": "validate",
              "documentation": "Allows checking an answer set for validity against submission rules without persisting any data"
            }
          ]
        },
        {
          "type": "DocumentReference",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "search-type",
              "documentation": "Allows discovery of existing documents that may be included in a form pre-population request"
            }
          ]
        },
        {
          "type": "Binary",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific binary (as pointed to by a DocumentReference)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
                  "valueCode": "MAY"
                }
              ],
              "code": "vread",
              "documentation": "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."
            }
          ]
        }
      ],
      "operation": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/conformance-expectation",
              "valueCode": "MAY"
            }
          ],
          "name": "populate",
          "definition": {
            "reference": "http://hl7.org/fhir/OperationDefinition#questionnaire-populate",
            "display": "Populate Questionnaire"
          }
        }
      ]
    }
  ]
}