HPV Vaccination Module

1. HPV Overview

The HPV Module is a dedicated feature within the ZM Mobile Application designed to support the HPV vaccination campaign. The campaign targets girls aged 9–14 years and enables vaccinators to efficiently record, manage, and synchronize vaccination data in both online and offline modes.

This module is structured around three types of campaign activities — Fixed, Outreach, and Mobile Van — allowing flexibility in capturing vaccination data from different operational settings. Each event type supports field-level data collection, form submission, and synchronization with the central database to ensure data accuracy and visibility on the reporting dashboard.

2. System Overview
Frontend**:** Android (Native)
Backend**:** Spring MVC / JavaScript
Database**:** MySQL

3. Modules

The HPV module consists of three main submodules (event types):

1. Fixed Event Type
2. Outreach Event Type
3. Mobile Van Event Type

Each submodule serves a unique operational purpose but follows a similar workflow of vaccination data entry and synchronization.

3.1 Fixed Event Type

Objective:
To capture vaccination data from fixed vaccination centers (e.g., health facilities or static vaccination sites). This event type supports vaccinators assigned to permanent health centers.

3.2 Outreach Event Type

Objective:
To record vaccination data from outreach centers, typically temporary or field-based vaccination sites such as schools or community areas, to ensure coverage of target populations beyond fixed centers.

3.3 Mobile Van Event Type

Objective:
To facilitate vaccination data collection from mobile van-based campaigns, enabling vaccinators to cover remote or hard-to-reach areas through mobile health units.

4. Process Overview
Across all event types, the overall process involves:

1. Accessing the HPV Module within the ZM Mobile Application.

2. Selecting the Event Type – Fixed, Outreach, or Mobile Van.

3. For Outreach and Mobile Van, specifying Location Type (School or Community).

4. Adding Vaccination Records by filling out the vaccination form for each eligible girl.

5. Saving or Uploading the record:

   • Save stores data locally (offline mode).

   • Upload immediately sends data to the server (online mode).

6. Viewing record status – Pending, Synced, or Failed – on the vaccination page.

5. Each Process Flow Description

5.1 Fixed Event Type Flow

• User opens the HPV Module.

• Selects Fixed Event Type.

• Redirected directly to the Vaccination Page.

• Taps Add Vaccination → Vaccination form opens.

• Fills required fields (Name, Father Name, Age, etc.).

• Saves or uploads the record.

• Status updates based on connectivity (Pending/Synced/Failed).

5.2 Outreach Event Type Flow

• User opens the HPV Module.

• Selects Outreach Event Type.

• System prompts for Location Type (School/Community).

• User selects the desired location type.

• Redirected to the Vaccination Page for that outreach activity.

• Adds and submits vaccination form (Save/Upload).

• Data synced to server when online.

5.3 Mobile Van Event Type Flow

• User opens the HPV Module.

• Selects Mobile Van Event Type.

• System prompts for Location Type (School/Community).

• User selects location type.

• Redirected to Vaccination Page for mobile campaign.

• Adds and submits vaccination form (Save/Upload).

• Data synced automatically when connectivity is available.

6. Vaccination Form Key Components

The vaccination form captures the essential details of each vaccinated girl.
Fields:

Field Name	Description	Type	Validation
Girl Name	Name of the girl	Text	Required
Father Name	Father’s name	Text	Required
Age	Age (9–14 years)	Picker	Required
CNIC No.	Guardian’s CNIC	Text	Optional
Mobile Number	Contact number	Text	Optional
District	Location	Dropdown	Required
Taluka/Town	Sub-location	Dropdown	Required
Union Council	Sub-location	Dropdown	Required
Address	Full address	Text	Optional

7. Unique Identifier Generation:
To ensure that each vaccination record is uniquely identifiable, the system generates a Unique Identifier (UID) for every record at the time of form saving. This identifier helps prevent duplicate entries and allows accurate tracking of individual vaccination records across the system.

7.1 Components Used for UID Generation

The UID is generated based on a combination of the following key attributes:

• Girl Name
• Father Name
• Location ID
• Age

These fields collectively represent a unique vaccination record for an individual.

7.2. Hashing Algorithm

The system uses the SHA-256 hashing algorithm to generate the unique identifier.

• The SHA-256 (Secure Hash Algorithm 256-bit) is a cryptographic hash function that produces a 32-byte (256-bit) hash value.

• The output is typically represented as a 64-character hexadecimal string.

• This ensures a highly secure and collision-resistant unique value.

7.3. Truncation for Identifier Generation

Since the full 64-character hash is not required for internal use, only the first 12 hexadecimal characters of the SHA-256 hash are utilized to form the Unique Identifier (UID).

• This 12-character subset provides a compact yet sufficiently unique representation for the vaccination record.

• The probability of hash collisions remains extremely low due to the cryptographic nature of SHA-256.

Example:

Input: AyeshaRashid12345

SHA-256 Hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

Generated UID: e3b0c44298fc

8. Vaccination Page & Add Vaccination

The vaccination page displays the chosen campaign and location type. It also shows a list of previously added records and an 'Add Vaccination' button.

Upon clicking Add Vaccination:
• The user fills the vaccination form.
• At the bottom of the form, two buttons appear: Save and Upload.

9. Save vs Upload

The HPV module provides two options for handling vaccination records after form completion — Save and Upload. These options allow vaccinators to work effectively in both online and offline environments.

• Save:
  When the user selects the Save option, the vaccination record is stored locally on the device with a Pending status. This ensures that data is not lost if the device is offline. The record remains in Pending status until the user manually uploads it or the system automatically syncs it once an active internet connection is available.

• Upload:
  When the Upload option is selected, the application attempts to send the vaccination record immediately to the central server using REST API integration.

  • If the upload is successful, the record status is updated to UPLOADED.

  • If the upload is in progress, the record status temporarily changes to UPLOADING.

  • If a network or server error occurs during the upload, the record status is marked as FAILED.

This mechanism ensures reliable data handling across all network conditions, maintaining synchronization integrity and traceability of each vaccination entry.

API Integration

API Integration Overview – HPV Vaccination Module

The HPV Vaccination Module interacts with multiple RESTful API endpoints to manage the submission, synchronization, and validation of vaccination records within the ZM application.
This section outlines the key API calls, their purpose, behavior, and execution flow within the mobile application.

1. Vaccination Submission API

Endpoint: https://zm-mdr-staging01.irdresearch.org/mrest/hpv/vaccination
Method: POST
Triggered: On each vaccination form submission.

Purpose:
This API is responsible for submitting vaccination data from the mobile application to the server. Each time a vaccinator completes and submits a form (either online or when connectivity is restored), this API call sends the vaccination details to the backend system for processing and storage.

Key Notes:

• The payload includes all vaccination form fields along with a unique identifier generated at the time of form saving.
• The API ensures that data is transmitted securely and that each record is uniquely identified to prevent duplication.
• In case of network failure, the application queues the data locally and retries the submission based on the defined retry policy.

2. Get All Identifiers API

Endpoint: https://zm-mdr-staging01.irdresearch.org/mrest/hpv/vaccination?offset=0&limit=100&dateFrom=2025-08-01
Method: GET
Triggered: On every application login.

Purpose:
This API retrieves a list of all vaccination unique identifiers previously submitted by the vaccinator. It allows the system to locally store these identifiers and use them for duplication validation when new forms are created.

Key Notes:

• The application maintains a local cache of all retrieved identifiers.
• During new form creation, the system cross-verifies the locally stored identifiers to ensure that the same individual’s vaccination record is not submitted more than once.
• The offset, limit, and dateFrom parameters enable pagination and incremental fetching of records based on date filters.

3. Vaccination Summary API

Endpoint: https://zm-mdr-staging01.irdresearch.org/mrest/hpv/summary?limit=20&offset=0&lastSyncDate=2025-08-01
Method: GET
Triggered: On every login into the application.

Purpose:
This API retrieves a summary of all vaccination records submitted by the logged-in vaccinator. It helps synchronize the application’s local database with the latest data available on the server, ensuring the vaccinator’s dashboard and summary screens reflect up-to-date information.

Key Notes:

• The lastSyncDate parameter ensures that only records submitted after the last synchronization are fetched, optimizing performance.

• The retrieved data is used to populate summary views and maintain synchronization between local and server-side data.

• Supports pagination through the limit and offset parameters.

API Name	Endpoint	Method	Trigger Point	Purpose
Vaccination Submission API	/mrest/hpv/vaccination	POST	On each form submission	Sends vaccination data to the server
Get All Identifiers API	/mrest/hpv/vaccination?offset=0&limit=100&dateFrom=YYYY-MM-DD	GET	On every application login	Fetches all submitted identifiers to prevent duplication
Vaccination Summary API	/mrest/hpv/summary?limit=20&offset=0&lastSyncDate=YYYY-MM-DD	GET	On every application login	Retrieves all vaccination records submitted by the vaccinator

Roles & Permissions

HPV Vaccine Module – Roles and Permissions Overview

The HPV Vaccine Module has been designed to support both routine immunization activities and the HPV campaign. To manage access and functionality efficiently, two distinct user roles have been defined within the system:

1. Routine Vaccinator

This role is assigned to vaccinators who are involved in both routine immunization and HPV vaccination activities.

• Home Screen Visibility:
  The HPV module tab is visible on the application’s home screen alongside other routine immunization forms.
• Attendance Check-In:
  Routine vaccinators are required to perform the standard attendance check-in process, which includes:
  • Selecting their work shift.
  • Entering the ILR temperature.
• Permissions:
  The role assigned is “VACCINATOR” with an additional permission of ADD_HPV_CAMPAIGN.
  This allows routine vaccinators to access and submit HPV-related forms in addition to their existing routine immunization forms.

2. HPV-Only Vaccinator

This role is specifically designed for vaccinators who are part of the HPV campaign only, and are not responsible for routine immunization activities.

• Home Screen Visibility:
  On the application’s home screen, only the HPV module tab is visible. Other routine immunization modules or forms are hidden.
• Attendance Check-In:
  HPV-only vaccinators are required to tap the “Check-In” button; however, the system automatically bypasses the following steps:
  • Shift selection.
  • ILR temperature entry.
    This ensures a simplified check-in process tailored for campaign vaccinators.
• Permissions:
  The role assigned is “HPV_VACCINATOR”, which comes with the permission ONLY_HPV_CAMPAIGN.
  This restricts access to HPV-related activities only, ensuring a focused user experience.

Role Name	Description	HPV Module Access	Attendance Check-In Requirement	Permission
VACCINATOR	Routine vaccinator with HPV module access	HPV + Routine Forms	Shift selection and ILR temperature required	ADD_HPV_CAMPAIGN
HPV_VACCINATOR	HPV campaign-only vaccinator	HPV Forms Only	Check-in without shift/ILR temperature selection	ONLY_HPV_CAMPAIGN

Dashboard Reports

1. HPV Dashboard Report

1. Overview

The HPV Dashboard provides a high-level, real-time snapshot of the vaccination campaign's performance. It is designed for program managers and administrators who require immediate operational insights into key metrics, vaccination trends, and staff performance without needing to run detailed reports. The dashboard aggregates data from the lowest operational level (vaccination records) into visual, actionable summaries.

2. Report Functionality and Modules

The dashboard is structured into three main modules: Filters, Key Performance Indicators (KPIs)/Summary Charts, and Performance Grids.

A. Filter Module (Geographical Scope)

The filter module allows the user to drill down into the data based on geographical hierarchy.

Filter Category	Type	Description
Geographical Filters	Dropdown	Hierarchical selection fields (Province, Division, District, Town/Taluka, UC, and Center). Applying these filters dynamically updates all the charts and grids on the dashboard to reflect data only from the selected area.
Action Button	Button	Apply: Executes the query using the selected filters to refresh all the dashboard components instantly.

B. Key Performance Indicators (KPIs) and Summary Charts

This section provides quantitative summaries of vaccination achievements, broken down by age group.

1. Today's Vaccinations

• Metric: Displays the absolute count of vaccinations administered on the current date.
  Breakdown: The accompanying Pie Chart and legend break this total down by target age group:
  • Age 9
  • Ages 10-14
• Purpose: Serves as a real-time pulse check of daily operational output.

2. Campaign Vaccinations

• Metric: Displays the cumulative total count of vaccinations administered since the campaign start.
  Breakdown: The accompanying Pie Chart and legend break this total down by target age group:
  • Age 9
  • Ages 10-14
• Purpose: Measures the overall success and scale of the campaign to date.

3. Vaccination Count Trend (Area Chart)

• Chart Type: Multi-series Area Chart.
• X-Axis (Date): Reflects the campaign timeline, showing day-by-day progress (e.g., from Sep 15 onward).
• Y-Axis (Vaccination Count): Reflects the daily volume of vaccinations.
• Series Breakdown: The chart uses stacked or overlapping areas to reflect the contribution of the three main intervention event types:
  • Fixed Site (e.g., permanent health facilities)
  • Community (e.g., outreach or mobile team camps)
  • School (e.g., campaigns conducted within educational institutions)
• Purpose: Allows managers to identify trends, peak performance days, and the relative effectiveness of different intervention strategies over time.

C. Performance Grids

These comparative tables highlight staff performance, facilitating quick identification of high- and low-performing vaccinators.

1. Top Performing Vaccinators

• Data: Lists vaccinators ranked by the highest total number of vaccinations achieved.
• Columns:
  • Name: The name of the vaccinator.
  • Vaccinations: The total cumulative count of vaccinations they have administered.
• Purpose: Recognizes top contributors and establishes a benchmark for high performance.

2. Low Performing Vaccinators

• Data: Lists vaccinators ranked by the lowest total number of vaccinations achieved.
• Columns:
  • Name: The name of the vaccinator.
  • Vaccinations: The total cumulative count of vaccinations they have administered (often very low or zero, indicating new staff or performance issues).
• Purpose: Highlights staff requiring immediate supervisory attention, training, or re-assignment.

3. Operational Flow

The user starts by selecting a desired geographical location (e.g., District: Karachi). Upon clicking Apply, the dashboard queries the database and renders all three summary charts and both performance grids, showing the metrics only for the selected geographical jurisdiction. This interactive, filter-driven approach ensures the data presented is always relevant to the manager's area of focus.

HPV Vaccination List Report

1. Overview

The HPV Vaccination List Report, titled "HPV Vaccination Records," provides a comprehensive, granular, record-by-record view of every vaccination administered within the scope of the campaign. It functions as a data audit and detailed monitoring tool, presenting key demographic, geographical, and operational details for each dose administered.

The report allows users to search, filter, and export the entire dataset for further analysis (e.g., in CSV format).

2. Report Functionality and Modules

The report consists of three core functional modules: Filters, Controls, and the Data Table.

A. Filter Module (Search Criteria)

Users can refine the displayed records based on a combination of geographical and temporal parameters.

Filter Category	Type	Description
Geographical Filters	Dropdown	Hierarchical selection fields for narrowing down the data to a specific administrative area: Province, Division, District (Malir Distt in screenshot), Town/Taluka, UC, and Center.
Temporal Filters	Date Picker	Start Date (09/01/2025) and End Date (09/30/2025). This defines the time window for which vaccination records are fetched and displayed.
Action Buttons	Button	Search: Executes the query using the applied filters to refresh the data table. Download: Triggers the export process, typically generating a CSV file of the currently filtered dataset.

B. Report Controls

Entries Control: The Show [N] entries control allows the user to set the number of rows displayed per page in the data table (e.g., Show 50 entries).

C. Data Table Module (Core Report Content)

This module displays the vaccination records in a tabular format, with each row representing a single dose administered to a girl. The table is highly detailed, covering recipient identity, location, time, and vaccinator details.

3. Key Data Fields (Columns)

The table columns are essential for data auditing and linkage across systems. The fields include:

Data Field	Description	Example Data	Category
Girl ID	The unique identifier for the vaccine recipient.	2D11A0AA4E29	Recipient Detail
Name	The name of the vaccine recipient.	Aroosa Ali hasan	Recipient Detail
Vaccine	The type of vaccine administered (e.g., HPV).	HPV	Dose Detail
Latitude / Longitude	The GPS coordinates recorded at the time of vaccination.	24.806526 / 67.242169	Location Detail
Vaccination Date	The date the vaccination was administered.	9/15/2025	Dose Detail
Vaccination Time	The time the vaccination was administered.	09:28:37	Dose Detail
Vaccinator Name	The name of the staff member who administered the dose.	akhter zaman	Staff Detail
Vaccinator ID	The unique identifier for the vaccinator.	0131502	Staff Detail
Vaccination District	The district where the vaccination event took place.	Malir Distt	Location Detail
Vaccination Town	The town/taluka where the vaccination event took place.	Bin Qasim	Location Detail
Vaccination UC	The Union Council where the vaccination event took place.	Cattle Colony - 3	Location Detail
Center	The specific vaccination center or facility name.	FIXED	Operational Detail
School	The school name, if the intervention was school-based.	Maternity Home Labour Square	Operational Detail
Residential District	The recipient's recorded district of residence.	Malir Distt	Recipient Residence
Residential Town	The recipient's recorded town of residence.	Bin Qasim	Recipient Residence
Residential UC	The recipient's recorded UC of residence.	Cattle Colony - 3	Recipient Residence
Phone	Recipient or guardian contact number.	032102363216	Recipient Detail

4. Operational Functionality

A. Data Export (Download)

The Download button is a critical feature, enabling the user to export the full, filtered dataset currently displayed (up to the maximum limit) into a machine-readable format, typically a CSV file. This allows for offline analysis, bulk data processing, and integration with other analytical tools.

B. Audit Trail

This report acts as the primary audit trail for all operational data, linking the recipient, the geographical location (both vaccination site and residence), and the responsible vaccinator for every single dose.

3. UC Coverage Report

1. Overview

The UC Coverage Report provides a comprehensive performance analysis of the HPV vaccination campaign at the Union Council (UC) level. Its primary purpose is to assess progress against defined targets, highlighting both overall coverage and disaggregated coverage by intervention type (Fixed, Community, School) and target age group (Age 9, Ages 10-14). This report is crucial for program managers to identify UCs that are over- or under-performing relative to their assigned goals.

2. Report Functionality and Modules

The report is structured into three main modules: Filters, Controls, and the Data Table, and includes an export function.

A. Filter Module (Search Criteria)

Users must apply filters to define the geographical and temporal scope of the coverage data presented.

Filter Category	Type	Description
Geographical Filters	Dropdown	Hierarchical selection fields for narrowing data, typically starting from Province (Sindh) down to Center (Maadri Welfare). The selection defines which UC records are visible.
Temporal Filters	Date Picker	Start Date (08/01/2025) and End Date (10/20/2025). This defines the time period for which coverage and totals are calculated.
Action Buttons	Button	Search: Executes the query using the applied filters to refresh the data table. Download: Triggers the export of the currently filtered table data into a CSV file for external analysis.

B. Report Controls

Entries Control: The Show [N] entries control allows the user to specify the number of UC records displayed per page (e.g., Show 50 entries).Search Bar: Allows for quick, real-time filtering of the displayed records based on keywords (e.g., searching for a specific UC name).

C. Data Table Module (Core Report Content)

This module is the core of the report, presenting performance metrics against targets for each listed UC. The data is organized into three primary sections: Total Coverage, Coverage by Intervention Site, and Coverage by Age Group.

3. Key Data Fields (Columns)

The table columns provide a detailed breakdown of targets and achievements:

I. Overall Coverage

Data Field	Description	Example Data	Metric Type
UC	The name or code of the Union Council being reported.	UC 08 Malir Cantt	Identifier
Total Target	The total expected population to be vaccinated in this UC for the period.	11975	Target
Total Coverage	The actual cumulative number of vaccinations achieved in this UC.	7886	Achievement
Total Coverage %	The percentage of the target population covered (Total Coverage / Total Target * $100$).	65.85	Performance

II. Coverage by Intervention Site

This section breaks down targets and achievements by the location type where the service was delivered. Note that a percentage exceeding $100\%$ indicates that more vaccinations were performed at that site type than initially targeted.

Data Field	Description	Example Data	Metric Type
Data Field	Description	Example Data	Site Type
Fixed Target	The target number of vaccinations assigned to Fixed Sites (e.g., clinics).	500	Fixed Site
Fixed Coverage	The actual number of vaccinations achieved at Fixed Sites.	1010	Fixed Site
Fixed Coverage %	The percentage of the Fixed Target achieved.	202.00	Fixed Site
Community Target	The target number of vaccinations assigned to Community Outreach activities.	4313	Community Site
Community Coverage	The actual number of vaccinations achieved via Community Outreach.	6568	Community Site
Community Coverage %	The percentage of the Community Target achieved.	152.28	Community Site
School Target	The target number of vaccinations assigned to School campaigns.	7162	School Site
School Coverage	The actual number of vaccinations achieved via School campaigns.	308	School Site
School Coverage %	The percentage of the School Target achieved.	4.30	School Site
UC	The name or code of the Union Council being reported.	UC 08 Malir Cantt	Identifier
Total Target	The total expected population to be vaccinated in this UC for the period.	11975	Target
Total Coverage	The actual cumulative number of vaccinations achieved in this UC.	7886	Achievement
Total Coverage %	The percentage of the target population covered (Total Coverage / Total Target * $100$).	65.85	Performance

III. Coverage by Age Group

Data Field	Description	Example Data	Age Group
Age 9 Coverage	The total number of vaccinations administered to the 9-year-old age cohort.	1609	Age 9
Age 10-14 Coverage	The total number of vaccinations administered to the 10-14 age cohort.	6277	Age 10-14

4. Operational Functionality

The report’s primary operational strength is its ability to compare performance against targets across multiple dimensions, providing immediate actionable insights into resource allocation and campaign efficiency. The Download functionality ensures that users can extract this rich, comparative data for detailed external reporting or archiving.

District Coverage Report

1. Overview

The District Coverage Report provides a strategic and aggregated performance analysis of the HPV vaccination campaign at the District level. Its core function is to measure progress against defined targets for each district, offering a high-level view of overall coverage, as well as disaggregated performance across key operational categories: intervention type (Fixed, Community, School) and target age groups (Age 9, Ages 10-14). This report is vital for regional management to assess which districts are meeting their campaign goals and to facilitate resource allocation decisions.

2. Report Functionality and Modules

The report is systematically organized into three primary functional areas: Filters, Controls, and the Data Table.

A. Filter Module (Search Criteria)

Users must apply geographical and temporal filters to define the exact scope of the coverage data presented. Unlike the UC report, the filters applied here often serve to narrow the visible list of districts if the database is large, or to focus the calculation period.

Filter Category	Type	Description
Geographical Filters	Dropdown	Hierarchical selection fields (Province, Division, District, Town/Taluka, UC, and Center). Selecting a filter like Division or District will typically limit the table output to show coverage records only for the districts within that selected area.
Temporal Filters	Date Picker	Start Date (08/01/2025) and End Date (09/30/2025). This defines the time period for which all coverage and total figures are calculated.
Action Buttons	Button	Search: Executes the query using the applied filters to refresh the data table. Download: Triggers the export process, generating a CSV file of the currently filtered and displayed dataset.

B. Report Controls

• Entries Control: The Show [N] entries control allows the user to set the number of district records displayed per page (e.g., Show 50 entries).
• Search Bar: Allows for quick, real-time filtering of the displayed district records based on keywords (e.g., searching for a specific district name).

C. Data Table Module (Core Report Content)

This module presents the aggregated performance metrics against targets for each listed District. The data is organized into three primary analytical sections: Total Coverage, Coverage by Intervention Site, and Coverage by Age Group.

3. Key Data Fields (Columns)

The table columns provide a detailed breakdown of targets and achievements, aggregated at the district level:

I. Overall Coverage

Data Field	Description	Example Data	Metric Type
District	The name of the District being reported.	Malir District	Identifier
Total Target	The total expected population to be vaccinated in this District for the specified period.	178661	Target
Total Coverage	The actual cumulative number of vaccinations achieved in this District.	75143	Achievement
Total Coverage %	The percentage of the target population covered (Total Coverage / Total Target * $100$).	42.06	Performance

II. Coverage by Intervention Site

This section segregates targets and achievements based on the type of intervention site, which is critical for evaluating the efficiency of different delivery strategies (e.g., fixed health facilities vs. mobile outreach).

Data Field	Description	Example Data	Site Type
Fixed Target	The target number of vaccinations assigned to Fixed Sites (e.g., clinics) in the District.	10051	Fixed Site
Fixed Coverage	The actual number of vaccinations achieved at Fixed Sites within the District.	7829	Fixed Site
Fixed Coverage %	The percentage of the Fixed Target achieved.	77.89	Fixed Site
Community Target	The target number of vaccinations assigned to Community Outreach activities.	82063	Community Site
Community Coverage	The actual number of vaccinations achieved via Community Outreach.	55376	Community Site
Community Coverage %	The percentage of the Community Target achieved.	67.48	Community Site
School Target	The target number of vaccinations assigned to School campaigns.	86547	School Site
School Coverage	The actual number of vaccinations achieved via School campaigns.	11938	School Site
School Coverage %	The percentage of the School Target achieved.	13.79	School Site

III. Coverage by Age Group

This section breaks down the total coverage count by the two primary target age cohorts.

Data Field	Description	Example Data	Age Group
Age 9 Coverage	The total number of vaccinations administered to the 9-year-old age cohort in the District.	12067	Age 9
Age 10-14 Coverage	The total number of vaccinations administered to the 10-14 age cohort in the District.	63076	Age 10-14

4. Operational Functionality

The report's primary operational strength is its ability to facilitate District-level decision-making. By aggregating all UC data up to the District level, program managers can quickly evaluate the overall success rate (Total Coverage %), compare the relative success of different delivery channels (Fixed vs. Community vs. School), and ensure adequate coverage of the distinct age groups. The Download functionality ensures that this high-level data can be easily exported for governmental reporting and strategic planning.

Vaccinator Performance Report

1. Document Purpose and Overview

The Vaccinator Performance Report serves as the primary tool for individual-level operational monitoring and evaluation of the HPV vaccination campaign staff. Its core function is to measure the performance of each Vaccinator against assigned targets, providing a granular assessment of achievement across operational categories: overall goals, intervention site types (Fixed, Community, School), and age cohorts (Age 9, Ages 10-14).

This report is critical for:

1. Staff Management: Identifying high and low-performing vaccinators.
2. Resource Planning: Assessing the effectiveness of resource allocation to specific team members.
3. Target Setting: Providing data for future performance planning and goal definition.

2. Report Functionality and Modules

The report follows the standard structure of the other operational reports, consisting of Filters, Controls, and the Data Table.

A. Filter Module (Search Criteria)

Users define the geographical and temporal context for the vaccinator performance data. The hierarchical filters help narrow the list of vaccinators shown to those operating within a specific area.

Filter Category	Type	Description
Geographical Filters	Dropdown	Hierarchical selection fields (Province, Division, District (Karachi Central D in screenshot), Town/Taluka, UC, and Center). Selecting these filters restricts the table output to show performance records only for vaccinators assigned to or operating in the selected geographic area.
Temporal Filters	Date Picker	Start Date (09/01/2025) and End Date (09/30/2025). This defines the time window used to aggregate and calculate the coverage and total figures for each vaccinator.
Action Buttons	Button	Search: Executes the query using the applied filters to fetch and display the updated data. Download: Triggers the export of the currently filtered table data into a CSV file for external analysis.

B. Report Controls

• Entries Control: The Show [N] entries control allows the user to set the number of vaccinator records displayed per page (e.g., Show 50 entries).
• Search Bar: Enables quick, real-time filtering of the displayed records based on keywords (e.g., searching for a specific Vaccinator Name or ID).

C. Data Table Module (Core Report Content)

This module presents detailed performance metrics against targets for each listed vaccinator. The data is organized into three primary analytical sections: Total Coverage, Coverage by Intervention Site, and Coverage by Age Group.

3. Key Data Fields (Columns)

The table columns provide a detailed breakdown of the targets assigned to and achievements recorded by each vaccinator.

I. Identifier and Overall Coverage

Data Field	Description	Example Data	Metric Type
Vaccinator ID	The unique identifier assigned to the staff member.	0125802	Identifier
Vaccinator Name	The name of the staff member.	Shagufta Rizvi	Identifier
Total Target	The total expected number of vaccinations assigned to this vaccinator for the specified period.	1299	Target
Total Coverage	The actual cumulative number of vaccinations achieved by this vaccinator.	412	Achievement
Total Coverage %	The percentage of the total target achieved (Total Coverage / Total Target * $100$).	31.72	Performance

II. Coverage by Intervention Site

This section segregates performance based on the specific type of intervention site, allowing managers to see how well a vaccinator is performing in different settings (e.g., if they are effective in community outreach but underperforming in school settings).

Data Field	Description	Example Data	Site Type
Fixed Target	The target number of vaccinations assigned to the vaccinator for Fixed Sites.	38	Fixed Site
Fixed Coverage	The actual number of vaccinations achieved by the vaccinator at Fixed Sites.	0	Fixed Site
Fixed Coverage %	The percentage of the Fixed Target achieved.	0.00	Fixed Site
Community Target	The target number of vaccinations assigned for Community Outreach.	488	Community Site
Community Coverage	The actual number of vaccinations achieved via Community Outreach.	200	Community Site
Community Coverage %	The percentage of the Community Target achieved.	40.98	Community Site
School Target	The target number of vaccinations assigned for School campaigns.	811	School Site
School Coverage	The actual number of vaccinations achieved via School campaigns`.	174	School Site
School Coverage %	The percentage of the School Target achieved.	21.45	School Site

III. Coverage by Age Group

This section breaks down the total coverage count achieved by the vaccinator across the two primary target age cohorts.

Data Field	Description	Example Data	Age Group
Age 9 Coverage	The total number of vaccinations administered by the vaccinator to the 9-year-old cohort.	42	Age 9
Age 10-14 Coverage	The total number of vaccinations administered by the vaccinator to the 10-14 age cohort.	370	Age 10-14

4. Operational Functionality

The report's primary operational strength is its use as a management accountability tool. By linking performance directly to the individual vaccinator, managers can perform granular analysis: comparing efficiency across different team members, identifying training needs based on low-performing categories (e.g., consistently low school coverage), and verifying data against operational logs. The Download functionality is essential for HR and supervisory staff to perform in-depth analysis and track performance trends over time.

Reporting & ETL Process Overview

HPV Module – Reporting & ETL Process Overview

This section outlines how HPV vaccination data is processed, transformed, and displayed on the dashboard. It covers the ETL (Extract, Transform, Load) workflow, execution frequency, and the database tables involved in generating HPV-related reports.

1. Dashboard Update Frequency

The HPV dashboard ETL script runs every 10 minutes. During each execution, the script aggregates the latest HPV vaccination data based on the vaccination date and updates all relevant reporting tables.

ETL script

2. ETL Data Flow & Table Utilization

The ETL pipeline extracts raw HPV vaccination records, transforms them according to age group and administration site, and loads them into the following reporting tables:

2.1 hpv_facts (Primary Reporting Table)

The main HPV dashboard retrieves its data from the hpv_facts table.
This table includes:

• Total HPV vaccinations administered to children aged 9 years and above.
• Vaccination counts segregated by Fixed, School, and Community sites.
• UC-level details indicating where each vaccination was administered.
• Vaccinator-level details, including vaccinator ID and associated counts of administered HPV doses.

This table serves as the core source for consolidated HPV vaccination analytics.

2.2 hpv_dim_location & hpv_dim_vaccinator (Supporting Dimension Tables)

Additional HPV reports utilize these two dimension tables:

hpv_dim_location

• Provides vaccination counts per specific location/UC.
• Includes breakdown of vaccinations administered at Fixed, School, and Community sites.
• Contains vaccination target data for each location.

hpv_dim_vaccinator

• Stores vaccinator-specific metadata.
• Supports reports that display dose counts per vaccinator and distribution across service delivery points.

3. Summary

The HPV reporting ecosystem relies on a structured ETL workflow that runs at 10-minute intervals, ensuring near real-time updates on vaccination performance. By leveraging the hpv_facts table for aggregated results and the supporting dimension tables for detailed views, the system provides comprehensive and accurate HPV vaccination insights across locations and vaccinators.