Conformance-sdc-form-filler.json

SDC System for completing forms

{
  "resourceType": "Conformance",
  "id": "sdc-formfiller",
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "name": "SDC Form Filler",
  "publisher": "U.S. Office of the National Coordinator (ONC)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://wiki.siframework.org/Structured+Data+Capture+Initiative"
        }
      ]
    }
  ],
  "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.",
  "status": "draft",
  "date": "2014-07-06",
  "fhirVersion": "0.2",
  "acceptUnknown": false,
  "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 [[QuestionnaireAnswer]] 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": "Profile/questionnaire-sdc.xml-StructuredDataCaptureForm"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Allows discovery of existing questionnaires to be completed"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-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/ExtensionDefinition/conformance-common-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/ExtensionDefinition/conformance-common-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/Profile/valueset-sdc"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-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/ExtensionDefinition/conformance-common-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/ExtensionDefinition/conformance-common-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": "QuestionnaireAnswers",
          "profile": {
            "reference": "http://hl7.org/fhir/Profile/dataelement-sdc"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-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/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Allows recording a completed or partially-completed form"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-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/ExtensionDefinition/conformance-common-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/ExtensionDefinition/conformance-common-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/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "validate",
              "documentation": "Allows checking an answer set for validity against submission rules without persisting any data"
            }
          ]
        },
        {
          "type": "DocumentReference",
          "profile": {
            "reference": "http://hl7.org/fhir/Profile/documentreference-sdc"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "search-type",
              "documentation": "Allows discovery of existing documents that may be included in a form pre-population request"
            }
          ]
        },
        {
          "type": "Binary",
          "profile": {
            "reference": "http://hl7.org/fhir/Profile/binary-sdc"
          },
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "read",
              "documentation": "Allows retrieval of a specific binary (as pointed to by a DocumentReference)"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/ExtensionDefinition/conformance-common-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/ExtensionDefinition/conformance-common-expectation",
              "valueCode": "MAY"
            }
          ],
          "name": "populate",
          "definition": {
            "reference": "http://hl7.org/fhir/OperationDefinition#questionnaire-populate",
            "display": "Populate Questionnaire"
          }
        }
      ]
    }
  ]
}