Skip Navigation LinksCAIR-records-LHD-COVID-DataDictionary

california immunization registry

COVID-19 Vaccinations                                CAIR LogoData Dictionary - Dose Level View

Last Updated 9/20/2022
PDF

LHJ Data Source in IRIS

View Name: VW_ALL_IIS_LHJ

View Description: This is a dose level view that contains all 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 No.
​COVID-19 Data Element
​Variable Name
​Data Element Description
​Value Set
​1
​Vaccination event ID
​vax_event_id
​The vaccination event’s unique identifier within the system.
​n/a
​2
​Recipient ID
​​recip_id
​Unique ID for this recipient 

This can be the ID used by the
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
3​​​Recipient
name: first
​recip_first_name
​​Recipient's first name.
​n/a
​4
​Recipient
name: middle
​​recip_middle_name
​Recipient's middle name.
​n/a
​5
​​Recipient
name: last
​recip_last_name
​Recipient's last name.
​n/a
​6
​Recipient date
of birth

​​recip_dob
​Recipient's date of birth.
​n/a
​7
​Recipient sex
​recip_sex
​​Recipient sex.

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

​8
​Recipient address: street
​recip_address_street
​The street component of the recipient's address.
​n/a
​9
​Recipient address: 
street 2
​recip_address
_street_2​
​The street 2 component of the recipient's address.
​n/a
​10
​​Recipient address: city
​​recip_address_city
​​The city component of the
recipient's address.
​n/a
​11
​Recipient address: county
​recip_address_county
​The county code component of the recipient's address.
​​FIPS Codes
12

​Recipient County Name


​​recip_county_label 


​The county name component of the recipient's address.


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

​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
​​Administration date
​​admin_date
​​The date the vaccination event occurred (or was intended to occur).
​n/a
​16
​​CVX
​cvx
​The vaccine type that was administered.
COVID-19 Vaccine Codes
​17
​NDC
​ndc
​The vaccine product that was administered: Unit of Use (UoU) is preferred if both UoU and Unit of Sale (UoS) are available.
NDC Crosswalk Tables
​18
​MVX
​mvx
​The manufacturer of the vaccine administered.
MVX – Manufacturers of Vaccines
​19
​​Lot number
​​lot_number
​​The lot number of the vaccine administered: Unit of Use (UoU) is preferred if both UoU and Unit of Sale (UoS) are available.
​n/a
​20
​​Vaccine expiration date
​​vax_expiration
​The expiration date of the vaccine administered.
​n/a
​21
​​Vaccine administering site
​vax_admin_site
​The body site of vaccine administration.
​​HL7 defined table 0163
LT (Left thigh) 
LA (left arm)
LD (left deltoid)
LG (left gluteus medius)
LVL (left vastus lateralis)
LLFA (left lower forearm)
RT (right thigh)
RA (right arm)
RD (right deltoid)
RG (right gluteus medius)
RVL (right vastus lateralis)
RLFA (right lower forearm)
​22
Vaccine 
route of administration

​​vax_route
​The route of vaccine administration (e.g., oral, subcutaneous).
HL7 defined table 0162 or 
FDA NCI Thesaurus (NCIT)
NCIT values preferred and provided for reference
C38238 (Intradermal)
C28161 (Intramuscular)
C38284 (Nasal)
C38276 (Intravenous)
C38288 (Oral)
C38676 (Percutaneous)
C38299 (Subcutaneous)
C38305 (Transdermal)

​23
​Dose number
​dose_num
​Dose number in vaccination series, provided dose is considered valid (e.g., counts towards immunity).
​Locally Defined Value Set:
1 (Valid first dose)
2 (Valid second dose)
3 (Valid third dose)
INV (Invalid dose)
UNK (Unknown validity)
​24
​Vaccination series complete
​vax_series_complete
​Report if the vaccination series is complete. Select "YES" when the recipient has completed the required doses for the specific vaccine product. If more doses are required select "NO." If unknown,or cannot be calculated, select "UNK."
​Locally Defined Value Set:
YES (Yes)
NO (No)
UNK (Unknown)



​25
​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
​26
​​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
​27
​VTrckS provider PIN
​​vtrcks_prov_pin
​The 6-digit Provider PIN in VTrckS. For VFC Providers, this is the VFC PIN. This ID is being used for linking across data sources.
​n/a
​28
​Administered at location: type
​​admin_type
​​The characteristic of the provider site that reported the vaccination, refusal, or missed appointment.
​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)
​29
​Administration address: street
​admin_address_street
​The street component of where the vaccine is administered/ planned
to be administered. Exception for mobile clinics. 
​n/a
​30
​Administration address: 
street 2

​​admin_address_street_2
​The street 2 component of where the vaccine is administered/planned to be administered. Exception for mobile clinics.
​n/a
​31
​​Administration address: city 
​admin_address_city
​​The city component of where the vaccine is administered/planned to be administered. Exception for mobile clinics. 
​n/a
​32
​Administration address: county
​​admin_address_county
​​The county component of the administration address
​​FIPS Codes 
​33
​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
​34
​Administration address: state
​​admin_address_state
​The state component of where the vaccine is administered/ planned to be administered. Exception for mobile clinics.
​US Postal Service two-character state codes
​35
​Administration address: 
zip code

​admin_address_zip
​​The zip code component of where the vaccine is administered/planned to be administered. Exception for mobile clinics. 
​n/a
36​​​Date Vaccine Entered into Registry
​​IIS_ADDED_DATE
​The date vaccine reported to local registry.
​n/a
​37
​​Source IIS
​​source_iis
​​Name of IIS.
​Locally Defined Value Set:
CAIR2
RIDE
SDIR
​38
​​Vaccine label
​​vax_label
​​Name of vaccine manufacturer.
​Locally Defined Value Set: 
CVX 207, 221 =  ‘Moderna’
CVX 208, 217 = ‘Pfizer’ 
CVX 212 =  ‘J&J’
CVX 213 = ‘COVID-19, Unspecified’
CVX 218 = ‘Pfizer Pediatric’
CVX 219 = ‘Pfizer Under 5’
CVX 228 = ‘Moderna Under 6’
​39
​​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 (1002-5, 2028-9, 2076-8, 2054-5, 2106-3) is noted then ‘Multiracial’, otherwise first race noted.
​40
​​Recipient race 1 
​recip_race_1
​Patient's race.
​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)
​41
​Recipient race 2
​​recip_race_2
​Patient's race. Fields recipient
race 2-6 support recipients with more than 1 race. (Skip if only one race reported).  
​​See Value Set in "Recipient Race 1" field
​42
​​Recipient race 3
​​recip_race_3
​​Patient's race. Fields recipient
race 2-6 support recipients with more than 1 race. (Skip if only one race reported).
​See Value Set in "Recipient Race 1" field 
​43
​Recipient race 4 
​​recip_race_4
​Patient's race. Fields recipient
race 2-6 support recipients with more than 1 race. (Skip if only one race reported). 
​See Value Set in "Recipient Race 1" field 
​44
​​Recipient race 5 
​​recip_race_5
​Patient's race. Fields recipient
race 2-6 support recipients with more than 1 race. (Skip if only one race reported). 
​See Value Set in "Recipient Race 1" field
​45
​Recipient race 6
​recip_race_6
​​Patient's race. Fields recipient
race 2-6 support recipients with more than 1 race. (Skip if only one race reported).
​See Value Set in "Recipient Race 1" field
​46
​Recipient ethnicity 
​recip_ethnicity
​The ancestry of the recipient.
​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)
47​​​Recipient Address: county (New
​​recip_address
_county_new
​​If recipient county is blank, this field gets populated by the FIPS code of using the recipient ZipCode if available.
​48
​​Mixed zip
​​mixed_zip
​​If recipient zipcode is null, this
field is populated by admin zip
code.
​49
​Mixed county
​​mixed_county

If Recip_Address_County_New is NULL or unknown, populated  with admin_county_label. 
 
‘Outside California’ category includes out-of-state residents and records where recipient’s state of residence is blank. 

​50
​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.
​County derived from recip_address_zip
​51
​​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.

‘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', 
 '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
​52
​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.
​Locally Defined Value Set:
CDCR (State Agency MCE -
CA Dept of Corrections and Rehabilitation)
DHS (State Agency MCE -
Dept 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)
​53
​ID
​​immun_fact_ID

​​Unique identifier for the immunization record.

​54
​​Email
​email_address
​​Recipient’s email.
​55
​Phone number
​​phone_number
​Recipient’s phone number.
​56
​Organization code
​org_code
​The CAIR2 & RIDE Organization
Code assigned to administering organization.
​57
​Snapshot time
​SNAPSHOT_TIME
​​Data current as of this timestamp.
​58
​Snowflake entered date
​​WAREHOUSE_
ENTER_DATE
​Date/time record created in Snowflake.
​59
​Snowflake updated date
​​WAREHOUSE_
UPDATE_DATE
​Date/time record updated in Snowflake. Available for CAIR2 records only.
​60
​​CAIR2 updated Date
​CAIR_UPDATE_TS
​Date/time record updated in CAIR2. Available for CAIR2 records only.
​61
​​Recipient vaccination number
​RECIP_VAX_NUM

​Dose number in vaccination series, incremented by 1 for each dose received by the recipient, in order of vaccination date. All doses received by each recipient, including invalid doses, are assigned a number. May differ from dose number assigned by IIS.

​62
​Bridge recipient ID
​BRIDGE_RECIP_ID
​​Recipient ID used for this individual in the recipient level view. 


When an individual is identified as having more than one recipient ID in the dataset using the below bridging logic, all doses for that individual are mapped under one of the recipient IDs in the recipient level view. The recipient ID that is selected will be denoted as BRIDGE_RECIP_ID. In the recipient level view, RECIP_ID field reflects BRIDGE_RECIP_ID. 

 
Bridging logic: 

  1. Same first name AND​ 
  2. Same last name AND 
  3. Same DOB AND 
  4. One of the following:​ 
(Address street similar (50% max difference) OR both address street is blank) AND same ZIP code​ 
Same admin date and same lot number​ 
Same phone number​ 
Same email address


​63
​​Booster dose flag – Pfizer 
​Pfizer_Booster
​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)



​64
​Booster dose flag - Pfizer with minimum interval
​Pfizer_Booster
_Interval
​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)



​65
​Additional dose flag
​​IS_ADDITIONAL
_DOSE_AND_24_DAYS
​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)



​66
​Historical dose
​HISTORICAL_IND
​Vaccination entered as an administered or historical dose.  Available for CAIR2 records only.​00 (Administered)
01 (Historical)
​67
​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)

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

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

​70
​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)
​71
​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)
​72
​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)

​73
​Additional dose flag – 52 day interval
​​IS_ADDITIONAL
_DOSE_AND_52_
DAYS
​Additional dose administered at least 52 days after series completion.
​0 (FALSE)
1 (TRUE)

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

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

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

​77
​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)
​78
​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)
79
​​Additional dose flag – 108 day interval
​​is_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)

​80
​Census tract – recipient address (2020)
​CENSUS_TRACT
​2020 census tract based on recipient address only.
​81
​Census tract – recipient address (2010)
​CENSUS_TRACT_10
​2010 census tract based on recipient address only.
​82
​Census tract – administration address
​CENSUS_TRACT_ADMIN_10
​2010 census tract based on vaccinating provider’s address only.
​83
​HPI 3.0 - census tract
​HPI_3_TRACT
Healthy Places Index 3.0 score based on the 2010 census tract from the recipient’s address
​Healthy Places Index
​84
​HPI 3.0 – zip
​HPI_3_ZIP
Healthy PIaces Index 3.0 score 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
​85
​HPI 3.0 - mixed
​HPI_3_MIXED
​HPI_3_TRACT; if null, uses HPI_3_ZIP.
​Healthy Places Index
​86
​Recipient address: concatenated
​MIXED_ADDRESS
​Concatenation of the recipient address street, city, state, and zip code.
​87
​Administration address: concatenated
​MIXED_ADMIN_ADDRESS
​Concatenation of the vaccinating provider’s address street, city, state, and zip code
​88
​Booster dose flag - bivalent
​BIVALENT_BOOSTER
​NEW 10/5/2022
0 (FALSE)
1 (TRUE)




​​
Page Last Updated :