PXVIMM IMM LOT (3659)    REMOTE PROCEDURE (8994)

Name Value
NAME PXVIMM IMM LOT
TAG ILOT
ROUTINE PXVRPC1
RETURN VALUE TYPE GLOBAL ARRAY
WORD WRAP ON TRUE
DESCRIPTION
This RPC returns information from the IMMUNIZATION LOT file 
(#9999999.41).
INPUT PARAMETER
  • FILTER
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   NO
    SEQUENCE NUMBER:   1
    DESCRIPTION:   
    This input parameter is used to specify the IMMUNIZATION LOT file 
    records to be returned. Possible values:
       R:XXX - return entry with ien XXX
       N:XXX - return entry with lot number XXX
       S:A   - return list of all active lot numbers
       S:I   - return list of all inactive lot num
       S:B   - return list of all lot numbers, active and inactive
     
    If this parameter is null, it defaults to "S:B".
    
  • PXVI
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   1
    REQUIRED:   NO
    SEQUENCE NUMBER:   2
    DESCRIPTION:   
    This optional input parameter is used to return an alternate array with 
    record data in a caret delimited string. If this parameter is null or 0, 
    the return defaults to the other array.
       1 - return alternate array with internal values in delimited string
    
  • PXLOC
    PARAMETER TYPE:   LITERAL
    MAXIMUM DATA LENGTH:   30
    REQUIRED:   NO
    SEQUENCE NUMBER:   3
    DESCRIPTION:   
    This optional input parameter is used to specify the institution
    (division) for which records should be returned at multidivisional
    facilities that may have immunization inventory specific to divisions.
    Possible values are:
      "I:X": Institution (#4) IEN #X
      "V:X": Visit (#9000010) IEN #X
      "L:X": Hopital Location (#44) IEN #X
    If determination cannot be made based off input, then default to DUZ(2),
    and if DUZ(2) is not defined, default to Default Institution.
    
RETURN PARAMETER DESCRIPTION
Returns with PXVI not equal to 1:
This RPC returns the internal entry number (IEN) of the record and data in
external format from the following data fields in the IMMUNIZATION LOT
file:
   - LOT NUMBER (#.01)
   - MANUFACTURER (#.02)
   - STATUS (#.03)
   - VACCINE (#.04)
   - EXPIRATION DATE (#.09)
   - ASSOCIATED VA FACILITY (#.1)
   - DOSES UNUSED (#.12)
   PXVRETRN  - returned information is stored in ^TMP("PXVLST",$J))
   - LOW SUPPLY ALERT (#.15)
   - NDC CODE (VA) (#.18)
  
  Example Global Array Returned:
   ^TMP("PXVLST",$J,"P92A8769LN 1",0)="RECORD^1 OF 1"
                                .001)="IEN^6"
                                 .01)="LOT NUMBER^P92A8769LN"
                                 .02)="MANUFACTURER^SCLAVO, INC."
                                 .03)="STATUS^ACTIVE"
                                 .04)="VACCINE^ANTHRAX"
             - return info format: Data Element Name^Data Element Value
                                 .09)="EXPIRATION DATE^DEC 31, 2016"
                                  .1)="ASSOCIATED VA FACILITY^ALBANY"
                                 .12)="DOSES UNUSED^94"
                                 .15)="LOW SUPPLY ALERT^10"
                                 .18)="NDC CODE (VA)^"
     
  Example Global Array Returned if No Records Found:
   ^TMP("PXVLST",$J,0)="0 RECORDS"
  
  Example error messages:
             -       error format: -1^error message
   ^TMP("PXVLST",$J,0)="-1^Invalid input value"
   ^TMP("PXVLST",$J,0)="-1^Invalid input for immunization lot IEN"
   ^TMP("PXVLST",$J,0)="-1^Invalid input for lot number"
 
Returns with PXVI equal to 1:
   PXVRETRN  - returned information is stored in ^TMP("PXVLST",$J))
 
   Each record is a caret-delimited list of values. Within the 
   caret-delimited list, for fields with different internal and external
   values, both the internal and external values are included, delimited
  
   by a tilde (~) as indicated below:
    Piece# Field# Field Name
    ------ ------ ----------
    1             IEN             
    2      .01    LOT NUMBER
    3      .02    MANUFACTURER  (Internal~External)
    4      .03    STATUS (Internal~External)
    5      .04    VACCINE (Internal~External)
    6      .09    EXPIRATION DATE (Internal~External)
    7      .12    DOSES UNUSED
For each record returned in the global array, the top value returned will
    8      .15    LOW SUPPLY ALERT
    9      .18    NDC CODE (VA) (Internal~External)
   10      .1     ASSOCIATED VA FACILITY (Internal~External)
  
  Example Alternate Global Array:
   ^TMP("PXVLST",$J,0)=1 RECORD 
                     6)="6^P92A8769LN^49~SCLAVO, INC.^0~ACTIVE^41~ANTHRAX^
                          3161231~DEC 31, 2016^93^10^~^500~ALBANY"
indicate the record number in the array and the total number of records 
returned, e.g., "RECORD^1 OF 3".