Conformance-sdc-form-archiver

SDC Form Archiver

(Requirements Definition)

Published: 2015-09-03 (draft)

Published by: U.S. Office of the National Coordinator (ONC)

This profile defines the expected capabilities of the SDC Form Archiver role when conforming to the S&I Framework's 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.<br>The focus of this role is on consuming form instances. Examples might be applications accepting insurance coverage forms, research forms, etc. There is no expectation that submitted form data is subsequently made available for retrieval (at least not in the same format).

General

FHIR Version:	1.4.0
Supported formats:	xml, json

REST behavior

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 SDC implementation guide.

Resource summary

Resource	Search	Read	Read Version	Instance History	Resource History	Create	Update	Delete
QuestionnaireResponse (Profile)						SHALL	SHOULD	MAY
Binary						SHOULD	MAY	MAY
DocumentReference						SHOULD	MAY	MAY
Provenance						SHOULD

General interactions

Name	Conformance	Description
transaction	SHOULD	Modes: Allows submission of a QuestionnaireResponse together with Provenance and other supporting resources as a single unit of work.

QuestionnaireResponse

Interactions

Name	Conformance	Description
create	SHALL	Allows archiving (storing) a completed or partially-completed form
update	SHOULD	Allows updating a previously archived form. (Systems may place rules on who can update forms and under what circumstances).
delete	MAY	Allows removal of an archived form from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove a submitted response and under what circumstances.

Binary

Interactions

Name	Conformance	Description
create	SHOULD	Allows storage of a binary (generally containing information used in the completion of a QuestionnaireResponse). The data might be in a variety of forms.
update	MAY	Allows updating a previously submitted binary data. (Systems may place rules on who can update binary data and under what circumstances).
delete	MAY	Allows removal of binary data from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove binary data and under what circumstances.

DocumentReference

Interactions

Name	Conformance	Description
create	SHOULD	Allows storage of a document reference (generally containing information used in the completion of a QuestionnaireResponse).
update	MAY	Allows updating a previously submitted document reference. (Systems may place rules on who can update document references and under what circumstances).
delete	MAY	Allows removal of document references from a repository. Note that the removal may be logical rather than physical. Some systems may have rules for who can remove document references and under what circumstances.

Provenance

Interactions

Name	Conformance	Description
create	SHOULD	Allows submitting a Provenance record associated with a particular QuestionnaireResponse.