Skip Navigation LinksHepB-DataDictionaryRecipView

california immunization registry

Hepatitis B ​Vaccinations                           CAIR2 Logo  
Data Dictionary – Recipient Level View

Excel

​Last Updated 2/8 /2024

Dataset Name: VW_HEP_B_RECIP_LHJ

Dataset Description: This is a recipient level view that contains all hepatitis B 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 date of birth
​RECIP_DOB
​Recipient's date of birth.
​n/a
​3
​Recipient sex
​RECIP_SEX
​Recipient sex.
​HL7 User Defined table 0001 
M (Male) 
F (Female) 
U (Unknown/undifferentiated)
X (Non-binary) 



​4
​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)

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)




​5
​Administration date: dose 1 (most recent)
​ADMIN_DATE_1
​Most recent (up to four) Hep B vaccine administration dates. ADMIN_DATE_1 = most recent Hep B vaccine administration date.​
​n/a
​6
​Administration date: dose 2
​ADMIN_DATE_2
​Most recent (up to four) Hep B vaccine administration dates. ADMIN_DATE_1 = most recent Hep B vaccine administration date.
​n/a
​7
​Administration date: dose 3
​ADMIN_DATE_3
​Most recent (up to four) Hep B vaccine administration dates. ADMIN_DATE_1 = most recent Hep B vaccine administration date.
​n/a
​8
​Administration date: dose 4
​ADMIN_DATE_4
​Most recent (up to four) Hep B vaccine administration dates. ADMIN_DATE_1 = most recent Hep B vaccine administration date.
​n/a
​9
​Vaccine product - dose 1
​VACCINE_PRODUCT_1
​The manufacturer name of vaccine received for the most recent (up to four) Hep B vaccinations. Vaccine_Product_1 = most recent Hep B vaccination given​
​n/a
​10
​Vaccine product - dose 2
​VACCINE_PRODUCT_2
​The manufacturer name of vaccine received for the most recent (up to four) Hep B vaccinations. Vaccine_Product_1 = most recent Hep B vaccination given.
​n/a
​11
​Vaccine product - dose 3
​VACCINE_PRODUCT_3
​The manufacturer name of vaccine received for the most recent (up to four) Hep B vaccinations. Vaccine_Product_1 = most recent Hep B vaccination given.
​n/a
​12
​Vaccine product - dose 4
​VACCINE_PRODUCT_4
​The manufacturer name of vaccine received for the most recent (up to four) Hep B vaccinations. Vaccine_Product_1 = most recent Hep B vaccination given.
​n/a
​13
​CVX - dose 1
​VACCINE_PRODUCT_1_CVX
​The vaccine type that was administered for the most recent (up to four) Hep B vaccinations. Vaccine_Product_1_cvx = most recent Hep B vaccination given.

CVX Codes

​14
​CVX - dose 2
​VACCINE_PRODUCT_2_CVX
​The vaccine type that was administered for the most recent (up to four) Hep B vaccinations. Vaccine_Product_1_cvx = most recent Hep B vaccination given.

CVX Codes

​15
​CVX - dose 3
​VACCINE_PRODUCT_3_CVX
​The vaccine type that was administered for the most recent (up to four) Hep B vaccinations. Vaccine_Product_1_cvx = most recent Hep B vaccination given.

CVX Codes

​16
​CVX - dose 4
​VACCINE_PRODUCT_4_CVX
​The vaccine type that was administered for the most recent (up to four) Hep B vaccinations. Vaccine_Product_1_cvx = most recent Hep B vaccination given.

CVX Codes

​17
​Vaccine received - Birth
​VAX_BIRTH_RECEIVED
​Received Hep B vaccine at birth, as recommended by CDC.
​Yes/No
​18
​Vaccine received - within 3 days of birth
​VAX_BIRTH_3_DAYS_RECEIVED
​Received Hep B vaccine within 3 days of birth.
​Yes/No​
​19
​Vaccine 2 received - 1-2 Months of age
​VAX_2_RECEIVED_CHILDHOOD
​Received second Hep B vaccine at 1-2 months of age, as recommended by CDC.
​Yes/No
​20
​Vaccine 3 received - 6-18 Months of age
​VAX_3_RECEIVED_CHILDHOOD
​Received third Hep B dose at 6-18 months of age, as recommended by CDC.
​Yes/No
​21
​Hep B series completed per CDC childhood immunization schedule
​Hep_B_SERIES_COMPLETE_CHILDHOOD
​Three dose Hep B childhood vaccination series was completed according to CDC childhood immunization schedule 
​Yes/No
​22
​Vaccine received - time 0
​VAX_1_RECEIVED
​Received first Hep B dose
​Yes/No
​23
​Vaccine 2 received - 1-2 months after first dose
​VAX_2_RECEIVED
​Received second Hep B vaccine  1-2 months after first dose, as recommended by CDC.
​Yes/No
​24
​Vaccine 3 received - 6 months after first  dose
​VAX_3_RECEIVED
​Received third Hep B dose 6 months after first dose, as recommended by CDC.
​Yes/No
​25
​Hep B 3 dose series completed
​Hep_B_SERIES_3_COMPLETE
​Three dose Hep B vaccination series completed at 0, 1-2 months and 6 month interval​
​Yes/No
​26
​Hep B 3 dose series completed, varied interval
​Hep_B_RECEIVED_3_DOSES
​Received three doses of Hep B, vaccine interval varied
​Yes/No
​27
​Hep B 2 dose series completed 
​Hep_B_SERIES_2_COMPLETE_Recombivax
​Adolescents age 11–15 years may use an alternative 2-dose schedule with at least 4 months between doses (adult formulation Recombivax HB only)
​Yes/No
​28
​Hep B 2 dose series completed 
​Hep_B_SERIES_2_COMPLETE_Heplisav
​Adolescents age 18 years or older may receive: Heplisav-B 2-dose series at least 4 weeks apart
​Yes/No
​29
​Recipient age - at first dose, months
​AGE_FIRST_Hep_B_Months
​Recipient age in months when received first Hep B vaccine.
​n/a
​30
​Recipient age - at second dose, months
​AGE_SECOND_Hep_B_Months
​Recipient age in months when received second Hep B vaccine.
​n/a
​31
​Recipient age - at third dose, months
​AGE_THIRD_Hep_B_Months
​Recipient age in months when received third Hep B vaccine.
​n/a
​32
​Recipient age - at first dose, years
​AGE_FIRST_Hep_B_Years
​Recipient age in years when received first Hep B vaccine.​
​n/a
​33
​Recipient age - at second dose, years
​AGE_SECOND_Hep_B_Years
​Recipient age in years when received second Hep B vaccine.
​n/a
​34
​Recipient age - at third dose, years
​AGE_THIRD_Hep_B_Years
​Recipient age in years when received third Hep B vaccine.
​n/a
​35
​Recipient name: first
​RECIP_FIRST_NAME
​Recipient's first name.
​n/a
​36
​Recipient name: middle
​RECIP_MIDDLE_NAME
​Recipient's middle name.
​n/a
​37
​Recipient name: last
​RECIP_LAST_NAME
​Recipient's last name.
​n/a
​38
​Recipient age
​RECIP_AGE
​Recipient’s age in years as of current date.
​n/a
​39
​Recipient address: street
​RECIP_ADDRESS_STREET
​The street component of the recipient's address.
​n/a
​40
​Recipient address:  street 2
​RECIP_ADDRESS_STREET_2
​The street 2 component of the recipient's address.​
​n/a
​41
​Recipient address: city
​RECIP_ADDRESS_CITY
​The city component of the recipient's address
​n/a
​42
​Recipient address: state
​RECIP_ADDRESS_STATE
​The state component of the recipient's address.
​US Postal Service two-character State Codes
​43
​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
​44
​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. 
45​​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
​46
​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. Derived from value recorded for most recent dose. 
​Join with FIPs table based on County Code to get county name.
​47
​Census tract – recipient address (2020)
​CENSUS_TRACT
​2020 census tract based on recipient address only.
​48
​Census tract – recipient address (2010)
​CENSUS_TRACT_10
​2010 census tract based on recipient address only.
​49
​Census tract – administration address
​CENSUS_TRACT_ADMIN_10
​2010 census tract based on vaccinating provider’s address only.
​50
​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
​51
​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.
​52
​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 



​53
​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  



​54
​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
Page Last Updated :