Skip Navigation LinksCAIR-records-LHD-HepA-DataDictionaryRecipView

california immunization registry

Hepatitis A ​Vaccinations                               CAIR logo
Data Dictionary
- Recipient  Level View 

  

Excel​

Last Updated 9/25/2023

Dataset Name: VW_HEP_A_RECIP_LHJ

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



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




​8
Recipient’s current age
RECIP_CURRENT_AGE
Recipient's current age in years.
n/a
​9​

​Recipient age at first dose
​AGE_FIRST_HEPA
​Recipient age in years at time of first dose of hep A vaccine.​
​n/a

10
​Recipient age at second dose
​AGE_SECOND_HEPA
​Recipient age in years at time of second dose of hep A vaccine.
​n/a

11
​Recipient age at third dose
​AGE_THIRD_HEPA
​Recipient age in years at time of third dose of hep A vaccine.
​n/a
​12

​Recipient age at fourth dose
​AGE_FOURTH_HEPA
​Recipient age in years at time of fourth dose of hep A vaccine.
​n/a

13
​Recipient age​
​RECIP_AGE
​Recipient age in years at time of most recent dose.
​n/a

14
​Recipient address: street
​RECIP_ADDRESS_STREET
​The street component of the recipient's address.
​n/a

15

​Recipient address:  street 2
​RECIP_ADDRESS_STREET_2
​The street 2 component of the recipient's address.​
​n/a
​16
​Recipient address: city

​RECIP_ADDRESS_CITY
​The city component of the recipient's address.
​n/a

17
Recipient address: state​​RECIP_ADDRESS_STATE
​The state component of the recipient's address.
​US Postal Service two-character State Codes
​18
​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
​19

​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


20
​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​
​21

​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

22
​Census tract – recipient address (2020)
​CENSUS_TRACT
​2020 census tract based on recipient address only.

23

​Census tract – recipient address (2010)
​CENSUS_TRACT_10
​2010 census tract based on recipient address only.
​24

​Census tract – administration address
​CENSUS_TRACT_ADMIN_10
​2010 census tract based on vaccinating provider’s address only
​25

​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 



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




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

​​


28
​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.
​29

​Administration date: dose 1
​ADMIN_DATE_DOSE1
​The first recorded hepatitis A vaccine administration date for the recipient
​n/a

30
Administration date: dose 2​​ADMIN_DATE_DOSE2
​The second recorded hepatitis A vaccine administration date for the recipient. ​
​n/a
​31

​Administration date: dose 3
​ADMIN_DATE_DOSE3
​The third recorded hepatitis A vaccine administration date for the recipient. 
​n/a
​32

​Administration date: dose 4
​ADMIN_DATE_DOSE4
​The fourth recorded hepatitis A vaccine administration date for the recipient. 
​n/a

33
​Vaccine product - dose 1
​VACCINE_PRODUCT_1
​The manufacturer name of vaccine received for the first dose of the hepatitis A vaccine series. Vaccine_Product_1 = first hepatitis A vaccination given.
​n/a
​34

​Vaccine product - dose 2
​VACCINE_PRODUCT_2
​The manufacturer name of vaccine received for the second dose of the hepatitis A vaccine series. Vaccine_Product_2 = second hepatitis A vaccination given.
​n/a

35
​Vaccine product - dose 3
​VACCINE_PRODUCT_3
​The manufacturer name of vaccine received for the third dose of the hepatitis A vaccine series. Vaccine_Product_3 = third hepatitis A vaccination given.​
​n/a
​36

​Vaccine product - dose 4
​VACCINE_PRODUCT_4
​The manufacturer name of vaccine received for the fourth dose of the hepatitis A vaccine series. Vaccine_Product_4 = fourth hepatitis A vaccination given.
​n/a
​37

​CVX - dose 1
​VACCINE_PRODUCT_1_CVX
​The vaccine type that was administered for the first dose of the hepatitis A vaccine series. Vaccine_Product_1_CVX = first hepatitis A vaccination given. 
CVX Codes​
​38

​CVX - dose 2
​VACCINE_PRODUCT_2_CVX
​The vaccine type that was administered for the second dose of the hepatitis A vaccine series. Vaccine_Product_2_CVX = second hepatitis A vaccination given. 
CVX Codes​
​39
​CVX - dose 3
​VACCINE_PRODUCT_3_CVX
​The vaccine type that was administered for the third dose of the hepatitis A vaccine series. Vaccine_Product_3_CVX = third hepatitis A vaccination given
CVX Codes
​40
​CVX - dose 4
​VACCINE_PRODUCT_4_CVX
​The vaccine type that was administered for the fourth dose of the hepatitis A vaccine series. Vaccine_Product_4_CVX = fourth hepatitis A vaccination given. 
CVX Codes​
​41
Hepatitis A vaccination series completed
HAV_SERIES_COMPLETE_
ON_SCHEDULE
Hepatitis A vaccination completed according to CDC recommended schedules: (1) 1-17 years and 2 doses of CVX 83 at least 6 months apart; (2) 18+ and 2 doses of CVX 52; (3) 18+ and 3 doses of CVX 104 [0, 1, and 6 months]; or (4) 18+ and 3 doses of CVX 104 at 0, 7, and 21-30 days, followed by a booster dose at 12 months.
Yes
No






 


                                              ​​​


​​
Page Last Updated :