SDC Form Filler

(Requirements Definition)

http://hl7.org/fhir/us/sdc/CapabilityStatement/sdc-form-filler Published: 2014-07-06 (draft)

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

This profile defines the expected capabilities of the SDC Form Filler role when conforming to the S&I Framework's 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 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).

General

FHIR Version:	$ver$
Supported formats:	xml, json

REST behavior

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.

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

Resource summary

Resource	Search	Read	Read Version	Instance History	Resource History	Create	Update	Delete
Questionnaire (Profile)	Yes	Yes	Yes	Yes
ValueSet (Profile)		Yes	Yes	Yes
CodeSystem (Profile)		Yes	Yes	Yes
QuestionnaireResponse (Profile)	Yes			Yes		Yes	Yes	Yes
DocumentReference	Yes
Binary		Yes	Yes

Operations:

• expand - Generate expansion for specified value set
• expand - Check to see whether a specific code is valid against a specified value set
• populate - Populate Questionnaire returning QuestionnaireResponse to review/edit/submit
• populatehtml - Populate Questionnaire returning HTML page to render locally for reviewing/editing/submitting
• populatelink - Populate questionnaire returning URL to page to review/edit/submit

Questionnaire

Interactions

Name	Description
search-type	Allows discovery of existing questionnaires to be completed
read	Allows retrieval of a specific questionnaire by id. Allows systems to maintain a 'favorites' list of forms and retrieve them by id.
history-instance	Allows review of changes made to a questionnaire over time. Of interest to some systems, but probably not most.
vread	Allows retrieval of a historical version of a questionnaire. Most systems will make use of the current version only.

ValueSet

Interactions

Name	Description
read	Allows retrieval of a specific value set by id (as referenced in a Questionnaire)
vread	Allows retrieval of a specific version of a value set (as referenced in a Questionnaire)
history-instance	Allows review of changes to a value set over time. Of interest to some systems, but probably not most.

CodeSystem

Interactions

Name	Description
read	Allows retrieval of a specific code system by id (as referenced by a ValueSet used in a Questionnaire)
vread	Allows retrieval of a specific version of a code system (as referenced by a ValueSet used in a Questionnaire)
history-instance	Allows review of changes to a code system over time. Of interest to some systems, but probably not most.

QuestionnaireResponse

Interactions

Name	Description
search-type	Allows a user to search for existing completed or partially-completed forms. Generally used to find partially-completed forms for update.
create	Allows recording a completed or partially-completed form
update	Allows updating an existing completed or partially-completed form. (Systems may place rules on who can update forms and under what circumstances.)
delete	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.
history-instance	Allows review of prior versions of an answer set - allows reversion to previously recorded versions

DocumentReference

Interactions

Name	Description
search-type	Allows discovery of existing documents that may be included in a form pre-population request

Binary

Interactions

Name	Description
read	Allows retrieval of a specific binary (as pointed to by a DocumentReference)
vread	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.