Situational Awareness for Novel Epidemic Response
0.1.0 - STU Ballot

Situational Awareness for Novel Epidemic Response, published by HL7 International Public Health Workgroup. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/HL7/fhir-saner/ and changes regularly. See the Directory of published versions

Actors

This section defines the actors in this implementation guide.

Figure 1.1-1 below shows the actors directly involved in the SANER Profile and the relevant transactions between them.

Figure 3-1: SANER Actor Diagram

Figure 3-1: SANER Actor Diagram

Table 3-1 lists the transactions for each actor directly involved in the SANER Implementation Guide. To claim compliance with this guide, an actor shall support all required transactions (labeled “R”) and may support the optional transactions (labeled “O”).

Table 3-1: SANER Implementation Guide - Actors and Transactions
Actors Transactions Optionality
Measure Source Query Measure [PULL-TX] C 1
Produce Measure [PUSH-TX] C 2
Measure Consumer Communicate Results [REPORT-TX] R
Query Measure [PULL-TX] C 3
Produce Measure [PUSH-TX] C 4
Measure Intermediary Query Measure [PULL-TX]
As Measure Source
C 1
Produce Measure [PUSH-TX]
As Measure Source
C 2
Communicate Results [REPORT-TX]
As Measure Consumer
R
Query Measure [PULL-TX]
As Measure Consumer
C 3
Produce Measure [PUSH-TX]
As Measure Consumer
C 4
Query Measure [PULL-TX]
As Measure Intermediary
C 5
Produce Measure [PUSH-TX]
As Measure Intermediary
C 6
Query Measure [PULL-TX]
As Measure Intermediary
C 7
Produce Measure [PUSH-TX]
As Measure Intermediary
C 8
Measure Definition Source Query Measure Definition [PULL-MX] R
Measure Definition Consumer Query Measure Definition [PULL-MX] R
Measure Computer Query Measure [PULL-TX]
As Measure Source
C 1
Produce Measure [PUSH-TX]
As Measure Source
C 2
Query Measure Definition [PULL-MX]
As Measure Definition Consumer
R
Query Measure Definition [PULL-MX]
As Measure Computer
R
Compute Measure [COMPUTE-MX]
As Measure Computer
R
Query Measure [PULL-TX]
As Measure Computer
C 9
Produce Measure [PUSH-TX]
As Measure Computer
C 10
Data Source Compute Measure [COMPUTE-MX] R

Notes:

  1. This transaction is required when the Measure Source implements the Pull Option.

  2. This transaction is required when the Measure Source implements the Push Option, or Supplemental Data Option.

  3. This transaction is required when the Measure Consumer implements the Pull Option.

  4. This transaction is required when the Measure Consumer implements the Push Option, or Supplemental Data Option.

  5. This transaction is required when the Measure Intermediary implements the Pull Option.

  6. This transaction is required when the Measure Intermediary implements the Push Option.

  7. This transaction is required when the Measure Intermediary implements the Pull Option.

  8. This transaction is required when the Measure Intermediary implements the Push Option.

  9. This transaction is required when the Measure Computer implements the Pull Option.

  10. This transaction is required when the Measure Computer implements the Push Option.

Actors

The actors in this profile are described in more detail in the sections below.

Measure Source

The Measure Source Actor reports results Measures for a single facility, collection of facilities or aggregated data for a region.

In a single facility, or organization, the Measure Source Actor will compile data directly from the facility or organization source systems.

A Measure Source may also exist in an Aggregator, Intermediary or Bridging role. In this guide we will use the term Intermediary to describe these roles.

A Measure Source provides the FHIR data that is used by a Measure Consumer.

Measure Source Requirements
  1. The Measure Source shall implement either the Pull Option or the Push Option.
  2. A Measure Source that implements the Pull Option shall provide a CapabilityStatement when queried via [base]/metadata.
  3. A Measure Source that implements the Supplemental Data Option shall support creation of MeasureReport and Supplemental Data resources through the HTTP Batch operation and endpoint.
  4. A Measure Source that implements the Supplemental Data option must also implement the Push Option
Measure Source Conformance

See the following CapabilityStatement resources for conformance requirements:

The Measure Consumer provides access to aggregated or fine-grained data gathered from one or more Measure Sources.

The Measure Consumer provides the ability to report on data from one or more Measure Sources.

In the case of a single facility or organization the Measure Consumer is reporting the data at aggregated or varying levels of granularity using data extracted from a Measure Source.

Measure Consumer Requirements
  1. The Measure Consumer shall implement either the Pull Option or the Push Option.
  2. A Measure Consumer that implements the Push Option shall provide a CapabilityStatement when queried via [base]/metadata.
  3. A Measure Consumer that implements the Supplemental Data Option shall support creation of MeasureReport and Supplemental Data resources through the HTTP Batch operation and endpoint.
  4. A Measure Consumer that implements the Supplemental Data option must also implement the Push Option
Measure Consumer Conformance

See the following CapabilityStatement resources for conformance requirements:

The Measure Intermediary is a grouping of a Measure Source with a Measure Consumer.

This actor represents the composition of a Measure Source with a Measure Source.

The Measure Intermediary role can aggregate data from multiple Measure Sources. Data from Measure Sources may be pulled in by the Intermediary, or pushed to the Intermediary by the Measure Source.

The Measure Intermediary may also provide the capabilities of a Measure Consumer to enable data to be reported at an aggregated level.

The Measure Intermediary role may aggregate data from other Measure Intermediaries. Since the Intermediary is exposing a Measure Source capability this method allows data to be aggregated in a hierarchy such as:

  • Supporting multiple data inputs within a single facility to create a complete measure from multiple partial reports,
  • Enabling aggregation of data for Groups of hospitals in a health system, a hospital service area, or referral region,
  • Aggregating to county or state levels for local and regional Public Health agencies
  • Communicating aggregated data to National / Federal Agencies such as CDC or FEMA.

Bridging between Incompatible Options

In networking parlance, a Bridge is a system that connects between different protocols. The different options in this Implementation Guide can create incompatibilities, but these can be bridged by an Intermediary.

For example, a Measure Intermediary that implements the Push Option in the Measure Consumer, that groups with a Measure Source implementing the Push Option can bridge between a Measure Source implementing the Pull option to enable communication with a Measure Consumer implementing the Pull option.

In this example, the Bridge is simply a FHIR Server. A FHIR Server that supports CRUD operations on MeasureReport and Measure effectively implements both the Measure Consumer with the Push Option and the Measure Source actor implementing the Pull Option.

FHIR Server

Measure Intermediary Requirements
  1. A Measure Intermediary whose Consumer implements the Push Option shall provide a CapabilityStatement when queried via [base]/metadata.
  2. A Measure Intermediary whose Source implements the Pull Option shall provide a CapabilityStatement when queried via [base]/metadata.
Measure Intermediary Conformance

See the following CapabilityStatement resources for conformance requirements:

Measure Definition Source

The Measure Definition Source Actor provides access to Measures defined by public health and emergency response authorities.

The Measure Definition Source actor is responsible for maintaining measures for systems that are using this implementation guide to automate measure reporting.

Measure Definition Source Requirements
  1. A Measure Definition Source shall provide a CapabilityStatement when queried via [base]/metadata.
Measure Definition Source Conformance

See the following CapabilityStatement resources for conformance requirements:

The Measure Definition Consumer Actor accesses Measures defined by public health and emergency response authorities.

The Measure Definition Consumer actor is responsible for retrieving measures from publishing systems to automate measure reporting.

Measure Definition Consumer Conformance

See the following CapabilityStatement resources for conformance requirements:

The Measure Computer Actor is responsible for computing measures from definitions provided through its grouping with a Measure Definition Consumer actor, and reporting these measures through its grouping with the Measure Source actor.

Measure Computer Requirements
  1. The Measure Computer shall implement either the Pull Option or the Push Option.
  2. A Measure Computer that implements the Pull Option shall provide a CapabilityStatement when queried via [base]/metadata.
Measure Computer Conformance

See the following CapabilityStatement resources for conformance requirements:

The Data Source actor is responsible for supplying data to a MeasureComputer.

The Data Source supplies data via FHIR Queries supported by national standards.

Data Source Requirements
  1. A Data Source shall provide a CapabilityStatement when queried via [base]/metadata.
Data Source Conformance

See the following CapabilityStatement resources for conformance requirements:

Options that may be selected for each actor in this guide, are listed in Table 3.2-1 below. Dependencies between options when applicable are specified in notes.

Table 3.2-1 Actor Options
Actor Option Name
Measure Source CSV Option
Push Option
Pull Option
Supplemental Data Option
Questionnaire Option
Measure Consumer CSV Option
Push Option
Pull Option
Supplemental Data Option
Questionnaire Option
Measure Intermediary No Options Defined
Measure Definition Source No Options Defined
Measure Definition Consumer No Options Defined
Measure Computer No Options Defined
Data Source No Options Defined

The options in this guide are describe in more detail the sections below.

CSV Option

An actor implementing the CSV Option supports the ability to exchange MeasureReport resources in CSV format using FHIR Operations

This option applies to the actors as described below.

Measure Source

A Measure Source actor implementing the CSV option supports a FHIR Operation to provide data in CSV format.

Measure Consumer

A Measure Consumer actor implementing the CSV option supports a FHIR Operation to consume data in CSV format.

Push Option

An actor implementing the Push Option supports the periodic push of resources describing the current status of health delivery resources to a centralized collection point.

This option applies to the actors as described below.

Measure Source

A Measure Source implementing the Push Option periodically sends updates to a Measure Consumer using the Produce Measure transaction.

Measure Consumer

An Measure Consumer implementing the Push Option periodically recieves updates from the Measure Source using the Produce Measure transaction.

Pull Option

An actor implementing the Pull Option supports the periodic pull resources describing the current status of selected health delivery resources.

This option applies to the actors as described below.

Measure Source

A Measure Source implementing the Pull Option is periodically queried by an Measure Consumer using the Query Measure transaction to enable collection of the current status.

Measure Consumer

An Measure Consumer implementing the Pull Option periodically queries a Measure Source using the Query Measure transaction to enable collection of the current status.

Supplemental Data Option

An actor implementing the Supplemental Data Option supports the use of Bundle in Push transactions used with the MeasureReport resource. Actors implementing the Supplemental Data Option must also implement the Push Option.

This option applies to the actors as described below.

Measure Source

A MeasureSource implementing the Supplemental Data Option will send measures containing Supplemental Data using the HTTP Batch operation with a FHIR Collection bundle to the Bundle endpoint for the receiving Measure Consumer. The MeasureReport resource will be the first resource in this bundle, and all following resources in the Bundle will be the resources representing the supplemental data referenced by that MeasureReport.

Measure Consumer

A MeasureConsumer implementing the Supplemental Data Option can receive measures containing supplemental data at its Bundle endpoint, and will store the resources following the requirements of the HTTP Batch operation.

Questionnaire Option

An actor implementing the Questionnaire Option supports the use of Questionnaire and QuestionnaireResponse resources to determine the current status of selected health delivery resources.

This option applies to the actors as described below.

Measure Source

A Measure Source implementing the Questionnaire Option will interact using Questionnaire and QuestionnaireResponse resources to report on the current status of health delivery resources.

Measure Consumer

A Measure Consumer implementing the Questionnaire Option will interact using Questionnaire and QuestionnaireResponse resources to access the current status of health delivery resources.

Aggregate Option

An actor implementing the Aggregate option enables aggregation of multiple MeasureReport resources into a consolidated MeasureReport.

This option enables multiple reports to be aggregated:

  • From multiple systems reporting partial results within a facility into a singular consolidated report.
  • From multiple reports over a period of time from a given location, e.g., to aggregate daily measure reports into a weekly report.
  • From multiple subjects within a geographic region into a MeasureReport describing that region.

This option applies to the actors as described below.