Skip Navigation LinksCAIR-records-LHD-COVID-DataDictionary-RecipView

CALIFORNIA IMMUNIZATION REGISTRY

COVID-19 Vaccination 
Snowflake IRIS DATA Dictionary Recipient View

Last Updated 7/6/2022

LHJ Data Source in IRIS 

View Name: VW_ALL_ IIS_RECIPIENTS_LHJ 

View Description: This is a recipient level view that contains one row per vaccine recipient and is used by the California Department of Public Health (CDPH) vaccine data team for calculations that involve measures of people (e.g., partially/fully vaccinated, race/ethnicity). The data include COVID-19 vaccine doses reported to the California Immunization Registry (CAIR2) and the Healthy Futures Registry (the San Diego Immunization Registry was integrated into CAIR2 in April 2022). Doses administered by the following federal agencies and reported directly to the CDC are not included: Veterans Health Administration, Department of Defense, the Federal Bureau of Prisons, and some Indian Health Service clinics. 

FIELD DEFINITIONS 

Field No.
COVID-19 Data Element
​Variable Name
Data Element Description
​Value Set
​1

Recipient ID 

recip_id

Unique ID for this recipient. This can be the ID used by your system or a randomly assigned unique identifier. However, the ID must be consistent across reports to allow linking doses to the same recipient ID. 

n/a 

​2

Administration

date – Dose 1 

ds1_admin_date 

The first recorded dose administration date for the recipient. 


Ignores DOSE_NUM field in VW_ALL_IIS_LHJ for determination. 

n/a 

​3

Administration

date – Dose 2 

ds2_admin_date 

The second recorded dose administration date for the recipient. 


Ignores DOSE_NUM field in VW_ALL_IIS_LHJ for determination. 

n/a 

​4

Vaccine types

received 

vax_received 

The manufacturer name (s) of all vaccines received, for up to 4 doses.  

​Locally Defined Value Set:  

Moderna 

Pfizer 

J&J 

​5

Vaccination

status 

fully_vaccinated 

Recipient’s vaccination status  


The following criteria were removed on 2/22/2022: 

- Three or more vaccination records 

- Only dose in IRIS is labeled as dose number 2 


​Locally Defined Value Set: 

FALSE (Partially vaccinated) 
TRUE (Fully vaccinated) 

 

A vaccine recipient is considered fully vaccinated if they meet at least one of the following criteria: 

1) They received one dose of J&J 

2) They received two 

Pfizer doses 

>= 17 days apart 

3) They received two Moderna doses

>= 24 days apart 

4) They received a combination of Pfizer/Moderna doses

>= 17 days apart. 

​6

Recipient

name: first 

recip_first_name 

Recipient's first name 


Derived from value recorded for second dose, unless null, then first dose value is used.  

n/a 

​7

Recipient

name: middle 

recip_middle

_name 

Recipient's middle name


Derived from value recorded for second dose, unless null, then first dose value is used.  

n/a 

​8

Recipient

name: last 

recip_last_name 

Recipient's last name 


Derived from value recorded for second dose, unless null, then first dose value is used. 

​n/a
​9

Recipient

date of birth 

recip_dob 

Recipient's date of birth  


Derived from value recorded for second dose, unless null, then first dose value is used. 

​n/a
​10

Recipient age 

recip_age 

Recipient’s age in years 


Derived from value recorded for second dose, unless null, then first dose value is used. 

​n/a
​11

Recipient

age group 

recip_age_group 

Recipient’s age group, in years 


Derived from value recorded for second dose, unless null, then first dose value is used. 

​Locally Defined Value Set: 

Under 5 

5-11 

12-17 

18-49 

50-64 

65+ 

Unknown* 

 

Birthdates within 60 days of the vaccination date are categorized as ‘Unknown’

​12

Recipient sex 

recip_sex 

Recipient sex 


Derived from value recorded for second dose, unless null, then first dose value is used. 

HL7 User Defined Table 0001  
M (Male) 
F (Female) 
U (Unknown/undifferentiated) 

​13

Recipient race/ethnicity   

recip_race_eth 

Recipient’s race/ethnicity  


Derived from value recorded for second dose, unless null, then first dose value is used. 

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

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) 

POL (Unable to report due to policy/law) 

​14

Recipient

address: street 

recip_address_street 

The street component of the recipient's address 


UPDATED 4/5/2022. Derived from value recorded for most recent dose. Previously derived from second dose value. 

​n/a
​15

Recipient

address:  street 2 

recip_address

_street_2 

The street 2 component of the recipient's address 


UPDATED 4/5/2022. Derived from value recorded for most recent dose. Previously derived from second dose value.  

Previous name: recip_recip_address_street_2.

​n/a
​16

Recipient

address: city 

recip_address_city 

The city component of the recipient's address 


UPDATED 4/5/2022. 

Derived from value recorded for most recent dose. Previously derived from second dose value.

​n/a
​17

Recipient

address:

zip code 

recip_address_zip 

The zip code of the recipient's address (5 digit or 10 digits, with hyphen, are acceptable) 


UPDATED 4/5/2022. 

Derived from value recorded for most recent dose. Previously derived from second dose value. 

​n/a
​18

Recipient

county name 

recip_county_label 

The county name component of the recipient's address 


UPDATED 4/5/2022. 

Derived from value recorded for most recent dose. Previously derived from second dose value. 

 

‘Outside California’ category includes out-of-state residents and records where recipient’s state of residence is blank. 

Derived from FIPs based on County_Code. When recip_address_county is null, derived from recip_address_zip. 

See Recip_Address_

County_New. 

​19

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


UPDATED 4/5/2022. 

Derived from value recorded for most recent dose. Previously derived from second dose value.  

​n/a
​20

Administered

at location 

admin_name 

The name of the physical clinic or facility that reported the vaccination, refusal, or missed appointment. In a small practice setting, this could be the same as the responsible organization. 


UPDATED 4/5/2022. 

Derived from value recorded for most recent dose. Previously derived from second dose value. 

​n/a
​21

Administration

address:  
zip code 

admin_address_zip 

The zip code component of where the vaccine is being administered/ planned to be administered. Exception for mobile clinics.  


UPDATED 4/5/2022. 

Derived from value recorded for most recent dose. Previously derived from second dose value. 

​n/a
​22

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.  


UPDATED 4/5/2022. 

Derived from value recorded for most recent dose. Previously derived from second dose value. 

Join with FIPS table based on County_Code to get the name/desc. 

​23

Mixed zip 

mixed_zip 

If recipient zip code is null, this field is populated by admin zip code. 


Derived from value recorded for second dose, unless null, then first dose value is used. 

​24

Mixed county 

mixed_county 

If recip_address_county_new is NULL or unknown, populate this with admin_county_label. 


Derived from value recorded for second dose, unless null, then first dose value is used. 

 

‘Outside California’ category includes out-of-state residents and records where recipient’s state of residence is blank. 


​25

Local health jurisdiction 

LHJ 

Local health jurisdiction of recipient’s residence; if zip code (mixed_zip) is in Berkeley, Long Beach, or Pasadena cities, LHJ = Berkeley, Long Beach and Pasadena, respectively, otherwise LHJ = mixed_county 


Derived from value recorded for second dose, unless null, then first dose value is used. 

 

‘Outside California’ category includes out-of-state residents and records where recipient’s state of residence is blank


​when mixed_zip in
('94701', '94702', '94703', '94704', '94705', '94707', '94708', '94709', '94710', '94712', '94720') then 'Berkeley' 

 when mixed_zip in 

('90801', '90802', '90803', '90804', '90805', '90806', '90807', '90808', '90809', '90810', '90813', '90814', '90815', '90822', '90831', '90832',  

 when mixed_zip in 

('90833', '90834', '90835', '90840', '90842', '90844', '90845', '90846', '90847', '90848', '90853', '90888', '90899') then 'Long Beach' 

when left(mixed_zip,5) 

in ('91101', '91102', 

'91103', '91104', '91105', '91106', '91107', '91109', '91110', '91114', '91115', '91116', '91117', '91121', '91123', '91124', '91125', '91126', '91129', '91131', '91182', '91184', '91185', '91188', '91189', '91191', '91199') then 'Pasadena' 

ELSE mixed_county 

​26

VEM quartile  

hpiquartile 

​Vaccine Equity Metric (VEM) score quartiles based on mixed_zip 

 

Vaccine Equity Metric (VEM) score quartiles combine the Public Health Alliance of Southern California’s Healthy Places Index (HPI) measure with CDPH-derived scores to estimate factors that impact health, like income, education, and access to health care. Zip codes range from less healthy community conditions in Quartile 1 to more healthy community conditions in Quartile 4. 


Derived from value recorded for second dose, unless null, then first dose value is used. 

​Locally Defined Value Set:  

1 (VEM Quartile 1) 

2 (VEM Quartile 2) 

3 (VEM Quartile 3) 

4 (VEM Quartile 4) 

Null (no VEM score assigned) 


​27

VEM quartile

based on

recipient

zip code 

hpiquartile_rcp_zip 

​Vaccine Equity Metric (VEM) score quartiles based on recipient zip code 

 

Vaccine Equity Metric (VEM) score quartiles combine the Public Health Alliance of Southern California’s Healthy Places Index (HPI) measure with CDPH-derived scores to estimate factors that impact health, like income, education, and access to health care. Zip codes range from less healthy community conditions in Quartile 1 to more healthy community conditions in Quartile 4.


Derived from value recorded for second dose, unless null, then first dose value is used. 

​Locally Defined Value Set:  

1 (VEM Quartile 1) 

2 (VEM Quartile 2) 

3 (VEM Quartile 3) 

4 (VEM Quartile 4) 

Null (no VEM score assigned) 


​28

Recipient

address:

county based

on zip code 

hpi_county_rcp_zip 

The county name of the recipient’s address, derived from the zip code of the recipient’s address. 


Derived from value recorded for second dose, unless null, then first dose value is used. 

County derived from recip_address_zip. 

​29

Administered

at location: type 

admin_type_desc 

The characteristic of the provider site that reported the vaccination, refusal, or missed appointment 


Derived from value recorded for second dose, unless null, then first dose value is used. 

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

​30

MCE

MCE

Provider affiliated with state agency multi-county entity, health system multi-county entity, or pharmacy entity participating in CDC Long Term Care or Retail Pharmacy Partnership programs. 


Derived from value recorded for second dose, unless null, then first dose value is used. 

Locally Defined Value Set: 

CDCR (State Agency MCE - California Department of Corrections and Rehabilitation) 

DHS (State Agency MCE - Department of State Hospitals) 

AHMC Healthcare (Health System MCE) 

Dignity Health (Health System MCE) 

Kaiser Permanente (Health System MCE) 

Providence (Health System MCE) 

Sutter Health (Health System MCE) 

UC Health (Health System MCE) 

CVS (Pharmacy) 

Rite Aid (Pharmacy) 

Walgreens (Pharmacy) 

Albertson Companies, Inc. (Pharmacy) 

Costco (Pharmacy) 

Kroger (Pharmacy) 

Walmart (Pharmacy) 

Topco (Pharmacy) 

Good Neighbor (Pharmacy) 

Health Mart (Pharmacy) 

CPESN (Pharmacy) 

Cardinal (Pharmacy) 

GeriMed (Pharmacy) 

MHA (Pharmacy) 

Premier-Innovatix (Pharmacy)

​31

Lot numbers 

lot_numbers 

The lot numbers for all COVID vaccinations administered, concatenated. 

​n/a
​32

Original dose

number – Dose 1  

ds1_orig_dose_num 

Original reported dose number in vaccination series for first dose. 

Locally Defined Value Set: 
1 (Valid first dose) 
2 (Valid second dose) 
INV (Invalid dose) 
UNK (Unknown validity) 

​33

Original dose

number – Dose 2 

ds2_orig_dose_num 

Original reported dose number in vaccination series for second dose. 

Locally Defined Value Set: 
1 (Valid first dose) 
2 (Valid second dose) 
INV (Invalid dose) 
UNK (Unknown validity) 

​34

Dose 1

vaccination

event ID  

ds1_vax_event_id 

The vaccination event’s unique identifier within the system for first reported dose (based on vaccination date). 

​n/a
​35

Dose 2

vaccination

event ID 

ds2_vax_event_id 

The vaccination event’s unique identifier within the system for second reported dose (based on vaccination date). 

​n/a
​36

Dose 3

vaccination

event ID 

ds3_vax_event_id 

The vaccination event’s unique identifier within the system for third reported dose (based on vaccination date). 

​n/a
​37

Dose 4

vaccination

event ID 

ds4_vax_event_id 

The vaccination event’s unique identifier within the system for fourth reported dose (based on vaccination date). 

​n/a
​38

Snapshot time 

snapshot_time 

Data current as of this timestamp. 

​n/a
​39

Partially

vaccinated date 

partially_vaccinated

_date 

Date recipient became partially vaccinated (i.e., received first dose of Pfizer or Moderna) 

​n/a
​40

Fully

vaccinated date 

fully_vaccinated_date 

Date recipient became fully vaccinated. 

​n/a
​41

Email

Email_Address 

Recipient’s email 


Derived from value recorded for second dose, unless null, then first dose value is used.

​42

Phone number 

Phone_Number 

Recipient’s phone number 


Derived from value recorded for second dose, unless null, then first dose value is used. 

​43

Administration

date – Dose 3 

ds3_admin_date 

If given, the third recorded dose administration date for the recipient. 


Ignores DOSE_NUM field in VW_ALL_IIS_LHJ for determination. 

​n/a
​44

Administration

date – Dose 4 

ds4_admin_date 

If given, the fourth recorded dose administration date for the recipient. 


Ignores DOSE_NUM field in VW_ALL_IIS_LHJ for determination. 

​n/a
​45

Original dose

number – Dose 3 

ds3_orig_dose_num 

Original reported dose number in vaccination series for third dose. 

Locally Defined Value Set: 
1 (Valid first dose) 
2 (Valid second dose) 
INV (Invalid dose) 
UNK (Unknown validity) 

​46

Original dose

number – Dose 4 

ds4_orig_dose_num 

Original reported dose number in vaccination series for fourth dose. 

Locally Defined Value Set: 
1 (Valid first dose) 
2 (Valid second dose) 
INV (Invalid dose) 
UNK (Unknown validity) 

​47

Booster dose

flag – Pfizer  

Pfizer_Booster 

Received at least 3 doses of Pfizer and 12+ years of age


UPDATED 1/25/2022. 

Previous names:  

Is_Pfizer_3+_18+; 

Is_Pfizer_3+_12+ (1/11/2022)   

​0 (FALSE) 

1 (TRUE) 

​48

Booster dose flag - Pfizer with minimum interval 

 Pfizer_Booster

_Interval 

Received at least 3 doses of Pfizer, with minimum interval of 136 days between 2nd and 3rd dose, and 12+ years of age 


UPDATED 1/25/2022. 

Previous names: Is_Pfizer_3+_18+_164+;

Is_Pfizer_3+_12+_136+ 

(1/11/2022)

​0 (FALSE) 

1 (TRUE) 



​49

Additional dose flag 

HAS_ADDITIONAL

_DOSE_AND_24_DAYS 

Received additional dose administered at least 24 days after series completion (Pfizer recipients 5+ years of age, Moderna and J&J recipients 18+ years of age) 


Includes any dose that was administered at least 24 days after series completion (2 mRNA or 1 J&J). Includes both additional doses and booster doses. 

0 (FALSE) 

1 (TRUE) 


​50

Booster dose flag – Moderna 

Moderna_Booster 

At least 3 doses of Moderna and 18+ years of age 


UPDATED 1/25/2022. 

Previous name: Is_Moderna_3+_18+. 

​0 (FALSE) 

1 (TRUE) 

​51

Booster dose flag – Moderna with minimum interval 

Moderna_Booster

_Interval 

At least 3 doses of Moderna, with minimum interval of 136 days between 2nd and 3rd dose, and 18+ years of age 


UPDATED 1/25/2022. 

Previous name: Is_Moderna_3+_18+_164+. 

Changed minimum interval from 164 days to 136 days per updated CDC recommendations. 

0 (FALSE) 

1 (TRUE) 


​52

Booster dose flag – J&J 

JJ_Booster 

At least 2 doses of J&J and 18+ years of age 


UPDATED 1/25/2022. 

Previous name: Is_JJ_2+_18+. 

​0 (FALSE) 

1 (TRUE)


​53

Booster dose flag – J&J with minimum interval 

JJ_Booster_Interval 

At least 2 doses of J&J, with minimum interval of 52 days between 1st and 2nd dose, and 18+ years of age 


UPDATED 1/25/2022. 

Previous name: 

Is_JJ_2+_18+_52+. 

​0 (FALSE) 

1 (TRUE)


​54

Booster dose flag – mixed mRNA 

Pfizer_or_Moderna

_Booster 

At least 3 doses of Pfizer or Moderna combined and 18+ years of age 


UPDATED 1/25/2022. 

Previous name: Is_Pfizer_or_Moderna

_3+_18+. 

​0 (FALSE) 

1 (TRUE)


​55

Booster dose flag – mixed mRNA with minimum interval 

Pfizer_or_Moderna

_Booster_ Interval 

At least 3 doses of Pfizer or Moderna combined, with a minimum interval of 136 days between 2nd and 3rd dose, and 18+ years of age 


UPDATED 1/25/2022. 

Previous name: Is_Pfizer_or_Moderna

_3+_18+_164+. 

Changed minimum interval from 164 days to 136 days per updated CDC recommendations. 

​0 (FALSE) 

1 (TRUE)


​56

Additional dose flag – 52 day interval 

HAS_ADDITIONAL

_DOSE_AND_52_DAYS 

Additional dose administered at least 52 days after series completion 

​0 (FALSE) 

1 (TRUE)


​57

Recipient address: state 

RECIP_ADDRESS

_STATE 

The state component of the recipient's address 


UPDATED 4/5/2022. 

Derived from value recorded for most recent dose. Previously derived from second dose value. 

US Postal Service two-character state codes 

​58

Administration address: state 

ADMIN_ADDRESS

_STATE 

The state component of where the vaccine is administered/ planned to be administered. Exception for mobile clinics. 


UPDATED 4/5/2022. 

Derived from value recorded for most recent dose. Previously derived from second dose value. 

US Postal Service two-character state codes 

​59

Patient sharing indicator 

LOCKED_IND 

Patient sharing status.  


If 1, patient has requested that their record not be shared with organizations other than their own provider or public health. 

​0 (FALSE) 

1 (TRUE) 


​60

Booster eligibility flag 

IS_BOOSTER

_ELIGIBLE 

​0 (FALSE) 

1 (TRUE) 

 

A vaccine recipient is considered eligible for a booster if they meet at least one of the following criteria: 

  1. Age 18+ and received at least two doses of Moderna vaccine >= 136 days ago 

  1. Age 12+ and received at least two doses of Pfizer vaccine >= 136 days ago 

  1. Age 18+ and received at least one dose of J&J vaccine >= 52 days ago  

​61

Booster eligibility flag – 2nd booster 

IS_SECOND

_BOOSTER_ELIGIBLE 

​0 (FALSE) 

1 (TRUE) 

 

A vaccine recipient is considered eligible for a second booster if they meet at least one of the following criteria: 

  1. Age 50+ and received first booster of any vaccine >= 108 days ago 

  1. Age 18+ and received J&J vaccine for primary dose, and J&J vaccine for first booster >= 52 days ago 

​62

Booster dose flag – 2nd Pfizer booster with minimum interval 

Pfizer_Booster

_2_Interval 

At least 4 doses of Pfizer, with minimum interval of 108 days between 3rd and 4th dose, and 12+ years of age 

​0 (FALSE) 

1 (TRUE) 


​63

Booster dose flag – 2nd Moderna booster with minimum interval 

Moderna_Booster

_2_Interval 

At least 4 doses of Moderna, with minimum interval of 108 days between 3rd and 4th dose, and 18+ years of age 

​0 (FALSE) 

1 (TRUE) 


​64

Booster dose flag – 2nd booster of mixed mRNA with minimum interval 

Pfizer_or_Moderna

_Booster_2_Interval 

At least 4 doses of Pfizer or Moderna combined, with a minimum interval of 108 days between 3rd and 4th dose, and 12+ years of age 

​0 (FALSE) 

1 (TRUE) 


​65

Booster dose flag – 2nd J&J booster with minimum interval 

JJ_Booster

_2_Interval 

At least 3 doses of J&J, with minimum interval of 108 days between 2nd and 3rd dose, and 18+ years of age 

​0 (FALSE) 

1 (TRUE) 


​66

Additional dose flag – 108 day interval 

has_additional

_dose_and_108

_ days 

Second additional dose after completion of primary series 


Additional dose that is 108 days after IS_ADDITIONAL_DOSE

_AND_24_DAYS flag is set for mRNA vaccine; OR 

Additional dose that is 108 days after IS_ADDITIONAL_DOSE

_AND_52_DAYS flag is set for J&J vaccine. 

​0 (FALSE) 

1 (TRUE) 


Notes: 

Minimum intervals are based on CDC recommendations, using 28-day months and including a 4-day grace period.  


Page Last Updated :