GENERAL DESCRIPTION |
NAME: PXVIMM IMM MAN TAG: IMAN
ROUTINE: PXVRPC1 RETURN VALUE TYPE: GLOBAL ARRAY
WORD WRAP ON: TRUE
DESCRIPTION:
This RPC returns information from the IMM MANUFACTURER file
(#9999999.04). INPUT PARAMETER: FILTER PARAMETER TYPE:
LITERAL
MAXIMUM DATA LENGTH: 80 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
M:XXX - return entry with MVX code XXX
N:XXX - return entry with imm manufacturer name XXX
S:A - return list of all active manufacturers
S:I - return list of all inactive manufacturers
S:B - return list of all manufacturers, active and inactive
If this parameter is null, it defaults to "S:B". INPUT PARAMETER: 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. INPUT PARAMETER: PXVI PARAMETER TYPE: LITERAL
MAXIMUM DATA LENGTH: 1 REQUIRED: NO
SEQUENCE NUMBER: 3
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
RETURN PARAMETER DESCRIPTION:
Returns with PXVI not equal to 1:
PXVRETRN - returned information is stored in ^TMP("PXVLST",$J))
- return info format: Data Element Name^Data Element Value
- error format: -1^error message
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".
This RPC returns the internal entry number (IEN) of the record and data
in external format from the following data fields in the IMM
MANUFACTURER file:
- NAME (#.01)
- MVX (#.02)
- INACTIVE FLAG (#.03)
- CDC NOTES (#201)
- STATUS (computed by Data Standardization utility)
Example Global Array Returned:
^TMP("PXVLST",$J,"WYETH-AYERST 1",0)="RECORD^1 OF 1"
.001)="IEN^55"
.01)="NAME^WYETH-AYERST"
.02)="MVX CODE^WA"
.03)="INACTIVE FLAG^INACTIVE"
201)="CDC NOTES^became WAL, now owned by
Pfizer"
"STATUS")="STATUS^INACTIVE"
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 manufacturer IEN"
^TMP("PXVLST",$J,0)="-1^Invalid input for MVX code"
^TMP("PXVLST",$J,0)="-1^Invalid input for manufacturer name"
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 NAME
3 .02 MVX CODE
4 .03 INACTIVE FLAG (Internal~External)
5 201 CDC NOTES
6 STATUS (computed by Data Standardization utility)
|