CDC COVID-19 Vaccine Reporting Specifications (CVRS) Version 3 Instructions

Related Pages

This specification defines the COVID-19 vaccination reporting requirements to the Centers for Disease Control and Prevention’s (CDC) Immunization Data Clearinghouse (DCH). Whenever possible, existing and new connections between provider organizations and immunization information systems (IISs) should be leveraged to report vaccinations directly to IISs. This specification addresses how IISs will report these data to CDC’s DCH, as well as how provider organizations that are unable to report to IISs can still report to CDC’s DCH to ensure a comprehensive accounting of administered doses of COVID-19 vaccine.

The COVID-19 Vaccination Reporting Specification (CVRS) provides requirements for three data models: redacted, identified, and Privacy-Preserving Record Linkage (PPRL). Each data model is represented by a tab in the CVRS (“Redacted Extract Fields”, “Identified Extract Fields”, and “PPRL Extract Fields”) that specifies the submission requirements for the 45 data elements contained within. Currently, submitters may submit data according to the data model of their choosing to the DCH, however, use of the PPRL data model is encouraged. If interested in switching data models (e.g., from “Redacted” to “Identified”), please inform the CDC before doing so.

Each data model allows for the submission of either redacted case-level data, “Redacted Extract” and “PPRL” data models, or identified case-level data, “Identified” data model. All data models are the same file format but vary in what identifying information is provided.

Further, the CVRS allows for submission of two different types of events: (1) vaccination events and (2) vaccine refusals. Each has unique requirements and is defined in the “Redacted Extract Fields,” “Identified Extract Fields,” and “PPRL Extract Fields” tabs. Only vaccination events are required to be reported at this time. CDC understands that not all IISs collect data about comorbidities or serology. When these data are not collected by the IIS, the values for these variables must be reported as “unknown.” It is also understood that an IIS may not have information about refusals. Information on comorbidities, serology, and vaccine refusals are only required to be reported if and when available.

Data Conventions

  1. All data shall be output to the extract file as UTF-8 encoded text strings without change.
  2. Fields in the extract file shall be separated by a tab character.
    NOTE: It is possible for some extracted data elements to contain one or more-tab (ASCII 09) characters. In such instances, any tab characters appearing in data elements shall be mapped to space (ASCII 32) characters in the extract file.
  3. Files can be new-line terminated or carriage-return new-line terminated.
  4. The first line must be a header row containing all variable names, even if data will not be sent in for those variables.
  5. Three data types are used in the extract specification:
    • String: Free text fields
    • Date: Formatted YYYY-MM-DD or YYYY-MM
    • Coded Value: A selection of predefined values.
      NOTE: Many coded values are from HL7, with some extensions to support unknown and local law/policy restrictions.
  6. Field-level data population requirements are defined in the extract specification spreadsheet using the following language:
    • Required: These fields must have a value. Without a value, these records will not be accepted by the DCH. For deidentified reporting, some fields default to “Redacted.” In coded values, codes have been provided to accommodate local law/policy restrictions or unknown values.
    • Required if known: These fields must be populated if the value is known, but if the field value is unknown, then the field may not be populated. Regardless of data population, submitting entities must be able to record and submit this information in their systems. Do not populate: There are conditional situations where it does not make sense to populate a field (e.g., a lot number for a vaccine refusal). In these cases, the expectation is that the field is left empty, but still represented in the extract (i.e., do not skip the field in the extract).
  7. Data are not case-sensitive.

Extract File Conventions

  1. Each day a single file will be extracted and sent to CDC’s DCH.
  2. The extract file shall be named using the format yyyymmdd_NN_AAA_Z.txt:
    • yyyy = 4-digit year
    • mm = 2-digit month
    • dd = 2-digit day of month
    • _NN = sequential count of file for given day (e.g., 01, 02). This will likely always be 01.
    • _AAA = awardee or submitting entity 3-character code. These codes are listed on the “Submitting Entity Codes” tab.
    • _Z = abbreviation of whether the file contains additions (A), updates (U), or deletes (D).

The date portion of the file name should represent the date being reported, not necessarily the date the extract was run.

  1. Individual extract files must not exceed 200,000 records. Data submissions over 200,000 records must be broken into subsequent files.

Daily Extract Criteria for COVID-19 Vaccines

Inclusion Criteria

  1. Each extract shall include one specific day of COVID-19 vaccine data.
  2. Each extract shall include all newly created vaccination events or refusals for the day.
  3. IISs shall include records even if the patient address is outside of their jurisdiction.
  4. Patients who have more than one event in a single day (e.g., a refusal and a vaccination event) will have two records (lines) in the extract file.
  5. Include both administered and historical vaccines unless the vaccination event is a confirmed duplicate.

Exclusion Criteria

  1. Do NOT include newly created COVID-19 vaccination events that have been provided to the IIS from another originating jurisdiction (IIS) (e.g., through the IZ Gateway or other sharing arrangements).
    NOTE: This does not include pharmacy data. Please submit ALL pharmacy data received.

Extract Timing

  1. Reporting time period: 12:00 am to 11:59 pm.
  2. Deadline for submission: 12:00 pm local time the following day (e.g., 12 hours after the close of the reporting period). This includes holidays and weekends.
    NOTE: Batch processing may be submitted the morning of the following day (e.g., prior to 12:00 pm local time the following day) to allow for nightly calculations or data quality checks to be completed prior to extract and submission to CDC’s DCH.
    NOTE: If no doses are administered on a given day, a CVRS file that includes a header row with no data in the rows beneath the header row MUST be submitted to the DCH.
Top of Page
Page last reviewed: October 12, 2021
Content source: National Center for Immunization and Respiratory Diseases