VPS LIST ALL (3255) REMOTE PROCEDURE (8994)

Name	Value
NAME	VPS LIST ALL
TAG	LISTALL
ROUTINE	VPSRPC5
RETURN VALUE TYPE	ARRAY
AVAILABILITY	RESTRICTED
INACTIVE	ACTIVE
VERSION	1
DESCRIPTION	Returns a list of patients with names start with ( NOT PREFIXED BY ) To get the next patients, caller must request the next batch of 44 records. For this reason, this RPC accepts two different format of 'LIST FROM' text: 1. FROM = PATIENT NAME. This format will return records start with ( NOT PREFIXED BY ) FROM (PATIENT NAME) 2. FROM = LAST IEN^LAST PATIENT NAME. This format with return the next batch of 44 records after the LAST PATIENT NAME. the input value. Only 44 records will be returned to the caller. e.q: If Patient File contains patient names 'AA', 'AB', 'BB', 'BC, 'CC', 'CD' in this order and caller passes in 'A', all of those patients will be included in the list. If 'GG', 'KK', 'LL' are the 44th, 45th, and 46th patients in the patient name order, 'KK' and 'LL' will not be included.
INPUT PARAMETER	FROM PARAMETER TYPE: LITERAL MAXIMUM DATA LENGTH: 30 REQUIRED: YES SEQUENCE NUMBER: 1 DESCRIPTION: Contains the patient's name or contains the patient's file #2 IEN and name. Name part of the input may be a partial or full name. Examples: "DOE,J" OR "99999^DOE,J". DIR PARAMETER TYPE: LITERAL MAXIMUM DATA LENGTH: 2 REQUIRED: YES SEQUENCE NUMBER: 2 DESCRIPTION: The value of DIR can be 1 or -1. This parameter determines the $ORDER search direction, 1 is ascending and -1 is descending. FROM PARAMETER TYPE: LITERAL MAXIMUM DATA LENGTH: 30 REQUIRED: YES SEQUENCE NUMBER: 1 DESCRIPTION: FORM is the 'Start With' or 'List From' input parametr. This is 2. FORM = LAST IEN^LAST PATIENT NAME. This format is to provide a caller to get the next batch of 44 records. The list returned will NOT include the LAST PATIENT NAME. Commonly, RPC caller will set LAST IEN^LAST PATIENT NAME with the last record returned in the previous RPC call. NOT a 'Prefixed by' input parameter. This is a required field and can have two different formats. 1. FORM = PATIENT NAME. This format will return a batch of 44 patient records in patient name order start with PATIENT NAME. This is NOT a 'Prefixed by' input parameter. Any records in that batch including patient names not prefixed by the FORM will be included. DIR PARAMETER TYPE: LITERAL MAXIMUM DATA LENGTH: 2 REQUIRED: YES SEQUENCE NUMBER: 2 DESCRIPTION: Input parameter DIR determines the order of the output array returned. The value is either 1 (ascending order = default value) or -1 ( descending order).
RETURN PARAMETER DESCRIPTION	The parameter Y is an array passed by reference and will contain a list of patients whose NAME or IEN^NAME match the input value stored in FROM.