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

ACRP INTERFACE TOOLKIT (AIT)    ICR (2546)

Name Value
NUMBER 2546
IA # 2546
DATE CREATED 1998/09/22
CUSTODIAL PACKAGE SCHEDULING
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE SDOE
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 SDOE
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
GETDX(encounter,dx_list[,errors]) 
Returns diagnoses for an encounter.
VARIABLES TYPE VARIABLES DESCRIPTION
encounter Input 
Encounter IEN
dx_list Output 
List of V POV Entries
errors Output 
Error Array [optional]
GETPRV(encounter,provider_list[,errors]) 
Returns providers for an encounter.
VARIABLES TYPE VARIABLES DESCRIPTION
encounter Input 
Encounter IEN
provider_list Output 
List of V PROVIDER Entries
errors Output 
Error Array [optional]
GETCPT(encounter,cpt_list[,errors]) 
Returns procedures for an encounter.
VARIABLES TYPE VARIABLES DESCRIPTION
encounte Input 
Encounter IEN
cpt_list Output 
List of V CPT Entries
errors Output 
Error Array [optional]
$$PRV(encounter[,errors]) 
Is at least one provider assigned to an encounter?
VARIABLES TYPE VARIABLES DESCRIPTION
$$PRV Output 
1 - Yes, at least one provider is associated with
encounter 0 - No, no providers are associated with encounter
encounter Input 
Encounter IEN
errors Output 
Error Array [optional]
$$CPT(encounter[,errors]) 
Is at least one procedure assigned to an encounter?
VARIABLES TYPE VARIABLES DESCRIPTION
$$CPT Output 
1 - Yes, at least one procedure is associated with
encounter 0 - No, no procedures are associated with encounter
encounter Input 
Encounter IEN
errors Output 
Error Array [optional]
$$DX(encounter[,errors]) 
Is at least one diagnosis assigned to an encounter?
VARIABLES TYPE VARIABLES DESCRIPTION
$$DX Output 
1 - Yes, at least one diagnosis is associated with
encounter 0 - No, no diagnoses are associated with encounter
encounter Input 
Encounter IEN
errors Output 
Error Array [optional]
$$FINDPRV(encounter,provider[,errors]) 
Is a specific provider assigned to an encounter?
VARIABLES TYPE VARIABLES DESCRIPTION
$$FINDPRV Output 
1 - Yes, specific provider is associated with
encounter 0 - No, provider is not associated with encounter
encounter Input 
Encounter IEN
provider Output 
Practitioner ID
errors Output 
Error Array [optional]
$$FINDDX(encounter,diagnosis[,errors]) 
Is a specific diagnosis assigned to an encounter?
VARIABLES TYPE VARIABLES DESCRIPTION
$$FINDDX Output 
1 - Yes, specific diagnosis is associated with
encounter 0 - No, diagnoisis is not associated with encounter
encounter Input 
Encounter IEN
diagnosis Output 
Diagnosis IEN
errors Output 
Error Array [optional]
$$FINDCPT(encounter,cpt[,errors]) 
Is a specific procedure assigned to an encounter?
VARIABLES TYPE VARIABLES DESCRIPTION
$$FINDCPT Output 
1 - Yes, specific procedure is associated with
encounter 0 - No, procedure is not associated with encounter
encounter Input 
Encounter IEN
cpt Output 
CPT IEN
errors Output 
Error Array [optional]
$$EXAE(dfn,begin_date,end_date[,flags][,errors]) 
Returns the first standalone add/edit encounter for a
patient in a date range.
VARIABLES TYPE VARIABLES DESCRIPTION
$$EXAE Output 
<pointer>  Outpatient Encounter IEN for first
standalone encounter
found in date range <null>     if no encounter exists
dfn Input 
Patient ID
begin_date Input 
Begin Date/Time
end_date Input 
End Date/Time
flags Input 
Search Flags
errors Output 
Error Array [optional]
$$GETPDX(encounter[,errors]) 
Returns the primary diagnosis for an encounter.
VARIABLES TYPE VARIABLES DESCRIPTION
$$GETPDX Output 
<pointer>  ien to ^ICD9 for primary dx 0          no
primary dx found for encounter
encounter Input 
Encounter IEN
errors Output 
Error Array [optional]
$$EXOE(dfn,begin_date,end_date[,flags][,errors]) 
Returns the first encounter for a patient in a date
range.
VARIABLES TYPE VARIABLES DESCRIPTION
$$EXOE Output 
<pointer>  Outpatient Encounter ID for first
encounter found in date range <null>     if no encounter exists
dfn Input 
Patient ID
begin_date Input 
Begin Date/Time
end_date Input 
End Date/Time
flags Input 
Search Flags
errors Output 
Error Array [optional]
$$GETLAST(dfn,begin_date[,flags][,errors]) 
Returns the last standalone add/edit encounter for a
patient from a specified begin date.
VARIABLES TYPE VARIABLES DESCRIPTION
$$GETLAST Output 
<pointer>  Outpatient Encounter ID for last
standalone encounter found
after date <null>     if no encounter exists
dfn Input 
Patient ID
begin_date Input 
Begin Date/Time
flags Input 
Search Flags
errors Output 
Error Array [optional]
GETGEN(encounter,encounter_data[,errors]) 
Returns the zeroth and other nodes of an outpatient
encounter entry.
VARIABLES TYPE VARIABLES DESCRIPTION
encounter Input 
Encounter IEN
encounter_data Output 
Encounter Data
errors Output 
Error Array [optional]
PARSE(.encounter_data,format,parsed_data[,errors]) 
Parses the data returned from the GETGEN supported
call.
VARIABLES TYPE VARIABLES DESCRIPTION
encounter_data Input 
Encounter Data
format Input 
Encounter Parse Format
parsed_data Output 
Encounter Parsed Data
errors Output 
Error Array [optional]
$$GETOE 
Returns the zeroth node of an Outpatient Encounter
record.