NURAPI ICR (3227)

Name

Value

NUMBER

3227

IA #

3227

DATE CREATED

2000/10/17

CUSTODIAL PACKAGE

NURSING SERVICE

CUSTODIAL ISC

Chicago

USAGE

Private

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

NURAPI

NAME

NURAPI

GENERAL DESCRIPTION

This routine provides entry points to return Nursing
package data to the calling package.

STATUS

Active

DURATION

Till Otherwise Agreed

NURAPI

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

ACTLOCS(.ARRAY)

Returns all active nursing locations from the NURS
LOCATION file (#211.4) in the array specified. FILE 211.4 points to HOSPITAL
LOCATION file (#44).

VARIABLES	TYPE	VARIABLES DESCRIPTION
ARRAY	Both	Input - (Required) The name of the array to store the entries. Output - ArrayName(sequential #)=File 211.4 ien^File 44 name (for 211.4 ien). If no active locations returns: ArrayName(1)="NO UNIT".

PTCHK(LOC)

This function indicates if any patients (active or
inactive) are associated with the Nursing location identified.

Returns: 0 - no patients associated with this location
1 - yes, patients are associated with this location
-1 - (minus 1) LOC is undefined or not found

VARIABLES	TYPE	VARIABLES DESCRIPTION
LOC	Input	(Required) NURS LOCATION file (#211.4) ien.

APTCHK(LOC)

This function indicates if active patients are
associated with the Nursing location identified.

Returns: 0 - no active patients associated with this location
1 - yes, active patients are associated with this location
-1 - (minus 1) LOC is undefined or not found

VARIABLES	TYPE	VARIABLES DESCRIPTION
LOC	Input	(Required) NURS LOCATION file (#211.4) ien.

PTLIST(LOC,.ARRAY)

Returns a list of all (active and inactive) patients
for a nursing location in the array specified.

VARIABLES

TYPE

VARIABLES DESCRIPTION

LOC

Input

(Required) NURS LOCATION file (#211.4) ien.

ARRAY

Both

Input - (Required) Name of array to return entries in Output - Subscripted by
sequential number with DFN in first piece and
patient name in second piece.
Example: ArrayName(sequential #)=DFN^patient name

If LOC is undefined or not found, then returns ARRAY(1)=-1.  If no patients on
the Location, then returns ARRAY(1)="^No Patients".

APTLIST(LOC,.ARRAY)

Returns a list of active patients for a nursing
location in the array specified.

VARIABLES

TYPE

VARIABLES DESCRIPTION

LOC

Input

(Required) NURS LOCATION file (#211.4) ien.

ARRAY

Both

Input - (Required) Name of the array to return entries in Output -
Subscripted by sequential number with DFN in first piece and
patient name in second piece.
Example: ArrayName(sequential #)=DFN^patient name

If LOC is undefined or not found, then returns ARRAY(1)=-1.  If no patients on
the Location, then returns ARRAY(1)="^No Patients".

FINDNLOC(LOC)

This function returns the NURS LOCATION file (#211.4)
ien and the ien of the location (File 44, Field .01). If LOC is undefined,
then returns -1.  If no such location returns: "^Location not found".

Returns: File 211.4 ien^File 44 ien

VARIABLES	TYPE	VARIABLES DESCRIPTION
LOC	Input	(Required) Name of the Nursing location (as it appears in File 44). The name should begin with the characters 'NUR '. If not, NUR<space> will be appended to the beginning of LOC.

MASWARDS(LOC,.ARRAY)

Returns the MAS wards associated with this Nursing
location in the array specified. The .01 field of the MAS WARD multiple of the
NURS LOCATION file points to the WARD LOCATION file (#42).

VARIABLES

TYPE

VARIABLES DESCRIPTION

LOC

Input

(Required) NURS LOCATION file (#211.4) ien.

ARRAY

Both

Input - (Required) Name of array to return entries in.  Output - ARRAY
subscripted by the MAS WARD value.
Example: ArrayName($P(^NURSF(211.4,LOC,3,D1,0),U,1))=""

If LOC is null or not found, then ARRAY(1)=-1.

SUBSCRIBING PACKAGE

SUBSCRIBING PACKAGE	ISC
GEN. MED. REC. - VITALS	Hines