Skip to content

Conversation

@cchuong
Copy link
Collaborator

@cchuong cchuong commented Aug 29, 2025

addresses issue(s): Add documentation for RVDSS endpoint

Summary:

Prerequisites:

  • Unless it is a documentation hotfix it should be merged against the dev branch
  • Branch is up-to-date with the branch to be merged with, i.e. dev
  • Build is successful
  • Code is cleaned up and formatted

@nmdefries nmdefries marked this pull request as ready for review November 7, 2025 22:48
@nmdefries nmdefries self-requested a review November 7, 2025 22:49
@sonarqubecloud
Copy link

sonarqubecloud bot commented Nov 8, 2025

Copy link
Contributor

@nmdefries nmdefries left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First set of comments. I'm trying to edit small stuff directly too, so the comments are mostly clarifications where I wasn't sure what you meant.


This data source of respiratory virus detections in Canada is collected by the [Respiratory Virus Detection Surveillance System](https://health-infobase.canada.ca/respiratory-virus-surveillance/?source=rvdss) (RVDSS) and published by the Public Health Agency of Canada (PHAC). Laboratory tests for various respiratory illnesses from various sentinel laboratories across Canada are reported on a weekly basis year-round 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), Public Health Agency of Canada. The data was originally scraped when weekly online reports, but since June 2024, has been reported on a dynamic dashboard.

NOTE: Pandemic COVID-19 is not reported in this data source.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: Not sure what you mean here. Doesn't this source report COVID data for the COVID pandemic time period?


| Signal | Description |
|--------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `sarscov2_tests` | Number of SARS-CoV-2 laboratory tests <br/> **Earliest Date Available:** 2022-09-03 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: Recommend clarifying in the description that SARS-CoV-2 is the virus that causes COVID-19, both for better searching and because people mostly use the name "COVID-19". I guess maybe it's not technically correct to say that this is a "COVID-19 laboratory test" (?), but we could say that too.

Second, do we know what kind of tests these are? E.g. antigen, nose swab, NAAT (nucleic acid amplification)

Comment on lines 29 to 30
| `flua_tests` | Number of Influenza A laboratory tests (Same as `flu_tests`, just maintained for convenience) <br/> **Earliest Date Available:** 2013-08-31 |
| `flub_tests` | Number of Influenza B laboratory tests (Same as `flu_tests`, just maintained for convenience) <br/> **Earliest Date Available:** 2013-08-31 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: please clarify "Same as flu_tests, just maintained for convenience". E.g. values are exactly the same, meanings are the same, flu a and b are always tested together, so the flu a/b denominator is always the same, etc

| `flua_tests` | Number of Influenza A laboratory tests (Same as `flu_tests`, just maintained for convenience) <br/> **Earliest Date Available:** 2013-08-31 |
| `flub_tests` | Number of Influenza B laboratory tests (Same as `flu_tests`, just maintained for convenience) <br/> **Earliest Date Available:** 2013-08-31 |
| `flu_positive_tests` | Number of positive Influenza laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
| `flu_pct_positive` | Percentage of Influenza laboratory tests that are positive (for all subtypes) <br/> **Earliest Date Available:** 2013-08-31 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion:

Suggested change
| `flu_pct_positive` | Percentage of Influenza laboratory tests that are positive (for all subtypes) <br/> **Earliest Date Available:** 2013-08-31 |
| `flu_pct_positive` | Percentage of Influenza laboratory tests that are positive. Positive test results for all influenza subtypes are included. <br/> **Earliest Date Available:** 2013-08-31 |

and similarly below.

| `hmpv_tests` | Number of Human Metapneumovirus (hMPV)laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
| `hmpv_positive_tests` | Number of positive hMPV laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
| `hmpv_pct_positive` | Percentage of hMPV laboratory tests that are positive <br/>**Earliest Date Available:** 2013-08-31 |
| `evrv_tests` | Number of Enterovirus/Rhinovirus (EV/RV) laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue: what does the "/" mean between viruses? Is this a combined test, or are we combining tests for EV and tests for RV?

| `evrv_tests` | Number of Enterovirus/Rhinovirus (EV/RV) laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
| `evrv_positive_tests` | Number of positive EV/RV laboratory tests <br/>**Earliest Date Available:** 2013-08-31 |
| `evrv_pct_positive` | Percentage of EV/RV laboratory tests that are positive <br/>**Earliest Date Available:** 2013-08-31 |
| `hcov_tests` | Number of Human Coronavirus (HCoV) laboratory tests <br/> **Earliest Date Available:** 2013-08-31 |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: please add a note/warning that this is not the same as COVID with a little more detail. The name similarity could cause confusion.


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

| Signal | Description |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

suggestion: we should add the descriptive columns (time_value, issue, etc) to this table so that we can define them and explain the general time formats.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants