FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package hl7.fhir.uv.sdc.r4b#3.0.0 (125 ms)

Package hl7.fhir.uv.sdc.r4b
Type CapabilityStatement
Id Id
FHIR Version R4B
Source http://hl7.org/fhir/uv/sdc/http://hl7.org/fhir/uv/sdc/STU3/CapabilityStatement-sdc-form-filler.html
Url http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-filler
Version 3.0.0
Status draft
Date 2014-07-06
Name SDCFormFiller
Title SDC Form Filler
Experimental False
Realm uv
Authority hl7
Description This profile defines the expected capabilities of the ''SDC Form Filler'' role when conforming to the S&I Framework's [[index.html|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.
Note that Form Fillers may also take on the role of [[CapabilityStatement-sdc-form-archiver.html|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

Resources that use this resource

CapabilityStatement
https://smartforms.csiro.au/ig/CapabilityStatement/SmartFormsApplication Smart Forms Application

Resources that this resource uses

OperationDefinition
Questionnaire-populate Populate Questionnaire
Questionnaire-populatehtml Generate HTML for Questionnaire
Questionnaire-populatelink Generate a link to a Questionnaire completion webpage
Questionnaire-populate Populate Questionnaire
Questionnaire-populatehtml Generate HTML for Questionnaire
Questionnaire-populatelink Generate a link to a Questionnaire completion webpage
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem SDC Code System
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire SDC Base Questionnaire
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse SDC Questionnaire Response
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset SDC Value Set
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem SDCCodeSystem
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire SDCBaseQuestionnaire
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse SDC Questionnaire Response
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset SDC ValueSet


Narrative

Note: links and images are rebased to the (stated) source

SDC Form Filler

(Requirements Definition Capability Statement)

Canonical URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-filler Published: 2014-07-06 (draft)

Published by: HL7 International - FHIR Infrastructure

This profile defines the expected capabilities of the SDC Form Filler role when conforming to the S&I Framework's 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.

Note that Form Fillers may also take on the role of 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).

General

FHIR Version: 1.0.0
Supported formats: xml, json

REST client behavior

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.

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:

Implementations must meet the general security requirements documented in the SDC implementation guide.

Resource summary

Resource Search Read Read Version Instance History Resource History Create Update Delete Operations
Questionnaire (Profile) SHALL SHOULD MAY MAY
ValueSet (Profile) SHALL SHOULD MAY
CodeSystem (Profile) SHALL SHOULD MAY
QuestionnaireResponse (Profile) SHALL SHALL SHOULD SHALL SHALL SHALL
DocumentReference SHOULD
Binary SHOULD MAY

Operations:



Questionnaire

Profile: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire

Interactions

Name Conformance Description
  search-type SHALL

Allows discovery of existing questionnaires to be completed

  read SHOULD

Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.

  history-instance MAY

Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.

  vread MAY

Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.



ValueSet

Profile: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset

Interactions

Name Conformance Description
  read SHALL

Allows retrieval of a specific value set by id (as referenced in a Questionnaire)

  vread SHOULD

Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)

  history-instance MAY

Allows review of changes to a value set over time. Of interest to some systems, but probably not most.



CodeSystem

Profile: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem

Interactions

Name Conformance Description
  read SHALL

Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)

  vread SHOULD

Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)

  history-instance MAY

Allows review of changes to a code system over time. Of interest to some systems, but probably not most.



QuestionnaireResponse

Profile: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse

Interactions

Name Conformance Description
  search-type SHALL

Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.

  read SHALL

Allows retrieval of a specific QuestionnaireResponse by id.

  create SHALL

Allows recording a completed or partially-completed form

  update SHALL

Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)

  delete SHALL

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.

  history-instance SHOULD

Allows review of prior versions of an answer set - allows reversion to previously recorded versions



DocumentReference

Interactions

Name Conformance Description
  search-type SHOULD

Allows discovery of existing documents that may be included in a form pre-population request



Binary

Interactions

Name Conformance Description
  read SHOULD

Allows retrieval of a specific binary (as pointed to by a DocumentReference)

  vread MAY

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.


Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "sdc-form-filler",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <h2>SDC Form Filler</h2>\n <p>(Requirements Definition Capability Statement)</p>\n <p>Canonical URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-filler Published: 2014-07-06 (draft)</p>\n <p>Published by: <b>HL7 International - FHIR Infrastructure</b>\n </p>\n <p>This profile defines the expected capabilities of the <i>SDC Form Filler</i> role when conforming to the S&amp;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>\n <p>Note that Form Fillers may also take on the role of <a href=\"CapabilityStatement-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>\n <h2>General</h2>\n <div class=\"table-wrapper\">\n <table class=\"grid\">\n <tbody>\n <tr>\n <th>FHIR Version:</th>\n <td>1.0.0</td>\n </tr>\n <tr>\n <th>Supported formats:</th>\n <td>xml, json</td>\n </tr>\n </tbody>\n </table>\n </div>\n <h2>REST client behavior</h2>\n <p>The <a href=\"http://hl7.org/fhir/R4/questionnaire.html\">Questionnaire</a>, <a href=\"http://hl7.org/fhir/R4/valueset.html\">ValueSet</a> and <a href=\"http://hl7.org/fhir/R4/codesystem.html\">CodeSystem</a> resources are retrieved to allow the system to guide the user through the entry process. The <a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a> and <a href=\"http://hl7.org/fhir/R4/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/R4/questionnaireresponse.html\">QuestionnaireResponse</a> resource is used to record the populated form.</p>\n <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>\n </p>\n <p>\n <b>Security:</b>\n </p>\n <p>Implementations must meet the general security requirements documented in the <a href=\"security.html\">SDC implementation guide</a>.</p>\n <h3>Resource summary</h3>\n <div class=\"table-wrapper\">\n <table class=\"grid\">\n <thead>\n <tr>\n <th>Resource</th>\n <th>Search</th>\n <th>Read</th>\n <th>Read Version</th>\n <th>Instance History</th>\n <th>Resource History</th>\n <th>Create</th>\n <th>Update</th>\n <th>Delete</th>\n <th>Operations</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>Questionnaire (<a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire\">Profile</a>)</th>\n <td>\n <a href=\"#Questionnaire-search-type\" title=\"Allows discovery of existing questionnaires to be completed\">SHALL</a>\n </td>\n <td>\n <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.\">SHOULD</a>\n </td>\n <td>\n <a href=\"#Questionnaire-vread\" title=\"Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.\">MAY</a>\n </td>\n <td>\n <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.\">MAY</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>ValueSet (<a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset\">Profile</a>)</th>\n <td/>\n <td>\n <a href=\"#ValueSet-read\" title=\"Allows retrieval of a specific value set by id (as referenced in a Questionnaire)\">SHALL</a>\n </td>\n <td>\n <a href=\"#ValueSet-vread\" title=\"Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)\">SHOULD</a>\n </td>\n <td>\n <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.\">MAY</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>CodeSystem (<a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem\">Profile</a>)</th>\n <td/>\n <td>\n <a href=\"#CodeSystem-read\" title=\"Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)\">SHALL</a>\n </td>\n <td>\n <a href=\"#CodeSystem-vread\" title=\"Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)\">SHOULD</a>\n </td>\n <td>\n <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.\">MAY</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>QuestionnaireResponse (<a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse\">Profile</a>)</th>\n <td>\n <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.\">SHALL</a>\n </td>\n <td>\n <a href=\"#QuestionnaireResponse-read\" title=\"Allows retrieval of a specific QuestionnaireResponse by id.\">SHALL</a>\n </td>\n <td/>\n <td>\n <a href=\"#QuestionnaireResponse-history-instance\" title=\"Allows review of prior versions of an answer set - allows reversion to previously recorded versions\">SHOULD</a>\n </td>\n <td/>\n <td>\n <a href=\"#QuestionnaireResponse-create\" title=\"Allows recording a completed or partially-completed form\">SHALL</a>\n </td>\n <td>\n <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.)\">SHALL</a>\n </td>\n <td>\n <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.\">SHALL</a>\n </td>\n <td/>\n </tr>\n <tr>\n <th>DocumentReference</th>\n <td>\n <a href=\"#DocumentReference-search-type\" title=\"Allows discovery of existing documents that may be included in a form pre-population request\">SHOULD</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n <tr>\n <th>Binary</th>\n <td/>\n <td>\n <a href=\"#Binary-read\" title=\"Allows retrieval of a specific binary (as pointed to by a DocumentReference)\">SHOULD</a>\n </td>\n <td>\n <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.\">MAY</a>\n </td>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n <td/>\n </tr>\n </tbody>\n </table>\n </div>\n <p>\n <b>Operations:</b>\n </p>\n <ul>\n <li>\n <a href=\"http://hl7.org/fhir/OperationDefinition/ValueSet-expand\">$expand</a>\n <i> SHOULD</i>\n </li>\n <li>\n <a href=\"http://hl7.org/fhir/operationdefinition/valueset-validate-code\">$validate code</a>\n <i> SHOULD</i>\n </li>\n <li>\n <a href=\"http://hl7.org/fhir/uv/sdc/operationdefinition/questionnaire-populate\">$populate</a>\n <i> MAY</i>\n </li>\n <li>\n <a href=\"http://hl7.org/fhir/uv/sdc/operationdefinition/questionnaire-populatehtml\">$populatehtml</a>\n <i> MAY</i>\n </li>\n <li>\n <a href=\"http://hl7.org/fhir/uv/sdc/operationdefinition/questionnaire-populatelink\">$populatelink</a>\n <i> MAY</i>\n </li>\n </ul>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/questionnaire.html\">Questionnaire</a>\n </h3>\n <p>Profile: <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Questionnaire-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows discovery of existing questionnaires to be completed</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Questionnaire-read\"> </a>\n <span>read</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Questionnaire-history-instance\"> </a>\n <span>history-instance</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Questionnaire-vread\"> </a>\n <span>vread</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/valueset.html\">ValueSet</a>\n </h3>\n <p>Profile: <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"ValueSet-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows retrieval of a specific value set by id (as referenced in a Questionnaire)</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"ValueSet-vread\"> </a>\n <span>vread</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"ValueSet-history-instance\"> </a>\n <span>history-instance</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows review of changes to a value set over time. Of interest to some systems, but probably not most.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/codesystem.html\">CodeSystem</a>\n </h3>\n <p>Profile: <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"CodeSystem-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"CodeSystem-vread\"> </a>\n <span>vread</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"CodeSystem-history-instance\"> </a>\n <span>history-instance</span>\n </th>\n <td>MAY</td>\n <td>\n <p>Allows review of changes to a code system over time. Of interest to some systems, but probably not most.</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/questionnaireresponse.html\">QuestionnaireResponse</a>\n </h3>\n <p>Profile: <a href=\"http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse</a>\n </p>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"QuestionnaireResponse-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHALL</td>\n <td>\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 </td>\n </tr>\n <tr>\n <th>\n <a name=\"QuestionnaireResponse-read\"> </a>\n <span>read</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows retrieval of a specific QuestionnaireResponse by id.</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"QuestionnaireResponse-create\"> </a>\n <span>create</span>\n </th>\n <td>SHALL</td>\n <td>\n <p>Allows recording a completed or partially-completed form</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"QuestionnaireResponse-update\"> </a>\n <span>update</span>\n </th>\n <td>SHALL</td>\n <td>\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 </td>\n </tr>\n <tr>\n <th>\n <a name=\"QuestionnaireResponse-delete\"> </a>\n <span>delete</span>\n </th>\n <td>SHALL</td>\n <td>\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 </td>\n </tr>\n <tr>\n <th>\n <a name=\"QuestionnaireResponse-history-instance\"> </a>\n <span>history-instance</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows review of prior versions of an answer set - allows reversion to previously recorded versions</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/documentreference.html\">DocumentReference</a>\n </h3>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"DocumentReference-search-type\"> </a>\n <span>search-type</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows discovery of existing documents that may be included in a form pre-population request</p>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n <br/>\n <br/>\n <h3>\n <a href=\"http://hl7.org/fhir/R4/binary.html\">Binary</a>\n </h3>\n <h4>Interactions</h4>\n <div class=\"table-wrapper\">\n <table class=\"list\">\n <thead>\n <tr>\n <th>Name</th>\n <th>Conformance</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n <tr>\n <th>\n <a name=\"Binary-read\"> </a>\n <span>read</span>\n </th>\n <td>SHOULD</td>\n <td>\n <p>Allows retrieval of a specific binary (as pointed to by a DocumentReference)</p>\n </td>\n </tr>\n <tr>\n <th>\n <a name=\"Binary-vread\"> </a>\n <span>vread</span>\n </th>\n <td>MAY</td>\n <td>\n <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>\n </td>\n </tr>\n </tbody>\n </table>\n </div>\n </div>"
  },
  "url" : "http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-filler",
  "version" : "3.0.0",
  "name" : "SDCFormFiller",
  "title" : "SDC Form Filler",
  "status" : "draft",
  "date" : "2014-07-06",
  "publisher" : "HL7 International - FHIR Infrastructure Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description" : "This profile defines the expected capabilities of the ''SDC Form Filler'' role when conforming to the S&I Framework's [[index.html|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 [[CapabilityStatement-sdc-form-archiver.html|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).",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.3.0",
  "format" : [
    "xml",
    "json"
  ],
  "rest" : [
    {
      "mode" : "client",
      "documentation" : "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" : "Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]]."
      },
      "resource" : [
        {
          "type" : "Questionnaire",
          "profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "search-type",
              "documentation" : "Allows discovery of existing questionnaires to be completed"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-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/capabilitystatement-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/capabilitystatement-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" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-valueset",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-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/capabilitystatement-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/capabilitystatement-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" : "CodeSystem",
          "profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-codesystem",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "vread",
              "documentation" : "Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "MAY"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of changes to a code system over time. Of interest to some systems, but probably not most."
            }
          ]
        },
        {
          "type" : "QuestionnaireResponse",
          "profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-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/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "read",
              "documentation" : "Allows retrieval of a specific QuestionnaireResponse by id."
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode" : "SHALL"
                }
              ],
              "code" : "create",
              "documentation" : "Allows recording a completed or partially-completed form"
            },
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-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/capabilitystatement-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/capabilitystatement-expectation",
                  "valueCode" : "SHOULD"
                }
              ],
              "code" : "history-instance",
              "documentation" : "Allows review of prior versions of an answer set - allows reversion to previously recorded versions"
            }
          ]
        },
        {
          "type" : "DocumentReference",
          "interaction" : [
            {
              "extension" : [
                {
                  "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-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/capabilitystatement-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/capabilitystatement-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/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "name" : "expand",
          "definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-expand"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHOULD"
            }
          ],
          "name" : "validate code",
          "definition" : "http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "name" : "populate",
          "definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populate"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "name" : "populatehtml",
          "definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populatehtml"
        },
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "MAY"
            }
          ],
          "name" : "populatelink",
          "definition" : "http://hl7.org/fhir/uv/sdc/OperationDefinition/Questionnaire-populatelink"
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.