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 Response Manager

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

This profile defines the expected capabilities of the ‘‘SDC Form Response Manager’’ role when conforming to the S&I Framework’s [[index.html Structured Data Capture FHIR implementation guide]]. This role is responsible for providing read/write access to QuestionnaireResponses. This is typically to support light-weight clients that want to be able to complete forms but do not have local storage to save work in progress.

Raw OpenAPI-Swagger Definition file | Download

SDC Form Response Manager

  • 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: server

Security

Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]]. Systems may wish to ensure that QuestionnaireResponse instances are only accessible to the user (or at least the organization) who was responsible for creating them.

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 TypeProfileRSUCDH-ISearches_include_revincludeOperations
QuestionnaireResponsehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponseyyyyyy

Resource Conformance: SHALLQuestionnaireResponse

Base System Profile
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse
Profile Conformance
SHALL
Reference Policy

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

Documentation

This allows QuestionnaireResponses to be created, updated and retrieved. Note that storing a QuestionnaireResponse does not imply any execution of behavior on the basis of the stored data.