PXVIMM VIS (3661)    REMOTE PROCEDURE (8994)

Name Value
NAME PXVIMM VIS
TAG IVIS
ROUTINE PXVRPC1
RETURN VALUE TYPE GLOBAL ARRAY
WORD WRAP ON TRUE
DESCRIPTION
This RPC returns information from the VACCINE INFORMATION STATEMENT file 
(#920).
INPUT PARAMETER
  • FILTER
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   55
    REQUIRED:   NO
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    This input parameter is used to specify the VACCINE INFORMATION 
    STATEMENT file records to be returned.
       R:XXX - return entry with ien XXX
       N:XXX - return entry with VIS name XXX   
       S:A   - return list of all active VISs
       S:I   - return list of all inactive VISs
       S:B   - return list of all VISs, active and inactive
     
    If this parameter is null, it defaults to "S:B".
    
  • PXVDATE
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   7
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This optional input parameter is used in determining status. Input 
    should be in VA FileMan date format. The default value is the current 
    date.
    
RETURN PARAMETER DESCRIPTION
Returns:
This RPC returns the internal entry number (IEN) of the record and data
in external format from the following data fields in the VACCINE
INFORMATION STATEMENT file:
  - NAME (#.01)
  - EDITION DATE (#.02)
  - EDITION STATUS (#.03)
  - LANGUAGE (#.04)
  - VIS TEXT (#2) (word-processing)
  - 2D BAR CODE (#100)
  - VIS URL (#101)
  PXVRETRN  - returned information is stored in ^TMP("PXVLST",$J))
  - STATUS (computed by Data Standardization utility)
 
Example Global Array Returned:
(Stored in ^TMP("PXVLST",$J,"SHINGLES VIS 1",)
   0)="RECORD^1 OF 1"
 .001)="IEN^27"
 .01)="NAME^SHINGLES VIS"
 .02)="EDITION DATE^OCT 06, 2009"
 .03)="EDITION STATUS^CURRENT"
 .04)="LANGUAGE^ENGLISH"
            - return info format: Data Element Name^Data Element Value
 2,1)="VIS TEXT 1^Shingles  Vaccine: What you need to know "
   2)="VIS TEXT 2^ "
   3)="VIS TEXT 3^1. What is shingles?"
   4)="VIS TEXT 4^ "
   5)="VIS TEXT 5^Shingles is a painful skin rash, often with blisters. It
       is also called "
   .
   .
   .
   117)="VIS TEXT 117^ "
            -       error format: -1^error message
   118)="VIS TEXT 118^Department of Health and Human Services"
   119)="VIS TEXT 119^Centers for Disease Control and Prevention"
 100)="2D BAR CODE^253088698300020211091006"
 101)="VIS URL^http://www.immunize.org/vis/shingles.pdf"
 "STATUS")="STATUS^ACTIVE"
 
Example Global Array Returned if No Records Found:
 ^TMP("PXVLST",$J,0)="0 RECORDS"
 
Example error messages:
 
 ^TMP("PXVLST",$J,0)="-1^Invalid input value"
 ^TMP("PXVLST",$J,0)="-1^Invalid input for VIS IEN"
 ^TMP("PXVLST",$J,0)="-1^Invalid input for VIS name"
For each record returned in the global array, the top value returned will 
indicate the record number in the array and the total number of records 
returned, e.g., "RECORD^1 OF 3".