WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit b12f15e

Browse files
cchuongcchuong
committed
Add key table
1 parent bd110b8 commit b12f15e

File tree

1 file changed

+59
-48
lines changed

1 file changed

+59
-48
lines changed

‎docs/api/rvdss.md‎

Lines changed: 59 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,32 @@ nav_order: 1
99

1010
{: .no_toc}
1111

12-
- **Source name:** `rvdss`
13-
- **Earliest issue available:** Epiweek 36 2013 (2013-09-07)
14-
- **Date of last change:** Never
15-
- **Available for:** province, lab, region, nation (see [Geography](#geography))
16-
- **Time type:** week (see [date format docs](../covidcast_times.md))
17-
- **License:** [Open Government Licence - Canada](#source-and-licensing)
12+
- **Source name:** `rvdss`
13+
- **Earliest issue available:** Epiweek 36 2013 (2013-09-07)
14+
- **Date of last change:** Never
15+
- **Available for:** province, lab, region, nation (see [Geography](#geography))
16+
- **Time type:** week (see [date format docs](../covidcast_times.md))
17+
- **License:** [Open Government Licence - Canada](#source-and-licensing)
1818

1919
This data source of respiratory virus detections in Canada is collected by the [Respiratory Virus Detection Surveillance System (RVDSS)](https://health-infobase.canada.ca/respiratory-virus-surveillance/about.html) and published by the Public Health Agency of Canada (PHAC). Laboratory tests for various respiratory illnesses are reported on a weekly basis by sentinel laboratories across Canada to the [Centre for Immunization and Respiratory Infectious Diseases (CIRID)](https://www.canada.ca/en/public-health/services/infectious-diseases/centre-immunization-respiratory-infectious-diseases-cirid.html), a subsidiary of PHAC. The data was originally reported in weekly online reports, but since June 2024, has changed to being reported through a dynamic dashboard.
2020

2121
NOTE: Pandemic COVID-19 is not reported in this data source.
2222

23+
## Table Keys
24+
25+
There are the meta-data columns used to uniquely identify data rows/points.
26+
27+
| Key | Description |
28+
|--------------|---------------------------------------------------------------------------------------------------------------------------------|
29+
| `geo_value` | The geographical location (see [Geography](#geography)) |
30+
| `geo_type` | The type of geographical location (see [Geography](#geography)) <br/> **Available types:** `lab`,`province`, `region`, `nation` |
31+
| `time_value` | The end of the epiweek |
32+
| `time_type` | Type of time value, only `week` available |
33+
| `epiweek` | Epidemiological week |
34+
| `issue` | Issue/version date of the data (see [Data Versioning](#version) for full details) |
35+
36+
## Signals
37+
2338
| Signal | Description |
2439
|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
2540
| `sarscov2_tests` | Number of SARS-CoV-2 laboratory tests <br/> **Earliest Date Available:** 2022-09-03 |
@@ -32,21 +47,21 @@ NOTE: Pandemic COVID-19 is not reported in this data source.
3247
| `flu_pct_positive` | Percentage of influenza laboratory tests that are positive (for all subtypes) <br/> **Earliest Date Available:** 2013-08-31 |
3348
| `fluah1n1pdm09_positive_tests` | Number of positive influenza A(H1N1)pdm09 laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
3449
| `fluah3_positive_tests` | Number of positive influenza A(H3N2) laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
35-
| `fluauns_positive_tests` | Number of positive influenza A (unsubtyped) laboratory tests <br/> **Earliest Date Available:** 2016-09-03 |
50+
| `fluauns_positive_tests` | Number of positive influenza A (unsubtyped) laboratory tests <br/> **Earliest Date Available:** 2016-09-03 |
3651
| `flua_positive_tests` | Number of positive influenza A laboratory tests (for all subtypes) <br/> **Earliest Date Available:** 2013-08-31 |
3752
| `flua_pct_positive` | Percentage of influenza A laboratory tests that are positive (for all subtypes) <br/> **Earliest Date Available:** 2013-08-31 |
3853
| `flub_positive_tests` | Number of positive influenza B laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
3954
| `flub_pct_positive` | Percentage of influenza B laboratory tests that are positive <br/> **Earliest Date Available:** 2013-08-31 |
4055
| `rsv_tests` | Number of respiratory syncytial virus (RSV) laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
41-
| `rsv_positive_tests` | Number of laboratory tests positive for RSV <br/> **Earliest Date Available:** 2013-08-31 |
56+
| `rsv_positive_tests` | Number of laboratory tests positive for RSV <br/> **Earliest Date Available:** 2013-08-31 |
4257
| `rsv_pct_positive` | Percentage of RSV laboratory tests that are positive <br/> **Earliest Date Available:** 2013-08-31 |
4358
| `hpiv_tests` | Number of human parainfluenza virus (HPIV) laboratory tests (for all subtypes)<br/> **Earliest Date Available:** 2013-08-31 |
44-
| `hpiv1_positive_tests` | Number of HPIV laboratory tests positive for HPIV-1 <br/> **Earliest Date Available:** 2013-08-31 |
45-
| `hpiv2_positive_tests` | Number of HPIV laboratory tests positive for HPIV-2 <br/> **Earliest Date Available:** 2013-08-31 |
46-
| `hpiv3_positive_tests` | Number of HPIV laboratory tests positive for HPIV-3 <br/> **Earliest Date Available:** 2013-08-31 |
47-
| `hpiv4_positive_tests` | Number of HPIV laboratory tests positive for HPIV-4 <br/> **Earliest Date Available:** 2013-08-31 |
48-
| `hpivother_positive_tests` | Number of HPIV laboratory tests positive for any other HPIV subtype <br/> **Earliest Date Available:** 2013-08-31 |
49-
| `hpiv_positive_tests` | Number of laboratory tests positive for any HPIV subtype <br/> **Earliest Date Available:** 2013-08-31 |
59+
| `hpiv1_positive_tests` | Number of HPIV laboratory tests positive for HPIV-1 <br/> **Earliest Date Available:** 2013-08-31 |
60+
| `hpiv2_positive_tests` | Number of HPIV laboratory tests positive for HPIV-2 <br/> **Earliest Date Available:** 2013-08-31 |
61+
| `hpiv3_positive_tests` | Number of HPIV laboratory tests positive for HPIV-3 <br/> **Earliest Date Available:** 2013-08-31 |
62+
| `hpiv4_positive_tests` | Number of HPIV laboratory tests positive for HPIV-4 <br/> **Earliest Date Available:** 2013-08-31 |
63+
| `hpivother_positive_tests` | Number of HPIV laboratory tests positive for any other HPIV subtype <br/> **Earliest Date Available:** 2013-08-31 |
64+
| `hpiv_positive_tests` | Number of laboratory tests positive for any HPIV subtype <br/> **Earliest Date Available:** 2013-08-31 |
5065
| `hpiv_pct_positive` | Percentage of HPIV laboratory tests that are positive (for all subtypes) <br/> **Earliest Date Available:** 2013-08-31 |
5166
| `adv_tests` | Number of adenovirus (ADV) laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
5267
| `adv_positive_tests` | Number of positive ADV laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
@@ -76,40 +91,40 @@ Unlike most other sources in the Delphi Epidata API, this data source reports da
7691

7792
One of the 10 provinces or three territories, abbreviated using [standard 2-letter alpha codes](https://www.canada.ca/en/government/system/digital-government/digital-government-innovations/enabling-interoperability/gc-enterprise-data-reference-standards/data-reference-standard-canadian-provinces-territories.html)
7893

79-
- `nl`: Newfoundland and Labrador
80-
- `pe`: Prince Edward Island
81-
- `ns`: Nova Scotia
82-
- `nb`: New Brunswick
83-
- `qc`: Quebec
84-
- `on`: Ontario
85-
- `mb`: Manitoba
86-
- `sk`: Saskatchewan
87-
- `ab`: Alberta
88-
- `bc`: British Columbia
89-
- `yt`: Yukon
90-
- `nt`: Northwest Territories
91-
- `nu`: Nunavut
94+
- `nl`: Newfoundland and Labrador
95+
- `pe`: Prince Edward Island
96+
- `ns`: Nova Scotia
97+
- `nb`: New Brunswick
98+
- `qc`: Quebec
99+
- `on`: Ontario
100+
- `mb`: Manitoba
101+
- `sk`: Saskatchewan
102+
- `ab`: Alberta
103+
- `bc`: British Columbia
104+
- `yt`: Yukon
105+
- `nt`: Northwest Territories
106+
- `nu`: Nunavut
92107

93108
### Geo type `lab`
94109

95110
The laboratories reporting lab tests. Only Ontario, Quebec, and occasionally Saskatchewan report counts for individual lab facilities.
96111

97112
**NOTE**: Over time, some laboratories were expanded and renamed:
98113

99-
- Children's Hospital of Eastern Ontario (CHEO) -\> Eastern Ontario Regional Laboratory Association (EORLA)
100-
- Sunnybrook Women’s College Health Sciences Centre -\> Shared Hospital Laboratory
101-
- Toronto Medical Laboratory -\> University Health Network/Mount Sinai Hospital
114+
- Children's Hospital of Eastern Ontario (CHEO) -\> Eastern Ontario Regional Laboratory Association (EORLA)
115+
- Sunnybrook Women’s College Health Sciences Centre -\> Shared Hospital Laboratory
116+
- Toronto Medical Laboratory -\> University Health Network/Mount Sinai Hospital
102117

103118
### Geo type `region`
104119

105120
The provinces and territories are also aggregated into six geographic regions:
106121

107-
- `atlantic`: Newfoundland and Labrador, Prince Edward Island, Nova Scotia and New Brunswick
108-
- `prairies`: Manitoba, Saskatchewan and Alberta
109-
- `territories`: Nunavut, Northwest Territories and Yukon
110-
- `on`: Ontario
111-
- `qc`: Quebec
112-
- `bc`: British Columbia
122+
- `atlantic`: Newfoundland and Labrador, Prince Edward Island, Nova Scotia and New Brunswick
123+
- `prairies`: Manitoba, Saskatchewan and Alberta
124+
- `territories`: Nunavut, Northwest Territories and Yukon
125+
- `on`: Ontario
126+
- `qc`: Quebec
127+
- `bc`: British Columbia
113128

114129
### Geo type `nation`
115130

@@ -137,7 +152,7 @@ $$\text{Number Positive Lab Tests} = \frac{\text{Percent Positive Lab Tests}}{10
137152

138153
These values are not rounded, so some are not integers.
139154

140-
## Data Versioning
155+
## Data Versioning {#version}
141156

142157
Epiweeks end on Saturday, and the data is usually updated the following Thursday or Friday. While the data was being reported with weekly reports, the version/issue was the date the webpage was modified. If this date was more than 14 days after the epiweek being reported, we set the version to 5 days after the end of epiweek being reported, as this is usually when the data is updated. This should only be a consideration for the historic reports, as the new dashboard states when it was last updated.
143158

@@ -151,10 +166,10 @@ Data comes from labs across Canada, and some provinces only have one reporting l
151166

152167
The source uses multiple terms used to denote missing data:
153168

154-
- NC : Not collected
155-
- NR : Data not reported for current week
156-
- NA : Not available
157-
- Not tested
169+
- NC : Not collected
170+
- NR : Data not reported for current week
171+
- NA : Not available
172+
- Not tested
158173

159174
For convenience, we treat all these as NA, but there may be subtle differences.
160175

@@ -166,19 +181,15 @@ Data is reported around \~5 days after the end of an epiweek. For June-August 20
166181

167182
The data experiences backfill as counts are finalized in subsequent weeks. The amount and impact of revisions depend on the virus.
168183

169-
Across all indicators, most (99%) observations have less than 3 revisions.
170-
`hpiv1_*`,`hpiv2_*`,`hpiv3_*` and `hpiv4_*` indicators have revisions even more rarely.
184+
Across all indicators, most (99%) observations have less than 3 revisions. `hpiv1_*`,`hpiv2_*`,`hpiv3_*` and `hpiv4_*` indicators have revisions even more rarely.
171185

172-
Across all indicators, the top 10% of observations (unique location-date pairs) with the largest relative spread have had values revised by 25-33% or more.
173-
However, 90% of observations with revisions are revised to within 20% of their final value (and stay within that 20% range) 1-3 weeks after the date an observation is being reported for.
174-
And 95% of observations with revisions are finalized within 3-4 weeks.
175-
So revisions that greatly impact a reported value happen soon after an observation is first reported.
186+
Across all indicators, the top 10% of observations (unique location-date pairs) with the largest relative spread have had values revised by 25-33% or more. However, 90% of observations with revisions are revised to within 20% of their final value (and stay within that 20% range) 1-3 weeks after the date an observation is being reported for. And 95% of observations with revisions are finalized within 3-4 weeks. So revisions that greatly impact a reported value happen soon after an observation is first reported.
176187

177188
Looking at the revision speed of specific indicators, `sarscov2_*` and `flub_*` indicators are finalized fairly fast (95% finalized after 12 days). `fluah3_positive_tests` and `adv_*` indicators are finalized fairly slowly (95% finalized after 30-40 days).
178189

179190
`flu_pct_positive`, `flua_pct_positive`, `fluah1n1pdm09_positive_tests` and related indicators have larger spread than other indicators. That is, \~70-90% of observations have more than 10% relative spread vs 20-30% in other indicators.
180191

181-
## Source and Licensing
192+
## Source and Licensing {#source-and-licensing}
182193

183194
This source is derived from PHAC's Respiratory Virus Detection Data, originally reported in [weekly reports](https://www.canada.ca/en/public-health/services/surveillance/respiratory-virus-detections-canada.html), and currently reported in a [dynamic dashboard](https://health-infobase.canada.ca/respiratory-virus-surveillance/?source=rvdss).
184195

0 commit comments

Comments
 (0)