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 637e830

Browse files
committed
docs: add endpoint details for flueview
1 parent 4c22c73 commit 637e830

File tree

2 files changed

+46
-1
lines changed

2 files changed

+46
-1
lines changed

docs/api/fluview.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ nav_order: 1
1313
| :--- | :--- |
1414
| **Source Name** | `fluview` |
1515
| **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) |
16-
| **Geographic Levels** | National, states, HHS regions, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) |
16+
| **Geographic Levels** | National, states, HHS regions, Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)), and cities (see [FluView Cities](geographic_codes.html#fluview-cities)) |
1717
| **Temporal Granularity** | Weekly (Epiweek) |
1818
| **Reporting Cadence** | Weekly (typically Fridays) |
1919
| **Temporal Scope Start** | 1997w40 |
@@ -35,6 +35,35 @@ General topics not specific to any particular endpoint are discussed in the
3535
1. TOC
3636
{:toc}
3737

38+
## Estimation
39+
40+
### Definition of ILI
41+
For this system, ILI is defined as fever (temperature of 100°F [37.8°C] or greater) and a cough and/or a sore throat without a known cause other than influenza.
42+
43+
### Weighted vs. Unweighted ILI
44+
The `fluview` endpoint provides two percentage metrics: `ili` (unweighted) and `wili` (weighted).
45+
46+
* **Unweighted (`ili`):** Calculated simply as the number of ILI cases divided by the total number of patients seen:
47+
48+
$$ILI = 100 \cdot \frac{\text{num\_ili}}{\text{num\_patients}}$$
49+
50+
* **Weighted (`wili`):** To produce a representative estimate for larger regions (like National or HHS Regions), the CDC weights the state-level data by state population. This corrects for the fact that some states may have higher provider participation rates than others relative to their actual population.
51+
52+
$$wILI_{region} = \sum_{s \in region} \left( \%ILI_s \times \frac{Pop_s}{Pop_{region}} \right)$$
53+
54+
### Imputation
55+
State-level data was not publicly available from the CDC prior to the 2010-2011 flu season (2010w40). For dates prior to this, and for occasional missing reports, Delphi uses a sensor fusion approach (OLS regression) to impute state-level values based on the available regional data.
56+
57+
Private imputed data may require specific authorization via the `auth` parameter.
58+
59+
## Lag and Backfill
60+
61+
The data is preliminary and subject to revision. Participating providers may report data late, or correct previously reported data. The `issues` and `lag` parameters in the API allow you to access historical versions of the data as they were reported on specific dates.
62+
63+
## Limitations
64+
65+
ILINet is a voluntary system. While it covers all states, the coverage within a state may not be perfectly representative of the entire population. Also, ILI is a syndromic definition, not a laboratory diagnosis. It captures patients with flu-like symptoms, which can be caused by other respiratory pathogens (including SARS-CoV-2 and RSV).
66+
3867
# The API
3968

4069
The base URL is: <https://api.delphi.cmu.edu/epidata/fluview/>

docs/api/geographic_codes.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -449,3 +449,19 @@ Geographic codes used by the [KCDC ILI](kcdc_ili.html) endpoint.
449449
| ROK | Republic of Korea |
450450

451451

452+
## FluView Cities
453+
454+
Specific cities used by the [FluView](fluview.html) endpoint.
455+
456+
| City | Code |
457+
|---|---|
458+
| Chicago | ord |
459+
| Los Angeles | lax |
460+
| New York City | jfk |
461+
462+
### Note on New York
463+
464+
In the CDC FluView system, New York State and New York City are often reported separately.
465+
* `ny_minus_jfk` represents New York State **excluding** NYC.
466+
* `jfk` represents New York City.
467+
* `ny` represents the entire state (the sum of the two).

0 commit comments

Comments
 (0)