Print Page as PDF
ACRP INTERFACE TOOLKIT (AIT) ICR (2548)

ACRP INTERFACE TOOLKIT (AIT)    ICR (2548)

Name Value
NUMBER 2548
IA # 2548
DATE CREATED 1998/09/22
CUSTODIAL PACKAGE SCHEDULING
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE SDQ
NAME ACRP INTERFACE TOOLKIT (AIT)
GENERAL DESCRIPTION 

The ACRP Interface Toolkit (AIT) is a set of programmer tools that
provides access to outpatient encounter data.  The toolkit contains
Application Programmer Interfaces (APIs) and Remote Procedure Calls
(RPCs) that provide access to procedure, diagnosis, provider, and
general data related to an encounter.

This AIT provides Class I packages, Class III software, and other local
code with one highly structured interface to the encounter data.



Note: For detail information on each specific API call, see the following
AIT documentation files:
sd_53_p131_tooldoc.doc or
sd_53_p131_tooldoc.pdf.
Theses files are distributed as part of patch SD*5.3*131.

Also, the documentation is available on-line at the following URL:
http://127.0.0.1   /softserv/mip/wr/acrpapi.htm
STATUS Active
ID SDQ
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
OPEN(.query[,errors]) 
Open a Query Object instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Output 
Encounter Query Handle
errors Output 
Error Array [optional]
CLOSE(.query[,errors]) 
Close a Query Object instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
errors Output 
Error Array [optional]
PAT(query,.dfn,action[,errors]) 
Set or retrieve Patient property of a Query Object
instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
dfn Input 
Patient ID
action Input 
Action
errors Output 
Error Array [optional]
DATE(query,.begin_date,.end_date,action[,errors]) 
Set or retrieve Date Range property of a Query Object
instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
begin_date Input 
Begin Date/Time
end-date Input 
End Date/Time
action Input 
Action
errors Output 
Error Array [optional]
FILTER(query,.filter,action[.errors]) 
Set or retrieve Filter property of a Query Object
instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
filter Both 
Encounter Query Filter
action Input 
Action
errors Output 
Error Array [optional]
Y Output 
current encounter entry number
Y0 Output 
zeroth node of current encounter entry (only
supported fields)
VISIT(query,.visit,action[,errors]) 
Set or retrieve Visit property of a Query Object
instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
visit Input 
Visit IEN
action Input 
Action
errors Output 
Error Array [optional]
INDEX(query,.index,action[,errors]) 
Set or retrieve Index property of a Query Object
instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
index Input 
Encounter Query Index
action Input 
Action
errors Output 
Error Array [optional]
$$EOF(query[,errors]) 
Is cursor positioned on the last encounter record in
the Query Object result set?
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
errors Output 
Error Array [optional]
$$EOF Output 
1 - Yes, query cursor is at the last record or no
records exist for query 0 - No, query cursor is not at last record
$$BOF(query[,errors]) 
Is cursor positioned on the first encounter record in
the Query Object result set?
VARIABLES TYPE VARIABLES DESCRIPTION
$$BOF Output 
1 - Yes, query cursor is at the first record or no
records exist for query 0 - No, query cursor is not at first record
query Input 
Encounter Query Handle
errors Output 
Error Array [optional]
ACTIVE(query,.status,action[,errors] 
Set or retrieve Active property of a Query Object
instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
status Input 
Encounter Query Active Status
action Input 
Action
errors Output 
Error Array [otional]
$$COUNT(query[,errors]) 
Returns the number of encounter records in a Query
Object result set.
VARIABLES TYPE VARIABLES DESCRIPTION
$$COUNT Output 
<number>  count of records in query's result set 0
no records in the query's result set <null>    invalid query or query not
active
query Input 
Encounter Query Handle
errors Output 
Error Array [optional]
FIRST(query[,errors]) 
Positions the cursor at the first encounter record in
the Query Object result set.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
errors Output 
Error Array [optional]
LAST(query[,errors]) 
Positions the cursor at the last encounter record in
the Query Object result set.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
errors Output 
Error Array [optional]
NEXT(query[,errors]) 
Positions the cursor at the next encounter record in
the Query Object result set.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
errors Output 
Error Array [optional]
PRIOR(query[,errors]) 
Positions the cursor at the previous encounter record
in the Query Object result set.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
errors Output 
Error Array [optional]
REFRESH(query[,errors]) 
Refresh the Query Object result set.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
errors Output 
Error Array [optional]
$$GETENTRY(query[,errors]) 
Returns the internal entry number of the Outpatient
Encounter (#409.68) file for the encounter record at the current cursor
position of the Query Object result set.
VARIABLES TYPE VARIABLES DESCRIPTION
$$GETENTRY Output 
<pointer>  ID for entry <null>     if no entries in
result set
query Input 
Encounter Query Handle
errors Output 
Error Array [optinal]
SCAN(query[,direction][,errors]) 
Scans encounter records that meet the criteria
defined by the properties of the Query Object instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
scan_direction Input 
Direction [optional]
errors Output 
Error Array [optional]
SCANCB(query,.callback,action[,errors]) 
Set or retrieve Callback property of a Query Object
instance.
VARIABLES TYPE VARIABLES DESCRIPTION
query Input 
Encounter Query Handle
callback Input 
Scan Callback Logic
action Input 
Action
errors Output 
Error Array [optional]