ROR LIST HOSPITAL LOCATIONS

TITLEVALUE
NAMEROR LIST HOSPITAL LOCATIONS
DESCRIPTIONThe ROR LIST HOSPITAL LOCATIONS remote procedure returns a list of
hospital locations (defined in the HOSPITAL LOCATION file), which conform
the criteria.
TAGHLOCLIST
ROUTINERORRP015
INPUT PARAMETERSSEQUENCE NUMBER1
INPUT PARAMETERHLTYPES
DESCRIPTIONList of location types separated by commas (internal values of the TYPE
field of the HOSPITAL LOCATION file):

C Clinic
F File Area
I Imaging
M Module
N Non-Clinic Stop
OR Operating Room
W Ward
Z Other Location

Only locations of the types defined by this parameter are selected by the
remote procedure. By default ($G(HLTYPES)=""), all locations are selected.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER2
INPUT PARAMETERDIVIEN
DESCRIPTIONDivision IEN. If this parameter is defined and greater than zero then only
the locations associated with this division are selected.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER3
INPUT PARAMETERPART
DESCRIPTIONThe partial match restriction.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH30
INPUT PARAMETERSSEQUENCE NUMBER4
INPUT PARAMETERFLAGS
DESCRIPTIONFlags that control the execution (can be combined):

A Include active locations (default)

B Backwards. Traverses the index in the opposite
direction of normal traversal.

I Include inactive locations
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER5
INPUT PARAMETERNUMBER
DESCRIPTIONMaximum number of entries to return. A value of "*" or no value in this
parameter designates all entries.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
INPUT PARAMETERSSEQUENCE NUMBER6
INPUT PARAMETERFROM
DESCRIPTIONThe index entry(s) from which to begin the list
^01: FromName
^02: FromIEN

For example, a FROM value of "VA" would list entries following VA. You can
use the 2-nd and 3-rd "^"- pieces of the @RESULTS@(0) node to continue the
listing in the subsequent procedure calls.

NOTE: The FROM value itself is not included in the
resulting list.

See description of the LIST^DIC for more details about the PART, NUMBER
and FROM parameters.
PARAMETER TYPELITERAL
REQUIRED
MAXIMUM DATA LENGTH
RETURN VALUE TYPEGLOBAL ARRAY
RETURN PARAMETER DESCRIPTIONA negative value of the first "^"-piece of the Results[0] indicates that
an error occurred during the execution of the remote procedure. In this
case, the second piece of the Results[0] will contain number of the error
descriptors returned in the subsequent nodes of the Results array:

Results[0] Result Descriptor
^01: The last error code
^02: Number of the error descriptors

Results[i] Error Descriptor
^01: Error code
^02: Message
^03: Place of the error

Otherwise, number of hospital locations and the value of the FROM
parameter for the next procedure call are returned in the Results[0] and
the subsequent nodes of the global array contain the locations.

Results[0] Result Descriptor
^01: Number of locations
^02: FromName
^03: FromIEN

Results[i] Hospital Location
^01: IEN
^02: Name
^03: Location Type (internal)
^04: Institution IEN
^05: Division IEN
^06: Active (0/1)

NOTE: The 6th "^"-piece of the location record (Active) is
populated only if both "A" and "I" flags are used.
AVAILABILITYRESTRICTED
INACTIVE
CLIENT MANAGER
WORD WRAP ONTRUE
VERSION1
SUPPRESS RDV USER SETUP
APP PROXY ALLOWED