This page is part of the SMART IG STARTER KIT (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Examples

Examples are essential for L3 authors to validate the specification before it is implementable. Each SMART Implementation Guide shall contain sufficient data to validate itself, which includes examples that contain the data that is intended to assert and assess the functioning of the specification in the available tooling.

Inputs

• Conformance / Definitional artifacts:
• Example Scenarios

Outputs

• Example instances of resources - Patient, Observation, … that can be used on the available tools to validate the specification.

Activities

• For each of the definitional artifacts, the author shall create an example instance, matching the story and data of its predecessors - for example an Immunization or Observation that contain the data that is in the logical model example, which matches the story line selected.

Output Criteria / Definition of Done

• Examples should be in the main package, or may be in a dedicated package when the number of examples is significant.
• Each of the definitional artifacts shall have at least one example
• Examples should be conformant to their specification - i.e. no QA errors
• Terminology used in the examples, even with example bindings, shall be defined as L3 valuesets and codesystems.

Change tracking

• All the validating examples should follow the same rules as for normative materials - i.e. track changes for each relevant change
• Other examples are normally not normative material

Tooling

Tool	Usage	Doc
Sushi	Examples can be authored in FSH syntax	HL7 Spec Sushi Documentation
CQF tooling	CQF tooling can generate example instances

Informative examples

SMART Guidelines - Immunizations (Measles): Example Immunization event SMART Guidelines - Immunizations (Measles): Example QuestionnaireResponse

Known issues and dependencies

• Test and Data generation, and packaging of such data, might take considerable effort. This will be handled when tools and processes are in place.