Structured Data Capture
2.8.0 - CI Build

Structured Data Capture, published by HL7 International - FHIR Infrastructure Work Group. This is not an authorized publication; it is the continuous build for version 2.8.0). This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Artifact List

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

SDC Form Designer

SDC Form authoring system

SDC Form Response Manager

SDC Form response management system

SDC Form Filler

SDC System for completing forms

SDC Form Manager

SDC Repository for forms

SDC Form Receiver

SDC Repository for completed forms

SDC Form Archiver

SDC System for archiving and retrieving the completed forms

Behavior: Operation Definitions

These are custom operations that can be supported by and/or invoked by systems conforming to this implementation guide

Adaptive questionnaire next question

Returns the next question or set of questions for an adaptive questionnaire

Populate Questionnaire

Generates a QuestionnaireResponse from a Questionnaire, possibly with data partially populated

Populate HTML Questionnaire

Generates an HTML representation of the Questionnaire as a form, possibly partially populated with data

Populate Questionnaire Link

Generates a link to an HTML page that can be used to complete the Questionnaire, possibly partially populated with data

Questionnaire process response

Allows submission of a QuestionnaireRespone for ‘processing’ by the target server

Questionnaire response extract to resource(s)

Converts a QuestionnaireResponse to a clinical or administrative resource or a Transaction Bundle of them

Behavior: Search Parameters

These define the properties by which a RESTful server can be searched. They can also be used for sorting and including related resources.

Questionnaire Item definition

Allows searching by ‘definition’ element within a Questionnaire’s items

Structures: Logical Models

These define data models that represent the domain covered by this implementation guide in more business-friendly terms than the underlying FHIR resources.

Patient Gender

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide

SDC Base Questionnaire

Sets expectations for SDC-conformant systems around how to create questionnaires

Search Questionnaire

Defines properties that must be supported for systems that support searching for and returning Questionnaires

Advanced Rendering Questionnaire

Defines additional capabilities for controlling the rendering of the questionnaire.

Advanced Behavior Questionnaire

Defines additional capabilities for controlling data entry and calculating values within the questionnaire.

Populatable Questionnaire - Observation

Defines elements that support auto-population and pre-population of questionnaires using the Observation-based population mechanism.

Populatable Questionnaire - Expression

Defines elements that support auto-population and pre-population of questionnaires using the Expression-based population mechanism.

Populatable Questionnaire - StructureMap

Defines elements that support auto-population and pre-population of questionnaires using the StructureMap-based population mechanism.

Extractable Questionnaire - Observation

Defines elements that allow conversion of a QuestionnaireResponse to an Observation resource or Bundle of Observation resources using the Observation-based extraction mechanism

Extractable Questionnaire - Definition

Defines elements that allow conversion of a QuestionnaireResponse to a FHIR resource or Bundle of FHIR resources using the Definition-based extraction mechanism

Extractable Questionnaire - StructureMap

Defines elements that allow conversion of a QuestionnaireResponse to a FHIR resource or Bundle of FHIR resources using the StructureMap-based extraction mechanism

Adaptive Questionnaire

Defines the metadata that should be present to embedding an adaptive Questionnaire as part of a QuestionnaireResponse

Adaptive Questionnaire - search

Defines the metadata that should be present to support searching for adaptive questionnaires.

SDC Questionnaire Response

Sets expectations for SDC-conformant systems around how to create responses to questionnaires.

Adaptive Questionnaire Response

Represents a response to a questionnaire that is dynamically built as each question is answered.

SDC Value Set

Sets expectations for SDC-conformant systems around the definition of value sets for use with questionnaires.

SDC Code System

Sets expectations for SDC-conformant systems around the definition of code systems to provide values for choices within questionnaires.

SDC Library

Sets expectations for SDC-conformant systems around the definition of libraries to provide logical expressions within questionnaires.

Next question operation input parameters

Profile used to validate the parameters that are the input of the ‘next question’ adaptive questionnaire operation

Questionnaire extract operation input parameters

Profile used to validate the parameters that are the input of the ‘extract’ questionnaire operation

Next question operation output parameters

Profile used to validate the parameters that are the output of the ‘next question’ adaptive questionnaire operation

Process response operation input parameters

Profile used to validate the parameters that are the input of the ‘process response’ questionnaire operation

TaskQuestionnaire

Defines how Task is used to as for a Questionnaire to be completed

Structures: Data Type Profiles

These define constraints on FHIR data types for systems conforming to this implementation guide

SDC Usage Context

Constraints on the codes and values of UsageContext to help ensure consistent usage in SDC Questionnaires

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide

Entry mode

An indication of how the user should be prompted for answers when completing a QuestionnaireResponse

Endpoint

The base URL for the server to which questionnaire response associated with this questionnaire should be submitted

Optional Display?

If set to true, it means that the system displaying the form (or the individual encoding the form for data capture) can choose to omit the item from display to the user.

Source queries for population mapping

A Batch Bundle containing a set of queries that should be executed to provide source data for a StructureMap to create a populated QuestionnaireResponse

Initial Expression

Initial value for a question answer as determined by an evaluated expression

Candidate Answers Expression

A FHIRPath or CQL Expression, or FHIR Query that resolves to a list of candidate answers (usually based on other answers in the questionnaire or based on information within the health record) for the question item or that establishes context for a group item

Answer Expression

An expression (FHIRPath, CQL or FHIR Query) that resolves to a list of permitted answers for a question item.

Answer Context Expression

A FHIR Query that resolves to one or more resources that can be displayed to the user to help provide context for answering a question

Calculated Expression

Calculated value for a question answer as determined by an evaluated expression

Choice column

Provides guidelines for rendering multi-column choices

Width of column

When used with an item control that causes the question to appear as a column in a table, indicates the width to give to the column for this question.

Context resources

Resources that provide context for form processing logic (pre-population, flow-control, drop-down selection, etc.) when creating/displaying/editing a QuestionnaireResponse

Enable when?

An expression that returns a boolean value for whether to enable the item

Is subject?

If present and true, indicates that the item establishes a different subject for the group in a response

Item population context

Specifies a query that identifies the resource (or set of resources for a repeating item) that should be used to populate this Questionnaire or Questionnaire.item on initial population.

Item extraction context

Specifies a query that identifies the resource (or set of resources for a repeating item) to be extracted from this item once the QuestionnaireResponse is complete.

Lookup questionnaire

For items of type reference, the reference can be populated either by picking an existing entity or by creating a new one. In the latter case, this Questionnaire allows specifying the Questionnaire to use in creating the target instance. This can be direct (if the Reference is to a Questionnaire) or indirect via mapping if the Reference is to some other sort of resource.

Observation link period

Indicates the time-period (from ‘now’) to search for observations that match the Questionnaire.item.code and Questionnaire.subject when pre-populating the QuestionnaireResponse.

Observation extract?

If true, indicates that the observation-based approach should be used to extract either the particular item (if extension is defined on an individual question or group based on the code present) or all items in the questionnaire (if defined at the questionnaire root and if they have a code present)

Source structure map

StructureMaps that have this QuestionnaireResponses for this Questionnaire as ‘target’ - i.e. that can be used to create QuestionnaireResponses that are valid against this Questionnaire.

Target structure map

StructureMaps that have QuestionnaireResponses of this Questionnaire as ‘source’- i.e. that can be used to create other artifacts from QuestionnaireResponses that are valid against this Questionnaire.

Is subject (response)?

If present and true, indicates that the item indicates a different subject for this group

Performer type

Indicates the types of resources that can record answers to a Questionnaire

Questionnaire Adaptive

Indicates if a questionnaire is adaptive: either set to true or set the base URL of the server that can perform the nextQuestion operation of the questionnaire

Collapsible

Indicates that the child items of an item are displayed in collapsible form (either collapsed or expanded)

Min Quantity

The inclusive lower bound on the range of allowed values for a ‘quantity’ type question

Max Quantity

The inclusive upper bound on the range of allowed values for a ‘quantity’ type question

Choice Constraint

Controls what the user is allowed to enter as an answer aside from the answer options provided

PreferredTerminologyServer

Indicates the terminology server(s) that are known to be capable of returning and potentially expanding the value set(s) associated with the whole questionnaire or a particular group or question within the questionnaire (depending on where the extension appears).

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide

Questionnaire Context Species ValueSet

Species for defining the context of Questionnaires

Questionnaire Launch Context ValueSet

Defines standard context of Questionnaires at launch time

Questionnaire Entry Mode ValueSet

Defines mechanisms of capturing data in a QuestionnaireResponse

Questionnaire Collapsible ValueSet

Defines mechanisms of displaying child items in collapsible form

Questionnaire Performer Type

List of resource types that can record answers to a Questionnaire.

DEX mapping language mime types

The list of mime types that identify mapping languages supported by DEX.

Questionnaire Item Choice Constraint

Defines what the user is allowed to enter as an answer aside from the answer options provided

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide

Questionnaire Launch Context CodeSystem

Defines standard context of Questionnaires at launch time

Questionnaire Entry Mode CodeSystem

Defines mechanisms of capturing data in a QuestionnaireResponse

Questionnaire Collapsible CodeSystem

Defines mechanisms of displaying child items in collapsible form

Choice Constraint Codes

Defines what the user is allowed to enter as an answer aside from the answer options provided.

Temporty SDC Codes

Defines codes defined within the SDC implementation guide that are expected to migrate elsewhere in future releases

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like

SDC-Advanced Rendering

Demo questionnaire showing most of the advanced rendering capabilities of SDC

SDC-Advanced Form Behavior

Demo questionnaire showing most of the advanced form behavior capabilities of SDC. Each example here is itemized in the Examples page.

SDC-Combination

Set of several examples - medication, AHRQ and NCI forms

SDC-Response to Diagnosis NCI Standard Template

Example responses to the questionnaire found in the SDC - Combination list of questionnaires

SDC-PHQ9

Patient Health Questionnaire (9 Item) including contained value sets and calculatedExpression

SDC-Response to PHQ9

Example response to the SDC-PHQ9 questionnaire

SDC-CodeSystem PHQ9

The answer list for questions 1 through 9 on the Patient Health Questionnaire (9 item) form

SDC-LOINC AHRQ

LOINC perspective on the AHRQ form found in the SDC - Combination set of questionnaires

SDC-Response to LOINC AHRQ

Example response to te LOINC AHRQ questionnaire.

SDC-ValueSet AHRQ_Medication_Q1

The answer list for question 1 on the AHRQ ‘Medication or Other Substance’ form

SDC-LOINC USSG Family History

LOINC US Surgeon General family history including data elements and value sets.

SDC-Response to LOINC USSG Family History

Example response to the SDC-LOINC USSG Family History questionnaire

SDC-Pathology

Cancer pathology questionnaire with flow-control extensions

SDC-Hard Coronary Heart Disease

A made-up form for calculating the 10-year-risk of Hard Coronary Heart Disease. It shows how variables and calculatedExpression can be used to compute for the risk probability.

SDC-Hunger Vital Sign

A hunger vital signs form (showing calculatedExpression selecting a value from a list).

SDC-Weight and Height Tracking Panel

A weight and height panel (from LOINC) with a FHIRPath rule for calculating the BMI.

SDC Test Form - All Data Types

A test form that has one of each data type included, useful in checking compatibility against.

SDC Test Form - Enable When

A test form that has a variety of enable when scenarios for testing.

SDC Test Form - Candidate Expression

A test form with a FHIRPath based prepopulation example that includes a candidate expression.

SDC Test Form - Initial Expression

A test form with a FHIRPath based prepopulation simple example.

SDC Test Form - Source Query

A test form with a FhirPath based prepopulation example that leverages a source query to extract data outside the launch context.

SDC Test Form - Initial Value

A test form with that uses initial values.

SDC Test Form - Multiple Initial Value

A test form with a question that has multiple initial values.

SDC Test Form - Repeats

A test form with repeatable nested groups.

SDC Test Form - Required

A test form with required fields.