Situational Awareness for Novel Epidemic Response
1.0.0 - STU Release

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 1.0.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

Extension: Enables specification of proposed measure reporting

The timing used for measure reporting

The official URL for this extension is:

http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod

Status: draft
Extension maintained by: HL7 International Public Health Workgroup

Context of Use

This extension may be used on the following element(s):

  • Measure

This Implementation Guide defines an exenstion supporting the definition of a recommended reporting period for a measure using the Timing data type. Specifying the reporting period enables systems to schedule automated reporting activities.

Specifying the frequncy and period for Measure Reporting

  1. The timing *shall contain one repeat describing the reporting frequency and period, more than one repeat component is not necessary for almost all cases of measures reported for COVID-19 to date.
  2. The repeat.frequency shall be one, so that the Timing value simply indicates the duration of the reporting period (e.g., every 8 hours, every day, every week).
  3. The base period for reporting shall be specified (e.g., daily, weekly, monthly) in repeat.periodUnit.
  4. The number of periods to include shall be specified repeat.period.
  5. The value of repeat.boundsPeriod.start may be specified to indicate the offset.

Specifying the days of week or time of day for reporting

  1. The starting time for the reporting period with a period of 1 day or larger shall be midnight local time unless otherwise specified.
  2. The starting time offset or day for reporting period may be specified in boundsPeriod.start to indicate the offset hour, day of week or day of month.

Examples

See the CDC Patient Impact and Hospital Capacity example Measure for an example use of this extension in a resource.

The example below illustrates a measure with a reporting period of one report provided every one day for data as of midnight.

   "extension": [
     {
       "url": "http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod",
       "valueTiming": {
         "repeat": {
           "frequency": 1,    // one report
           "period": 1,       // every one
           "periodUnit": "d", //          day
           "boundsPeriod": {
             "start":  "2020-09-01T00:00:00"  // reported starting on midnight 9/1/2020
           }
         }
       }
     }
   ]

The example below illustrates a measure with a reporting period every 8 hours (i.e., three reports per day) for data as of 2am, 10am and 6pm.

   "extension": [
     {
       "url": "http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod",
       "valueTiming": {
         "repeat": {
           "frequency": 1,    // one report
           "period": 8,       // every eight
           "periodUnit": "h", //          hours
           "boundsPeriod": {
             "start":  "2020-09-01T02:00:00"  // reported starting on 2am as of 9/1/2020
           }
         }
       }
     }
   ]

The example below illustrates a measure with a reporting period of once a week on Monday 8/31/2020 at midnight

   "extension": [
     {
       "url": "http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod",
       "valueTiming": {
         "repeat": {
           "frequency": 1,    // one report
           "period": 1,       // every one
           "periodUnit": "w", //          week
           "boundsPeriod": {
             "start":  "2020-08-31T00:00:00"  // reported starting on 8/31/2020 at midnight
           }
         }
       }
     }
   ]

Usage info

Usage:

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Extension

Summary

Mandatory: 2 elements
Must-Support: 1 element
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Extension.value[x] is sliced based on the value of type:$this

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionEnables specification of proposed measure reporting
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod"
... Slices for value[x] 1..1MeasureReportingTimingA timing schedule that specifies an event that may occur multiple times
Slice: Unordered, Open by type:$this

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionEnables specification of proposed measure reporting
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..0
... url 1..1uri"http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod"
.... value[x]:valueTiming S1..1TimingValue of extension

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 2 elements
Must-Support: 1 element
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Extension.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionEnables specification of proposed measure reporting
... extension 0..0
... url 1..1uri"http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod"
... Slices for value[x] 1..1MeasureReportingTimingA timing schedule that specifies an event that may occur multiple times
Slice: Unordered, Open by type:$this

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionEnables specification of proposed measure reporting
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..0
... url 1..1uri"http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod"
.... value[x]:valueTiming S1..1TimingValue of extension

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron