Print Page as PDF
Accept/Reject Insurance Buffer data APIs ICR (5353)

Accept/Reject Insurance Buffer data APIs    ICR (5353)

Name Value
NUMBER 5353
IA # 5353
DATE CREATED 2009/01/27
CUSTODIAL PACKAGE INTEGRATED BILLING
USAGE Private
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE UPDTICB
NAME Accept/Reject Insurance Buffer data APIs
GENERAL DESCRIPTION
This ICR provides APIs for the IB Insurance Application
which will suppress the Write Statements and Interactive Fileman calls for the
existing ACCEPT^IBCNBAR and REJECT^IBCNBAR logic. It includes logic to update
the Patient Insurance Type (2.312) sub file with a new Group Insurance Plan
and Insurance Company.

There is also an API (UPDTICB) which will allow for fields that are not stored
in the insurance buffer to be updated into the IB Insurance Files.

Update:  IB*2*528 increased the data length of the COMMENT-PATIENT POLICY
field (2.312, 1.08) from 80 characters to 250 characters; and therefore a new
DD definition COMMENT-SUSCRIBER POLICY (2.342) subfile was created to store
the increased length and the history of comments entered.   The UPDTICB
component (API) will be affected by this change.  All subscribers to this ICR
will need to make the necessary changes in their applications to reference the
new field. When all subscribers have implemented the use of the new fields,
the old fields will need to be deleted with a subsequent IB patch. Old and new
fields are noted at the UPDTICB component details.


STATUS Active
KEYWORDS
  • ACCEPAPI
  • IBCNICB
  • REJECAPI
  • UPDTICB
DURATION Till Otherwise Agreed
ID UPDTICB
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
ACCEPAPI()
API to be called by the Insurance Capture Buffer
(ICB) application to move buffer data to Insurance Files then cleanup. Usage
of this entry will suppress write statements and interactive fileman calls. In
addition to this, the follow are some difference that will only occur when
this API is used:

1. Allows a new insurance group to be updated into
an existing patient policy entry. If this is
done there is cleanup logic that will delete
obsolete Individual Plans, Repoint Insurance
Reviews if Insurance Company changes, and
Remove any Old Benefits Used.

2. The PAT^IBCNBMI will not be called

Entry point with parameters -

ACCEPAPI(RESULT,IBBUFDA,DFN,IBINSDA,IBGRPDA,IBPOLDA,IBMVINS,
IBMVGRP,IBMVPOL,IBNEWINS,IBNEWGRP,IBNEWPOL,IVMREPTR)
VARIABLES TYPE VARIABLES DESCRIPTION
RESULT Output
Returned Parameter Array with IENS of new entries
and/or errors/warnings.

RESULT(0) = -1 ^ error message
RESULT(0) =  0          -Move worked
RESULT(0) =  0 ^ warning message ^ warning message ^ warning message
^ warning message
- Move worked but there may be zero to 4
warning messages
RESULT(1) = "IBINSDA^" IEN of new Insurance Company (#36)
RESULT(1,"ERR",#) - Array with any FM errors when data updated from
file 355.33 to 36.

RESULT(2) = "IBGRPDA^" IEN of new GROUP INSURANCE PLAN (#355.3) File
RESULT(2,"ERR",#) - Array with any FM errors when data updated from
file 355.33 to 355.3.
RESULT(3) = "IBPOLDA^" IEN of new INSURANCE TYPE (#2.312) sub-file
of PATIENT (#2) IEN
RESULT(3,"ERR",#) - Array with any FM errors when data updated from
file 355.33 to 2.312.
RESULT(4) Contains the results of the call to UPDPOL^IBCNICB which is
used to update a new group into an existing patient policy
entry when applicable.
RESULT(4) =-1^error message
RESULT(4) =0 ^ message that process was successful or not required
IBBUFDA Input
INSURANCE BUFFER (#355.33) file internal entry number
(IEN). (Required)
DFN Input
PATIENT (#2) file IEN. (Required)
IBINSDA Input
INSURANCE COMPANY (#36) File IEN if not adding new
entry. (Optional)
IBGRPDA Input
GROUP INSURANCE PLAN (#355.3) File IEN if not adding
new entry. (Optional)
IBPOLDA Input
INSURANCE TYPE (#2.312) sub-file of PATIENT (#2) IEN
if not adding new entry. (Optional)
IBMVINS Input
Move Type for INSURANCE. (Required)
1=Merge, 2=Overwrite, 3=Replace
IBMVGRP Input
Move Type for GROUP. (Optional)
1=Merge, 2=Overwrite, 3=Replace
IBMVPOL Input
Move Type for POLICY. (Optional)
1=Merge, 2=Overwrite, 3=Replace
IBNEWINS Input
Add new INSURANCE COMPANY flag (non-zero means add).
IBNEWGRP Input
Add new GROUP INSURANCE PLAN flag (non-zero means
add).
IBNEWPOL Input
Add new patient insurance policy (non-zero means
add).
IVMREPTR Input
IVM REASONS FOR NOT UPLOADING (#301.91) File internal
entry number.  (Optional)
REJECAPI(RESULT,IBBUFDA,IVMREPTR)
API to be called by the Insurance Capture Buffer
(ICB) application to reject buffer entry. Usage of this entry will suppress
write statements and interactive fileman calls.
VARIABLES TYPE VARIABLES DESCRIPTION
IBBUFDA Input
INSURANCE BUFFER (#355.33) file internal entry
number. (required)
IVMREPTR Input
IVM REASONS FOR NOT UPLOADING (#301.91) File internal
entry number. (Optional)
RESULT Output
Returned parameter variable with errors messages if
problems with the reject processing. Format for array.

REJECT = -1 ^ error message
REJECT =  0                     - Reject worked
REJECT =  0 ^ warning message   - Reject process worked but there is a
warning message
UPDTICB()
The UPDTICB^IBCNICB API provides functionality to
update the following data elements:

Patient INSURANCE TYPE (#2.312) SUBFILE:
*COMMENT - PATIENT POLICY (#1.08) field
POLICY NOT BILLABLE (#3.04) field
Note:  IB*2*528 - COMMENT - PATIENT POLICY (1.08) replaced by
COMMENT-SUBSCRIBER POLICY (2.342).

COMMENT - SUBSCRIBER POLICY (#2.342) SUB-FILE:
COMMENT DATE/TIME (2.342,.01)
LAST EDITED BY (2.342,.02)
COMMENT (2.342,.03)


GROUP INSURANCE PLAN (#355.3) file:
PLAN FILING TIME FRAME (#.13) field
ELECTRONIC PLAN TYPE  (#.15) field
PLAN STANDARD FTF (#.16) field
PLAN STANDARD FTF VALUE (#.17) field
COMMENTS (#11) word-processing field

Entry point with parameters -

UPDTICB(RESULT,DFN,IBPOLDA,IBGRPDA,IBPOLCOM,IBPOLBIL,
IBPLAN,IBELEC,IBGPCOM,IBFTF,IBFTFVAL)


VARIABLES TYPE VARIABLES DESCRIPTION
DFN Input
PATIENT (#2) file Internal Entry Number.  (Required
if IBPOLCOM or IBPOLBIL variables passed)
IBPOLDA Input
INSURANCE TYPE (#2.312) sub-file of PATIENT (#2)
internal entry number.  (Required if IBPOLCOM or IBPOLBIL variables passed)
IBGRPDA Input
GROUP INSURANCE PLAN (#355.3) File internal entry
number (Required if IBPLAN, IBELEC, IBGPCOM, IBFTF, or IBFTFVAL variables
passed)
IBPOLCOM Input
Data to be filed into the *COMMENT - PATIENT POLICY
(#1.08) file of the 2.312 sub-file.  (Optional) Note:  IB*2*528 -patch will
implement the filing of the patient policy comment data and related fields
into the fields defined to the COMMENT-SUBSCRIBER POLICY multiple (2.342):
COMMENT DATE/TIME (2.342,.01)
LAST EDITED BY (2.342,.02)
COMMENT (2.342,.03)


IBPOLBIL Input
Data to be filed into the POLICY NOT BILLABLE (#3.04)
field of the 2.312 sub-file. (Optional)

Corresponds to the Internal codes in 3.04 field of 2.312 sub-file:
'0' FOR NO
'1' FOR YES
IBPLAN Input
Data to be filed in PLAN FILING TIME FRAME (#.13)
field of 355.3 file.  (Optional)
IBELEC Input
Data to be file in ELECTRONIC PLAN TYPE (#.15) field
of 355.3 file.  (Optional)

Corresponds to the Internal Codes in .15 field of 355.3 file:

'16' FOR HMO MEDICARE;
'MX' FOR MEDICARE A or B;
'TV' FOR TITLE V;
'MC' FOR MEDICAID;
'BL' FOR BC/BS;
'CH' FOR TRICARE;
'15' FOR INDEMNITY;
'CI' FOR COMMERCIAL;
'HM' FOR HMO;
'DS' FOR DISABILITY;
'12' FOR PPO;
'13' FOR POS;
'ZZ' FOR OTHER;
IBGPCOM Input
Group Plan Comment array that contains the word
processing data to be filed the COMMENTS (#11) word-processing field of  355.3
file. (Optional)

Example:
IBGPCOM(1)="This is line 1"
IBGPCOM(2)="This is line 2"
IBFTF Input
Data to be filed in the PLAN STANDARD FTF (#.16)
field of 355.3 file.  (Optional)

Corresponds to the Internal Entry Number of the entry in the INSURANCE FILING
TIME FRAME (#355.13) File.

1 - DAYS (Requires Plan Standard FTF Value)
2 - MONTH(S) (Requires FTF Value)
3 - YEAR(S) (Requires FTF Value)
4 - DAYS PLUS ONE YEAR (Requires FTF Value)
5 - DAYS OF FOLLOWING YEAR (Requires FTF Value)
6 - MONTHS OF FOLLOWING YEAR (Requires FTF Value)
7 - END OF FOLLOWING YEAR
8 - NO FILING TIME FRAME LIMIT
IBFTFVAL Input
Data to be filed in the PLAN STANDARD FTF VALUE
(#.17) field of 355.3 file (Optional - Calling application responsible to pass
value if required for Plan Standard FTF)
RESULT Output
RESULT   - Returned Parameter Array with results of
call
RESULT = 0 ^ No data to update
RESULT(1) = -1 ^ error with Insurance Type (#2.312) file update
RESULT(1) = 0                 - Insurance Type update worked
RESULT(2) = -1 ^ error with GROUP INSURANCE PLAN (#355.3) file update
RESULT(2) = 0                 - Group Insurance Plan update worked

SUBSCRIBING PACKAGE INSURANCE CAPTURE BUFFER
DATE ACTIVATED 2009/06/11