This page is part of the SMART Verifiable IPS for Pilgrimage (v1.0.0: Releases Draft) based on FHIR (HL7® FHIR® Standard) v4.3.0. This is the current published version. For a full list of available versions, see the Directory of published versions

Data Models and Exchange

This section contains the data models and data exchange protocols with actors and transactions defined. It is part of the L3 machine-readable knowledge representation.

The pages included in this section are described below.

• ​Actors - A list and description of software or human entities that interact with the system, derived from business requirements defined in the L2.
• Sequence Diagrams - Sequence diagrams depicting the interactions between system actors, in order, derived from business processes in the L2.
• Transactions - A defined list of system transactions at an atomic level for each actor along with narrative, capability statements, structure definition, questionnaires, document bundles and composition. It may also refer to transactions in other implementation guides.
• ​Logical Models - A StructureDefinition resource that describes data element definitions and their associated rules of usage, derived from the data dictionary in the L2.
• Indicators and Measures - A thematic list of indicators defined in the implementation guide that link to L1 and L2 guidance documents.

Design Documentation -DRAFT-

The documentation below details how to use this IG to execute the decision logic and the resources required to do so including PlanDefinitions, ActivityDefinitions, ValueSets, and Libraries.

PlanDefinitions

These PlanDefinitions can be found in the Artifact Index

ActivityDefinitions

To represent the activities that need to be carried out, this implementation guide follows the workflow patterns established by the base FHIR specification. Each antigen represented as a PlanDefinition will be processed to produce ActivityDefinitions conform to the FHIR Clinical Practice Guidelines Implementation guide CPG-ActivityProfiles.

FHIR Library

The FHIR Library contains a base64 encoded CQL library which represents the decision logic as a series of boolean clauses. Each PlanDefinition and Measure will reference a Library from which each decision point can be made and specify which expression from the CQL is used to trigger a decision in PlanDefinition or where to retrieve data to create the MeasureReport in the Measure, respectively.

ValueSets

Many of the ValueSets used in this IG are from CPG on FHIR and the IPS. There are a number of generated ValueSets based on the user scenarios detailed in this IG.

There is one exception to that format which is the vaccine libraries, which map the codes between a variety of different systems including SNOMED GPS and WHO ATC in order to allow implementers to search for any vaccine which might be applicable to their user. More details on this approach is provided below.