Nursing Ward Location API ICR (3052)

Name

Value

NUMBER

3052

IA #

3052

DATE CREATED

2000/02/24

CUSTODIAL PACKAGE

NURSING SERVICE

CUSTODIAL ISC

Chicago

USAGE

Supported

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

NURSUT5

NAME

Nursing Ward Location API

GENERAL DESCRIPTION

Patch NUR*4*31 introduces a new supported Application
Programming Interface(API).  This API provides a "Query" and "Look-up" on the
NURS LOCATION file (#211.4).  This DBIA was developed as a way to provide
access to File #211.4 and allow Nursing to retire two existing private DBIAs.

STATUS

Active

KEYWORDS

NUR
API
WARD LOCATION

DURATION

Till Otherwise Agreed

NURSUT5

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

WARD(FUNCT,.ARRAY)

In the following examples the ARRAY is variable VAR.
The first example is a query for all active wards.  The second example is a
look-up a specific entry in the NURS LOCATION file (#211.4).

1) Coding example of Query call:
<tab>KILL VAR ; initialize VAR
<tab>DO WARD^NURSUT5("Q^A",.VAR) ; Call to API

User interface:
Select NURSING UNIT NAME: ?

NOTE:  The letters NUR may be in front of the location name.
This is not to be corrected under any circumstance.

DO YOU WANT THE ENTIRE 26-ENTRY NURSING UNIT LIST? Y  (Yes)

CHOOSE FROM:
10E                                     SUPPORT ISC
10W                                     SUPPORT ISC
12E                                     SUPPORT ISC
2AS                                     SUPPORT ISC
3AS                                     HINES ISC
3E                                      SUPPORT ISC
4AS PSYCHIATRY                          SUPPORT ISC
5NP                                     HINES ISC
Select NURSING UNIT NAME: 4AS  PSYCHIATRY

2) Coding example of Look-up call:
<tab>KILL VAR ; initialize VAR
<tab>DO WARD^NURSUT5("L^5",.VAR) ; Call to API

In both cases when the API returns the data it will be placed into the
variable array specified.  If the data value is missing the array element for
that value will not be returned. The following is an example of the return
array.

Example of Return Array:
VAR=5
VAR(5,.01)="30^4AS PSYCHIATRY"
VAR(5,.02)="499^SUPPORT ISC"
VAR(5,.03)="1^NURSING"
VAR(5,1)="A^ACTIVE"
VAR(5,1.5)="A^ACTIVE"
VAR(5,2)=1
VAR(5,2,1,.01)="4^4AS"
VAR(5,2,1,1)="1^PSYCHIATRIC"
VAR(5,4)=1
VAR(5,4,1.01)="1^PSYCHIATRIC"
VAR(5,11)="60"
VAR(5,12)="8^PSYCHIATRY"
VAR(5,37)="YES"

VARIABLES

TYPE

VARIABLES DESCRIPTION

FUNCT

Input

FUNCT = Piece1_^_Piece2
Piece1 must contain an "L" or "Q"
Piece1 "L" means Look-up of specified
entry in File 211.4, and
Piece2 must contain the IEN for
the entry in File 211.4.

Piece1 "Q" means do a DIC style query
on File 211.4, and
Piece2 must contain "I","A" or
""(i.e., null).  This will be
the screen used on the look-up.
The API will do a DIC style
look-up for the ward.
"I" means look-up only
inactive wards.
"A" means look-up only
active wards.
""  means look-up all
wards.

.ARRAY

Both

.ARRAY = Recommend the return
array should be
namespaced.

Return Values:
ARRAY  = -1 means that the
Look-up or Query
failed.
ARRAY  = IEN means that the
Look-up or Query was
successful.

ARRAY can be any variable array that the developer chooses. When the API
returns the data it will be placed into the variable array specified. If the
data value is missing the array element for that value will not be returned.

Return Array:
ARRAY(IEN,.01) = Pointer to File 44
_"^"_ External value
of Hospital Location
file(44), Name
field(.01)
ARRAY(IEN,.02) = Facility pointer to
File 4_"^"_ External
name of facility
ARRAY(IEN,.03) = Pointer to File 212.7
_"^"_ External value
of NURS Product Line
file(212.7), Name
field(.01)
ARRAY(IEN,1)   = Patient care status
internal value_"^"_
External value of
Patient care status
ARRAY(IEN,1.5) = Ward status Internal
value_"^"_ External
value of Ward status
ARRAY(IEN,2)   = Total number of MAS
ward pointers
X = the IEN of the entry
within the MAS ward
Multiple.
ARRAY(IEN,2,X,.01) = Pointer to File
42 _"^"_ External
value of Ward
Location file(42),
Name field(.01)
ARRAY(IEN,2,X,1)   = Pointer to File
213.3_"^"_External
value of NURS AMIS
Ward file(213.3),
Bed Section
field(.01)
ARRAY(IEN,4)   = Total number of
AMIS ward pointers.
Y = the IEN of the entry
within the AMIS
Bed section Multiple.
ARRAY(IEN,4,Y,.01) = Pointer to file
213.3_"^"_External
value of NURS AMIS
Ward file(213.3),
Bed Section
field(.01)
ARRAY(IEN,11) = Professional Percentage
ARRAY(IEN,12) = Pointer to File
211.5_"^"_External
value of NURS
Clinical Background
file(211.5),
Description field(.01)
ARRAY(IEN,37) = Indicates whether
or not active staff
is assigned to this
ward.