$TXT Created by CAREY,BILL at ANCH2D.FO-BAYPINES.MED.VA.GOV (KIDS) on Tuesday, 12/16/03 at 15:16 ============================================================================= Run Date: DEC 19, 2003 Designation: IB*2*256 Package : IB - INTEGRATED BILLING Priority: Mandatory Version : 2 SEQ #222 Status: Released Compliance Date: JAN 19, 2004 ============================================================================= Subject: IB INSURANCE API Category: - Routine Description: ============ This patch is to standardize existing VistA Integrated Billing calls. All direct IB touch points will be replaced with standard API's available to all VistA packages. This patch is introducing a new API call INSUR^IBBAPI that returns Insurance information. FUNCTIONAL DESCRIPTION: This INTEGRATED BILLING patch provides an API to allow for seamless transition from the current IB system to a different authoritative source for insurance information. Insurance Information is returned inside an array to be used by the calling package where applicable. Values sent include the Patient's DFN, the Insurance Active Date, Status filters, the array to retain the returned data, and a list of fields to return. DOCUMENTATION ================ The following documentation is available and includes information for this Integrated Billing API. IB_2_256RN.PDF - API Release Notes To download from the first available FTP server, use FTP location download.vista.med.va.gov Or any of the following may also be used to download directly from a particular FTP location. ALBANY ftp.fo-albany.med.va.gov HINES ftp.fo-hines.med.va.gov SALT LAKE ftp.fo-slc.med.va.gov The file is available in the SOFTWARE sub-directory. TECHNICAL DESCRIPTION: IBBAPI New routine with tag INSUR to return Insurance data to calling VistA application. The following parameters are used: DFN Patient's Internal Entry number. (Required) IBDT Date to check for active insurance. (Optional) If not specified, the current date is used. IBSTAT Status Filter, see below for valid values. (Optional) Status Filter Value Description A Active and Inactive insurance is included. Default is active insurance only. R Reimbursable and Non-reimbursable insurance included, default is reimbursable insurance policies only. P All insurance policies that have Prescription coverage. Default is all active insurance policies with any coverage. O All insurance policies that have Outpatient coverage. Default is all active insurance policies with any coverage. I All insurance policies that have Inpatient coverage. Default is all active insurance policies with any coverage. IBR If passed by reference, insurance information will be returned in this variable. (Optional) IBFLDS If passed, will specify which fields to be returned in IBR, field numbers separated by commas. If all fields are desired, then a "*" may be passed. See below for field values. ID FIELD NAME DATA TYPE FORMAT DESCRIPTION 1 INSURANCE CO NAME REFERENCE ID^name Name of Insurance Company 2 INSURANCE CO ST ADD TEXT Free Text Street address of Ins Co 3 INSURANCE CO CITY TEXT Free Text City of Ins Co 4 INSURANCE CO STATE REFERENCE ID^name State of the Ins Co 5 INSURANCE CO ZIP TEXT Free Text Zip of the Ins Co 6 INSURANCE CO PHONE TEXT Free Text Phone of the Ins Co 7 COORD OF BENEFITS NUM/TEXT ID^name Number and Name 8 POLICY NAME NUM/TEXT ID^name IEN and Name 9 POLICY REIMBURSE? NUM/TEXT ID^name Does the Ins. reimburse? 10 EFFECTIVE DATE DATE YYYMMDD Effective date of policy 11 EXPIRATION DATE DATE YYYMMDD Expiration date of policy 12 SUBCRIBER REL. NUM/TEXT ID^name Rel of patient to Sub 13 SUBSCIBER ID TEXT Free Text Subscriber's ID number 14 PHARMACY COV? NUM/TEXT ID^name If Ins. Covers medications 15 OUTPATIENT COV? NUM/TEXT ID^name If Ins. Covers Outpatient 16 INPATIENT COV? NUM/TEXT ID^name If Ins. Covers Inpatient Installation will take less than 5 minutes. ================ INSTALLATION INSTRUCTIONS ================= 1. LOAD TRANSPORT GLOBAL --------------------- Choose the PackMan message containing this patch and invoke the INSTALL/CHECK MESSAGE PackMan option. 2. DISABLE ROUTINE MAPPING (DSM for Open VMS sites only) ----------------------- Disable routine mapping on all systems for the routines listed in step 3 below. NOTE: If the routines included in this patch are not currently in your mapped routine set, please skip this step. 3. ROUTINES SENT WITH PATCH ------------------------ The following is a list of the routines included in this patch. The second line of each of these routines now looks like: ;;2.0;INTEGRATED BILLING;**[patch list]**;21-MAR-94 CHECK^XTSUMBLD results Routine Before Patch After Patch Patch List -------- ------------ ----------- ----------------- IBBAPI n/a 8305791 256 Total number of routines - 1 4. START UP KIDS ------------- Start up the Kernel Installation and Distribution System Menu [XPD MAIN]: Edits and Distribution ... Utilities ... Installation ... Select Kernel Installation & Distribution System Option:INStallation --- Load a Distribution Print Transport Global Compare Transport Global to Current System Verify Checksums in Transport Global Install Package(s) Restart Install of Package(s) Unload a Distribution Backup a Transport Global Select Installation Option: 5. Select Installation Option: -------------------------- NOTE: The following are OPTIONAL - (When prompted for the INSTALL NAME, enter IB*2.0*256): a. Backup a Transport Global - This option will create a backup message of any routines exported with this patch. It will not backup any other changes such as DD's or templates. b. Compare Transport Global to Current System - This option will allow you to view all changes that will be made when this patch is installed. It compares all components of this patch (routines, DD's, templates, etc.). c. Verify Checksums in Transport Global - This option will allow you to ensure the integrity of the routines that are in the transport global. 6. Select Installation Option: Install Package(s) ---------------------------------------------- **This is the step to start the installation of this KIDS patch: a. Choose the Install Package(s) option to start the patch install. b. When prompted "Want KIDS to INHIBIT LOGONs during the install? YES//" answer NO c. When prompted 'Want to DISABLE Scheduled Options, Menu Options, and Protocols? YES//' answer NO. 7. REBUILD MAPPED ROUTINE(S) (DSM for Open VMS sites only) ------------------------- Optional - Include the routines distributed with this patch in the mapped routine set. NOTE: This step is only necessary if you performed step 2 or if you wish to include the routines in your mapped set. Routine Information: ==================== Routine Name: - IBBAPI Routine Checksum: ============================================================================= User Information: Entered By : CAREY,WILLIAM Date Entered : DEC 04, 2003 Completed By: FRANK,GEOFF Date Completed: DEC 19, 2003 Released By : BOTTINI,STEVE Date Released : DEC 19, 2003 ============================================================================= Packman Mail Message: ===================== $END TXT