Skip Navigation LinksPertussis-Vaccine-Data-Dictionary

california immunization registry

Pertussis Vaccine Data Dictionary         CAIR logo
 ā€“ Recipient Level View

 Excel   ā€‹ā€‹

Last Updated 11/28 /2023

Dataset Name: VW_TDAP_RECIP

Dataset Description: This is a recipient level view that contains all recipients who have received pertussis (DTaP or Tdap) vaccinations and have been 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

ā€‹Administration date ā€“ DTaP dose 1

ā€‹ADMIN_DATE_DOSE1_DTAP

ā€‹Vaccine administration date for 1st dose of DTaP (CVX code = 20, 50, 106, 107, 110, 120, 130, 132, 146, 170).

ā€‹n/a

ā€‹2

ā€‹Administration date ā€“ DTaP dose 2

ā€‹ADMIN_DATE_DOSE2_DTAP

ā€‹Vaccine adminisā€‹tration date for 2nd dose of DTaP (CVX code = 20, 50, 106, 107, 110, 120, 130, 132, 146, 170).ā€‹

ā€‹n/a
ā€‹3
ā€‹Administration date ā€“ DTaP dose 3ā€‹
ā€‹ADMIN_DATE_DOSE3_DTAP
ā€‹Vaccine administration date for 3rd dose of DTaP (CVX code = 20, 50, 106, 107, 110, 120, 130, 132, 146, 170).
ā€‹n/a
ā€‹4
ā€‹Administration date ā€“ DTaP dose 4
ā€‹ADMIN_DATE_DOSE4_DTAP
ā€‹Vaccine administration date for 4th dose of DTaP (CVX code = 20, 50, 106, 107, 110, 120, 130, 132, 146, 170).ā€‹
ā€‹n/a
ā€‹5
ā€‹Administration date ā€“ DTaP dose 5
ā€‹ADMIN_DATE_DOSE5_DTAP
ā€‹Vaccine administration date for 5th dose of DTaP (CVX code = 20, 50, 106, 107, 110, 120, 130, 132, 146, 170).
ā€‹n/a
ā€‹6
ā€‹Administration date ā€“ Tdap age 11-12
ā€‹ADMIN_DATE_TDAP_11-12
ā€‹Vaccine administration date for Tdap dose given at age 11-12 years (CVX Code = 115)
ā€‹n/a
ā€‹7
ā€‹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
ā€‹8
ā€‹Array ā€“ vaccine administration dates
ā€‹ARR_ADMIN_DATE
ā€‹Array showing dates that all DTaP or Tdap doses were administered to recipient.
ā€‹n/a
ā€‹9
ā€‹Array ā€“ age at receipt of vaccination
ā€‹ARR_AGE
ā€‹Array showing recipient's age in years when each DTaP or Tdap dose was administered.
ā€‹n/a
ā€‹10
ā€‹Array ā€“ CVX codes
ā€‹ARR_CVX
ā€‹Array showing CVX codes for all DTaP or Tdap doses administered to recipient.
ā€‹n/a
ā€‹11
ā€‹Census tract ā€“ recipient address (2020)
ā€‹CENSUS_TRACT
ā€‹2020 census tract based on recipient address only.
ā€‹
ā€‹12
ā€‹Census tract ā€“ recipient address (2010)
ā€‹CENSUS_TRACT_10
ā€‹2010 census tract based on recipient address only.
ā€‹
ā€‹13
ā€‹Census tract ā€“ administration address
ā€‹CENSUS_TRACT_ADMIN_10
ā€‹2010 census tract based on vaccinating providerā€™s address only.
ā€‹
ā€‹14
ā€‹5 DTaP by age 6
ā€‹FIVEDTAPBY6YO
ā€‹Received 5 DTaP doses by age 6 (CVX code = 20, 50, 106, 107, 110, 120, 130, 132, 146, 170).
ā€‹
0 (No)
1 (Yes)

ā€‹

ā€‹15
ā€‹4 DTaP by age 2
ā€‹FOURDTAPBY2YO
ā€‹Received 4 DTaP doses by age 2 (CVX code = 20, 50, 106, 107, 110, 120, 130, 132, 146, 170).
ā€‹
0 (No)
1 (Yes)



ā€‹16
ā€‹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 






ā€‹17
ā€‹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.ā€‹
ā€‹
ā€‹18
ā€‹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 



ā€‹19
ā€‹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  

ā€‹

ā€‹20
ā€‹Recipient address: city
ā€‹RECIP_ADDRESS_CITY
ā€‹The city component of the recipient's address.
ā€‹n/a
ā€‹21
ā€‹Recipient address: state
ā€‹RECIP_ADDRESS_STATE
ā€‹The state component of the recipient's address.
ā€‹US Postal Service two-character State Codesā€‹
ā€‹22
ā€‹Recipient address: street
ā€‹RECIP_ADDRESS_STREET
ā€‹The street component of the recipient's address.ā€‹
ā€‹n/a
ā€‹23
ā€‹Recipient address:  street 2
ā€‹RECIP_ADDRESS_STREET_2
ā€‹The street 2 component of the recipient's address.
ā€‹n/a
ā€‹24
ā€‹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
ā€‹25
ā€‹Recipient age
ā€‹RECIP_AGE
ā€‹Recipient age in years at time of most recent dose.
ā€‹n/a
ā€‹26
ā€‹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

ā€‹27
ā€‹Recipient date of birth
ā€‹RECIP_DOB
ā€‹Recipient's date of birth.
ā€‹n/a
ā€‹28
ā€‹Recipient name: first
ā€‹RECIP_FIRST_NAME
ā€‹Recipient's first name.ā€‹
ā€‹n/a
ā€‹29
ā€‹Recipient ID
ā€‹RECIP_ID
ā€‹Unique ID for this recipient.
ā€‹n/a
ā€‹30
ā€‹Recipient name: last
ā€‹RECIP_LAST_NAME
ā€‹Recipient's last name.
ā€‹n/a
ā€‹31
ā€‹Recipient name: middle
ā€‹RECIP_MIDDLE_NAME
ā€‹Recipient's middle name.ā€‹
ā€‹n/a
ā€‹32
ā€‹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)



ā€‹33
ā€‹Recipient sex
ā€‹RECIP_SEX
ā€‹Recipient sex.
ā€‹HL7 User Defined table 0001 
M (Male) 
F (Female) 
U (Unknown/undifferentiated)
X (Non-binary) ā€‹



34ā€‹ā€‹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
ā€‹35
ā€‹TDAP_11_12
TDAP_11_12
ā€‹Received at least 1 dose of Tdap at age 11-12 years (CVX code = 115).ā€‹
ā€‹
0 (No)
1 (Yes)




ā€‹
ā€‹ā€‹
Page Last Updated :