COVID-19 Vaccination Status (CVS) Dataset#
1. Summary#
The information below is retrieved from the Health Data Gateway API developed by NHS England, with additional fields added by UK LLC (indicated by italics).
# define target dataset to document
schema = 'nhsd'
table = 'CVS'
version = 'v0002'
# import functions from script helper
import sys
script_fp = "../../../../scripts/"
sys.path.insert(0, script_fp)
from data_doc_helper import DocHelper
# create instance
document = DocHelper(schema, table, version, script_fp)
# markdown/code hybrid cell module requirement
from IPython.display import display, Markdown
# get api data
dataset = document.get_api_data()
display(Markdown("**NHS England title of dataset:** "+dataset['datasetfields']['datautility']['title']))
display(Markdown("***Dataset name in UK LLC TRE:*** *nhsd.CVS*"))
display(Markdown("**Short abstract:** "+dataset['datasetfields']['abstract']))
display(Markdown("***Extended abstract:*** *The CVS dataset includes anyone vaccinated within England and anyone vaccinated in a devolved administration where this information is subsequently passed to England. The source of all vaccination data is the National Immunisation Management System (NIMS) database.The CVS dataset records individual vaccination events. Data collected include demographic information, vaccination details and vaccine batch details. For a full list of variables see the [NHS England Metadata dashboard.](https://digital.nhs.uk/services/data-access-request-service-dars/dars-products-and-services/metadata-dashboard)*"))
display(Markdown("**Geographical coverage:** "+dataset['datasetfields']['geographicCoverage'][0]))
display(Markdown("**Temporal coverage:** "+dataset['datasetfields']['datasetStartDate']))
display(Markdown("***Data available in UK LLC TRE from:*** *08/12/2020 onwards*"))
display(Markdown("**Typical age range:** "+dataset['datasetfields']['ageBand']))
display(Markdown("**Collection situation:** "+dataset['datasetv2']['provenance']['origin']['collectionSituation'][0]))
display(Markdown("**Purpose:** "+dataset['datasetv2']['provenance']['origin']['purpose'][0]))
display(Markdown("**Source:** "+dataset['datasetv2']['provenance']['origin']['source'][0]))
display(Markdown("**Pathway:** "+dataset['datasetv2']['coverage']['pathway']))
display(Markdown("***Information collected:*** *Demographic information, vaccination and vaccine batch details.*"))
display(Markdown("***Structure of dataset:*** *Each line represents one participant.*"))
display(Markdown("***Update frequency in UK LLC TRE:*** *Quarterly*"))
display(Markdown("***Dataset versions in UK LLC TRE:*** *TBC*"))
display(Markdown("***Data quality issues:*** *TBC*"))
display(Markdown("***Restrictions to data usage***: *Research must be related to COVID-19 and be for medical purposes only (medical research) as defined in the NHS Act 2006: [https://www.legislation.gov.uk/ukpga/2006/41/part/13/crossheading/patient-information](https://www.legislation.gov.uk/ukpga/2006/41/part/13/crossheading/patient-information)*"))
display(Markdown("**Further information:** [https://digital.nhs.uk/services/data-access-request-service-dars/dars-products-and-services/data-set-catalogue/covid-19-vaccination-status](https://digital.nhs.uk/services/data-access-request-service-dars/dars-products-and-services/data-set-catalogue/covid-19-vaccination-status)"))
NHS England title of dataset: COVID-19 Vaccination Status
Dataset name in UK LLC TRE: nhsd.CVS
Short abstract: Data relating to coronavirus (COVID-19) vaccination status.
Extended abstract: The CVS dataset includes anyone vaccinated within England and anyone vaccinated in a devolved administration where this information is subsequently passed to England. The source of all vaccination data is the National Immunisation Management System (NIMS) database.The CVS dataset records individual vaccination events. Data collected include demographic information, vaccination details and vaccine batch details. For a full list of variables see the NHS England Metadata dashboard.
Geographical coverage: United Kingdom,England
Temporal coverage: 08/12/2020
Data available in UK LLC TRE from: 08/12/2020 onwards
Typical age range: 16-150
Collection situation: PRIMARY CARE
Purpose: CARE
Source: EPR
Pathway: NOT APPLICABLE
Information collected: Demographic information, vaccination and vaccine batch details.
Structure of dataset: Each line represents one participant.
Update frequency in UK LLC TRE: Quarterly
Dataset versions in UK LLC TRE: TBC
Data quality issues: TBC
Restrictions to data usage: Research must be related to COVID-19 and be for medical purposes only (medical research) as defined in the NHS Act 2006: https://www.legislation.gov.uk/ukpga/2006/41/part/13/crossheading/patient-information
Further information: https://digital.nhs.uk/services/data-access-request-service-dars/dars-products-and-services/data-set-catalogue/covid-19-vaccination-status
2. Metrics#
The tables below summarise the CVS dataset in the UK LLC TRE.
Table 1 The number of participants from each LPS that are represented in the CVS dataset in the UK LLC TRE
(Note: numbers relate to the most recent extract of NHS England data)
gb_cohort = document.get_cohort_count()
print(gb_cohort.to_markdown(index=False, tablefmt="fancy_grid"))
╒══════════╤═════════╕
│ cohort │ count │
╞══════════╪═════════╡
│ total │ 0 │
╘══════════╧═════════╛
3. Helpful syntax#
Below we will include syntax that may be helpful to other researchers in the UK LLC TRE. For longer scripts, we will include a snippet of the code plus a link to Git where you can find the full script.