SMART Guidelines Starter Kit
2.1.0 - ci-build International flag

SMART Guidelines Starter Kit, published by WHO. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-ig-starter-kit/tree/main and changes regularly. See the Directory of published versions

Forms

Data used in the different stages of the business processes can be captured from the system, or directly from the user. When data is intended to be captured from the user, a form is created, which in L3 terms corresponds to a Questionnaire.

Since the purpose of the forms is to expose data in a user-friendly manner (and following the L2 DAK data structures), it is expected that several of these forms will result in the data being extracted to FHIR-native resources, like Patient, Observation, Condition, etc. This means the L2 data structures are represented both as instances Questionnaires and as FHIR resource profiles, and these FHIR resources can be obtained natively or by extracting a QuestionnaireResponse:

SMART Guidelines make use of the FHIR Structured Data Capture specification to define the common aspects around Questionnaire resources:

  • Design
  • Reuse
  • Data extraction

Forms are reuse other forms and make use of value sets.

Formidentifier 1..*url 1..*status 1..1name 1..1title 1..1experimental 1..1description 1..1item 1..*item 0..*Modular formValueSetReusesContainsData needsfor forms(seelegend)

This extraction uses structure maps and is represented as follows:

Resource BundleResource InstanceLogical ModelProfileStrutureMapQResp → LMStrutureMapLM → InstanceStrutureMap(Group)QuestionnaireQuestionnaireResponseLM Instance(transform)(transform)                                                       

Inputs

  • Logical model
  • ValueSets associated with logical model

Outputs

  • Questionnaires
  • Example QuestionnaireResponses for testing

  • Questionnaires elements may link to the data elements in the common definitions, when those common definitions exist
    • Note that this can conflict with the definition-based extraction described below

Activities

For each data element in the logical model (i.e. in the data dictionary)

  • For extracting data, ensure the Questionnaire is an instance of SDC extractable questionnaire profile
  • The Questionnaire shall indicate what is the StructureMap that should be used for extracting the data, using the targetStructureMap extension.
  • Define the questionnaire extraction in 2 steps -
    1. transform a QuestionnaireResponse to a logical model instance ;
    2. transform a logical model instance into the FHIR resources. These shall be 2 StructureMaps, and a third StructureMap that includes these 2 and runs the two transformations one after the other.
  • The StructureMap that is mentioned in the Questionnaire is the one corresponding to the combined transformation.
    • for example: ```
  • extension[+].url = "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-targetStructureMap"
  • extension[=].valueCanonical = "http://worldhealthorganization.github.io/smart-example-immz/StructureMap/IMMZCQRToResources" ```

StructureMap authoring requires tooling for validation. Please see the tooling section below.

Output Criteria / Definition of Done

  • For using the $extract operation, Questionnaires shall have the extension pointing to the StructureMap, and the map should also be present (see Authoring StructureMaps.)
  • Example instances of the QuestionnaireResponses, the corresponding Logical Model instance and the FHIR resources are available (the latter should actually be obtained by running the data extraction).
  • No QA errors in the build
  • Confirmation that extraction is working with the reference extraction tool.
  • Questionnaires SHALL conform to CRMIShareableQuestionnaire
  • Active, published Questionnaires SHALL conform to CRMIPublishableQuestionnaire
  • Questionnaires SHALL conform to CPGComputableQuestionnaire
  • Questionnaires SHALL conform to SDCBaseQuestionnaire
  • Questionnaires SHOULD conform to other SDC Questionnaire Profiles if they support other rendering and questionnaire behavior described by SDC.

Change tracking

As with all FHIR Conformance resources, change management is critical. Do not set the version element of Questionnaires and StructureMaps defined in the SMART Guideline, the version element will be set by the publication process. See the versioning topic for more information on change management.

Example instances (QuestionnaireResponse, logical model instance, and FHIR resource instances) may be tracked.

Tooling

Tool Usage Doc
Matchbox Compile FML files; Extract data  
LHC Form viewer Display questionnaires  
     

Several SDC-related tools and implementations are available from the HL7 Confluence.

Informative examples

SMART Guidelines - Immunizations (Measles): Questionnaires

Known issues and dependencies