Skip Navigation LinksMPX_Data_Dictionary

Top Menu

California Immunization registry

Vaccinia (including MPX)                            CAIRlogo-new-197x42
Vaccination - Doses 
Snowflake Data Dictionary

Last Updated 8/19/2022

PDFā€‹


LHJ Data Source

Table Name: TBL_IMMUN_MONKEYPOX

Description: This is a dose level table that contains all vaccinia vaccine doses (including monkeypox) reported to the California Immunization Registry (CAIR2) and the Healthy Futures Registry (the San Diego Immunization Registry was integrated into CAIR2 in April 2022).

FIELD DEFINITIONS

Field No.

Data Element

Variable Name

Description

Value Set
1 Vaccine ID VACCINE_ID Vaccine identifier for the vaccination given. n/a
2 Vaccination event ID VAX_EVENT_ID The vaccination event's unique identifier within the system. n/a
3 Extract type EXT_TYPE FOR CDC REPORTING ONLY. Extract type defines whether CDC file contains completely de-identified data, PPRL ID, or fully identifiable data. Set to Deidentified. Locally Defined Value Set:
D (Deidentified)
P (PPRL)
I (Identified)
4 Recipient ID RECIP_ID Unique ID for recipient. n/a
5 Recipient name: first RECIP_FIRST_NAME Recipient's first name. n/a
6 Recipient name: middle RECIP_MIDDLE_NAME Recipient's middle name. n/a
7 Recipient name: last RECIP_LAST_NAME Recipient's last name. n/a
8 Recipient date of birth RECIP_DOB Recipient's date of birth. n/a
9 Recipient sex RECIP_SEX Recipient sex. Derived from value recorded for second dose, unless null, then first dose value is used. Locally Defined Value Set:
F (Female)
M (Male)
O (Other)
X (Non-binary)
U (Unknown/undifferentiated)
10 Recipient address: street RECIP_ADDRESS
_STREET		 The street component of the recipient's address. n/a
11 Recipient address:
street 2		 RECIP_ADDRESS_
STREET_2

The street 2 component of the recipient's address.

 

 n/a
12 Recipient address: city RECIP_ADDRESS_CITY The city component of the recipient's address. n/a
13 Recipient address: county RECIP_ADDRESS
_COUNTY		 The county code component of the recipient's address FIPS Codes
14 Recipient address: state RECIP_ADDRESS_STATE The state component of the recipient's address. US Postal Service two-character state codes
15 Recipient address: zip code RECIP_ADDRESS_ZIP The zip code of the recipient's address.
 		 n/a
16 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)
17 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
18 Recipient 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
19 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
20 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
21 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
22 Recipient ethnicity RECIP_ETHNICITY Recipient's ethnicity.
 HL7 User Defined table 0189
2135-2 (Hispanic or Latino)
2186-5 (Not Hispanic or Latino)
UNK (Unknown ethnicity)
23 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)
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)
24 Administration date ADMIN_DATE The date the vaccination event occurred (or was intended to occur). n/a
25 CVX CVX The vaccine type that was administered. Vaccine Codes
26 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
27 MVX MVX The manufacturer of the vaccine administered. MVX ā€“ Manufacturers of Vaccines
28 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
29 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)
30 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)
31 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)
INV (Invalid dose)
UNK (Unknown validity)
32 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)
33 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
34 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. n/a
35 VTrckS provider PIN VTRCKS_PROV_PIN The 6-digit Provider PIN in VTrckS. For VFC Providers, this is the VFC PIN. n/a
36 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 (Childcare facility)
2 (College/university)
3 (Community HC)
4 (Corrections facility - all ages)
5 (Drug treatment facility)
6 (Family planning)
7 (Family practice)
8 (Fed-qual or rural HC)
9 (Foster care)
10 (Health department-associated site)
11 (Health plans)
12 (HIE/data aggregator)
13 (HIV/STD clinic)
14 (Home health)
15 (Hospital - birthing)
16 (Tribal/IHS clinic)
17 (Internal medicine)
18 (Juvenile detention center)
19 (Local health dept)
20 (Military healthcare)
21 (Multispecialty practice)
22 (Nursing home/LTC)
23 (OBGYN)
24 (Other)
25 (Other IIS)
26 (Pediatrics)
27 (Pharmacy)
28 (Private practice)
29 (School/school district)
30 (Special vaccine clinic)
31 (State agency)
32 (State public health)
33 (Urgent care)
34 (WIC program)
35 (Hospital)
36 (School clinic)
37 (Non clinical site)
38 (Pandemic only)
39 (Pending)
37 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
38 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
39 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
40 Administration address: county ADMIN_ADDRESS
_COUNTY		 The county component of the administration address. FIPS Codes
41 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
42 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. n/a
43 Vaccination refusal VAX_REFUSAL If vaccination was refused, select 'Yes'. If the vaccine was administered, select 'No'. Locally Defined Value Set:
YES
NO
44 Comorbidity status CMORBID_STATUS

Report if the recipient has a comorbidity. Recipients are a member of a special risk group that are at increased risk of severe illness.

CAIR2 does not collect information on comorbidity status; default is set to 'UNK'.

Locally Defined Value Set:
YES
NO
UNK
45 Serology results SEROLOGY

Report if there was a positive serology (antibody test) result.

CAIR2 does not collect information on comorbidity status; default is set to 'UNK'.

 Locally Defined Value Set:
YES
NO
UNK
46 Email EMAIL_ADDRESS Recipient's email address. n/a
47 Phone number PHONE_NUMBER Recipient's phone number. n/a
48 Date vaccine entered into registry IIS_ADDED_DATE The date vaccine reported to local registry. n/a
49 Source IIS SOURCE_IIS Name of IIS. Locally Defined Value Set:
CAIR2
RIDE
50 ID IMMUN_FACT_ID Unique identifier for the immunization record. n/a
51 Snowflake entered date WAREHOUSE_ENTER
_DATE		 Date/time record created in Snowflake. n/a
52 Recipient county name RECIP_COUNTY_DESC

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.
 
53 Administration address: county name ADMIN_COUNTY_DESC 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.
54 Organization code ORG_CODE The CAIR2 or RIDE Organization Code assigned to administering organization. n/a
55 Historical dose HISTORICAL_IND Vaccination entered as an administered or historical dose. Locally Defined Value Set:
00 (Administered)
01 (Historical)
56 Booster indicator BOOSTER_IND Vaccination is defined by IIS as booster dose.  Locally Defined Value Set:
Y (Yes)
N (No)
U (Unknown)
57 Medicaid ID MEDICAID_ID Medicaid ID. n/a
58 Mother's first name MOTHERS_FIRST_NAME Mother's first name. n/a
59 Mother's maiden name MOTHERS_MAIDEN
_LAST		 Mother's maiden name. n/a
60 Multiple birth count MULTIPLE_BIRTH
_COUNT		 Count of children if multiple birth.  
61 Multiple birth order MULTIPLE_BIRTH
_ORDER		 Birth order.
  
62 Medicare MEDICARE Medicare status (field not currently in use). n/a
63 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.

 Locally Defined Value Set:
0 (FALSE)
1 (TRUE)
64 Snowflake updated date WAREHOUSE_UPDATE
_DATE		 Date/time record updated in Snowflake. n/a
65 CAIR2 updated date CAIR_UPDATE_TS Date/time record updated in CAIR2. n/a
66 Table creation date TBL_CREATE_DTTM Date/time the recipient level view materialization (table creation) is performed. n/a

Notes:

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

Page Last Updated :