Home

Situational Awareness for Novel Epidemic Response
1.0.1 - CI Build International flag

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

Official URL: http://hl7.org/fhir/uv/saner/ImplementationGuide/hl7.fhir.uv.saner				Version: 1.0.1
Active as of 2024-05-18				Computable Name: SituationalAwarenessforNovelEpidemicResponse
Other Identifiers: OID:2.16.840.1.113883.4.642.40.42

Organization of This Guide
Copyrights and Acknowledgements
Legal Statements

The Situational Awareness for Novel Epidemic Response Implementation Guide enables transmission of high level situational awareness information from inpatient facilities to centralized data repositories to support the treatment of novel influenza-like illness.

Organization of This Guide

This guide is organized into five main sections:

Chapter I: Introduction and Overview
1. Introduction - Provides an Introduction to this IG
2. Measuring Situational Awareness - Describes situational awareness and how to measure it.
3. Use Cases - Illustrates Key Uses Cases addressed by this guide.
Chapter II: Technical Implementation
1. Architecture and Implementation - Illustrates the Microservice Architecture.
2. Security Considerations - Documents security concerns and mitigations.
3. Actors and Transactions - Provides an overview of technical components
Chapter III: Integrating with Existing Systems
1. Technology Environment - Identifies existing information systems containing situational awareness data.
2. Integrating via CSV Files - Describes how CSV Conversions are performed.
3. Aggregating Data - Describes how to aggregate Measure data.
Chapter IV: Conformance and Testing

Capability Statements
1. Data Source.
  Defines the requirements for the Data Source.
2. Data Source implementing the Compute Measure transaction.
  Defines the requirements for the Data Source implementing the Compute Measure transaction.
3. Measure Computer
  Defines the requirements for the Measure Computer.
4. Measure Computer implementing the Compute Measure transaction.
  Defines the requirements for the Measure Computer implementing the Compute Measure transaction.
5. Measure Consumer implementing the Aggregate Option.
  Defines the additional requirements for the Measure Consumer implementing the Aggregate Option.
6. Measure Consumer implementing the CSV Option and the Pull Option.
  Defines the additional requirements for the Measure Consumer implementing the CSV Option and the Pull Option.
7. Measure Consumer implementing the CSV Option and the Push Option.
  Defines the additional requirements for the Measure Consumer implementing the CSV Option and the Push Option.
8. Measure Consumer implementing the Produce Measure transaction with the CSV Option and the Push Option.
  Defines the additional requirements for the Measure Consumer implementing the Produce Measure transaction with the CSV Option and the Push Option.
9. Measure Consumer implementing the Produce Measure transaction with the Push Option.
  Defines the additional requirements for the Measure Consumer implementing the Produce Measure transaction with the Push Option.
10. Measure Consumer implementing the Produce Measure transaction with the Supplemental Data Option.
  Defines the additional requirements for the Measure Consumer implementing the Produce Measure transaction with the Supplemental Data Option.
11. Measure Consumer implementing the Pull Option.
  Defines the additional requirements for the Measure Consumer implementing the Pull Option.
12. Measure Consumer implementing the Push Option.
  Defines the additional requirements for the Measure Consumer implementing the Push Option.
13. Measure Consumer implementing the Query Measure transaction with the CSV Option and the Pull Option.
  Defines the additional requirements for the Measure Consumer implementing the Query Measure transaction with the CSV Option and the Pull Option.
14. Measure Consumer implementing the Query Measure transaction with the Pull Option.
  Defines the additional requirements for the Measure Consumer implementing the Query Measure transaction with the Pull Option.
15. Measure Consumer implementing the Supplemental Data Option.
  Defines the additional requirements for the Measure Consumer implementing the Supplemental Data Option.
16. Measure Definition Consumer.
  Defines the requirements for the Measure Definition Consumer.
17. Measure Definition Consumer implementing the Query Measure Definition transaction.
  Defines the requirements for the Measure Definition Consumer implementing the Query Measure Definition transaction.
18. Measure Definition Source.
  Defines the requirements for the Measure Definition Source.
19. Measure Definition Source implementing the Query Measure Definition transaction.
  Defines the requirements for the Measure Definition Source implementing the Query Measure Definition transaction.
20. Measure Source implementing the Aggregate Option.
  Defines the additional requirements for the Measure Source implementing the Aggregate Option.
21. Measure Source implementing the CSV Option and the Pull Option.
  Defines the additional requirements for the Measure Source implementing the CSV Option and the Pull Option.
22. Measure Source implementing the CSV Option and the Push Option.
  Defines the additional requirements for the Measure Source implementing the CSV Option and the Push Option.
23. Measure Source implementing the Produce Measure transaction with the CSV Option and the Push Option.
  Defines the additional requirements for the Measure Source implementing the Produce Measure transaction with the CSV Option and the Push Option.
24. Measure Source implementing the Produce Measure transaction with the Push Option.
  Defines the additional requirements for the Measure Source implementing the Produce Measure transaction with the Push Option.
25. Measure Source implementing the Produce Measure transaction with the Supplemental Data Option.
  Defines the additional requirements for the Measure Source implementing the Produce Measure transaction with the Supplemental Data Option.
26. Measure Source implementing the Pull Option.
  Defines the additional requirements for the Measure Source implementing the Pull Option.
27. Measure Source implementing the Push Option.
  Defines the additional requirements for the Measure Source implementing the Push Option.
28. Measure Source implementing the Query Measure transaction with the CSV Option and the Pull Option.
  Defines the additional requirements for the Measure Source implementing the Query Measure transaction with the CSV Option and the Pull Option.
29. Measure Source implementing the Query Measure transaction with the Pull Option.
  Defines the additional requirements for the Measure Source implementing the Query Measure transaction with the Pull Option.
30. Measure Source implementing the Supplemental Data Option.
  Defines the additional requirements for the Measure Source implementing the Supplemental Data Option.
Operations
1. Measure/$evaluate-measure Evaluate the Measure
2. Measure/$report-csv Create or update a MeasureReport from CSV Format
3. MeasureReport/$aggregateAggregate MeasureReport resources
4. MeasureReport/$read-csv Read in CSV Format
5. MeasureReport/$search-csv Search in CSV Format
Search Parameters
1. code - Enables Measure, MeasureReport, Questionnaire and QuestionnaireResponse resources to be discovered by codes used in the resource
2. definition-text - Enables definition resources to be discovered from text used in the resource definition
3. disposition - Enables query of encounters by discharge disposition
Profiles and Extensions
Terminology Resources
Test Plan
Test Data Sets

Chapter V: Defining Measures from Essential Elements of Information
1. Computing Measures - Describes mechanisms to automate measure computation.
2. Phrase Book - A Phrase Book for creating automatable Measures
3. Creating an Automated Measure - A detailed walk through the steps for creating an automated measure.
Appendix A: Supporting Terminology
Appendix B: Fluent Query
Downloads
- this entire guide,
- the definition resources in json, xml, ttl, or csv format, or
- the example resources in json, xml or ttl format.
- The source code for this Implementation Guide can be found on https://github.com/HL7/fhir-saner.

Click on any of the links above, head on over the table of contents, or if you are looking for a specific artifact, check out the index.

The SANER Project Logo

Fighting COVID-19 with FHIR®

Copyrights and Acknowledgements

Value Sets in this guide include:

Vocabulary Content from SNOMED CT, which is copyright © 2002+ International Health Terminology Standards Development Organisation (IHTSDO), and distributed by agreement between IHTSDO and HL7. Implementer use of SNOMED CT is not covered by this agreement.
Vocabulary Content from LOINC (http://loinc.org). LOINC is copyright © 1995-2020, Regenstrief Institute, Inc. and the Logical Observation Identifiers Names and Codes (LOINC) Committee and is available at no cost under the license at LOINC/license. LOINC® is a registered United States trademark of Regenstrief Institute, Inc
Vocabulary Content developed by the US National Library of Medicine: Reference to specific commercial products, manufacturers, companies, or trademarks does not constitute its endorsement or recommendation by the U.S. Government, Department of Health and Human Services, or NLM. Source materials are available from the NLM Website at no charge at https://www.nlm.nih.gov/research/umls/rxnorm/index.html
Vocabulary Content developed by CDC: Reference to specific commercial products, manufacturers, companies, or trademarks does not constitute its endorsement or recommendation by the U.S. Government, Department of Health and Human Services, or Centers for Disease Control and Prevention. Source materials are available from the CDC Website at no charge at https://www.cdc.gov/nhsn/cdaportal/terminology/codesystem/hsloc.html
The SANER Logo was created by Adrian “Kingsley” McDermott, additional imagery by @RoseFyreWolf

Contributors

Name	Organization	Role
Keith Boone	Audacious Inquiry	Project Lead, Lead Developer
Gino Canessa	Microsoft	Developer
Michael Donnelly	Epic	Developer
Rick Geimer	Lantana	Measure Computer
John Moehrke	Bylight	Security and Testing Advisor
Austin Kreisler	Leidos	Subject Matter Expert
Josh Mandel	Microsoft	Subject Matter Expert
Abigail Watson	Symptomatic.io	Subject Matter Expert
David Pyke	Audacious Inquiry	HL7 Liaison, Developer

Legal Statements

While this implementation guide and the underlying FHIR are licensed as public domain under the FHIR license. The license page also describes rules for the use of the FHIR name and logo.

This guide includes examples making use of terminologies such as LOINC, SNOMED CT and RxNorm codes that have more restrictive licensing requirements. Implementers should make themselves familiar with licensing and any other constraints of terminologies, questionnaires, and other components used as part of their implementation process. In some cases, licensing requirements may limit the systems that data captured using certain Definitions may be shared with.

This publication includes IP covered under the following statements.