STANDARD DATA DICTIONARY #920.2 -- IMM ADMINISTRATION ROUTE FILE 6/27/25 PAGE 1
STORED IN ^PXV(920.2, (9 ENTRIES) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 1.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
Per VHA Directive, this file has been "locked down" by Data Standardization (DS). The file definition (i.e. data dictionary) shall
not be modified. All additions, changes and deletions to entries in the file shall be done by Enterprise Reference Terminology
(ERT) using the Master File Server (MFS), provided by the Common Services (CS). Creating and/or editing locally defined fields in
the file are not permitted. Use of locally defined fields that were created prior to the VHA Directive shall not be supported.
This file is a table of routes of administration for vaccines/immunization events. The data in this table are from the HL7-defined
Table 0162 - Route of Administrations.
DD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
IDENTIFIED BY: HL7 CODE (#.02)
POINTED TO BY: ROUTE OF ADMINISTRATION field (#1302) of the IMMUNIZATION sub-field (#920.051) of the IMM DEFAULT RESPONSES File
(#920.05)
REPLACED BY VHA STANDARD TERM field (#99.97) of the IMM ADMINISTRATION ROUTE File (#920.2)
ROUTE field (#.01) of the IMM ROUTES TO SITES File (#920.6)
ROUTE OF ADMINISTRATION field (#1302) of the V IMMUNIZATION File (#9000010.11)
ROUTE OF ADMINISTRATION field (#1302) of the V IMMUNIZATION DELETED File (#9000080.11)
CROSS
REFERENCED BY: REPLACED BY VHA STANDARD TERM(AREPLACETERM), MASTER ENTRY FOR VUID(AVUID), VUID(AVUID), ROUTE(B), HL7 CODE(H)
INDEXED BY: VUID & MASTER ENTRY FOR VUID (AMASTERVUID)
920.2,.01 ROUTE 0;1 FREE TEXT (Required) (audited)
Route
INPUT TRANSFORM: K:$L(X)>30!($L(X)<3) X
LAST EDITED: FEB 27, 2015
HELP-PROMPT: Answer must be 3-30 characters in length.
DESCRIPTION: This is the route of administration for an immunization/vaccine. The response is expected to be at
least 3 characters and no more than 30 characters. Response should also be all uppercase letters.
TECHNICAL DESCR: This is the route of administration of a vaccine to a patient. Routes entered should be 3-30
uppercase characters. The values entered here will be pointed by the V IMMUNIZATION file and the
IMMUNIZATION file.
AUDIT: YES, ALWAYS
PRE-LOOKUP: I $G(DIC(0))["L",'$D(XUMF) K X D EN^DDIOL("Entries must be edited via the Master File Server (MFS).
","","!?5")
DELETE TEST: 1,0)= D:'$D(XUMF) EN^DDIOL("Entries must be inactivated via the Master File Server(MFS).","","!?5")
I '$D(XUMF)
LAYGO TEST: 1,0)= D:'$D(XUMF) EN^DDIOL("Entries must be added via the Master File Server (MFS).","","!?5") I $D
(XUMF)
WRITE AUTHORITY: ^
CROSS-REFERENCE: 920.2^B
1)= S ^PXV(920.2,"B",$E(X,1,30),DA)=""
2)= K ^PXV(920.2,"B",$E(X,1,30),DA)
920.2,.02 HL7 CODE 0;2 FREE TEXT (audited)
HL7 Code
INPUT TRANSFORM: K:$L(X)>3!($L(X)<1)!'(X?1.3U) X
LAST EDITED: FEB 27, 2015
HELP-PROMPT: Answer must be 1-3 characters in length.
DESCRIPTION: This is the HL7 code associated with this route. It is expected to be 1-3 uppercase alpha
characters, only.
TECHNICAL DESCR: This is the HL7-0162 code for this route of administration. It must one to three uppercase alpha
characters - no numbers or punctuation.
AUDIT: YES, ALWAYS
WRITE AUTHORITY: ^
CROSS-REFERENCE: 920.2^H
1)= S ^PXV(920.2,"H",$E(X,1,30),DA)=""
2)= K ^PXV(920.2,"H",$E(X,1,30),DA)
3)= Used to facilitate entry selection.
This is used to make selection of an entry (hopefully) easier and quicker.
920.2,.03 FDA NCIT 0;3 FREE TEXT (audited)
INPUT TRANSFORM: K:$L(X)>6!($L(X)<6)!'(X?1U5N) X
LAST EDITED: FEB 27, 2015
HELP-PROMPT: Answer must be 6 characters in length, 1 uppercase alpha followed by 5 numbers.
DESCRIPTION: This is the FDA NCIT code for this route. It must be in the format of 1 uppercase alpha character
followed by 5 numbers.
TECHNICAL DESCR: This is the NCIT - FDA NCI Thesaurus - for this route. Healthcare Information Technology Standards
(HITSP) specifies the use of FDA routes of administration. The code in this field maps this route
to the FDA route.
AUDIT: YES, ALWAYS
WRITE AUTHORITY: ^
920.2,.04 DEFINITION 0;4 FREE TEXT (audited)
Definition
INPUT TRANSFORM: K:$L(X)>90!($L(X)<3) X
LAST EDITED: FEB 27, 2015
HELP-PROMPT: Answer must be 3-90 characters in length.
DESCRIPTION:
This is the definition of this route. It must be 3-90 characters.
TECHNICAL DESCR: This is the definition (explanation) of this route of administration, as provided by the
HL7-defined Table 0162 - Route of administration.
AUDIT: YES, ALWAYS
WRITE AUTHORITY: ^
920.2,99.97 REPLACED BY VHA STANDARD TERM VUID;3 POINTER TO IMM ADMINISTRATION ROUTE FILE (#920.2) (audited)
LAST EDITED: MAR 27, 2015
HELP-PROMPT: Enter the Term/Concept that replaces this entry.
DESCRIPTION: This field is populated when one Term/Concept replaces another Term/Concept. This field is
controlled by standardization and should only be changed by standardization processes. This field
contains a pointer to a VHA standard term that replaces this entry.
AUDIT: YES, ALWAYS
WRITE AUTHORITY: ^
UNEDITABLE
CROSS-REFERENCE: 920.2^AREPLACETERM
1)= S ^PXV(920.2,"AREPLACETERM",$E(X,1,30),DA)=""
2)= K ^PXV(920.2,"AREPLACETERM",$E(X,1,30),DA)
This cross-reference can be used to identify the replacement entries associated with a
Term/Concept.
920.2,99.98 MASTER ENTRY FOR VUID VUID;2 SET (Required) (audited)
'1' FOR YES;
'0' FOR NO;
LAST EDITED: FEB 27, 2015
HELP-PROMPT: Enter YES if this is the Master entry.
DESCRIPTION:
This field identifies the Master entry for a VUID associated with a Term/Concept.
AUDIT: YES, ALWAYS
WRITE AUTHORITY: ^
UNEDITABLE
CROSS-REFERENCE: 920.2^AVUID
1)= S ^PXV(920.2,"AVUID",$E(X,1,30),DA)=""
2)= K ^PXV(920.2,"AVUID",$E(X,1,30),DA)
3)= XXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
This cross-reference is by VUID.
RECORD INDEXES: AMASTERVUID (#422)
920.2,99.99 VUID VUID;1 FREE TEXT (Required) (audited)
INPUT TRANSFORM: S X=+X K:$L(X)>20!($L(X)<1)!'(X?1.20N) X
LAST EDITED: FEB 27, 2015
HELP-PROMPT: Answer must be 1-20 characters in length.
DESCRIPTION:
VHA Unique ID (VUID). A unique meaningless integer assigned to reference terms VHA wide.
AUDIT: YES, ALWAYS
WRITE AUTHORITY: ^
UNEDITABLE
NOTES: XXXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
CROSS-REFERENCE: 920.2^AVUID
1)= S ^PXV(920.2,"AVUID",$E(X,1,30),DA)=""
2)= K ^PXV(920.2,"AVUID",$E(X,1,30),DA)
3)= XXX--CAN'T BE ALTERED EXCEPT BY PROGRAMMER
This cross-reference is by VUID.
RECORD INDEXES: AMASTERVUID (#422)
920.2,99.991 EFFECTIVE DATE/TIME TERMSTATUS;0 DATE Multiple #920.299
DESCRIPTION:
Describes the pair Status and Effective Date/Time for each reference term.
WRITE AUTHORITY: ^
920.299,.01 EFFECTIVE DATE/TIME 0;1 DATE (audited)
INPUT TRANSFORM: S %DT="ESTX" D ^%DT S X=Y K:Y<1 X
LAST EDITED: MAR 27, 2015
HELP-PROMPT: Enter the date and time when the status of this term was established.
DESCRIPTION:
This is the date/time when the Status of the reference term was established.
AUDIT: YES, ALWAYS
WRITE AUTHORITY: ^
UNEDITABLE
CROSS-REFERENCE: 920.299^B
1)= S ^PXV(920.2,DA(1),"TERMSTATUS","B",$E(X,1,30),DA)=""
2)= K ^PXV(920.2,DA(1),"TERMSTATUS","B",$E(X,1,30),DA)
920.299,.02 STATUS 0;2 SET (Required) (audited)
'1' FOR ACTIVE;
'0' FOR INACTIVE;
LAST EDITED: FEB 27, 2015
HELP-PROMPT: Enter the Status of this term.
DESCRIPTION: The Status of a reference term is either 'ACTIVE' or 'INACTIVE'. If ACTIVE', then the term will
be accessible by end-users to document a particular patient event. If 'INACTIVE', then the term
will only be accessible by the application to display legacy data.
AUDIT: YES, ALWAYS
WRITE AUTHORITY: ^
UNEDITABLE
FILES POINTED TO FIELDS
IMM ADMINISTRATION ROUTE
(#920.2) REPLACED BY VHA STANDARD TERM (#99.97)
File #920.2
Record Indexes:
AMASTERVUID (#422) RECORD REGULAR IR SORTING ONLY
Short Descr: This cross-reference identifies the Master Entry for a VUID.
Description: If multiple entries have the same VUID in the file, this cross-reference can be used to identify the Master
entry for a VUID associated with a Term/Concept.
Set Logic: S ^PXV(920.2,"AMASTERVUID",$E(X(1),1,30),X(2),DA)=""
Kill Logic: K ^PXV(920.2,"AMASTERVUID",$E(X(1),1,30),X(2),DA)
Whole Kill: K ^PXV(920.2,"AMASTERVUID")
X(1): VUID (920.2,99.99) (Subscr 1) (Len 30) (forwards)
X(2): MASTER ENTRY FOR VUID (920.2,99.98) (Subscr 2) (forwards)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):