Print Page as PDF
GETALL API CALL ICR (2848)

GETALL API CALL    ICR (2848)

Name Value
NUMBER 2848
IA # 2848
DATE CREATED 1999/06/16
CUSTODIAL PACKAGE SCHEDULING
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE SCAPMCA
NAME GETALL API CALL
STATUS Active
KEYWORDS GETALL
DURATION Till Otherwise Agreed
ID SCAPMCA
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$GETALL(DFN[,SCDATE][,SCARR])
Function: $$GETALL^SCAPMCA(DFN) Input:    DFN - This
is a required parameter that is the internal
entry number of the PATIENT file.

Output:   HIERARCHICAL FORMAT  (This format will exist only if there are
assignments that exist.)

@SCARR@(DFN,"TM",a,b)=team data
@SCARR@(DFN,"TM",a,b,"POS",c)=position data
@SCARR@(DFN,"TM",a,b,"POS",c,"PROV",d)=provider data
@SCARR@(DFN,"TM",a,b,"POS",c,"PPOS",e)=preceptor position data
@SCARR@(DFN,"TM",a,b,"POS",c,"PPROV",f)=preceptor provider data
where:
a = TEAM file (#404.51) ifn
b = PATIENT TEAM Assignment file (#404.42) ifn
c = PATIENT TEAM POSITION Assignment file (#404.43) ifn
d = POSITION Assignment HISTORY file (#404.52) ifn
e = TEAM POSITION file (#404.57) ifn
f = POSITION Assignment HISTORY file (#404.52) ifn

Output:   FLAT FORMAT   (The zero nodes of this format are always
returned.  They are equal to zero if no
assignments exist.)

@SCARR@(DFN,"NPCPOS",0)=non-PC position count
@SCARR@(DFN,"NPCPOS",n)=non-PC position data
@SCARR@(DFN,"NPCPPOS",0)=non-PC preceptor position count
@SCARR@(DFN,"NPCPPOS",n)=non-PC preceptor position data
@SCARR@(DFN,"NPCPPR",0)=non-PC preceptor provider count
@SCARR@(DFN,"NPCPPR",n)=non-PC preceptor provider data
@SCARR@(DFN,"NPCPR",0)=non-PC provider count
@SCARR@(DFN,"NPCPR",n)=non-PC provider data
@SCARR@(DFN,"NPCTM",0)=non-PC team count
@SCARR@(DFN,"NPCTM",n)=non-PC team data
@SCARR@(DFN,"PCAP",0)=PC associate provider count
@SCARR@(DFN,"PCAP",n)=PC associate provider data
@SCARR@(DFN,"PCPOS",0)=PC position count
@SCARR@(DFN,"PCPOS",n)=PC position data
@SCARR@(DFN,"PCPPOS",0)=PC preceptor position count
@SCARR@(DFN,"PCPPOS",n)=PC preceptor position data
@SCARR@(DFN,"PCPR",0)=PC provider count
@SCARR@(DFN,"PCPR",n)=PC provider data
@SCARR@(DFN,"PCTM",0)=PC team count
@SCARR@(DFN,"PCTM",n)=PC team data
where:
n = incrementing number from 1 to 'n'.

Output:   ARRAY DATA STRINGS  (This outlines the various pieces of data
that are returned for the Team, Position
and Provider.)

TEAM Information Data String:
Piece   Description
1     IEN of TEAM file entry
2     Name of Team
3     IEN of file #404.42 (Patient Team Assignment)
4     Current Effective Date
5     Current Inactive Date (if any)
6     Pointer to #403.47 (purpose)
7     Name of Purpose
8     Is this the Patient's PC Team?

POSITION Information Data String:
Piece   Description
1     IEN of TEAM POSITIONfile (#404.57)
2     Name of Position
3     IEN of Team #404.51
4     IEN of file #404.43 (Patient/Team/Position
Assignment)
5     Current Effective Date
6     Current Inactive Date (if any)
7     Pointer to Standard Role (#403.46)
8     Name of Standard Role
9     Pointer to User Class (#8930)
10     Name of User Class
11     Pointer to Patient Team Assignment (#404.42)
12     IEN of Preceptor Position (#404.57)


PROVIDER Information Data String:
Piece   Description
1     IEN of NEW PERSON file entry (#200)
2     Name of Person
3     IEN of Team Position file (#404.57)
4     Name of Position
5     IEN of User Class (#8930) of Position
(#404.57)
6     User Class Name
7     IEN of Standard Position (#403.46)
8     Standard Role (Position) Name
9     Activation Date for #404.52 (not 404.59!)
10     Inactivation Date for #404.52
11     IEN of Position Assignment History (#404.52)
12     IEN of Preceptor Position
13     Name of Preceptor Position
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
Internal entry of the PATIENT file (#2).
SCDATE Input
Array of Dates (Default=DT)
SCDATE("BEGIN")=beginning date
SCDATE("END")=ending date
SCDATE("INCL")= 1:  only reference practitioners that were on
team for entire date range.
0:  anytime in date range
(Default = 1)
SCARR Output
Name of array to return data.  (Default is
^TMP("SC",$J)