Skip to content

Commit 19a3b8b

Browse files
krivardkrivard
committed
API docs: clarify terminology for first issue/first available
1 parent 5f216de commit 19a3b8b

File tree

15 files changed

+123
-123
lines changed

15 files changed

+123
-123
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 by Delphi:** 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 by Delphi:** 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 by Delphi:** 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: 31 additions & 31 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 by Delphi:** 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 by Delphi:** 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 by Delphi:** 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: 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:** `hhs`
11-
* **First issued by Delphi:** January 26, 2021
11+
* **Earliest issue available:** January 26, 2021
1212
* **Number of data revisions since 19 May 2020:** 0
1313
* **Date of last change:** Never
1414
* **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md))

‎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 by Delphi:** 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}

‎docs/api/covidcast-signals/indicator-combination.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ calculated or composed by Delphi. It is not a primary data source.
2020

2121
## Statistical Combination Signals
2222

23-
* **First issued by Delphi:** May 20, 2020
23+
* **Earliest issue available:** May 20, 2020
2424
* **Number of data revisions since May 19, 2020:** 1
2525
* **Date of last change:** [June 3, 2020](../covidcast_changelog.md#indicator-combination)
2626
* **Available for:** county, msa, state (see [geography coding docs](../covidcast_geography.md))
@@ -201,7 +201,7 @@ The resampling method for each input source is as follows:
201201

202202
## Compositional Signals: Confirmed Cases and Deaths
203203

204-
* **First issued by Delphi:** 7 July 2020
204+
* **Earliest issue available:** 7 July 2020
205205
* **Number of data revisions since 19 May 2020:** 1
206206
* **Date of last change:** [12 October 2020](../covidcast_changelog.md#indicator-combination)
207207
* **Available for:** county, msa, hrr, state (see [geography coding docs](../covidcast_geography.md))
@@ -215,11 +215,11 @@ backfill, and other limitations.
215215

216216
| Signal | 7-day average signal | Description |
217217
| --- | --- | --- |
218-
| `confirmed_cumulative_num` | `confirmed_7dav_cumulative_num` | Cumulative number of confirmed COVID-19 cases <br/> **First Available:** 2020-02-20 |
219-
| `confirmed_cumulative_prop` | `confirmed_7dav_cumulative_prop` | Cumulative number of confirmed COVID-19 cases per 100,000 population <br/> **First Available:** 2020-02-20 |
220-
| `confirmed_incidence_num` | `confirmed_7dav_incidence_num` | Number of new confirmed COVID-19 cases, daily <br/> **First Available:** 2020-02-20 |
221-
| `confirmed_incidence_prop` | `confirmed_7dav_incidence_prop` | Number of new confirmed COVID-19 cases per 100,000 population, daily <br/> **First Available:** 2020-02-20 |
222-
| `deaths_cumulative_num` | `deaths_7dav_cumulative_num` | Cumulative number of confirmed deaths due to COVID-19 <br/> **First Available:** 2020-02-20 |
223-
| `deaths_cumulative_prop` | `deaths_7dav_cumulative_prop` | Cumulative number of confirmed due to COVID-19, per 100,000 population <br/> **First Available:** 2020-02-20 |
224-
| `deaths_incidence_num` | `deaths_7dav_incidence_num` | Number of new confirmed deaths due to COVID-19, daily <br/> **First Available:** 2020-02-20 |
225-
| `deaths_incidence_prop` | `deaths_7dav_incidence_prop` | Number of new confirmed deaths due to COVID-19 per 100,000 population, daily <br/> **First Available:** 2020-02-20 |
218+
| `confirmed_cumulative_num` | `confirmed_7dav_cumulative_num` | Cumulative number of confirmed COVID-19 cases <br/> **Earliest date available:** 2020-02-20 |
219+
| `confirmed_cumulative_prop` | `confirmed_7dav_cumulative_prop` | Cumulative number of confirmed COVID-19 cases per 100,000 population <br/> **Earliest date available:** 2020-02-20 |
220+
| `confirmed_incidence_num` | `confirmed_7dav_incidence_num` | Number of new confirmed COVID-19 cases, daily <br/> **Earliest date available:** 2020-02-20 |
221+
| `confirmed_incidence_prop` | `confirmed_7dav_incidence_prop` | Number of new confirmed COVID-19 cases per 100,000 population, daily <br/> **Earliest date available:** 2020-02-20 |
222+
| `deaths_cumulative_num` | `deaths_7dav_cumulative_num` | Cumulative number of confirmed deaths due to COVID-19 <br/> **Earliest date available:** 2020-02-20 |
223+
| `deaths_cumulative_prop` | `deaths_7dav_cumulative_prop` | Cumulative number of confirmed due to COVID-19, per 100,000 population <br/> **Earliest date available:** 2020-02-20 |
224+
| `deaths_incidence_num` | `deaths_7dav_incidence_num` | Number of new confirmed deaths due to COVID-19, daily <br/> **Earliest date available:** 2020-02-20 |
225+
| `deaths_incidence_prop` | `deaths_7dav_incidence_prop` | Number of new confirmed deaths due to COVID-19 per 100,000 population, daily <br/> **Earliest date available:** 2020-02-20 |

0 commit comments

Comments
 (0)