Structured Data Capture
3.0.0 - STU 3 International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 3.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

CapabilityStatement: SDC Form Filler

Official URL: http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-filler Version: 3.0.0
Standards status: Trial-use Maturity Level: 3 Computable Name: SDCFormFiller

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).

Raw OpenAPI-Swagger Definition file | Download

SDC Form Filler

  • Implementation Guide Version: 3.0.0
  • FHIR Version: 1.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: Sun Jul 06 00:00:00 UTC 2014
  • Published by: HL7 International / FHIR Infrastructure

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as "SHALL NOT". A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

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

Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]].

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)

Resource Conformance: SHALLQuestionnaire

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type.
  • SHOULD support read.
  • MAY support history-instance, vread.

Resource Conformance: SHALLValueSet

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read.
  • SHOULD support vread.
  • MAY support history-instance.

Resource Conformance: SHALLCodeSystem

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support read.
  • SHOULD support vread.
  • MAY support history-instance.

Resource Conformance: SHALLQuestionnaireResponse

Profile Conformance
SHALL
Reference Policy

Interaction summary
  • SHALL support search-type, read, create, update, delete.
  • SHOULD support history-instance.

Resource Conformance: SHOULDDocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHOULD support search-type.

Resource Conformance: SHOULDBinary

Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • SHOULD support read.
  • MAY support vread.