Data structure changes (to be deployed in the course of calendar week 2/2022)

[andreasamsler]

Advance notice: The OGD resources of the Department of Health of the Canton of Zurich on the vaccination campaign in the Canton of Zurich (https://github.com/openZH/covid_19_vaccination_campaign_ZH#readme) will undergo adjustments in the course of the beginning of calendar week 2/2022: both data structure and variables, as well as access URLs of the four resources.

The adjustments are described hereunder.

Please enter your questions and feedback here as comments; thank you very much!

1. COVID19_Impfungen_pro_Datum_Altersklasse_Geschlecht

Data structure and variables
Please prepare to switch from current structure and variables:
| date | ageclass | gender | ncumul_firstvacc | ncumul_secondvacc |
to NEW structure and variables:
| date | ageclass | gender | vacc_status | vacc_stage | nCumul |
| .. | .. | .. | 'atLeastOneDose' OR 'fullProtection' OR 'booster' | 'basicImmu' OR 'refresher' | [Number] |

Data access
Please prepare to switch from current Access URL: https://raw.githubusercontent.com/openZH/covid_19_vaccination_campaign_ZH/master/COVID19_Impfungen_pro_Datum_Altersklasse_Geschlecht.csv
to NEW Access URL: https://raw.githubusercontent.com/openZH/covid_19_vaccination_campaign_ZH/master/COVID19_Impfungen_pro_Datum_Altersklasse_Geschlecht_v2.csv

2. COVID19_Impfungen_pro_Woche_Alter_in_KTZH_wohnhaft

Data structure and variables
Please prepare to switch from current structure and variables:
| week_from | week_until | calendar_week | age | ncumul_firstvacc | ncumul_secondvacc |
to NEW structure and variables:
| week_from | week_until | calendar_week | age | vacc_status | vacc_stage | nCumul |
| .. | .. | .. | .. | 'atLeastOneDose' OR 'fullProtection' OR 'booster' | 'basicImmu' OR 'refresher' | [Number] |

Data access
Please prepare to switch from current Access URL: https://raw.githubusercontent.com/openZH/covid_19_vaccination_campaign_ZH/master/COVID19_Impfungen_pro_Woche_Alter_in_KTZH_wohnhaft.csv
to NEW Access URL: https://raw.githubusercontent.com/openZH/covid_19_vaccination_campaign_ZH/master/COVID19_Impfungen_pro_Woche_Alter_in_KTZH_wohnhaft_v2.csv

3. COVID19_Impfungen_pro_Woche_PLZ

Data structure and variables
Please prepare to switch from current structure and variables:
| week_from | week_until | calendar_week | plz | population | ncumul_firstvacc | ncumul_secondvacc |
to NEW structure and variables:
| week_from | week_until | calendar_week | plz | vacc_status | vacc_stage | nCumul | population |
| .. | .. | .. | .. | 'atLeastOneDose' OR 'fullProtection' OR 'booster' | 'basicImmu' OR 'refresher' | [Number] | .. |

Data access
Please prepare to switch from current Access URL: https://raw.githubusercontent.com/openZH/covid_19_vaccination_campaign_ZH/master/COVID19_Impfungen_pro_Woche_PLZ.csv
to NEW Access URL: https://raw.githubusercontent.com/openZH/covid_19_vaccination_campaign_ZH/master/COVID19_Impfungen_pro_Woche_PLZ_v2.csv

4. COVID19_Impfungen_pro_Woche_Wohnsitz

Data structure and variables
Please prepare to switch from current structure and variables:
| week_from | week_until | calendar_week | bfsNumber | residence | ncumul_firstvacc | ncumul_secondvacc |
to NEW structure and variables:
| week_from | week_until | calendar_week | bfsNumber | residence | vacc_status | vacc_stage | nCumul |
| .. | .. | .. | .. | .. | 'atLeastOneDose' OR 'fullProtection' OR 'booster' | 'basicImmu' OR 'refresher' | [Number] |

Data access
Please prepare to switch from current Access URL: https://raw.githubusercontent.com/openZH/covid_19_vaccination_campaign_ZH/master/COVID19_Impfungen_pro_Woche_Wohnsitz.csv
to NEW Access URL: https://raw.githubusercontent.com/openZH/covid_19_vaccination_campaign_ZH/master/COVID19_Impfungen_pro_Woche_Wohnsitz_v2.csv

[rsalzer]

Could you please elaborate whats the difference between vacc_status and vacc_stage?
vacc_status can have the values: 'atLeastOneDose' OR 'fullProtection' OR 'booster'
and vacc_state: 'basicImmu' OR 'refresher'

Is the vacc_status 'atLeastOneDose' and 'fullProtection' not always 'basicImmu' while 'booster' responds to 'refresher'?
Or why is there a necessity to have two as it seems redundant fields?

[andreasamsler]

Thanks @rsalzer for your question. We are happy to share the background of the challenge and the chosen solution.

Up to now the ZH vaccination campaign data have simply shown 1st and 2nd vaccinations. But with the introduction of the Jannsen vaccine (Johnson & Johnson), where only one dose is needed, the possibility for a convalescent to be vaccinated only once for full vaccination protection, and with booster vaccinations, we are not in a position with the current OGD variables to map the relevant vaccination occurrence.

Therefore, the Departement of Health ZH with our consulting has decided to change the format of the OGD resources: The data are now presented in long format. This means that any number of vaccinations can be reported without having to create new variables. In addition, the first and second vaccinations are no longer shown, but instead:

vacc_type (=type of vaccination)

• "atLeastOneDose" (=at least one vaccination)
• "fullProtection" (=full vaccination protection: currently either J&J vaccination with one dose or two doses of mRNA vaccination or one dose of mRNA & recovered)
• "booster" (=booster vaccination)

vacc_stage

• "bascImmu" (=basic immunisation)
• "refresher" (=booster)

nCumul

• Cumulative number of persons

HTH, aam

[amslera]

The term "fullProtection" would probably have to be reconsidered. We are still thinking about it.

[rsalzer]

Thank you for the explanation, Andreas.
One question remains: Why do you need both fields (vacc_type and vacc_stage)? atLeastOneDose and fullProtection are always basicImmu and booster is always refresher. The vacc_stage-field therefore seems obsolete. What am I missing?

[andreasamsler]

Valid question, indeed, @rsalzer. Conceptually, the difference is that 'vacc_type' is defined as an integer variable (for the time being with three stages) while 'vacc_stage' is defined as a boolean variable. We will clarify this in the documentation, thank you.

[gmacauda]

Thanks a lot for your input.

After thinking about it, the vacc_stage variable is indeed obsolete.

Initially, we had the idea of presentig vacc_status as an integer variable (number of doses) as Andreas mentioned and having a second variable (vacc_stage) that would help to differentiate a second dose belonging to the basic immunisation from a second dose representing a refreseher.

However, now that vacc_status is a factor/string variable, vacc_stage has become obsolete. We will work on the structure.

We will keep you updated

[andreasamsler]

Many thanks für your feedback (.cc @rsalzer). The originally announced adjustments (#8 (comment)) will undergo the following changes:

• "vacc_stage" variable will be removed
• "vacc_status": "fullProtection" will be renamed to "completedBasicImmu"