Print Page as PDF
DBIA4419 ICR (4419)

DBIA4419    ICR (4419)

Name Value
NUMBER 4419
IA # 4419
DATE CREATED 2004/05/07
CUSTODIAL PACKAGE INTEGRATED BILLING
CUSTODIAL ISC Albany
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE IBBAPI
NAME DBIA4419
GENERAL DESCRIPTION
IBBAPI is a new routine to return insurance data to
calling VistA applications.
STATUS Active
KEYWORDS
  • IBBAPI
  • insurance
DURATION Till Otherwise Agreed
ID IBBAPI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$INSUR(DFN,IBDT,IBSTAT,IBR,IBFLDS)
Return Patient Insurance Information
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
PATIENT IEN
IBDT Input
DATE INSURED (optional - default is today's date)
IBSTAT Input
INSURANCE STATUS FILTER (combinable based on groups
below)
Group 1
A = Inactive included (Default is active only)
Group 2
R = Not reimbursable included (Default is reimbursable only)
B = Indemnity included (Default is not included)
Group 3
P = Prescription coverage required (Default is all coverages)
(Note: "E" and "P" are mutually exclusive)
O = Outpatient coverage required (Default is all coverages)
I = Inpatient coverage only (Default is all coverages)
E = ePharmacy billable insurance plans only (Default is all coverages)
(Note: "E" and "P" are mutually exclusive)
IBR Input
Array to return insurance information - passed by
reference
IBFLDS Input
List of fields to return (1-24) in a comma separated
list
1 = Insurance Company Name
2 = Insurance Company Street Address Line 1
3 = Insurance Company City
4 = Insurance Company State
5 = Insurance Company Zip
6 = Insurance Company Phone
7 = Coordination of Benefits
8 = Policy Name
9 = Policy Reimbursable?
10 = Policy Effective Date
11 = Policy Expiration Date
12 = Subscriber Relationship
13 = Subscriber Name
14 = Subscriber ID
15 = Pharmacy Coverage?
16 = Outpatient Coverage?
17 = Inpatient Coverage?
18 = Group Number
19 = Patient Relationship to Subscriber
20 = VA Advantage Plan Subscriber (future functionality)
21 = Plan Type
22 = Subscriber Sex
23 = Insurance Company Street Address Line 2
24 = Insurance Company Street Address Line 3
$$INSUR Output

-1 = error occurred (error message passed back in IBR("IBBAPI","INSUR",
"ERROR",x) where x is error number between 101 & 111
0 = No insurance found based on parameters
1 = Insurance found

If no insurance information is found, then the IBR("IBBAPI","INSUR",y) array
will not be generated.

If no errors occur, insurance is found, and IBR is passed by reference, IBR
will contain the insurance array requested in IBR("IBBAPI","INSUR",x,y) =
field y data where 'x' is an incremental insurance company count (starting
with 1) and 'y' is the field number requested.

If an error occurs, the extrinsic function will return -1 and the error codes
and messages will be returned in IBR("IBBAPI","INSUR","ERROR",error code) =
error message if IBR is passed by reference.
$$CIDC(DFN)
The API will evaluate both a CIDC switch and the
patient's insurance to determine if the CIDC questions should be asked.

The switch will have three internal values:
0 = Don't ask any patients
1 = Ask for patients only with active billable insurance
2 = Ask for all patients

See output for the two possible return values.
VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
PATIENT IEN
$$CIDC Output
Output is based on the patient's insurance and the
switch values:

1 = Ask CIDC questions for the specified patient
0 = Don't ask CIDC questions for the specified patient
DATE ACTIVATED 2010/08/25