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 94c6812

Browse files
JavierMtzRdzJavierMtzRdz
committed
docs: update headers to align with epiportal and add details on estimation, processing, Strata definitions, lag, backfill, and limitations for the Flusurv endpoint
1 parent d6122aa commit 94c6812

File tree

1 file changed

+91
-15
lines changed

1 file changed

+91
-15
lines changed

‎docs/api/flusurv.md‎

Lines changed: 91 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ nav_order: 1
1212
| Attribute | Details |
1313
| :--- | :--- |
1414
| **Source Name** | `flusurv` |
15-
| **Data Source** | [Laboratory-Confirmed Influenza Hospitalizations](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html) |
16-
| **Geographic Coverage** | See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list |
17-
| **Temporal Resolution** | Weekly (Epiweek) |
18-
| **Earliest Date** | 2003w40 |
19-
| **Update Frequency** | Weekly |
15+
| **Data Source** | [CDC FluSurv-NET](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html) |
16+
| **Geographic Levels** | Specific catchment areas (Network, State, or County-level catchments). See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list |
17+
| **Temporal Granularity** | Weekly (Epiweek) |
18+
| **Temporal Scope Start** | 2003w40 |
19+
| **Reporting Cadence** | Weekly |
2020
| **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) |
2121

2222

@@ -25,46 +25,122 @@ nav_order: 1
2525
## Overview
2626
{: .no_toc}
2727

28-
This data source provides laboratory-confirmed influenza hospitalization rates from the FluSurv-NET surveillance system. The data includes age-stratified hospitalization rates and rates by race, sex, and flu type, when available.
28+
This data source provides laboratory-confirmed influenza hospitalization rates from the from the [CDC's Influenza Hospitalization Surveillance Network (FluSurv-NET)](https://www.cdc.gov/fluview/overview/influenza-hospitalization-surveillance.html?CDC_AAref_Val=https://www.cdc.gov/flu/weekly/influenza-hospitalization-surveillance.htm). The data includes age-stratified hospitalization rates and rates by race, sex, and flu type, when available.
2929

3030
General topics not specific to any particular endpoint are discussed in the
3131
[API overview](README.md). Such topics include:
3232
[contributing](README.md#contributing), [citing](README.md#citing), and
3333
[data licensing](README.md#data-licensing).
3434

35-
## Table of contents
36-
{: .no_toc .text-delta}
37-
38-
1. TOC
39-
{:toc}
40-
4135
See also:
4236
- <https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html>
4337
- <https://wwwnc.cdc.gov/eid/article/21/9/14-1912_article>
4438
- Chaves, S., Lynfield, R., Lindegren, M., Bresee, J., & Finelli, L. (2015).
4539
The US Influenza Hospitalization Surveillance Network. Emerging Infectious
4640
Diseases, 21(9), 1543-1550. <https://dx.doi.org/10.3201/eid2109.141912>.
4741

42+
## Table of contents
43+
{: .no_toc .text-delta}
44+
45+
1. TOC
46+
{:toc}
47+
48+
49+
## Estimation
50+
51+
The rates provided in this dataset are pulled directly from the CDC's GRASP (Geospatial Research, Analysis, and Services Program) API.
52+
53+
For a specific location and stratum (e.g., Age 0-4), the rate represents the number of residents of the catchment area hospitalized with laboratory-confirmed influenza divided by the total population of that stratum in that catchment area, multiplied by 100,000.
54+
55+
### Processing Details
56+
The Delphi pipeline scrapes the CDC GRASP API to emulate browser requests.
57+
* **Duplicate Handling:** In rare instances where the source API provides two differing rates for the same location, epiweek, and demographic group, the pipeline is configured to retain the first value returned by the API.
58+
* **Seasonality:** Data is processed based on "seasons" defined by the CDC, but is stored and served by Delphi indexed by Epiweek.
59+
60+
## Strata Definitions
61+
62+
The signals are broken down into specific demographic groups. The suffix of the signal name corresponds to the groups below.
63+
64+
### Age Groups
65+
The dataset includes both historical age groupings (0-4) and newer, more granular groupings (0tlt1, etc.) added in recent years.
66+
67+
| Signal Suffix | Age Group |
68+
| :--- | :--- |
69+
| `age_0` | 0-4 yr |
70+
| `age_1` | 5-17 yr |
71+
| `age_2` | 18-49 yr |
72+
| `age_3` | 50-64 yr |
73+
| `age_4` | 65+ yr |
74+
| `age_5` | 65-74 yr |
75+
| `age_6` | 75-84 yr |
76+
| `age_7` | 85+ yr |
77+
| `age_0tlt1` | 0 to <1 yr |
78+
| `age_1t4` | 1-4 yr |
79+
| `age_5t11` | 5-11 yr |
80+
| `age_12t17` | 12-17 yr |
81+
| `age_18t29` | 18-29 yr |
82+
| `age_30t39` | 30-39 yr |
83+
| `age_40t49` | 40-49 yr |
84+
| `age_gte75` | >= 75 yr |
85+
| `age_lt18` | < 18 yr |
86+
| `age_gte18` | >= 18 yr |
87+
88+
### Race and Ethnicity
89+
The dataset tracks 5 specific racial and ethnic groups.
90+
91+
| Signal Suffix | Group Description |
92+
| :--- | :--- |
93+
| `race_white` | White |
94+
| `race_black` | Black |
95+
| `race_hisp` | Hispanic/Latino |
96+
| `race_asian` | Asian/Pacific Islander |
97+
| `race_natamer` | American Indian/Alaska Native |
98+
99+
### Sex
100+
101+
| Signal Suffix | Group Description |
102+
| :--- | :--- |
103+
| `sex_male` | Male |
104+
| `sex_female` | Female |
105+
106+
### Influenza Type
107+
108+
| Signal Suffix | Group Description |
109+
| :--- | :--- |
110+
| `flu_a` | Influenza A |
111+
| `flu_b` | Influenza B |
112+
113+
## Lag and Backfill
114+
115+
FluSurv-NET data is subject to reporting lags and revisions. The CDC may update past weekly rates as more hospitalization data becomes available or is corrected.
116+
117+
The Delphi API tracks these changes via the `issue` date (inferred from the `loaddatetime` provided by the CDC API). When new data is fetched from the CDC, if a rate for a past week has changed, the database is updated to reflect the new value, allowing users to query historical versions of the data using the `lag` or `issues` parameters.
118+
119+
## Limitations
120+
121+
* This data does not cover the entire United States. It covers specific catchment areas within 13 states (EIP sites) and additional states participating in the IHSP. Rates are representative of these specific populations and may not perfectly generalize to the entire national population.
122+
* As with all surveillance data, recent weeks may be subject to significant backfill.
123+
* Not all strata (e.g., specific age bands or racial groups) may be available for all locations or all historical dates, depending on the data collection practices at the time.
124+
48125
# The API
49126

50127
The base URL is: <https://api.delphi.cmu.edu/epidata/flusurv/>
51128

52-
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
53129

54130
## Parameters
55131

56132
### Required
57133

58134
| Parameter | Description | Type |
59135
| --- | --- | --- |
60-
| `epiweeks` | epiweeks | `list` of epiweeks |
136+
| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks |
61137
| `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#flusurv-locations)) |
62138

63139
### Optional
64140

65141
| Parameter | Description | Type |
66142
|-----------|--------------------------------------------|--------------------|
67-
| `issues` | issues | `list` of epiweeks |
143+
| `issues` | issues (see [Date Formats](date_formats.html)) | `list` of epiweeks |
68144
| `lag` | # weeks between each epiweek and its issue | integer |
69145

70146
{: .note}

0 commit comments

Comments
 (0)