STANDARD DATA DICTIONARY #9999999.41 -- IMMUNIZATION LOT FILE 3/24/25 PAGE 1
STORED IN ^AUTTIML( *** NO DATA STORED YET *** SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
In order to preserve the continuity of files shared by the Indian Health Service and the Department of Veterans Affairs, this file
includes fields used by Indian Health Service that will not be used by the Department of Veterans Affairs. These fields may point
to other files and routines not deployed by the Department of Veterans Affairs. Inclusion of these fields, as designed, was
approved by the DBA. These fields were initially introduced with the release of the VISTA IMMUNIZATION ENHANCEMENTS 1.0 (PX*1*201)
for the VistA Immunization Enhancements Project. Additional fields may be included in later enhancements.
This file contains the Immunization Manufacturers' LOT NUMBERS for the immunizations/vaccines administered in the VA. The LOT
NUMBERs themselves may not be unique, but the combination of LOT NUMBER and MANUFACTURER must form a unique entry. This file also
relies on a nightly background task that checks the entries' EXPIRATION DATE field. If the date is equal to that day's date, or
has passed, that entry's STATUS is set to EXPIRED.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
IDENTIFIED BY: MANUFACTURER (#.02)[R], VACCINE (#.04)[R], EXPIRATION DATE (#.09)[R], ASSOCIATED VA FACILITY (#.1),
DOSES UNUSED (#.12)
POINTED TO BY: LOT field (#.05) of the V IMMUNIZATION File (#9000010.11)
LOT NUMBER field (#1207) of the V IMMUNIZATION File (#9000010.11)
LOT field (#.05) of the V IMMUNIZATION DELETED File (#9000080.11)
LOT NUMBER field (#1207) of the V IMMUNIZATION DELETED File (#9000080.11)
DEFAULT LOT# field (#.04) of the IMMUNIZATION File (#9999999.14)
CROSS
REFERENCED BY: EXPIRATION DATE(AE), ASSOCIATED VA FACILITY(AF), LOT NUMBER(B), VACCINE(C)
INDEXED BY: VACCINE & MANUFACTURER & ASSOCIATED VA FACILITY & LOT NUMBER (AC), LOT NUMBER & STATUS (AD)
LAST MODIFIED: OCT 5,2022@14:55:07
9999999.41,.01LOT NUMBER 0;1 FREE TEXT (audited)
Lot Number
INPUT TRANSFORM: K:$L(X)>25!($L(X)<3)!'(X'?1P.E) X I $D(X),$G(DA) D INUSE^PXVXR Q
LAST EDITED: JUL 01, 2016
HELP-PROMPT: Answer must be 3-25 characters in length.
DESCRIPTION:
This is the lot number of a manufacturer's immunization/vaccine product.
TECHNICAL DESCR: A manufacturer's lot number for an immunization, 3-25 characters. In the Department of Veterans
Affairs version of this file, more than one entry may have the same LOT NUMBER, but entries must
have a unique combination of LOT NUMBER and MANUFACTURER.
AUDIT: YES, ALWAYS
DELETE TEST: 1,0)= I $D(^AUPNVIMM("LN",DA)) D EN^DDIOL("This lot number is already in use. Deletion is not allow
ed! ",,"!!,?2")
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 9999999.41^B
1)= S ^AUTTIML("B",$E(X,1,30),DA)=""
2)= K ^AUTTIML("B",$E(X,1,30),DA)
RECORD INDEXES: AC (#1324), AD (#1684)
9999999.41,.02MANUFACTURER 0;2 POINTER TO IMM MANUFACTURER FILE (#9999999.04) (Required) (audited)
Manufacturer
INPUT TRANSFORM: S DIC("S")="I '$P(^AUTTIMAN(Y,0),U,3)" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X I $D(X),$G(DA) D COMB1^P
XVXR Q
LAST EDITED: JUL 01, 2016
HELP-PROMPT: Select the manufacturer of this lot number.
DESCRIPTION: This is the manufacturer using this lot number. You will only be able to select manufacturers with
a STATUS of ACTIVE.
TECHNICAL DESCR: This field is a pointer to the IMM MANFACTURER file (9999999.04). The field is screened so that
only manufacturers with status of active can be seen in the lookup.
SCREEN: S DIC("S")="I '$P(^AUTTIMAN(Y,0),U,3)"
EXPLANATION: You can only select a manufacturer with a STATUS of ACTIVE.
AUDIT: YES, ALWAYS
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
RECORD INDEXES: AC (#1324)
9999999.41,.03STATUS 0;3 SET (audited)
Status
'2' FOR EXPIRED;
'1' FOR INACTIVE;
'0' FOR ACTIVE;
LAST EDITED: FEB 28, 2019
HELP-PROMPT: Enter '1' or 'INACTIVE' to designate this lot as inactive.
DESCRIPTION: This is the status of this lot number, used to determine if this lot is usable. As long this field
is blank or has a value of '0', it will be seen as ACTIVE. If a '1' is entered, it will be seen as
INACTIVE.
TECHNICAL DESCR: This field is seen as ACTIVE as long it is blank or a '0', which may be the opposite of what you
are used to seeing.
AUDIT: YES, ALWAYS
RECORD INDEXES: AD (#1684)
9999999.41,.04VACCINE 0;4 POINTER TO IMMUNIZATION FILE (#9999999.14) (Required) (audited)
Vaccine
INPUT TRANSFORM: S DIC("S")="I '$P(^(0),U,7)" D ^DIC K DIC S DIC=DIE,X=+Y K:Y<0 X I $D(X),$G(DA) D COMB2^PXVXR Q
LAST EDITED: JUL 01, 2016
HELP-PROMPT: Enter a vaccine that uses this lot number and manufacturer.
DESCRIPTION: This is a VACCINE that is labeled with this lot number and produced by lot's manufacturer. The
vaccine must designated as active.
SCREEN: S DIC("S")="I '$P(^(0),U,7)"
EXPLANATION: Vaccine must be active.
AUDIT: YES, ALWAYS
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 9999999.41^C
1)= S ^AUTTIML("C",$E(X,1,30),DA)=""
2)= K ^AUTTIML("C",$E(X,1,30),DA)
3)= This cross reference is used for lookups.
This cross reference allows lot numbers to be selected by their associated IMMUNIZATION (VACCINE).
RECORD INDEXES: AC (#1324)
9999999.41,.05VACCINE #2 0;5 POINTER TO IMMUNIZATION FILE (#9999999.14) (audited)
Vaccine #2
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter a vaccine that has this lot number and manufacturer.
DESCRIPTION:
This is a VACCINE that is labeled with this lot number and produced by lot's manufacturer.
TECHNICAL DESCR: This field is not used by the Department of Veterans Affairs. It is included for backward
compatibility with the Indian Health Service version of the file.
AUDIT: YES, ALWAYS
9999999.41,.06VACCINE #3 0;6 POINTER TO IMMUNIZATION FILE (#9999999.14) (audited)
Vaccine #3
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter a vaccine that has this lot number and manufacturer.
DESCRIPTION:
This is a VACCINE that is labeled with this lot number and produced by lot's manufacturer.
TECHNICAL DESCR: This field is not used by the Department of Veterans Affairs. It is included for backward
compatibility with the Indian Health Service version of the file.
AUDIT: YES, ALWAYS
9999999.41,.07VACCINE #4 0;7 POINTER TO IMMUNIZATION FILE (#9999999.14) (audited)
Vaccine #4
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter a vaccine that has this lot number and manufacturer.
DESCRIPTION:
This is a VACCINE that is labeled with this lot number and produced by lot's manufacturer.
TECHNICAL DESCR: This field is not used by the Department of Veterans Affairs. It is included for backward
compatibility with the Indian Health Service version of the file.
AUDIT: YES, ALWAYS
9999999.41,.08VACCINE #5 0;8 POINTER TO IMMUNIZATION FILE (#9999999.14) (audited)
Vaccine #5
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter vaccine that has this lot number and manufacturer.
DESCRIPTION:
This is a VACCINE that is labeled with this lot number and produced by lot's manufacturer.
TECHNICAL DESCR: This field is not used by the Department of Veterans Affairs. It is included for backward
compatibility with the Indian Health Service version of the file.
AUDIT: YES, ALWAYS
9999999.41,.09EXPIRATION DATE 0;9 DATE (Required) (audited)
Expiration Date
INPUT TRANSFORM: S %DT="EX" D ^%DT S X=Y K:Y<1 X I $D(X) D EXP^PXVXR Q
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter the expiration date for this lot number.
DESCRIPTION: This is the date that the immunization represented by this lot number is due to expire, as
determined by the manufacturer.
TECHNICAL DESCR: This field is used to determine if the immunization represented by this lot number has expired.
This field is checked nightly by a background task. If the EXPIRATION DATE is equal to that day's
date (or in the past), the STATUS field is set to "EXPIRED".
AUDIT: YES, ALWAYS
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 9999999.41^AE
1)= S ^AUTTIML("AE",$E(X,1,30),DA)=""
2)= K ^AUTTIML("AE",$E(X,1,30),DA)
Used by a task set to run nightly to change the status of lot numbers that have expired.
9999999.41,.1 ASSOCIATED VA FACILITY 0;10 POINTER TO INSTITUTION FILE (#4) (audited)
Associated VA Facility
LAST EDITED: JUL 01, 2016
HELP-PROMPT: Enter the name or station number of the VA facility associated with this lot number.
DESCRIPTION: This is the VA facility associated with this lot number. At multi-division institutions this
facility is a division of that multi-division institution.
AUDIT: YES, ALWAYS
UNEDITABLE
CROSS-REFERENCE: 9999999.41^AF
1)= S ^AUTTIML("AF",$E(X,1,30),DA)=""
2)= K ^AUTTIML("AF",$E(X,1,30),DA)
This cross reference is used for sorting by associated facility.
RECORD INDEXES: AC (#1324)
9999999.41,.11STARTING COUNT 0;11 NUMBER (audited)
Starting Count
INPUT TRANSFORM: K:+X'=X!(X>99999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter the initial number of doses for this lot.
DESCRIPTION:
This is the starting number of doses for this lot, from 1 to 99,999.
TECHNICAL DESCR: This is the initial number of doses for this lot, which should be a number from 1 to 99999. If the
DOSES UNUSED field is empty, it is automatically set to the number entered here, via a trigger.
AUDIT: YES, ALWAYS
CROSS-REFERENCE: ^^TRIGGER^9999999.41^.12
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(0)=X S Y(1)=$S($D(^AUTTIML(D0,0)):^(0),1:"") S X=$P(Y(1),U,12
)="" I X S X=DIV S Y(1)=$S($D(^AUTTIML(D0,0)):^(0),1:"") S X=$P(Y(1),U,12),X=X S DIU=X K Y S X=DIV
S X=DIV X ^DD(9999999.41,.11,1,1,1.4)
1.4)= S DIH=$G(^AUTTIML(DIV(0),0)),DIV=X S $P(^(0),U,12)=DIV,DIH=9999999.41,DIG=.12 D ^DICR
2)= Q
CREATE CONDITION)= DOSES UNUSED=""
CREATE VALUE)= STARTING COUNT
DELETE VALUE)= NO EFFECT
FIELD)= DOSES UNUSED
NOREINDEX)= 1
When the STARTING COUNT is entered, DOSES UNUSED is checked. If DOSES UNUSED is NULL, then it is
set to the STARTING COUNT.
9999999.41,.12DOSES UNUSED 0;12 NUMBER (audited)
Doses Unused
INPUT TRANSFORM: K:$S(+X'=X:1,X>99999:1,X<0:1,X?.E1"."1N.N:1,$P(^AUTTIML(DA,0),"^",11)="":0,1:X>$P(^(0),"^",11)) X
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter the number of doses remaining from this lot.
DESCRIPTION: This is the number of remaining doses available for this lot. The number cannot be greater than
the original number of doses for this lot.
TECHNICAL DESCR: This is the number doses for this lot that have not yet been used. The number entered is checked
against the number entered for the STARTING COUNT field and cannot be greater.
AUDIT: YES, ALWAYS
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
TRIGGERED by the STARTING COUNT field of the IMMUNIZATION LOT File
9999999.41,.13VACCINE SOURCE 0;13 SET (audited)
Vaccine Source
'v' FOR VFC;
'n' FOR NON-VFC;
'o' FOR Other State;
'i' FOR IHS/Tribal;
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter the source of this lot.
DESCRIPTION:
This is the source of this lot, where it was obtained.
TECHNICAL DESCR: This field is not used by the Department of Veterans Affairs. It is included for backward
compatibility with the Indian Health Service version of the file.
AUDIT: YES, ALWAYS
9999999.41,.14HEALTH CARE FACILITY 0;14 POINTER TO LOCATION FILE (#9999999.06) (audited)
Health Care Facility
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Select the Health Care Facility (location) where this lot will be stored and used.
DESCRIPTION:
This is the location (facility) where this lot will be stored and used.
TECHNICAL DESCR: This field is not used by the Department of Veterans Affairs. It is included for backward
compatibility with the Indian Health Service version of the file.
AUDIT: YES, ALWAYS
9999999.41,.15LOW SUPPLY ALERT 0;15 NUMBER (audited)
Low Supply Alert
INPUT TRANSFORM: K:+X'=X!(X>99998)!(X<0)!(X?.E1"."1N.N)!(X>$P(^AUTTIML(DA,0),U,11)) X
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter the number of doses remaining that will trigger a Low Supply Alert for this lot, between 0
and 99,998.
DESCRIPTION: This is a number that is used to determine if a Low Supply alert should be issued. The number must
be between 0 and 99,998 and cannot be greater than the STARTING COUNT.
TECHNICAL DESCR: A number field between 0 and 99998. Input Transform also checks that the entry is not greater than
the number in the STARTING COUNT field.
AUDIT: YES, ALWAYS
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
9999999.41,.16LOT NUMBER FOR EXPORT 0;16 FREE TEXT (audited)
Lot Number For Export
INPUT TRANSFORM: K:$L(X)>12!($L(X)<3) X
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Enter the official lot number to be used for export to other registries, 3 to 12 characters in
length.
DESCRIPTION: This is this lot number's corresponding official lot number to be used for exporting to other
registries.
TECHNICAL DESCR: This field is not used by the Department of Veterans Affairs. It is included for backward
compatibility with the Indian Health Service version of the file.
AUDIT: YES, ALWAYS
9999999.41,.17NDC CODE 0;17 POINTER ***** TO AN UNDEFINED FILE (#9002084.95), STORED IN ^BINDC ******* (audited)
NDC Code
LAST EDITED: JUL 20, 2015
HELP-PROMPT: Select the NDC Code for this lot.
DESCRIPTION:
This is the NDC Code for this lot.
TECHNICAL DESCR: This field is not used by the Department of Veterans Affairs. It is included for backward
compatibility with the Indian Health Service version of the file.
This field points to Indian Health Service's BI TABLE NDC CODES file (#9002084.95) which is not
used by the Department of Veterans Affairs.
AUDIT: YES, ALWAYS
9999999.41,.18NDC CODE (VA) 0;18 FREE TEXT (audited)
NDC Code
INPUT TRANSFORM: D P01^PXVNDC
OUTPUT TRANSFORM: S:Y Y=$$NDCOUT^PXVNDC(Y)
LAST EDITED: FEB 17, 2016
HELP-PROMPT: Enter the National Drug Code (NDC) for this lot.
DESCRIPTION:
This is the National Drug Code (NDC) for this lot.
EXECUTABLE HELP: D QUEST^PXVNDC
AUDIT: YES, ALWAYS
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
9999999.41,1 EFFECTIVE DATE/TIME 1;0 DATE Multiple #9999999.411 (Add New Entry without Asking)
DESCRIPTION:
This multiple records any status changes to the Immunization Lot.
9999999.411,.01 EFFECTIVE DATE/TIME 0;1 DATE
INPUT TRANSFORM: S %DT="ESTX" D ^%DT S X=Y K:X<1 X
LAST EDITED: FEB 13, 2019
HELP-PROMPT: Enter the date and time when the status changed.
DESCRIPTION:
This is the date and time when the status for the Immunization Lot changed.
CROSS-REFERENCE: 9999999.411^B
1)= S ^AUTTIML(DA(1),1,"B",$E(X,1,30),DA)=""
2)= K ^AUTTIML(DA(1),1,"B",$E(X,1,30),DA)
9999999.411,.02 USER 0;2 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: FEB 13, 2019
HELP-PROMPT: Enter the user that changed the status of this Immunization Lot.
DESCRIPTION:
This is the user that changed the status of this Immunization Lot.
9999999.411,.03 STATUS 0;3 SET
'0' FOR ACTIVE;
'1' FOR INACTIVE;
'2' FOR EXPIRED;
LAST EDITED: FEB 13, 2019
HELP-PROMPT: Enter the status the Immunization Lot was changed to.
DESCRIPTION:
This is the status the Immunization Lot was changed to.
FILES POINTED TO FIELDS
IMM MANUFACTURER (#9999999.04) MANUFACTURER (#.02)
IMMUNIZATION (#9999999.14) VACCINE (#.04)
VACCINE #2 (#.05)
VACCINE #3 (#.06)
VACCINE #4 (#.07)
VACCINE #5 (#.08)
INSTITUTION (#4) ASSOCIATED VA FACILITY (#.1)
LOCATION (#9999999.06) HEALTH CARE FACILITY (#.14)
NEW PERSON (#200) EFFECTIVE DATE/TIME:USER (#.02)
}UNDEFINED FILE (#9002084.95) NDC CODE (#.17)
File #9999999.41
Record Indexes:
AC (#1324) RECORD REGULAR IR SORTING ONLY
Short Descr: Unique lot number, manufacturer and vaccine combination monitoring
Description: This cross reference is used in identifying a new lot number as unique for a facility, that is, the
immunization name, lot number and manufacturer combination is unique for a facility.
Set Logic: S ^AUTTIML("AC",X(1),X(2),$E(X(4),1,30),DA)=""
Set Cond: S X=1
Kill Logic: K ^AUTTIML("AC",X(1),X(2),$E(X(4),1,30),DA)
Kill Cond: S X=1
Whole Kill: K ^AUTTIML("AC")
X(1): VACCINE (9999999.41,.04) (Subscr 1) (forwards)
X(2): MANUFACTURER (9999999.41,.02) (Subscr 2) (forwards)
X(3): ASSOCIATED VA FACILITY (9999999.41,.1) (forwards)
Transform (Storage): S X=$S(X'="":"_#"_X,1:"")
X(4): LOT NUMBER (9999999.41,.01) (Subscr 3) (Len 30) (forwards)
Transform (Storage): S X=X_X(3)
AD (#1684) RECORD MUMPS ACTION
Short Descr: Whenever the STATUS (#.03) changes, update the EFFECTIVE DATE/TIME multiple.
Description: This cross-reference adds a new entry to the EFFECTIVE DATE/TIME multiple whenever the STATUS (#.03) changes.
Set Logic: D UPDSTAT^PXVXR(DA,X1(2),X2(2))
Kill Logic: Q
X(1): LOT NUMBER (9999999.41,.01) (forwards)
X(2): STATUS (9999999.41,.03) (forwards)
NO RE-INDEXING ALLOWED!
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):