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 Archiver

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

This profile defines the expected capabilities of the ‘‘SDC Form Archiver’’ role when conforming to the S&I Framework’s [[index.html Structured Data Capture FHIR implementation guide]]. This role is responsible for persisting (archiving) completed or partially completed forms ([[QuestionnaireResponse]] resource instances). These instances may be submitted individually or in a bundle together with [[Provenance]] information providing details about the completion of the questionnaire response. In some cases [[Binary]] or [[DocumentReference]] resources might also be submitted to convey source information used in the population of the questionnaire response.
The purpose of this role is to capture “work in progress” for archival reasons. There is no expectation that submitted form data is subsequently made available for retrieval (at least not in the same format), though it might be made available through out-of-band mechanisms.

Raw OpenAPI-Swagger Definition file | Download

SDC Form Archiver

  • Implementation Guide Version: 3.0.0
  • FHIR Version: 1.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: Thu Sep 03 00:00:00 UTC 2015
  • 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 [[QuestionnaireResponse]] may be sent as a single instance or as a FHIR [[Bundle]] also containing [[Provenance]] resources providing details on the sources of information. A Bundle submission might also include [[Binary]] and/or [[DocumentReference]] instances referring to the data used to populate the form. A Form Archiver must support persisting, searching and retrieving those resources.

Security

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

Summary of System-wide Interactions
  • SHOULD support the transaction interaction described as follows:

    Allows submission of a [[QuestionnaireResponse]] together with [[Provenance]] and other supporting resources as a single unit of work.

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 TypeProfileRSUCDSearches_include_revincludeOperations
QuestionnaireResponsehttp://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponseyyy
Binary yyy
DocumentReference yyy
Provenance y

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.
  • SHOULD support update.
  • MAY support delete.

Resource Conformance: SHOULDBinary

Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • SHOULD support create.
  • MAY support update, delete.

Resource Conformance: SHOULDDocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHOULD support create.
  • MAY support update, delete.

Resource Conformance: SHOULDProvenance

Core FHIR Resource
Provenance
Reference Policy
Interaction summary
  • SHOULD support create.