2.7.0 - STU 3 (2nd ballot)

This page is part of the Structured Data Capture FHIR IG (v2.7.0: STU 3 Ballot 2) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

Artifact List

Artifact Packages

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

Capability Statements

Capabilities of systems claiming to be conformant to the SDC implementation guide

  •  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

Profiles

Constraints on FHIR resources to be adhered to as part of the SDC implementation guide

  •  SDC Usage Context Constraints on the codes and values of UsageContext to help ensure consistent usage in SDC Questionnaires
  •  SDC 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 Defines elements that support auto-population and pre-population of questionnaires
  •  Extractable Questionnaire Defines elements that allow conversion of a QuestionnaireResponse to a FHIR resource or Bundle of FHIR resources
  •  Adaptive Questionnaire Defines the metadata that should be present to embedding a 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.
  •  Next question operation input parameters Profile used to validate the parameters that are the input of the 'next question' adaptive questionnaire operation
  •  Questionnnaire 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 intput parameters Profile used to validate the parameters that are the input of the 'process response' questionnaire operation

Extensions

Extensions defined as part of the SDC 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 QuestionnaireRsponse
  •  Initial Expression Initial value for a question answer as determined by an evaluated expression
  •  Candidate Answers Expression A FHIRPath expression or FHIR Query that resolves to a list of candidate answers for the question item or that establishes context for a group 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 context Specifies a query that identifies the resource (or set of resources for a repeating item) that should be used to populate this Questionnaire.item on initial population or 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.
  •  Obervation 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.
  •  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

Terminology

ValueSets (and Code Systems) defined for use within the SDC implementation guide

  •  Questionnaire Context Species Species for defining the context of Questionnaires
  •  Questionnaire Launch Context Defines standard context of Questionnaires at launch time
  •  Questionnaire Launch Context Defines standard context of Questionnaires at launch time
  •  Questionnaire Entry Mode Defines mechanisms of capturing data in a QuestionnaireResponse
  •  Questionnaire Entry Mode Defines mechanisms of capturing data in a QuestionnaireResponse

Operation Definitions

Additional operations defined for use within the SDC 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

Search Parameters

Additional search parameters defined for use within the SDC implementation guide

  •  Questionnaire Item definition Allows searching by 'definition' element within a Questionnaire's items

Example(s)

Example(s) showing the use of the SDC profiles

  •  SDC-Advanced Rendering Example showing most of the advanced rendering capabilities of SDC
  •  SDC - Combination Set of several examples - medication, AHRQ and NCI forms
  •  SDC-Pathology Cancer pathology questionnaire with flow-control extensions
  •  SDC-LOINC AHRQ LOINC perspective on the AHRQ form found in the SDC - Combination set of questionnaires
  •  SDC-LOINC USSG Family History LOINC US Surgeon General family history including data elements and value sets.
  •  SDC - Response to Diagnosis NCI Standard Template Responses to the questionnaire found in the SDC - Combination list of questionnaires
  •  SDC-LOINC USSG Family History Response Example response to the SDC-LOINC USSG Family History questionnaire
  •  SDC-ValueSet AHRQ_Medication_Q1 The answer list for question 1 on the AHRQ 'Medication or Other Substance' form