Duplicate Doses
Indicator CD 5.2
PAHO/CIM
November 9, 2026
Source:vignettes/articles/en/duplicate_doses_en.Rmd
duplicate_doses_en.RmdRationale
In an Electronic Immunization Registry (EIR), each dose a person receives should be registered exactly once. In practice, the same dose can be registered more than once for the same person. Every extra record inflates the number of doses administered, so it biases traditional coverage indicators that typically rely on the “number of doses administered” as the numerator.
This module lets users analyze duplicate doses in an EIR. It compares all the records that belong to the same person and correspond to the same dose, and classifies each extra record into one of the following categories:
- Duplicate: the extra record has the same vaccination date and place of occurrence as an earlier record, that is, the same vaccination event was registered more than once.
- Repeated: the extra record has a different vaccination date or place of occurrence, that is, the same dose was registered at a different moment in time or in a different place.
These categories help analysts understand the broad possible causes for extra records in their EIR. However, the exact reason for each must be analyzed at the record level and combined with additional information sources if possible. For example, a Duplicate record could be caused by the data having been entered twice into the system, or by data being duplicated after migrating from an older system. As for Repeated records, a dose may have been truly administered twice (in which case we would call this a programmatic error), or it could have been entered with the wrong dose number (e.g., a DTP2 dose entered as DTP1). The plots and the record-level table of this module help investigate these possible causes.
Finally, since extra records (whatever their cause) are a data quality problem directly related to each vaccination event, this module disaggregates results geographically by the place of occurrence of the vaccination event, not by the place of residence of the individual.
Note
All functions used for duplicate dose analyses within immunABC begin with the
dd_prefix.
Glossary
Political Geographic Boundaries
Throughout this vignette, we will make reference to different levels of political geographic boundaries. These levels are defined by the country/territory and can have different names from country to country. immunABC is agnostic to these names and requires the user to recode their variable names to fit the immunABC structure.
Namely, immunABC can distinguish three administrative levels, which listed from top to bottom level are: ADM0, ADM1 and ADM2.
- ADM0: The country. This is the top-most administrative level.
- ADM1: The first geographic subdivision in the country. ADM0 contains several ADM1 subdivisions.
- ADM2: The second geographic subdivision in the country. Each ADM1 contains several ADM2 subdivisions.
Duplication Categories
When analyzing extra records, the following categorization applies: all the records that belong to the same person and contain the same dose are compared in order of vaccination date. The first record is considered the legitimate one, and each later record is classified by comparing it with the earlier ones:
-
FIRST_ENTRY: the first record of that person and dose. It is never counted as a problem. -
DUPLICATE: same person, dose, vaccination date and place of occurrence as an earlier record. -
REPEATED: same person and dose as an earlier record, but a different vaccination date or place of occurrence.
The following is an example of such classifications for a person with two extra records:
date_vax |
Place of occurrence | Category | Why |
|---|---|---|---|
| January 5 | ADM2_1_1 |
FIRST_ENTRY |
First record of this person and dose. Not counted as extra. |
| February 10 | ADM2_1_1 |
REPEATED |
Same dose, but on a different date. |
| February 10 | ADM2_1_1 |
DUPLICATE |
Identical to the previous record. |
Usage
Load Data
The functions in this module require your EIR
dataset in the standard immunABC format.
dd_repeat_plot() can optionally use a vaccination
schedule to show the vaccination window of each dose. The
expected format for these datasets is described below.
EIR
The immunabc::immunABC.EIR data frame provides a
simulated, nominal-level table representing individual vaccination
events from an Electronic Immunization Registry (EIR). Each row
corresponds to a single vaccination act for a person.
immunABC.EIR %>% head() %>% kable(caption = "Example Electronic Immunization Registry")| ID | date_birth | date_vax | ADM1_residence | ADM2_residence | ADM1_occurrence | ADM2_occurrence | dose |
|---|---|---|---|---|---|---|---|
| 191997 | 2023-08-08 | 2023-12-26 | ADM1_4 | ADM2_4_35 | ADM1_4 | ADM2_4_35 | DTP2 |
| 212189 | 2023-12-20 | 2023-12-26 | ADM1_5 | ADM2_5_61 | ADM1_5 | ADM2_5_61 | BCG RN |
| 118063 | 2022-09-15 | 2023-12-26 | ADM1_2 | ADM2_2_5 | ADM1_2 | ADM2_2_5 | DTP1 |
| 118063 | 2022-09-15 | 2023-12-26 | ADM1_2 | ADM2_2_5 | ADM1_2 | ADM2_2_5 | YFV1 |
| 130751 | 2022-10-27 | 2023-12-12 | ADM1_5 | ADM2_5_55 | ADM1_5 | ADM2_5_55 | YFV1 |
| 136532 | 2021-09-21 | 2023-12-26 | ADM1_3 | ADM2_3_12 | ADM1_3 | ADM2_3_12 | SRP1 |
-
ID: Unique person identification number. -
date_birth: Date of birth of person. -
date_vax: Date of vaccination event. -
ADM1_residence/ADM2_residence: First and second geographic administrative levels of residence. -
ADM1_occurrence/ADM2_occurrence: First and second geographic administrative levels where the vaccination occurred. -
dose: Combined variable representing vaccine type and dose number (e.g., DTP1).
Vaccination schedule
The immunabc::immunABC.schedule data frame defines the
age at which each dose should be administered, in days.
immunABC.schedule %>% kable(caption = "Example vaccination schedule")| dose | age_schedule | age_schedule_low | age_schedule_high |
|---|---|---|---|
| SRP1 | 365 | 360 | 420 |
| DTP1 | 60 | 54 | 90 |
| DTP2 | 120 | 116 | 150 |
| DTP3 | 180 | 176 | 210 |
| BCG RN | 0 | 0 | 28 |
| YFV1 | 365 | 360 | 420 |
-
dose: Combined variable representing vaccine type and dose number (e.g., DTP1). -
age_schedule: Recommended age of vaccination, in days. -
age_schedule_low/age_schedule_high: Lower and upper limits of the vaccination window, in days.
Duplicate Doses Analysis
Expected Workflow
The dd_ suite contains seven functions organized in
three pipelines:
-
dd_rate()— computes the percentage of duplicate and repeated records, permitting disaggregation by geographic level and optionally by dose or birth cohort.-
dd_barplot()— visualizes the output ofdd_rate()as a bar chart. -
dd_heatmap()— visualizes the output ofdd_rate()as a heatmap of geographic areas against doses or birth cohorts.
-
-
dd_trend()— computes the percentage of duplicate records by month of vaccination.-
dd_trend_plot()— visualizes the output ofdd_trend()as a line plot.
-
-
dd_duplicates()— lists every record of each dose registered more than once, for record-level review and correction.-
dd_repeat_plot()— for Repeated records of a dose, this function compares the age at vaccination of the repeats with that of the first entries of the same dose. This helps spot doses registered in the EIR with the wrong dose number (e.g., DTP1 repeats clustering at the age DTP2 is due may point towards DTP2 doses being registered as DTP1).
-
The figure below shows the expected workflow.
Step 1 — Compute duplicate and repeated records with
dd_rate()
dd_rate() classifies every record and returns, for each
group, the number and percentage of DUPLICATE and
REPEATED records. The denominator (total)
includes every evaluated record in the group. Below we show the result
at the national level.
dd_rate(data.EIR = immunABC.EIR) %>%
kable(digits = 2, caption = "Duplicate and repeated records at the national level")| duplication | n | total | rate |
|---|---|---|---|
| DUPLICATE | 1816 | 492688 | 0.37 |
| REPEATED | 1314 | 492688 | 0.27 |
Results can be disaggregated geographically with
geo_level and by one additional variable with the
disaggregate_by argument (either dose or
birth_cohort). For example, if we disaggregate by the first
subnational level (ADM1), we obtain the following table:
rate_adm1 <- dd_rate(
data.EIR = immunABC.EIR,
geo_level = "ADM1"
)
rate_adm1 %>% kable(digits = 2, caption = "Duplicate and repeated records by ADM1 of occurrence")| ADM1 | duplication | n | total | rate |
|---|---|---|---|---|
| ADM1_1 | DUPLICATE | 34 | 14099 | 0.24 |
| ADM1_1 | REPEATED | 33 | 14099 | 0.23 |
| ADM1_2 | DUPLICATE | 527 | 114336 | 0.46 |
| ADM1_2 | REPEATED | 290 | 114336 | 0.25 |
| ADM1_3 | DUPLICATE | 912 | 294763 | 0.31 |
| ADM1_3 | REPEATED | 815 | 294763 | 0.28 |
| ADM1_4 | DUPLICATE | 253 | 44965 | 0.56 |
| ADM1_4 | REPEATED | 131 | 44965 | 0.29 |
| ADM1_5 | DUPLICATE | 90 | 24525 | 0.37 |
| ADM1_5 | REPEATED | 45 | 24525 | 0.18 |
And disaggregating only by dose produces a table at the
national level where each dose is analyzed separately:
rate_dose <- dd_rate(
data.EIR = immunABC.EIR,
disaggregate_by = "dose"
)
rate_dose %>%
filter(duplication == "DUPLICATE") %>%
kable(digits = 2, caption = "Duplicate records by dose")| dose | duplication | n | total | rate |
|---|---|---|---|---|
| BCG RN | DUPLICATE | 536 | 82224 | 0.65 |
| DTP1 | DUPLICATE | 541 | 83356 | 0.65 |
| DTP2 | DUPLICATE | 230 | 81553 | 0.28 |
| DTP3 | DUPLICATE | 190 | 82080 | 0.23 |
| SRP1 | DUPLICATE | 136 | 80504 | 0.17 |
| YFV1 | DUPLICATE | 183 | 82971 | 0.22 |
Parameters accepted
-
data.EIR: EIR data frame in immunABC format. -
geo_level: Geographic level of occurrence:"ADM0"(default),"ADM1", or"ADM2". -
disaggregate_by: One additional variable to disaggregate by:"dose"or"birth_cohort". DefaultNULL(no additional disaggregation). With"birth_cohort", records with nodate_birthare excluded, with a message. -
vaccines: Character vector of doses to include, e.g.c("DTP1", "DTP2", "DTP3"). This is only a filter: usedisaggregate_by = "dose"to see results by dose. DefaultNULLuses all doses. -
birth_cohorts: Numeric vector of birth cohort year(s) to filter to. This is only a filter: usedisaggregate_by = "birth_cohort"to see results by cohort. DefaultNULLuses all available cohorts.
Output
Besides the grouping columns (ADM1, ADM2,
dose or birth_cohort, depending on
geo_level and disaggregate_by), the output
includes:
-
duplication: the category of the records,DUPLICATEorREPEATED. -
n: the number of records in that category. -
total: the total number of evaluated records in the group. -
rate: the percentage of records in that category (n / total * 100).
Step 2 — Visualize duplicate records with
dd_barplot()
The output of dd_rate() can be passed directly to
dd_barplot(). Geographic areas are shown on the x-axis if
present, otherwise this axis will show doses or birth cohorts. When the
data has both, doses or birth cohorts become panels. When showing rates,
a dashed line shows the rate of all groups combined.
dd_barplot(data = rate_adm1)
By default, the plot shows the percentage of DUPLICATE
records. Use duplication = "repeated" to show
REPEATED records instead, and value = "n" to
show the number of records instead of their percentage:
dd_barplot(
data = rate_dose,
duplication = "repeated",
value = "n"
)
At the ADM2 level, within_ADM1 focuses on the areas of
one or several ADM1, and min_total hides the bars with few
records, since their rates can be misleading due to the small
denominators involved:
rate_adm2 <- dd_rate(
data.EIR = immunABC.EIR,
geo_level = "ADM2"
)
dd_barplot(
data = rate_adm2,
within_ADM1 = "ADM1_3",
min_total = 1000
)
Parameters accepted
-
data: Output ofdd_rate(). -
value: What to show on the y-axis:"rate"(default) or"n". -
duplication: Which records to show:"duplicate"(default) or"repeated". -
within_ADM1: Character vector to filter to specific ADM1 units whengeo_level = "ADM2". Default:NULL. -
min_total: Minimum number of records for a bar to be shown. Hidden bars still count towards the dashed line. Default:NULL(all bars shown).
Interpretation
Rates and raw numbers are both useful but answer different questions.
With value = "rate", the plots show where the problem is
proportionally worst, pointing to registration practices worth
reviewing. With value = "n", they show where the most
records need correcting, which is where a cleanup effort will have the
largest impact. When showing rates, a dashed line marks the rate of all
groups combined and any bars well above it should be the first
candidates for review.
Step 3 — Combine two disaggregations with
dd_heatmap()
dd_heatmap() helps combine two disaggregations into a
single plot. For example, we can visualize the percentage of duplicate
records for each geographic area and dose:
rate_adm1_dose <- dd_rate(
data.EIR = immunABC.EIR,
geo_level = "ADM1",
disaggregate_by = "dose"
)
dd_heatmap(data = rate_adm1_dose)
We could visualize the same, but by birth cohort instead of dose, and additionally filter only for the most recent cohorts:
rate_adm1_cohort <- dd_rate(
data.EIR = immunABC.EIR,
geo_level = "ADM1",
disaggregate_by = "birth_cohort",
birth_cohorts = 2021:2023
)
dd_heatmap(data = rate_adm1_cohort)
Parameters accepted
-
data: Output ofdd_rate()withgeo_levelat"ADM1"or"ADM2"and a value fordisaggregate_by. -
value: What to show in the cells:"rate"(default) or"n". -
duplication: Which records to show:"duplicate"(default) or"repeated". -
within_ADM1: Character vector to filter to specific ADM1 units whengeo_level = "ADM2". Default:NULL. -
min_total: Minimum number of records for a cell to be filled. Other cells are grey and blank. Default:NULL(all cells filled). -
digits: Number of decimal digits in the cells whenvalue = "rate". Default:1. -
show_numbers: Logical, defaults toTRUE. Whether to show the number in each cell, or a color legend instead. Set it toFALSEwhen there are too many cells to read (e.g., at the ADM2 level).
Interpretation
A dark row across all areas points to a problem of that dose or
cohort everywhere, for example a dose that is systematically registered
twice by the information system. A dark column points to a problem in a
specific area, which suggests a local registration practice. A single
dark cell is a problem specific to one area and one dose or cohort. In
the example, ADM1_4 has the highest rates for most doses,
and BCG RN and DTP1 have the highest rates in
every area.
Step 4 — Follow duplicate records over time with
dd_trend() and dd_trend_plot()
dd_trend() performs the same calculation as
dd_rate(), but disaggregates results by month of
vaccination to spot trends over time. Only DUPLICATE
records are included: repeated records are better explored with
dd_repeat_plot() (see Step 6).
Below we see the summary of duplicate records by month and ADM1.
trend_adm1 <- dd_trend(
data.EIR = immunABC.EIR,
geo_level = "ADM1"
)
trend_adm1 %>% head() %>% kable(digits = 2, caption = "Duplicate records by ADM1 and month of vaccination")| ADM1 | month_vax | duplication | n | total | rate |
|---|---|---|---|---|---|
| ADM1_1 | 2022-01-01 | DUPLICATE | 0 | 484 | 0.00 |
| ADM1_1 | 2022-02-01 | DUPLICATE | 1 | 558 | 0.18 |
| ADM1_1 | 2022-03-01 | DUPLICATE | 3 | 590 | 0.51 |
| ADM1_1 | 2022-04-01 | DUPLICATE | 3 | 468 | 0.64 |
| ADM1_1 | 2022-05-01 | DUPLICATE | 2 | 510 | 0.39 |
| ADM1_1 | 2022-06-01 | DUPLICATE | 5 | 555 | 0.90 |
When results are disaggregated at a subnational level,
dd_trend_plot() draws the total for all areas as a
highlighted line, and each subnational area as a thin grey line for
context. Up to 5 subnational areas can be highlighted in color with the
highlight parameter. Exploring the data before selecting
the areas to highlight is recommended. In this case we are highlighting
ADM1_4 because it is the area with the highest rate of
duplicate records.
dd_trend_plot(
data = trend_adm1,
highlight = "ADM1_4"
)
Parameters accepted
-
data.EIR: EIR data frame in immunABC format. -
geo_level: Geographic level of occurrence:"ADM0"(default),"ADM1", or"ADM2". -
vaccines: Character vector of doses to include. DefaultNULLuses all doses. -
birth_cohorts: Numeric vector of birth cohort year(s) to filter to. DefaultNULLuses all available cohorts.
-
data: Output ofdd_trend(). -
value: What to show on the y-axis:"rate"(default) or"n". With"n", all areas combined is the sum of all areas, so it may be much larger than any single area. -
highlight: Up to 5 geographic areas to highlight in color. Only available whendatais disaggregated by ADM1 or ADM2. Default:NULL. -
within_ADM1: Character vector to filter to specific ADM1 units whengeo_level = "ADM2". All areas combined then refers to those areas only. Default:NULL. -
min_total: Minimum number of records for an area to be shown in a given month, leaving gaps in the lines otherwise. Useful because rates based on few records can be misleading and stretch the y-axis. Default:NULL(all months shown).
Interpretation
This analysis helps spot trends in duplicate records over time. If a
month or set of months has higher duplicate rates than the rest, it may
point to a systematic error affecting the records from that period. For
example, records may have been written more than once during a batch
migration from an older EIR, or a batch of paper records may have been
digitized twice. In the example, duplicates are clearly concentrated in
the first half of 2022, particularly in the ADM1_4 area,
and almost disappear afterwards.
Step 5 — Inspect individual records with
dd_duplicates()
dd_duplicates() returns a record-level table with every
record of each dose registered more than once for the same person. Below
we list all the DTP1 doses registered more than once:
duplicates_df <- dd_duplicates(data.EIR = immunABC.EIR, vaccines = "DTP1")
duplicates_df %>%
head() %>%
kable(caption = "DTP1 doses registered more than once")| ID | date_birth | dose | date_vax | ADM1_occurrence | ADM2_occurrence | group | copy | n_copies | days_since_first_entry | duplication |
|---|---|---|---|---|---|---|---|---|---|---|
| 185280 | 2023-07-07 | DTP1 | 2023-10-04 | ADM1_3 | ADM2_3_14 | 1 | 1 | 6 | NA | FIRST_ENTRY |
| 185280 | 2023-07-07 | DTP1 | 2023-10-04 | ADM1_3 | ADM2_3_14 | 1 | 2 | 6 | 0 | DUPLICATE |
| 185280 | 2023-07-07 | DTP1 | 2023-10-04 | ADM1_3 | ADM2_3_14 | 1 | 3 | 6 | 0 | DUPLICATE |
| 185280 | 2023-07-07 | DTP1 | 2023-10-04 | ADM1_3 | ADM2_3_14 | 1 | 4 | 6 | 0 | DUPLICATE |
| 185280 | 2023-07-07 | DTP1 | 2023-10-04 | ADM1_3 | ADM2_3_14 | 1 | 5 | 6 | 0 | DUPLICATE |
| 185280 | 2023-07-07 | DTP1 | 2023-10-04 | ADM1_3 | ADM2_3_14 | 1 | 6 | 6 | 0 | DUPLICATE |
Parameters accepted
-
data.EIR: EIR data frame in immunABC format. -
vaccines: Character vector of doses to include. DefaultNULLuses all doses. -
birth_cohorts: Numeric vector of birth cohort year(s) to filter to. DefaultNULLuses all available cohorts.
Output
Note that besides the original columns of each record, the output includes:
-
group: a number identifying all the records of the same person and dose. -
copy: the position of the record within its group, in date order. -
n_copies: the number of records in the group. -
days_since_first_entry: days between the record and theFIRST_ENTRYof its group. -
duplication: the category of the record:FIRST_ENTRY,DUPLICATEorREPEATED.
Interpretation
This table can be exported for record-level review and correction
workflows. For example, the days_since_first_entry column
tells apart REPEATED records registered on the same day in
two different places (days_since_first_entry = 0) from
those registered weeks or months after the first entry, which may point
to different causes (see Step 6).
Step 6 — Explore the possible causes of repeated records with
dd_repeat_plot()
For the sake of example, let’s consider the following hypothetical case for a person born on January 10, 2022:
dose |
date_vax |
Age at vaccination | ADM2_occurrence |
copy |
days_since_first_entry |
duplication |
|---|---|---|---|---|---|---|
| DTP1 | 2022-03-11 | 60 days | ADM2_1_1 |
1 | NA |
FIRST_ENTRY |
| DTP1 | 2022-05-12 | 122 days | ADM2_1_1 |
2 | 62 | REPEATED |
The first record falls inside the DTP1 vaccination window (54 to 90
days of age, according to immunABC.schedule), so it is most
likely a legitimate DTP1. The second DTP1 record, however, was
registered at 122 days of age, right inside the DTP2 window (116 to 150
days). If we look up the rest of this person’s records in the EIR and
find a DTP3 at 6 months but no DTP2, the most likely explanation is that
the DTP2 dose was registered with the wrong dose number. Rather than an
extra dose, this person probably has a mislabeled DTP2 dose.
The example above was a single person, but reviewing every group by
hand is not feasible when an EIR has thousands of them. What we really
want to know is whether that story is an isolated case or a systematic
pattern: are the REPEATED DTP1 records of the EIR mostly
registered at the age DTP2 is due?
dd_repeat_plot() answers this question for the whole
table at once. It takes the output of dd_duplicates() and,
for a single dose, shows the age at vaccination of the
FIRST_ENTRY records (top panel) and of the
REPEATED records (bottom panel). One can also pass
data.schedule and schedule_vaccines to shade
specific vaccination windows in the plot, and therefore more clearly
highlight any DTP2 doses being mislabeled as DTP1.
dd_repeat_plot(
data = duplicates_df,
vaccine = "DTP1",
max_age = 365,
data.schedule = immunABC.schedule,
schedule_vaccines = c("DTP1", "DTP2")
)
We can also split the results by subnational area using
geo_level, thereby showing whether the pattern is the same
everywhere:
dd_repeat_plot(
data = duplicates_df,
vaccine = "DTP1",
geo_level = "ADM1",
max_age = 365,
binwidth = 14,
data.schedule = immunABC.schedule,
schedule_vaccines = c("DTP1", "DTP2")
)
Parameters accepted
-
data: Output ofdd_duplicates(). -
vaccine: The single dose to show, e.g."DTP1". -
geo_level: Geographic level of occurrence to split the panels by:"ADM0"(default, no split),"ADM1", or"ADM2". -
within_ADM1: Character vector to filter to specific ADM1 units of occurrence whengeo_levelis"ADM1"or"ADM2". Default:NULL. -
binwidth: Width of each bar of the histogram, in days. Default:7(one week). -
max_age: Maximum age at vaccination to show on the x-axis, in days. The number of records beyond it is given in the caption. Default:NULL(all ages shown). -
data.schedule: Vaccination schedule data frame in immunABC format, used to shade vaccination windows. Default:NULL(no windows shown). -
schedule_vaccines: Up to 3 doses whose vaccination window is shaded. Only used withdata.schedule. DefaultNULLshades the window ofvaccine.
Interpretation
The shape of the bottom panel hints at the cause of the repeats:
- Repeats at the age of the next dose: if the repeats of DTP1 are concentrated in the DTP2 vaccination window, as in the example, the second record is most likely a DTP2 dose registered as DTP1. These people will probably appear with a skipped DTP2 in the CD 3.2 Dose Sequence Comparison module.
- Repeats shortly after the first entry, within the same window: the dose may have been registered again at a follow-up visit, or administered twice because the person’s vaccination history was not checked.
- Repeats spread over all ages: the records may belong to two different people linked to the same ID, which is a record linkage problem.
Note
Records with no
date_birth, or withdate_vaxbeforedate_birth, have no valid age at vaccination, so they are excluded from this analysis. The CD 3.1/3.3 Date Consistency Comparison module can help investigate the latter.
Summary
The dd_ module provides a complete pipeline for
detecting doses registered more than once in EIR data, telling apart
DUPLICATE records (the same vaccination event registered
more than once, with the same date and place) from REPEATED
records (the same dose registered on a different date or in a different
place).
-
dd_rate(),dd_barplot()anddd_heatmap()give a geographic overview by dose or birth cohort, -
dd_trend()anddd_trend_plot()analyze possible time trends in duplicate records, -
dd_duplicates()allows record-level inspection, and -
dd_repeat_plot()helps identify the causes of repeated records.
Since duplicate and repeated records are data quality issues that bias many indicators (such as coverage or dropout), we recommend running this module early to identify any possible issues with your own EIR.