CALIFORNIA IMMUNIZATION REGISTRY

HPV Vaccination Data Dictionary
Recipient View

Last Updated 6/19/2023

Excel spreadsheet version- for print only

Dataset Name: VW_HPV_RECIPIENT_LHJ

Dataset Description: This is a recipient level view that contains all HPV vaccine dose recipients reported to the California Immunization Registry (CAIR2), including records received from the Healthy Futures Registry (also known as the Regional Immunization Data Exchange or RIDE) via data exchange. RIDE data was incorporated into CAIR November 2022. The San Diego Immunization Registry was integrated into CAIR2 in April 2022.  

Field Definitions

Field No.	Data Element	Variable Name	Data Element Description	Value Set
1	Recipient ID	RECIP_ID	Unique ID for this recipient.	n/a
2	Recipient name: first	RECIP_FIRST_NAME	Recipient's first name.	n/a
3	Recipient name: middle	RECIP_MIDDLE_ NAME	Recipient's middle name.	n/a
4	Recipient name: last	RECIP_LAST_NAME	Recipient's last name.	n/a
5	Recipient date of birth	RECIP_DOB	Recipient's date of birth.	n/a
6	Recipient age	RECIP_AGE	Recipient's age in years at time of vaccination.	n/a
7	Recipient current age	RECIP_CURRENT_ AGE	Recipient's current age in years.	n/a
8	Recipient sex	RECIP_SEX	Recipient sex.	HL7 User Defined table 0001 M (Male) F (Female) U (Unknown/ undifferentiated) X (Non-Binary)
9	Recipient race/ethnicity	RECIP_RACE_ETH	Recipient's race/ethnicity.	When ethnicity is marked ‘Hispanic or Latino’ then ‘Latino’, when more than one specified race code (1002-5, 2028-9, 2076-8, 2054-5, 2106-3) is noted then ‘Multiracial’, otherwise first race is noted. Derived from original ethnicity and race codes: HL7 User Defined Table 0189 2135-2 (Hispanic or Latino) 2186-5 (Not Hispanic or Latino) PHC1175 (Prefer not to say) UNK (Unknown ethnicity) POL (Unable to report to do policy/law) HL7 User Defined Table 0005 1002-5 (American Indian or Alaska Native) 2028-9 (Asian) 2076-8 (Native Hawaiian or Other Pacific Islander) 2054-5 (Black or African American) 2106-3 (White) 2131-1 (Other Race) UNK (Unknown)
10	Recipient address: street	RECIP_ADDRESS_ STREET	The street component of the recipient's address.	n/a
11	Recipient address:  street 2	RECIP_ADDRESS_ STREET_2	The street 2 component of the recipient's address.	n/a
12	Recipient address: city	RECIP_ADDRESS _CITY	The city component of the recipient's address.	n/a
13	Recipient address: state	RECIP_ADDRESS_ STATE	The state component of the recipient's address.	US Postal Service two-character State Codes
14	Recipient address: zip code	RECIP_ADDRESS _ZIP	The zip code of the recipient's address (5 digit or 10 digits, with hyphen, are acceptable).	n/a
15	Recipient county name	RECIP_COUNTY _LABEL	The county name component of the recipient's address.	Derived from FIPs based on County Code. When RECIP_ADDRESS_ COUNTY is null, derived from RECIP_ADDRESS_ZIP. See RECIP_ADDRESS_ COUNTY_NEW
16	Responsible organization	RESPONSIBLE_ORG	The name of the parent organization or health system that originated and is accountable for the content of the record. If an organization has several clinics or facilities, this would be the organization that represents all of the clinics/facilities (the "Administered at location" field is the name of individual physical location).	n/a
17	Administered at location	ADMIN_NAME	The name of the physical clinic or facility that reported the vaccination. In a small practice setting, this could be the same as the responsible organization.	n/a
18	Administered at location: state	ADMIN_ADDRESS_ STATE	Address of the physical clinic or facility that reported the vaccination.	n/a
19	Administered at location: zip code	ADMIN_ADDRESS_ ZIP	Zipcode of the physical clinic or facility that reported the vaccination.	n/a
20	Administration address: county name	ADMIN_COUNTY_ LABEL	The county component of where the vaccine is being administered/ planned to be administered. Exception for mobile clinics.	Join with FIPs table based on County_Code to get the county name
21	Census tract – recipient address (2020)	CENSUS_TRACT	2020 census tract based on recipient address only.	n/a
22	Census tract – recipient address (2010)	CENSUS_TRACT_10	2010 census tract based on recipient address only.	n/a
23	Census tract – administration address	CENSUS_TRACT_ ADMIN_10	2010 census tract based on vaccinating provider’s address only.	n/a
24	HPI 3.0 - census tract	HPI_3_TRACT	Healthy Places Index 3.0 score quartile based on the 2010 census tract from the recipient’s address.	Healthy Places Index Locally Defined Value Set: 1 (HPI Quartile 1) 2 (HPI Quartile 2) 3 (HPI Quartile 3) 4 (HPI Quartile 4) Null (no HPI score assigned) https://map.healthyplacesindex.org
25	HPI 3.0 – zip	HPI_3_ZIP	Healthy PIaces Index 3.0 score quartile based on the recipient’s address zip (if null, uses the ZCTA zip from the zip-to-ZCTA crosswalk); if recipient’s address zip is still null, uses the vaccinating provider’s address zip (if provider’s address zip is null, uses the ZCTA from the zip-to-ZCTA crosswalk).	Healthy Places Index Locally Defined Value Set: 1 (HPI Quartile 1) 2 (HPI Quartile 2) 3 (HPI Quartile 3) 4 (HPI Quartile 4) Null (no HPI score assigned) https://map.healthyplacesindex.org
26	HPI 3.0 - mixed	HPI_3_MIXED	HPI_3_TRACT; if null, uses HPI_3_ZIP.	Healthy Places Index Locally Defined Value Set: 1 (HPI Quartile 1) 2 (HPI Quartile 2) 3 (HPI Quartile 3) 4 (HPI Quartile 4) Null (no HPI score assigned) https://map.healthyplacesindex.org
27	Recipient address: county based on HPI_3_MIXED	HPI_COUNTY_ RCP_MIXED	The county name of the recipient’s address, derived from HPI_3_MIXED.	n/a
28	Recipient age at time of dose number 1 of HPV	AGE_AT_DOSE_1	Recipient's age in years at time of dose number 1 of HPV.	n/a
29	Recipient age at time of dose number 2 of HPV	AGE_AT_DOSE_2	Recipient's age in years at time of dose number 2 of HPV.	n/a
30	Recipient age at time of dose number 3 of HPV	AGE_AT_DOSE_3	Recipient's age in years at time of dose number 3 of HPV.	n/a
31	Recipient age at time of dose number 4 of HPV	AGE_AT_DOSE_4	Recipient's age in years at time of dose number 4 of HPV.	n/a
32	Administration date: Dose 1	ADMIN_DATE_1	The first recorded HPV administration date for the recipient.	n/a
33	Administration date: Dose 2	ADMIN_DATE_2	The second recorded HPV administration date for the recipient.	n/a
34	Administration date: Dose 3	ADMIN_DATE_3	The third recorded HPV administration date for the recipient.	n/a
35	Administration date: Dose 4	ADMIN_DATE_4	The fourth recorded HPV administration date for the recipient.	n/a
36	Administered at location: type for Dose 1	ADMIN_TYPE_1	The characteristic of the provider site that reported the vaccination, refusal, or missed appointment, for the first recorded HPV dose.	Locally Defined Value Set: 1 (Commercial vaccination service provider) 2 (Corrections/detention health services) 3 (Health center – community) 4 (Health center – migrant or refugee) 5 (Health center – occupational) 6 (Health center – STD/HIV clinic) 7 (Health center – student) 8 (Home health care provider) 9 (Hospital) 10 (Indian Health Service) 11 (Tribal health) 12 (Medical practice – family medicine) 13 (Medical practice – pediatrics) 14 (Medical practice – internal medicine) 15 (Medical practice – OB/GYN) 16 (Medical practice – other specialty) 17 (Pharmacy – chain) 18 (Pharmacy – independent) 19 (Public health provider – public health clinic) 20 (Public health provider – Federally Qualified Health Center) 21 (Public health provider – Rural Health Clinic) 22 (Long-term care – nursing home, skilled nursing facility, federally certified) 23 (Long-term care – nursing home, skilled nursing facility, non-federally certified) 24 (Long-term care – assisted living) 25 (Long-term care – intellectual or developmental disability) 26 (Long-term care – combination) 27 (Urgent care) 28 (Other) UNK (Unknown)
37	Administered at location: type for Dose 2	ADMIN_TYPE_2	The characteristic of the provider site that reported the vaccination, refusal, or missed appointment, for the second recorded HPV dose.	See value set for ADMIN_TYPE_1 above.
38	Administered at location: type for Dose 3	ADMIN_TYPE_3	The characteristic of the provider site that reported the vaccination, refusal, or missed appointment, for the third recorded HPV dose.	See value set for ADMIN_TYPE_1 above.
39	Administered at location: type for Dose 4	ADMIN_TYPE_4	The characteristic of the provider site that reported the vaccination, refusal, or missed appointment, for the fourth recorded HPV dose.	See value set for ADMIN_TYPE_1 above.
40	Administered at location: type description for Dose 1	ADMIN_TYPE_ DESC_1	The characteristic of the provider site that reported the vaccination, refusal, or missed appointment, for the first recorded HPV dose.	See value set for ADMIN_TYPE_1 above.
41	Administered at location: type description for Dose 2	ADMIN_TYPE_ DESC_2	The characteristic of the provider site that reported the vaccination, refusal, or missed appointment, for the second recorded HPV dose.	See value set for ADMIN_TYPE_1 above.
42	Administered at location: type description for Dose 3	ADMIN_TYPE_ DESC_3	The characteristic of the provider site that reported the vaccination, refusal, or missed appointment, for the third recorded HPV dose.	See value set for ADMIN_TYPE_1 above.
43	Administered at location: type description for Dose 4	ADMIN_TYPE_ DESC_4	The characteristic of the provider site that reported the vaccination, refusal, or missed appointmen, for the fourth recorded HPV dose.	See value set for ADMIN_TYPE_1 above.
44	Vaccine status of recipient	VACCINE_STATUS	The up-to-date status of the recipient based on CDC guidelines.	NOT UP TO DATE - recipient has not completed series UP TO DATE- Up to date if: 1st dose between 9-15 y/o, 2nd dose was more than 136 days after 1st dose 1st dose between 9-15 y/o, 2nd dose less than 137 days after first, 3rd dose more than 80 days after 2nd, (3rd dose was given before 12/16/2016 and more than 108 days after 1st dose) OR (3rd dose given after 12/15/2016 and more than 136 days after 1st dose) 1st dose between 15-27 y/o, 2nd dose more than 24 days after 1st dose, 3rd dose more than 80 days after 2nd and more than 136 days after 1st 1st dose between 15-27 y/o, 2nd dose given early (before 25 days after 1st)/3rd dose given early (before 81 days after 2nd and/or before 137 days after 1st), but 4th dose given more than 80 days after 3rd
45	Eligible for second dose in series	ELIGIBLE_DOSE_2	Recipient eligible for second dose in series	1 - eligible for second dose 0 - not eligible for second dose
46	Eligible for third dose in series	ELIGIBLE_DOSE_3	Recipient eligible for third dose in series	1 - eligible for third dose 0 - not eligible for third dose
47	Recipient has initiated series	INITIATED_SERIES	Recipient has initiated series	1- recipient has initated series
48	Vaccine eligibility	VACCINE_ ELIGIBILITY	The recipient’s documented eligibility for the vaccine (e.g., VFC- MediCal/CHDP, VFC-Uninsured, etc.; 317; State General Fund; Private). Known data quality issues, not a required field.	V01 Private V02 VFC Eligible Medi-Cal/CHDP V03  VFC Eligible Uninsured V04 VFC Eligible Native American/AK Native V05  VFC Eligible Underinsured (FQHC/RHC Only) V07 317 Eligible LHD or HDAS Only CAA01 State General Funding

Page Last Updated :

To Top

COVID-19

Diseases and Conditions

Licensing, Certification and Other Credentials

Family Health

Personal Health and Prevention

Health and Safety

Health Facilities

Administrative

Person Interested In

CALIFORNIA IMMUNIZATION REGISTRY

HPV Vaccination Data Dictionary​​ Recipient View

Field Definitions

HPV Vaccination Data Dictionary
Recipient View