Skip to content

Examples & Templates

This section provides templates, examples, and reference materials to help you prepare and submit data.

Data Templates

CSV Submission Template

The standard template for submitting disease tracking data:

📄 disease_tracking_report_{jurisdiction}_{report_date}.csv

This template includes:

  • All required column headers
  • Placeholder values showing the expected format
  • Comments explaining each field

Jurisdiction Metadata Template

The template for submitting required metadata about your jurisdiction's data:

📄 disease-tracking-metadata-{jurisdiction}.yaml

This template includes:

  • Date classification method (CCCD or custom hierarchy)
  • Geographic units and their relationships
  • Data suppression policies and rules
  • Contact information for technical and data quality questions

When using this template, rename it with your jurisdiction's two-letter abbreviation (e.g., disease-tracking-metadata-WA.yaml).

Example Data File

A complete example showing simulated data that reflect what submitted data would look like:

📄 disease_tracking_report_CA-SIMULATED-EXAMPLE_2026-02-09.csv

This example demonstrates:

  • Proper formatting for each field
  • Multiple disease entries
  • Different stratification levels
  • Age group and demographic data
  • Suppressed data handling

Note: These data were generated from available data at the state-level from NNDSS, with age and county counts simulated using population size to define probability sampling.

Example Juridiction Geographies File

An example format for sharing sub-jurisdiction geographies, particularly for jurisdictions reporting sub-jurisdiction geographies other than county:

📄 Jurisdiction specification example

This example demonstrates:

  • Proper formatting for each field
  • Combination of counties into a region geography

Reference Materials

Data Dictionary

The comprehensive data dictionary defines all fields and their valid values:

📄 disease_tracking_data_dictionary.csv

The data dictionary includes:

  • Field names and descriptions
  • Data types and formats
  • Valid values for each field
  • Required vs. optional fields
  • Validation rules

MMWR Week Crosswalk

A reference table mapping MMWR weeks to calendar months:

📄 MMWR_week_to_month_crosswalk.csv

This crosswalk helps you:

  • Convert between MMWR weeks and calendar dates
  • Understand week boundaries (Sunday to Saturday)
  • Plan your reporting schedule

Schema Files

YAML Schema

The formal YAML schema defining the data structure:

📄 data_reporting_schema.yaml

Use this schema for:

  • Automated validation
  • Integration with validation tools
  • Understanding field relationships
  • Building your own tools

Python Schema

The Python Pydantic schema used for validation:

📄 data_reporting_schema.py

This schema includes:

  • Field definitions with types
  • Validation logic
  • Custom validators
  • Helper functions

How to Use These Resources

  1. Start with the Templates: Download the CSV template and metadata template to understand the structure
  2. Review the Example: Look at the example data file to see proper formatting
  3. Complete Metadata: Fill out the metadata template with your jurisdiction's information
  4. Consult the Data Dictionary: Use this as your primary reference for field specifications
  5. Validate with Schema: Use the JSON or Python schema to validate your data
  6. Check MMWR Crosswalk: Reference this when converting dates to MMWR weeks