This page is part of the Situational Awareness for Novel Epidemic Response (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
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):
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.
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:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Summary
Mandatory: 2 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Extension | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod" | |
value[x] | 1..1 | (Slice Definition) | A timing schedule that specifies an event that may occur multiple times Slice: Unordered, Open by type:$this | |
valueTiming | 1..1 | Timing | Value of extension | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod" | |
value[x] | 1..1 | (Slice Definition) | A timing schedule that specifies an event that may occur multiple times Slice: Unordered, Closed by type:$this | |
value[x]:valueTiming | 1..1 | Timing | Value of extension | |
Documentation for this format |
This structure is derived from Extension
Summary
Mandatory: 2 elements
Fixed Value: 1 element
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Extension | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod" | |
value[x] | 1..1 | (Slice Definition) | A timing schedule that specifies an event that may occur multiple times Slice: Unordered, Open by type:$this | |
valueTiming | 1..1 | Timing | Value of extension | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Extension | Extension | |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..0 | |||
url | 1..1 | uri | "http://hl7.org/fhir/uv/saner/StructureDefinition/ReportingPeriod" | |
value[x] | 1..1 | (Slice Definition) | A timing schedule that specifies an event that may occur multiple times Slice: Unordered, Closed by type:$this | |
value[x]:valueTiming | 1..1 | Timing | Value of extension | |
Documentation for this format |
Other representations of extension: Schematron