The Master Data Model for Veteran Care

Developer Documentation » VDM » Immunization-9999999_14

Immunization (9999999.14)

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. 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 (PX1201) for the VistA Immunization Enhancements Project. Additional fields may be included in later enhancements. This file is a list of Immunizations and associated codes developed specifically for use in the IHS. This file contains a full descriptive name for each Immunization, plus a shortened name of Ten Characters which is used on the Health Summary and on reports where space is limited, plus a Two Digit Code for each Immunization.

Global: ^AUTTIMM(

Domain: Non-Clinical

Properties

Label/Field Name Field # Description Datatype Attributes Range
Name
  name
.01 This is the name of the Immunization (e.g. Hib-Hep B).

Enter the Name of the Immunization using 3 to 100 characters.
STRING INDEXED
REQUIRED
 
Short Name
  short_name
.02 This is the “Short” name for this immunization such as an acronym,
nickname, or other name by which it might be called (e.g. Tet Tox).

Enter the short name using 2 to 10 characters (e.g. Tet Tox).
STRING INDEXED  
Cvx Code
  cvx_code
.03 This is the Center for Disease Control’s (CDC) code for this vaccine,
known as the CVX Code. The purpose of the CVX code is mainly when using
HL7 to share data regarding this vaccine.
STRING INDEXED  
Default Lot#
  default_lotnumber
.04 This is the default lot number for this immunization. POINTER   Immunization_Lot-9999999_41
Max # In Series
  max_number_in_series
.05 (Optional) This is the maximum number of vaccinations that can be given
for this immunization.

Enter the number between 0 and 8 that represents the maximum allowable
vaccinations that can be given for this immunization.
ENUMERATION   1: 1
2: 2
3: 3
4: 4
5: 5
6: 6
7: 7
8: 8
NON-SERIES: 0
Childhood Immunization
  childhood_immunization
.06 YES in this field indicates this immunization is a childhood
immunization. NO in this field indicates this immunization is not a
childhood immunization.
BOOLEAN   false: 1
true: 0
Inactive Flag
  inactive_flag
.07 This field is used to inactivate an immunization type. If this field
contains a “1” then the immunization is inactive. Inactive immunizations
cannot be selected in the manual data entry process. Immunization entries
should be made inactive when they are no longer used. Do not delete the
entry or change the meaning of the immunization entry.

To make an inactive immunization active,
enter the “@” symbol to delete the “1” from the field.
ENUMERATION   INACTIVE: 1
Skin Test
  skin_test
.08 This field indicates if this immunization is a skin test. Enter ‘1’ if
this immunization is a skin test. Enter ‘0’ if this immunization is not
a skin test.
ENUMERATION   NOT A SKIN TEST: 0
SKIN TEST: 1
Vaccine Group (series Type)
  vaccine_group_series_type
.09 This field identifies the Imm/Serve Series Type (or “Vaccine group”) to
which this immunization belongs.
     
Alternate Short Name
  alternate_short_name
.1 This is an alternate short name for this immunization. STRING INDEXED  
Cpt Code
  cpt_code
.11 This is the CPT code associated with this immunization. POINTER INDEXED Cpt-81
Related Contraind Hl7 Codes
  related_contraind_hl7_codes
.12 This field indicates the HL7 code(s) of any immunizations that should be
contraindicated when this immunization is contraindicated.
STRING    
Vis Default Date
  vis_default_date
.13 This is the default date of the Vaccine Information Statement for this
immunization.
DATE-TIME    
Icd Diagnosis Code
  icd_diagnosis_code
.14 This is the ICD diagnosis code associated with this immunization. STRING    
Icd Procedure Code
  icd_procedure_code
.15 This is the ICD Procedure Code associated with this immunization. STRING    
Include In Forecast
  include_in_forecast
.16 This field indicates if this vaccine is allowed to be forecast for
patients when appropriate. Enter NO to exclude this vaccine from all
forecasts.
ENUMERATION   YES, INCLUDE: 0
NO, EXCLUDE: 1
Include In Vac Account Report
  include_in_vac_account_report
.17 This field indicates if this vaccine should be included in the Vaccine
Accountability Report. Enter NO if not.
BOOLEAN   false: 0
true: 1
Default Volume
  default_volume
.18 This is the default volume for this vaccine. NUMERIC    
Combination Immunization (y/n)
  combination_immunization_y_n
.2 This YES/NO field identifies if this immunization is a combination
product or not. If this immunization is a combination product (a
multi-component vaccine requiring multiple vaccine information
statements), enter YES. If this immunization is not a combination
product, but can be represented by a single vaccine information
statement, enter NO.
BOOLEAN   false: 1
true: 0
Component #1
  component_number1
.21 This is the first component of this combination vaccine. POINTER   Immunization-9999999_14
Component #2
  component_number2
.22 This is the second component of this combination vaccine. POINTER   Immunization-9999999_14
Component #3
  component_number3
.23 This is the third component of this combination vaccine. POINTER   Immunization-9999999_14
Component #4
  component_number4
.24 This is the fourth component of this combination vaccine. POINTER   Immunization-9999999_14
Component #5
  component_number5
.25 This is the fifth component of this combination vaccine. POINTER   Immunization-9999999_14
Component #6
  component_number6
.26 This is the sixth component of this combination vaccine. POINTER   Immunization-9999999_14
Reading Required
  reading_required
.51 This field indicates if this inoculation requires an objective reading
and a subjective interpretation of the reading.
BOOLEAN   false: 0
true: 1
Brand #1
  brand_number1
1.01 This is the first brand name for this vaccine. STRING    
Brand #2
  brand_number2
1.03 This is the second brand name for this vaccine. STRING    
Brand #3
  brand_number3
1.05 This is the third brand name for this vaccine. STRING    
Brand #4
  brand_number4
1.07 This is the fourth brand name for this vaccine. STRING    
Brand #5
  brand_number5
1.09 This is the fifth brand name for this vaccine. STRING    
Full Name
  full_name
1.14 This is the full name for this immunization. STRING    
Cpt Code 2nd
  cpt_code_2nd
1.15 This is a second CPT code for this immunization. POINTER INDEXED Cpt-81
Cdc Full Vaccine Name
  cdc_full_vaccine_name
2 This is the CDC Full Vaccine Name for this immunization. STRING    
Coding System
  coding_system
3 This multiple stores the coding system(s) associated with the codes
identifying this immunization.
OBJECT   Coding_System-9999999_143
Vaccine Information Statement
  vaccine_information_statement
4 This multiple identifies the Vaccine Information Statement(s)
associated with this immunization.
POINTER   Vaccine_Information_Statement-920
Cdc Product Name
  cdc_product_name
5 This multiple stores the CDC Product Name(s) reflecting manufacturer
trade names, but may not be identical to those registered trade names.
STRING    
Vaccine Group Name
  vaccine_group_name
7 This multiple field contains the VACCINE GROUP NAME(s) with which this
immunization is associated.
STRING    
Synonym
  synonym
10 This multiple stores locally editable synonyms for this immunization. STRING    
Replaced By Vha Standard Term
  replaced_by_vha_standard_term
99.97 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.
POINTER INDEXED Immunization-9999999_14
Master Entry For VUID
  master_entry_for_vuid
99.98 This field identifies the Master entry for a VUID associated with a
Term/Concept.
BOOLEAN REQUIRED false: 0
true: 1
VUID
  vuid
99.99 VHA Unique ID (VUID). A unique meaningless integer assigned to reference
terms VHA wide.
STRING INDEXED
REQUIRED
 
Effective Date/time
  effective_date_time
99.991 Describes the pair Status and Effective Date/Time for each reference term. OBJECT   Effective_Date_time-9999999_1499
Class
  class
100 This is the CLASS of this Immunization. ENUMERATION   LOCAL: L
NATIONAL: N
VISN: V
Mnemonic
  mnemonic
8801 This is the mnemonic for this Immunization.

Enter a 1 to 3 character mnemonic.
STRING    
Acronym
  acronym
8802 This standardized vaccine acronym for this immunization is intended to
provide a uniform approach to vaccine references.
STRING INDEXED  
Selectable For Historic
  selectable_for_historic
8803 This field determines whether an inactive immunization is selectable when
documenting a historic administration.
BOOLEAN REQUIRED false: N
true: Y

↑ Return to top

Sub-Files

Coding System (9999999.143)

ID
Coding_System-9999999_143

Properties

Label/Field Name Field # Description Datatype Attributes Range
Coding System
  coding_system
.01 This field indicates the coding system associated with the codes
identifying this immunization.
STRING INDEXED
REQUIRED
 
Code
  code
.02 This multiple stores the code(s) representing this immunization within
this coding system.
STRING    

↑ Return to top

Effective Date/time (9999999.1499)

ID
Effective_Date_time-9999999_1499

Properties

Label/Field Name Field # Description Datatype Attributes Range
Effective Date/time
  effective_date_time
.01 This is the date/time when the Status of the reference term was
established.
DATE-TIME INDEXED
REQUIRED
 
Status
  status
.02 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.
ENUMERATION REQUIRED ACTIVE: 1
INACTIVE: 0

↑ Return to top


Document generated on August 31st 2017, 2:55:41 pm