Skip to content

Commit 7830d5a

Browse files
JavierMtzRdzJavierMtzRdz
committed
docs: standardize header for Other Endpoints
1 parent b5f61c3 commit 7830d5a

19 files changed

+276
-147
lines changed

‎docs/api/covid_hosp.md‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@ nav_order: 2
88
# COVID-19 Hospitalization by State
99
{: .no_toc}
1010

11-
* **Source name:** `covid_hosp_state_timeseries`
12-
* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh)
13-
* **Earliest issue available:** 2020-01-01
14-
* **Temporal Resolution:** Daily
15-
* **Spatial Resolution:** US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories))
16-
* **License:** [Public Domain US Government](https://www.usa.gov/government-works)
11+
12+
| Attribute | Details |
13+
| :--- | :--- |
14+
| **Source Name** | `covid_hosp_state_timeseries` |
15+
| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) |
16+
| **Geographic Coverage** | US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) |
17+
| **Temporal Resolution** | Daily |
18+
| **Update Frequency** | Inactive - No longer updated |
19+
| **Earliest Date** | 2020-01-01 |
20+
| **License** | [Public Domain US Government](https://www.usa.gov/government-works) |
1721

1822
## Overview
1923
{: .no_toc}
@@ -59,7 +63,7 @@ See [this documentation](README.md) for details on specifying locations and date
5963

6064
| Parameter | Description | Type |
6165
|-----------|--------------------------------|--------------------------------|
62-
| `states` | two-letter state abbreviations | `list` of states |
66+
| `states` | two-letter state abbreviations (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | `list` of states |
6367
| `dates` | dates | `list` of dates or date ranges |
6468

6569
### Optional

‎docs/api/covid_hosp_facility.md‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,16 @@ nav_order: 2
88
# COVID-19 Hospitalization by Facility
99
{: .no_toc}
1010

11-
* **Source name:** `covid_hosp_facility`
12-
* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u)
13-
* **Earliest issue available:** 2020-07-31
14-
* **Geographic resolution:** healthcare facility (address, city, zip, fips)
15-
* **Temporal resolution:** weekly (Friday -- Thursday)
16-
* **License:** [Public Domain US Government](https://www.usa.gov/government-works)
11+
12+
| Attribute | Details |
13+
| :--- | :--- |
14+
| **Source Name** | `covid_hosp_facility` |
15+
| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) |
16+
| **Geographic Coverage** | Healthcare facility |
17+
| **Temporal Resolution** | Weekly (Friday -- Thursday) |
18+
| **Update Frequency** | Inactive - No longer updated |
19+
| **Earliest Date** | 2020-07-31 |
20+
| **License** | [Public Domain US Government](https://www.usa.gov/government-works) |
1721

1822
## Overview
1923
{: .no_toc}
@@ -56,14 +60,14 @@ See [this documentation](README.md) for details on specifying locations and date
5660
| `hospital_pks` | facility unique identifiers | `list` of identifiers |
5761
| `collection_weeks` | dates | `list` of dates or date ranges |
5862

59-
NOTE: The companion
60-
[`covid_hosp_facility_lookup` endpoint](covid_hosp_facility_lookup.md) can be
61-
used to lookup facility identifiers in a variety of ways.
6263

63-
NOTE: A collection week spans Friday -- Thursday, and weeks are identified by
64-
the date corresponding to the Friday at the start of the week. Therefore, the
65-
`collection_weeks` parameter is formatted as a `YYYYMMDD` date (or list of
66-
dates) rather than an "epiweek" as in other endpoints.
64+
{: .note}
65+
> **NOTEs:**
66+
> - [`covid_hosp_facility_lookup` endpoint](covid_hosp_facility_lookup.md) can > be used to lookup facility identifiers in a variety of ways.
67+
> - A collection week spans Friday -- Thursday, and weeks are identified by
68+
> the date corresponding to the Friday at the start of the week. Therefore, the
69+
> `collection_weeks` parameter is formatted as a `YYYYMMDD` date (or list of
70+
> dates) rather than an "epiweek" as in other endpoints.
6771
6872
### Optional
6973

‎docs/api/covid_hosp_facility_lookup.md‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,17 @@ nav_order: 2
88
# COVID-19 Hospitalization: Facility Lookup
99
{: .no_toc}
1010

11-
* **Source name:** `covid_hosp_facility_lookup`
12-
* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u)
13-
* **Total facilities:** 4922
14-
* **License:** [Public Domain US Government](https://www.usa.gov/government-works)
11+
12+
| Attribute | Details |
13+
| :--- | :--- |
14+
| **Source Name** | `covid_hosp_facility_lookup` |
15+
| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) |
16+
| **Geographic Coverage** | Healthcare facility ([state](geographic_codes.html#us-states-and-territories), ccn city, zip, fips) |
17+
| **Update Frequency** | Inactive - No longer updated |
18+
| **License** | [Public Domain US Government](https://www.usa.gov/government-works) |
19+
20+
<!-- | **Earliest Date** | N/A |
21+
| **Temporal Resolution** | N/A -->
1522

1623
## Overview
1724
{: .no_toc}
@@ -42,6 +49,8 @@ See [this documentation](README.md) for details on specifying locations and date
4249

4350
## Parameters
4451

52+
### Required
53+
4554
| Parameter | Description | Type |
4655
|-------------|-----------------------------------|--------|
4756
| `state` | two-letter state abbreviation (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | string |
@@ -50,9 +59,10 @@ See [this documentation](README.md) for details on specifying locations and date
5059
| `zip` | 5-digit ZIP code | string |
5160
| `fips_code` | 5-digit FIPS county code | string |
5261

53-
NOTE: Exactly one of the above parameters must be present in requests.
54-
Combinations of parameters (e.g. specifying both `city` and `state`) are not
55-
supported.
62+
{: .note}
63+
> **NOTE:** Exactly one of the above parameters must be present in requests.
64+
> Combinations of parameters (e.g. specifying both `city` and `state`) are not
65+
> supported.
5666
5767
## Response
5868

‎docs/api/delphi.md‎

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,17 @@ nav_order: 2
88
# Delphi Forecasts
99
{: .no_toc}
1010

11-
* **Source name:** `delphi`
12-
* **Earliest issue available:** 2010w01
13-
* **Time type available:** epiweek
14-
* **License:** [CC BY](https://creativecommons.org/licenses/by/4.0/)
11+
12+
| Attribute | Details |
13+
| :--- | :--- |
14+
| **Source Name** | `delphi` |
15+
| **Data Source** | [Delphi](https://delphi.cmu.edu/) |
16+
| **Temporal Resolution** | Weekly (Epiweek) |
17+
| **Systems available** | `af`, `eb`, `ec`, `sp`, `st` |
18+
| **Update Frequency** | Inactive - No longer updated |
19+
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) |
20+
21+
<!--- | **Earliest Date** | 2014w41 | -->
1522

1623
## Overview
1724
{: .no_toc}
@@ -41,7 +48,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
4148

4249
| Parameter | Description | Type |
4350
|-----------|-------------|--------------------------------------|
44-
| `system` | system | system name from (...) <!-- TODO --> |
51+
| `system` | system | system name (`af`, `eb`, `ec`, `sp`, `st`) |
4552
| `epiweek` | epiweek | epiweek when forecast was made |
4653

4754
## Response
@@ -53,18 +60,22 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
5360
| `epidata[].system` | system | string |
5461
| `epidata[].epiweek` | epiweek | integer |
5562
| `epidata[].forecast` | forecast structure | object |
56-
| `epidata[].forecast.season` | year (yyyy) | integer |
57-
| `epidata[].forecast.ili_bins` | | integer |
63+
| `epidata[].forecast._version` | forecast version | integer |
64+
| `epidata[].forecast.baselines` | baseline values for each region | object |
65+
| `epidata[].forecast.baselines.<region>` | baseline value for \<region\> | float |
5866
| `epidata[].forecast.data` | forecast data for each region | object |
5967
| `epidata[].forecast.data.<region>` | forecast data for \<region\> | object |
6068
| `epidata[].forecast.data.<region>.<distrib>` | distribution for \<distrib\> (`peak`, `peakweek`, `onset`, `x1`, `x2`, `x3`, `x4`) | object |
61-
| ... | ... | ... | <!-- TODO -->
62-
| `epidata[].forecast.name` | name = "delphi-epicast" | string |
63-
| `epidata[].forecast.year_weeks` | number of weeks in year | integer |
64-
| `epidata[].forecast.ili_bin_size` | float |
65-
| `epidata[].forecast.season_weeks` | number of weeks in season | integer |
66-
| `epidata[].forecast._version` | forecast version | integer |
69+
| `epidata[].forecast.data.<region>.<distrib>.dist` | probability distribution | array of float |
70+
| `epidata[].forecast.data.<region>.<distrib>.point` | point estimate | float |
71+
| `epidata[].forecast.data.<region>.<distrib>.none` | probability of "none" (if applicable) | float |
6772
| `epidata[].forecast.epiweek` | forecast epiweek | integer |
73+
| `epidata[].forecast.ili_bin_size` | size of ILI bins | float |
74+
| `epidata[].forecast.ili_bins` | number of ILI bins | integer |
75+
| `epidata[].forecast.name` | system name | string |
76+
| `epidata[].forecast.season` | season year (yyyy) | integer |
77+
| `epidata[].forecast.season_weeks` | number of weeks in season | integer |
78+
| `epidata[].forecast.year_weeks` | number of weeks in year | integer |
6879
| `message` | `success` or error message | string |
6980

7081
# Example URLs

‎docs/api/dengue_digital_surveillance.md‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,16 @@ permalink: api/dengue_sensors.html
99
# Dengue Digital Surveillance Sensors
1010
{: .no_toc}
1111

12-
* **Source name:** `dengue_sensors`
13-
* **Earliest issue available:** 2003w01
14-
<!-- TODO: * **Available for:** pr, vi (Puerto Rico, US Virgin Islands)...? -->
15-
* **Time type available:** epiweek
16-
* **License:** [CC BY](https://creativecommons.org/licenses/by/4.0/)
12+
13+
| Attribute | Details |
14+
| :--- | :--- |
15+
| **Source Name** | `dengue_sensors` |
16+
| **Data Source** | Various digital data streams |
17+
| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) <br> *Note: Data availability varies by country.* |
18+
| **Temporal Resolution** | Weekly (Epiweek) |
19+
| **Update Frequency** | Inactive - No longer updated |
20+
| **Earliest Date** | 2003w01 |
21+
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) |
1722

1823

1924
## Overview
@@ -46,9 +51,9 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
4651
| --- | --- | --- |
4752
| `auth` | password | string |
4853
| `epiweeks` | epiweeks | `list` of epiweeks |
49-
| `locations` | locations | `list` of location labels |
54+
| `name` | name | `list` of names (`ght`)<!--- TODO: (`ght`, ....)---> |
55+
| `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) |
5056

51-
<!-- TODO: | `name` | name | `list` of names | -->
5257

5358
## Response
5459

‎docs/api/dengue_nowcast.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,16 @@ nav_order: 2
88
# Delphi's Dengue Nowcast
99
{: .no_toc}
1010

11-
* **Source name:** `dengue_nowcast`
12-
* **Earliest issue available:** 2014w01
13-
<!-- TODO: * **Available for:** pr, vi (Puerto Rico, US Virgin Islands)...? -->
14-
* **Time type available:** epiweek
15-
* **License:** Open access
11+
12+
| Attribute | Details |
13+
| :--- | :--- |
14+
| **Source Name** | `dengue_nowcast` |
15+
| **Data Source** | [Delphi](https://delphi.cmu.edu/) |
16+
| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) <br> *Note: Data availability varies by country.* |
17+
| **Temporal Resolution** | Weekly (Epiweek) |
18+
| **Update Frequency** | Inactive - No longer updated |
19+
| **Earliest Date** | 2014w09 |
20+
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/ |
1621

1722

1823
## Overview
@@ -44,7 +49,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
4449
| Parameter | Description | Type |
4550
| --- | --- | --- |
4651
| `epiweeks` | epiweeks | `list` of epiweeks |
47-
| `locations` | locations | `list` of location labels |
52+
| `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) |
4853

4954
## Response
5055

‎docs/api/digital_surveillance_sensors.md‎

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ permalink: api/sensors.html
88

99
# Digital Surveillance Sensors
1010

11+
12+
| Attribute | Details |
13+
| :--- | :--- |
14+
| **Source Name** | `sensors` |
15+
| **Data Source** | Various digital data streams |
16+
| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) |
17+
| **Temporal Resolution** | Weekly (Epiweek) |
18+
| **Update Frequency** | Inactive - No longer updated |
19+
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) |
20+
21+
<!-- | **Earliest Date** | Variable | -->
22+
1123
This is the documentation of the API for accessing the Digital Surveillance Sensors (`sensors`) endpoint of
1224
the [Delphi](https://delphi.cmu.edu/)'s epidemiological data.
1325

@@ -18,12 +30,12 @@ General topics not specific to any particular endpoint are discussed in the
1830

1931
{: .note}
2032
> **Note:** this repository was built to support modelling and forecasting efforts
21-
surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic,
22-
syndromic surveillance data, like ILI data (influenza-like illness) through
23-
FluView, will likely prove very useful. However, **we urge caution to users
24-
examining the digital surveillance sensors**, like ILI Nearby, Google Flu
25-
Trends, etc., during the COVID-19 pandemic, because these were designed to track
26-
ILI as driven by seasonal influenza, and were NOT designed to track ILI during
33+
> surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic,
34+
> syndromic surveillance data, like ILI data (influenza-like illness) through
35+
> FluView, will likely prove very useful. However, **we urge caution to users
36+
> examining the digital surveillance sensors**, like ILI Nearby, Google Flu
37+
> Trends, etc., during the COVID-19 pandemic, because these were designed to track
38+
> ILI as driven by seasonal influenza, and were NOT designed to track ILI during
2739
the COVID-19 pandemic.
2840

2941

@@ -56,8 +68,6 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
5668

5769
## Response
5870

59-
<!-- TODO: fix -->
60-
6171
| Field | Description | Type |
6272
|----------------------|-----------------------------------------------------------------|------------------|
6373
| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer |

‎docs/api/ecdc_ili.md‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,16 @@ nav_order: 2
88
# ECDC ILI
99
{: .no_toc}
1010

11-
* **Source name:** `ecdc_ili`
12-
* **Earliest issue available:** 2003w40
13-
* **Regions available:** European countries (see [Geographic Codes](geographic_codes.html#european-countries))
14-
* **Time type available:** epiweek
15-
* **License:** Open access
11+
12+
| Attribute | Details |
13+
| :--- | :--- |
14+
| **Source Name** | `ecdc_ili` |
15+
| **Data Source** | [European Centre for Disease Prevention and Control (ECDC)](https://www.ecdc.europa.eu/en/home) |
16+
| **Geographic Coverage** | European countries (see [Geographic Codes](geographic_codes.html#european-countries)) |
17+
| **Temporal Resolution** | Weekly (Epiweek) |
18+
| **Update Frequency** | Weekly |
19+
| **Earliest Date** | 2018w40 |
20+
| **License** | Open Access |
1621

1722

1823
## Overview
@@ -43,10 +48,6 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
4348

4449
### Required
4550

46-
## Parameters
47-
48-
### Required
49-
5051
| Parameter | Description | Type |
5152
| --- | --- | --- |
5253
| `epiweeks` | epiweeks | `list` of epiweeks |
@@ -59,9 +60,10 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
5960
| `issues` | issues | `list` of epiweeks |
6061
| `lag` | # weeks between each epiweek and its issue | integer |
6162

62-
Notes:
63-
- If both `issues` and `lag` are specified, only `issues` is used.
64-
If neither is specified, the current issues are used.
63+
{: .note}
64+
> **Notes:**
65+
> - If both `issues` and `lag` are specified, only `issues` is used.
66+
> - If neither is specified, the current issues are used.
6567
6668
## Response
6769

0 commit comments

Comments
 (0)