Skip to content

Commit e39992f

Browse files
krivardkrivard
authored
Merge pull request #344 from cmu-delphi/hhs-covidcast
API docs: initial add of HHS COVIDcast source
2 parents 366cd36 + ed577e8 commit e39992f

16 files changed

+225
-124
lines changed

‎docs/api/covidcast-signals/_source-template.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ grand_parent: COVIDcast Epidata API
88
{: .no_toc}
99

1010
* **Source name:** `SOURCE-API-NAME`
11-
* **First issued:** DATE RELEASED TO API
11+
* **Earliest issue available:** DATE RELEASED TO API
1212
* **Number of data revisions since 19 May 2020:** 0
1313
* **Date of last change:** Never
1414
* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))

‎docs/api/covidcast-signals/chng.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ grand_parent: COVIDcast Epidata API
88
{: .no_toc}
99

1010
* **Source name:** `chng`
11-
* **First issued:** November 4, 2020
11+
* **Earliest issue available:** November 4, 2020
1212
* **Number of data revisions since May 19, 2020:** 0
1313
* **Date of last change:** Never
1414
* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))
@@ -27,10 +27,10 @@ commercial purposes.
2727

2828
| Signal | Description |
2929
| --- | --- |
30-
| `smoothed_outpatient_covid` | Estimated percentage of outpatient doctor visits with confirmed COVID-19, based on Change Healthcare claims data that has been de-identified in accordance with HIPAA privacy regulations, smoothed in time using a Gaussian linear smoother <br/> **First Available:** 2020-02-01 |
31-
| `smoothed_adj_outpatient_covid` | Same, but with systematic day-of-week effects removed; see [details below](#day-of-week-adjustment) <br/> **First Available:** 2020-02-01 |
32-
| `smoothed_outpatient_cli` | Estimated percentage of outpatient doctor visits primarily about COVID-related symptoms, based on Change Healthcare claims data that has been de-identified in accordance with HIPAA privacy regulations, smoothed in time using a Gaussian linear smoother <br/> **First Available:** 2020-02-01 |
33-
| `smoothed_adj_outpatient_cli` | Same, but with systematic day-of-week effects removed; see [details below](#day-of-week-adjustment) <br/> **First Available:** 2020-02-01 |
30+
| `smoothed_outpatient_covid` | Estimated percentage of outpatient doctor visits with confirmed COVID-19, based on Change Healthcare claims data that has been de-identified in accordance with HIPAA privacy regulations, smoothed in time using a Gaussian linear smoother <br/> **Earliest date available:** 2020-02-01 |
31+
| `smoothed_adj_outpatient_covid` | Same, but with systematic day-of-week effects removed; see [details below](#day-of-week-adjustment) <br/> **Earliest date available:** 2020-02-01 |
32+
| `smoothed_outpatient_cli` | Estimated percentage of outpatient doctor visits primarily about COVID-related symptoms, based on Change Healthcare claims data that has been de-identified in accordance with HIPAA privacy regulations, smoothed in time using a Gaussian linear smoother <br/> **Earliest date available:** 2020-02-01 |
33+
| `smoothed_adj_outpatient_cli` | Same, but with systematic day-of-week effects removed; see [details below](#day-of-week-adjustment) <br/> **Earliest date available:** 2020-02-01 |
3434

3535
## Table of Contents
3636
{: .no_toc .text-delta}

‎docs/api/covidcast-signals/doctor-visits.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ grand_parent: COVIDcast Epidata API
88
{: .no_toc}
99

1010
* **Source name:** `doctor-visits`
11-
* **First issued:** April 29, 2020
11+
* **Earliest issue available:** April 29, 2020
1212
* **Number of data revisions since May 19, 2020:** 1
1313
* **Date of last change:** November 9, 2020
1414
* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))
@@ -24,8 +24,8 @@ percentage of COVID-related doctor's visits in a given location, on a given day.
2424

2525
| Signal | Description |
2626
| --- | --- |
27-
| `smoothed_cli` | Estimated percentage of outpatient doctor visits primarily about COVID-related symptoms, based on data from health system partners, smoothed in time using a Gaussian linear smoother <br/> **First Available:** 2020-02-01 |
28-
| `smoothed_adj_cli` | Same, but with systematic day-of-week effects removed; see [details below](#day-of-week-adjustment) <br/> **First Available:** 2020-02-01 |
27+
| `smoothed_cli` | Estimated percentage of outpatient doctor visits primarily about COVID-related symptoms, based on data from health system partners, smoothed in time using a Gaussian linear smoother <br/> **Earliest date available:** 2020-02-01 |
28+
| `smoothed_adj_cli` | Same, but with systematic day-of-week effects removed; see [details below](#day-of-week-adjustment) <br/> **Earliest date available:** 2020-02-01 |
2929

3030
## Table of Contents
3131
{: .no_toc .text-delta}

‎docs/api/covidcast-signals/fb-survey.md‎

Lines changed: 33 additions & 33 deletions
Large diffs are not rendered by default.

‎docs/api/covidcast-signals/ght.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ grand_parent: COVIDcast Epidata API
88
{: .no_toc}
99

1010
* **Source name:** `ght`
11-
* **First issued:** April 29, 2020
11+
* **Earliest issue available:** April 29, 2020
1212
* **Number of data revisions since May 19, 2020:** 0
1313
* **Date of last change:** Never
1414
* **Available for:** dma, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))
@@ -24,8 +24,8 @@ numbers of COVID-related searches.
2424

2525
| Signal | Description |
2626
| --- | --- |
27-
| `raw_search` | Google search volume for COVID-related searches, in arbitrary units that are normalized for population <br/> **First Available:** 2020-02-01 |
28-
| `smoothed_search` | Google search volume for COVID-related searches, in arbitrary units that are normalized for population, smoothed in time as [described below](#smoothing) <br/> **First Available:** 2020-02-01 |
27+
| `raw_search` | Google search volume for COVID-related searches, in arbitrary units that are normalized for population <br/> **Earliest date available:** 2020-02-01 |
28+
| `smoothed_search` | Google search volume for COVID-related searches, in arbitrary units that are normalized for population, smoothed in time as [described below](#smoothing) <br/> **Earliest date available:** 2020-02-01 |
2929

3030
## Table of Contents
3131
{: .no_toc .text-delta}

‎docs/api/covidcast-signals/google-survey.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ grand_parent: COVIDcast Epidata API
88
{: .no_toc}
99

1010
* **Source name:** `google-survey`
11-
* **First issued:** April 29, 2020
11+
* **Earliest issue available:** April 29, 2020
1212
* **Number of data revisions since May 19, 2020:** 0
1313
* **Date of last change:** Never
1414
* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))
@@ -40,8 +40,8 @@ specific geographical areas as needed to support forecasting efforts.
4040

4141
| Signal | Description |
4242
| --- | --- |
43-
| `raw_cli` | Estimated percentage of people who know someone in their community with COVID-like illness <br/> **First Available:** 2020-04-11 |
44-
| `smoothed_cli` | Estimated percentage of people who know someone in their community with COVID-like illness, smoothed in time [as described below](#smoothing) <br/> **First Available:** 2020-04-11 |
43+
| `raw_cli` | Estimated percentage of people who know someone in their community with COVID-like illness <br/> **Earliest date available:** 2020-04-11 |
44+
| `smoothed_cli` | Estimated percentage of people who know someone in their community with COVID-like illness, smoothed in time [as described below](#smoothing) <br/> **Earliest date available:** 2020-04-11 |
4545

4646
## Table of Contents
4747
{: .no_toc .text-delta}

‎docs/api/covidcast-signals/google-symptoms.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ grand_parent: COVIDcast Epidata API
88
{: .no_toc}
99

1010
* **Source name:** `google-symptoms`
11-
* **First issued:** November 30, 2020
11+
* **Earliest issue available:** November 30, 2020
1212
* **Number of data revisions since May 19, 2020:** 0
1313
* **Date of last change:** Never
1414
* **Available for:** county, MSA, HRR, state (see [geography coding docs](../covidcast_geography.md))
@@ -30,12 +30,12 @@ increased releative popularity of symptom-related searches.
3030

3131
| Signal | Description |
3232
| --- | --- |
33-
| `anosmia_raw_search` | Google search volume for anosmia-related searches, in arbitrary units that are normalized for overall search users <br/> **First Available:** 2020-02-13 |
34-
| `anosmia_smoothed_search` | Google search volume for anosmia-related searches, in arbitrary units that are normalized for overall search users, smoothed by 7-day average <br/> **First Available:** 2020-02-20 |
35-
| `ageusia_raw_search` | Google search volume for ageusia-related searches, in arbitrary units that are normalized for overall search users <br/> **First Available:** 2020-02-13 |
36-
| `ageusia_smoothed_search` | Google search volume for ageusia-related searches, in arbitrary units that are normalized for overall search users, smoothed by 7-day average <br/> **First Available:** 2020-02-20 |
37-
| `sum_anosmia_ageusia_raw_search` | The sum of Google search volume for anosmia and ageusia related searches, in an arbitrary units that are normalized for overall search users <br/> **First Available:** 2020-02-13 |
38-
| `sum_anosmia_ageusia_smoothed_search` | The sum of Google search volume for anosmia and ageusia related searches, in an arbitrary units that are normalized for overall search users, smoothed by 7-day average <br/> **First Available:** 2020-02-20 |
33+
| `anosmia_raw_search` | Google search volume for anosmia-related searches, in arbitrary units that are normalized for overall search users <br/> **Earliest date available:** 2020-02-13 |
34+
| `anosmia_smoothed_search` | Google search volume for anosmia-related searches, in arbitrary units that are normalized for overall search users, smoothed by 7-day average <br/> **Earliest date available:** 2020-02-20 |
35+
| `ageusia_raw_search` | Google search volume for ageusia-related searches, in arbitrary units that are normalized for overall search users <br/> **Earliest date available:** 2020-02-13 |
36+
| `ageusia_smoothed_search` | Google search volume for ageusia-related searches, in arbitrary units that are normalized for overall search users, smoothed by 7-day average <br/> **Earliest date available:** 2020-02-20 |
37+
| `sum_anosmia_ageusia_raw_search` | The sum of Google search volume for anosmia and ageusia related searches, in an arbitrary units that are normalized for overall search users <br/> **Earliest date available:** 2020-02-13 |
38+
| `sum_anosmia_ageusia_smoothed_search` | The sum of Google search volume for anosmia and ageusia related searches, in an arbitrary units that are normalized for overall search users, smoothed by 7-day average <br/> **Earliest date available:** 2020-02-20 |
3939

4040

4141
## Table of Contents

‎docs/api/covidcast-signals/hhs.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: Department of Health & Human Services
3+
parent: Data Sources and Signals
4+
grand_parent: COVIDcast Epidata API
5+
---
6+
7+
# Department of Health & Human Services
8+
{: .no_toc}
9+
10+
* **Source name:** `hhs`
11+
* **Earliest issue available:** November 16, 2020
12+
* **Number of data revisions since 19 May 2020:** 0
13+
* **Date of last change:** Never
14+
* **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md))
15+
* **Time type:** day (see [date format docs](../covidcast_times.md))
16+
* **License:** [Open Data Commons Open Database License (ODbL)](https://opendatacommons.org/licenses/odbl/1-0/)
17+
18+
The U.S. Department of Health & Human Services (HHS) publishes several
19+
datasets on patient impact and hospital capacity. One of these
20+
datasets is mirrored in Epidata at the following endpoint:
21+
22+
* [COVID-19 Hospitalization: States](../covid_hosp.md) - daily resolution, state aggregates
23+
24+
That dataset contains dozens of columns that break down hospital
25+
resource usage in different ways.
26+
27+
This indicator makes available several commonly-used combinations of
28+
those columns, aggregated geographically. In particular, we include
29+
the sum of all adult and pediatric COVID-19 hospital admissions. This
30+
sum is used as the "ground truth" for hospitalizations by the [COVID-19
31+
Forecast Hub](https://github.com/reichlab/covid19-forecast-hub/blob/master/data-processed/README.md#hospitalizations).
32+
33+
34+
| Signal | Geography | Resolution | Description |
35+
| --- | --- | --- | --- |
36+
| `confirmed_admissions_covid_1d` | state | 1 day | Sum of adult and pediatric confirmed COVID-19 hospital admissions occurring each day. <br/> **Earliest date available:** 2019-12-31 |
37+
| `sum_confirmed_suspected_admissions_covid_1d` | state | 1 day | Sum of adult and pediatric confirmed and suspected COVID-19 hospital admissions occurring each day. <br/> **Earliest date available:** 2019-12-31 |
38+
39+
## Table of contents
40+
{: .no_toc .text-delta}
41+
42+
1. TOC
43+
{:toc}
44+
45+
## Estimation
46+
47+
### Statewise, daily resolution
48+
49+
Statewise daily resolution signals use the following four columns from
50+
the HHS state timeseries dataset:
51+
52+
* `previous_day_admission_[adult|pediatric]_covid_[confirmed|suspected]`
53+
54+
The `confirmed` signal is the sum of the two `confirmed` columns:
55+
56+
* adult
57+
* pediatric
58+
59+
The `sum_confirmed_suspected` signal is the sum of all four columns:
60+
61+
* adult confirmed
62+
* adult suspected
63+
* pediatric confirmed
64+
* pediatric suspected
65+
66+
The source data specifies that admissions occurred on the previous
67+
day. We automatically adjust the date of each result so that
68+
admissions are incident on that date.
69+
70+
## Limitations
71+
72+
HHS collects data from state and territorial health departments about many, but
73+
not all, hospitals in the U.S. Notably excluded from this dataset are
74+
psychiatric and rehabilitation facilities, Indian Health Service (IHS)
75+
facilities, U.S. Department of Veterans Affairs (VA) facilities, Defense Health
76+
Agency (DHA) facilities, and religious non-medical facilities.
77+
78+
## Lag and Backfill
79+
80+
HHS issues updates to this timeseries once a week, and occasionally more
81+
often. We check for updates daily. Lag varies from 0 to 6 days.
82+
83+
Occasionally a value published in an early issue will be changed in a subsequent
84+
issue when additional data becomes known. This effect is known as
85+
backfill. Backfill is relatively uncommon in this dataset (80% of dates from
86+
November 1, 2020 onward are never touched after their first issue) and most such
87+
updates occur one to two weeks after information about a date is first
88+
published. In rare instances, a value may be updated 10 weeks or more after it
89+
is first published.
90+
91+
## Source and Licensing
92+
93+
This indicator mirrors and lightly aggregates data originally
94+
published by the U.S. Department of Health & Human Services under an
95+
[Open Data Commons Open Database License
96+
(ODbL)](https://opendatacommons.org/licenses/odbl/1-0/). The ODbL
97+
permits sharing, transformation, and redistribution of data or derived
98+
works so long as all public uses are distributed under the ODbL and
99+
attributed to the source. For more details, consult the official
100+
license text.

‎docs/api/covidcast-signals/hospital-admissions.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ grand_parent: COVIDcast Epidata API
88
{: .no_toc}
99

1010
* **Source name:** `hospital-admissions`
11-
* **First issued:** June 21, 2020
11+
* **Earliest issue available:** June 21, 2020
1212
* **Number of data revisions since May 19, 2020:** 1
1313
* **Date of last change:** October 20, 2020
1414
* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))
@@ -24,10 +24,10 @@ COVID-associated diagnosis code in a given location, on a given day.
2424

2525
| Signal | Description |
2626
| --- | --- |
27-
| `smoothed_covid19_from_claims` | Estimated percentage of new hospital admissions with COVID-associated diagnoses, based on claims data from health system partners, smoothed in time using a Gaussian linear smoother <br/> **First Available:** 2020-02-01 |
28-
| `smoothed_adj_covid19_from_claims` | Same as `smoothed_covid19_from_claims`, but with systematic day-of-week effects removed using [the same mechanism as in `doctor-visits`](doctor-visits.md#day-of-week-adjustment) <br/> **First Available:** 2020-02-01 |
29-
| `smoothed_covid19` | Estimated percentage of new hospital admissions with COVID-associated diagnoses, based on electronic medical record and claims data from health system partners, smoothed in time using a Gaussian linear smoother. _This signal is no longer updated as of 1 October, 2020._ <br/> **First Available:** 2020-02-01 |
30-
| `smoothed_adj_covid19` | Same as `smoothed_covid19`, but with systematic day-of-week effects removed using [the same mechanism as in `doctor-visits`](doctor-visits.md#day-of-week-adjustment). _This signal is no longer updated as of 1 October, 2020._ <br/> **First Available:** 2020-02-01 |
27+
| `smoothed_covid19_from_claims` | Estimated percentage of new hospital admissions with COVID-associated diagnoses, based on claims data from health system partners, smoothed in time using a Gaussian linear smoother <br/> **Earliest date available:** 2020-02-01 |
28+
| `smoothed_adj_covid19_from_claims` | Same as `smoothed_covid19_from_claims`, but with systematic day-of-week effects removed using [the same mechanism as in `doctor-visits`](doctor-visits.md#day-of-week-adjustment) <br/> **Earliest date available:** 2020-02-01 |
29+
| `smoothed_covid19` | Estimated percentage of new hospital admissions with COVID-associated diagnoses, based on electronic medical record and claims data from health system partners, smoothed in time using a Gaussian linear smoother. _This signal is no longer updated as of 1 October, 2020._ <br/> **Earliest date available:** 2020-02-01 |
30+
| `smoothed_adj_covid19` | Same as `smoothed_covid19`, but with systematic day-of-week effects removed using [the same mechanism as in `doctor-visits`](doctor-visits.md#day-of-week-adjustment). _This signal is no longer updated as of 1 October, 2020._ <br/> **Earliest date available:** 2020-02-01 |
3131

3232
## Table of Contents
3333
{: .no_toc .text-delta}

0 commit comments

Comments
 (0)