Skip Navigation LinksCAIR-records-LHD-Snowflake-All-Vaccines-Data-Dictionary

CALIFORNIA IMMUNIZATION REGISTRY

 All Vaccinations ​Data Dictionary          ​ CAIR Logo
​Dose Level View

​Last Updated 2/21/2023

PDF

​Snowflake Dataset 

Dataset Name: TBL_VAX_DOSES_ALL_LHJ 

​Dataset Description: This is a dose level view that contains all vaccine doses 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. 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

Bridge​d 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: 

  • Same first name AND​ 
  • Same last name AND 
  • Same DOB AND 
  • 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

​n/a

​2

​​Recipient ID

​RECIP_ID

​Unique ID for this recipient.

​​n/a

​3​

​​Vaccination event ID

​VAX_EVENT_ID​

​The vaccination event’s unique identifier within the system. 

​n/a

​4

​​Administration date

​ADMIN_DATE

​The date the vaccination event occurred.

​n/a​

​5

​CVX​

​​CVX​

​The vaccine type that was administered.

CVX Codes – Vaccines Administered

​6

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

​7

​Lot number

​LOT_NUMBER

​The lot number of the vaccine administered.

​n/a

​8

​​Number in Series

​NUMBER_IN_SERIES

​The total number of doses required to complete a vaccination series.

​n/a

​9

​Ordinal Position

​​ORDINAL_POSITION​

​The dose number in a vaccination series.

​n/a

​10
​Organization code
​ORG_CODE
​The CAIR2 Organization Code assigned to administering organization.
​n/a​​
​11
​Recipient name: first​​
​RECIP_FIRST_NAME
​Recipient's first name.
​n/a
​12
​​​Recipient name: middle
​RECIP_MIDDLE_NAME
​Recipient's middle name.
​n/a
​13
​Recipient name: last

​RECIP_LAST_NAME​​

​Recipient's last name.
​n/a
14
​​Recipient date of birth
​RECIP_DOB
​Recipient's date of birth.
​n/a
15
​Recipient address: street
​RECIP_ADDRESS
_STREET
​The street component of the recipient's address.
​n/a
​16
​​Recipient address:  
street 2
​RECIP_ADDRESS
_STREET_2
​The street 2 component of the recipient's address.
​n/a
17

​Recipient address: city
​RECIP_ADDRESS_CITY
​The city component of the recipient's address.
​n/a
​18
Recipient address: state
​​RECIP_ADDRESS_STATE
​​The state component of the recipient's address.

​US Postal Service two-character State Codes

​19
​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
​20
​Recipient race 1

​RECIP_RACE_1​

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

​21

​Recipient race 2​

​RECIP_RACE_2

​Recipient’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.

​22

​Reci​pient race 3

​RECIP_RACE_3​

​Recipient’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.

​23

​Recipient race 4

​RECIP_RACE_4

​Recipient’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.

​24

​Recipient race 5

​RECIP_RACE_5

​Recipient’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.

​25​

​Recipient race 6

​RECIP_RACE_6

​Recipient’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.

​26

​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) 
PHC1175 (Prefer not to say) 
UNK (Unknown ethnicity)

​27

​Recipient sex

​RECIP_SEX

​Recipient’s sex

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

​28

​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

29

​Vaccine group

​VACCINE_GROUP

​The code of the vaccine group. If the patient received a combination vaccine (e.g., Pediarix), the vaccination will appear within each vaccine group for the components included in the combination vaccine (e.g., for Pediarix, the vaccination will appear within the DTaP, Hep B, and Polio vaccine groups).

​1 (Adeno) 
2 (Anthrax) 
3 (BCG) 
4 (Cholera) 
6 (Tetanus, Diphtheria, Acellular Pertussis) 
7 (Diphtheria, Tetanus, Acellular Pertussis) 
8 (Encephalitis) 
9 (Influenza Seasonal) 
11 (Hepatitis A) 
12 (Hepatitis B) 
13 (Hib) 
14 (Ig) 
15 (Lyme) 
16 (Meningitis) 
17 (Measles, Mumps, Rubella) 
18 (Plague) 
19 (Pneumonia Conjugate) 
20 (Poliomyelitis) 
21 (Rabies) 
23 (Rotavirus) 
24 (Typhoid) 
25 (Vaccinia) 
26 (Varicella) 
27 (Yellow Fever) 
31 (Tetanus) 
33 (Diphtheria Antitoxin) 
34 (Pneumonia Polysaccharide) 
48 (Ig-RSV) 
128 (Pertussis) 
129 (Zoster) 
130 (Human Papilloma Virus) 
131 (Novel Influenza-09) 
132 (Ig-HBIg) 
135 (MenB) 
136 (Influenza - H5N1) 
138 (Coronavirus) 
139 (Dengue)

​30

​Vaccine Group Display Name

​VACCINE_GROUP
_DISPLAY_NAME 

​Short version of VACCINE_GROUP
_NAME

1 (Adeno) 
2 (Anthrax) 
3 (BCG) 
4 (Cholera) 
6 (Td/Tdap) 
7 (DTP/aP) 
8 (Encephalitis) 
9 (Influenza-seasnl) 
11 (HepA) 
12 (HepB) 
13 (Hib) 
14 (Ig) 
15 (Lyme) 
16 (Men ACWY) 
17 (MMR) 
18 (Plague) 
19 (PneumoConjugate) 
20 (Polio) 
21 (Rabies) 
23 (Rotavirus) 
24 (Typhoid) 
25 (Vaccinia) 
26 (Varicella) 
27 (Yellow Fever) 
31 (Tetanus) 
33 (Diphtheria) 
34 (PneumoPoly 23) 
48 (Ig-RSV) 
128 (Pertussis) 
129 (Zoster) 
130 (HPV) 
131 (Influenza-H1N1) 
132 (Ig-HBIg) 
135 (MenB) 
136 (Influenza - H5N1) 
138 (COVID-19) 
139 (Dengue)

​31

​Vaccine Group Name

​VACCINE_GROUP
_NAME

​The name of the vaccine group

​See Value Set in “Vaccine Group” field.

​32

​Vaccine Name

​VACCINE_NAME

​The name of the individual vaccine within a vaccine group

​CVX Codes – Vaccines Administered

​33

​Recipient age - days

​AGE_IN_DAYS

​Recipient’s age in days

​n/a

​34

​Recipient age - months

​AGE_IN_MONTHS

​Recipient’s age in months

​n/a

​35

​Recipient address: county

​RECIP_ADDRESS
_COUNTY

​The county code component of the recipient's address

FIPS Codes​

​36

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

​37

​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

38

MVX

​MVX

​The manufacturer of the vaccine administered

MVX – Manufacturers of Vaccines

​39

​Vaccine expiration date

​VAX_EXPIRATION

​The expiration date of the vaccine administered

​n/a

​40

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

​41

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

​42

​Dose number

​DOSE_NUM

​Dose number in vaccination series, provided dose is considered valid (e.g., counts towards immunity). Based on ORDINAL_POSITION.

1 (Valid first dose) 
2 (Valid second dose) 
3 (Valid third dose) 
4 (Valid fourth dose) 
5 (Valid fifth dose) 
INV (Invalid dose) 
UNK (Unknown validity)

​43

​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."​

​YES (Yes) 
NO (No) 
UNK (Unknown)

​44

​VTrckS provider PIN

​VTRCKS_PROV_PIN
The 6-digit Provider PIN in VTrckS. For VFC Providers, this is the VFC PIN
n/a
45​
Administered at location: type
ADMIN_TYPE
The characteristic of the provider site that reported the vaccination, refusal, or missed appointment
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)

​46

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

​47

​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

​48

​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

​49

​Administration address: county

​ADMIN_ADDRESS
_COUNTY 

​The county component of the administration address

FIPS Codes​

​50

​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

​51

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

​52

​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

​53

​​Date vaccine entered into registry

​IIS_ADDED_DATE

​The date vaccine reported to local registry

​n/a

​54

​ID

​IMMUN_FACT_ID

​Unique identifier for the immunization record

​n/a

​55

Email

​EMAIL_ADDRESS

​Recipient’s email

​n/a

​56

​Phone number

​PHONE_NUMBER

​Recipient’s phone number

​n/a

​57

​Historical dose

​HISTORICAL_IND

​Vaccination entered as an administered or historical dose

00 (Administered) 
01 (Historical)

​58

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

​59

​Snowflake entered date

​WAREHOUSE_ENTER
_DATE

​Date/time record created in Snowflake

​n/a

​60

​CAIR2 updated Date

​CAIR_UPDATE_TS

​Date/time record updated in CAIR2

​n/a

​61

​Snowflake updated date

​WAREHOUSE_UPDATE
_DATE

​Date/time record updated in Snowflake

​n/a

​62

​Recipient address: concatenated

​MIXED_ADDRESS

​Concatenation of the recipient address street, city, state, and zip code

​n/a

​63

​Administration address: concatenated

​MIXED_ADMIN
_ADDRESS

​Concatenation of the vaccinating provider’s address street, city, state, and zip code

​n/a

​64

​​Recipient Address: county (New)

​RECIP_ADDRESS
_COUNTY_NEW

​If recipient county is blank, this field gets populated by the FIPS code based on the recipient zip code, if available.

​FIPS Codes​

​65

​Recipient vaccination number

​RECIP_VAX_NUM

​Dose number, 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.

​n/a

​66

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

​Derived from FIPs based on County Code.

​67

​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. 
 
MIXED_ZIP: If recipient zip code is null, field is populated by admin zip code. 
 
MIXED_COUNTY: If RECIP_ADDRESS_
COUNTY_NEW is null or unknown, field is populated with ADMIN_COUNTY_LABEL.
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​

​68

​Recipient age - years

​RECIP_AGE

​Recipient’s age in years

​n/a

​69

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

​​70

​Snapshot time

​SNAPSHOT_TIME

​Data current as of this timestamp

​n/a

Page Last Updated :