Skip to content

Commit 56f544d

Browse files
cchuongnmdefriesJavierMtzRdz
authored
Add RVDSS documentation (#1667)
* Add documentation for RVDSS endpoint * Update rvdss.md Fix markdown formatting * Change earliest issue to first revision * Update rvdss.md * Add note on labs that have been renamed/expanded * add more details on backfill behaviour * remove unused columns * clarify indicator meanings, formatting, backfill info * Add key table * Update rvdss.md * add extra resource on respiratory surveillance * clarify counts of flu a/b subtests * clarify ev/rv combo test * geo type order and data version definition detail * more limitations, detail on missingness codes * use new docs formatting for header * add date before which we guessed at version dates * reorg sections * standardize signal descriptions * docs(rvdss): move geographic codes to geographic_codes.md * docs(rvdss): correct header and add reference to Canada section in geographic_codes.md * docs(rvdss): move toc to the top and move key table to "The API" section * docs(rvdss): add response, examples and code samples * docs(rvdss) update Parameters and response sections based on #1542 * Validate influenza A, B and total tests are the same * formatting --------- Co-authored-by: nmdefries <42820733+nmdefries@users.noreply.github.com> Co-authored-by: JavierMtzRdz <javierwolfsangel@gmail.com>
1 parent 822624d commit 56f544d

2 files changed

Lines changed: 321 additions & 0 deletions

File tree

docs/api/geographic_codes.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,65 @@ Selected US cities used by multiple endpoints.
315315
| `Washington_DC` | Washington, DC |
316316
| `Wichita_KS` | Wichita, KS |
317317

318+
## Canada
319+
320+
Canada-specific geographic codes used by the [RVDSS](rvdss.md) endpoint.
321+
322+
### Canada National Code {#canada-nation}
323+
324+
The national level for Canada.
325+
326+
| Code | Name |
327+
|---|---|
328+
| `ca` | Canada |
329+
330+
### Canada Regions {#canada-regions}
331+
332+
Provinces and territories aggregated into six geographic regions.
333+
334+
| Code | Region | Provinces/Territories |
335+
|---|---|---|
336+
| `atlantic` | Atlantic | NL, PE, NS, NB |
337+
| `prairies` | Prairies | MB, SK, AB |
338+
| `territories` | Territories | NU, NT, YT |
339+
| `on` | Ontario | Ontario |
340+
| `qc` | Quebec | Quebec |
341+
| `bc` | British Columbia | British Columbia |
342+
343+
{: .note}
344+
> **Note:** Ontario, Quebec, and British Columbia are single-province regions, so data for these provinces is the same whether using `geo_type = region` or `geo_type = province`.
345+
346+
### Canada Provinces and Territories {#canada-provinces}
347+
348+
The 10 provinces and three territories of Canada, 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).
349+
350+
| Code | Name |
351+
|---|---|
352+
| `ab` | Alberta |
353+
| `bc` | British Columbia |
354+
| `mb` | Manitoba |
355+
| `nb` | New Brunswick |
356+
| `nl` | Newfoundland and Labrador |
357+
| `ns` | Nova Scotia |
358+
| `nt` | Northwest Territories |
359+
| `nu` | Nunavut |
360+
| `on` | Ontario |
361+
| `pe` | Prince Edward Island |
362+
| `qc` | Quebec |
363+
| `sk` | Saskatchewan |
364+
| `yt` | Yukon |
365+
366+
### Canada Laboratories {#canada-labs}
367+
368+
The laboratories reporting lab tests. Only Ontario, Quebec, and occasionally Saskatchewan report counts for individual lab facilities.
369+
370+
{: .note}
371+
> **Note:** Over time, some laboratory networks were expanded and the responsible laboratories were renamed:
372+
>
373+
> - **CHEO** (Children's Hospital of Eastern Ontario) &rarr; **EORLA** (Eastern Ontario Regional Laboratory Association)
374+
> - **Sunnybrook Women’s College Health Sciences Centre** &rarr; **Shared Hospital Laboratory**
375+
> - **Toronto Medical Laboratory** &rarr; **University Health Network/Mount Sinai Hospital**
376+
318377
## NIDSS
319378

320379
Geographic codes used by [NIDSS Flu](nidss_flu.html) and [NIDSS Dengue](nidss_dengue.html) endpoints.

0 commit comments

Comments
 (0)