COREFLS INTERFACE UPDATES ICR (4092)

Name

Value

NUMBER

4092

IA #

4092

DATE CREATED

2003/04/29

CUSTODIAL PACKAGE

FEE BASIS

USAGE

Private

TYPE

Routine

DBIC APPROVAL STATUS

APPROVED

ROUTINE

FBCSL01

NAME

COREFLS INTERFACE UPDATES

GENERAL DESCRIPTION

CSL will need to call several Fee Basis APIs for the
processing of authorization and payment documents and records.  Depending on
the HL7 message event, the respective API will be invoked by the subscribing
package (CSL) after receiving and processing the HL7 message exported to VistA
by CoreFLS.

STATUS

Retired

FBCSL01

COMPONENT/ENTRY POINT

COMPONENT DESCRIPTION

VARIABLES

$$POUPD(CSLMID)

Logic is an extrinsic function with a single argument
in the formal parameter list, which is a scalar variable.  The returned
argument represents whether or not processing was successful.

The function is invoked by the subscribing package after receipt and
processing of the PO Update message exported by CoreFLS.  The subscribing
package shall store CoreFLS PO update results at ^XTMP(CSLMID) where CSLMID is
equal to the name-spaced routine of the subscribing package and the numeric
VistA HL7 messag ID separated by a semi-colon (e.g., "CSLrtname;nnnnnnn").
The function shall be invoked by the SET or WRITE command as:
$$POUPD^FBCSL01(CSLMID).

VARIABLES

TYPE

VARIABLES DESCRIPTION

CSLMID

Input

A scalar variable that is equal to the name-spaced
routine of the subscribing package and the numeric VistA HL7 message ID
(assigned to the exported messasge) separated by a semi-colon.  example:
CSLMID = "CSLFBnn;123456789"

The structure of the temporary global array shall be built as:
^XTMP(CSLMID,0)=PurgeDate^CreateDate^descriptive message

where purge date shall be greater than 2 days but not more than 7 days.

^XTMP(CSLMID, field_subscipt) = data

The second subscript represented, as 'field_subscript' are literal values.
Data will be stored at the second subscript of the array.  The literal value
defined at the second subscript will represent the data value stored at that
node.  The second subscript literal values are listed as follows:
EVENT_CODE
VETERAN_NAME
VETERAN_SSN
VETERAN_ICN
AUTHORIZATION_ID
PO_NUMBER
PO_STATUS
TREATMENT_FROM_DATE
TREATMENT_TO_DATE
ESTIMATED_AMOUNT
ERROR_DESCRIPTION

$$POUPD

Output

1 == the transaction was processed successfully
0^error text  == the transaction received an exception and did not update
VistA.

$$GLUPD(CSLMID)

Logic is an extrinsic function with a single argument
in the formal parameter list, which is a scalar variable.  The returned
argument represents whether or not processing was successful.

The function shall be invoked by the subscribing package after receipt and
processing of the General Ledger(GL) Journal Entry(JE) Update message exported
by CoreFLS.  The subscribing package shall place CoreFLS GL JE update results
at ^XTMP(CSLMID) where CSLMID is equal to the name-spaced routine of the
subscribing package and the numeric VistA HL7 message ID separated by a
semi-colon (e.g., "CSLrtname;nnnnnnn"). The function shall be invoked by the
SET or WRITE command as: $$GLUPD^FBCSL01(CSLMID).

VARIABLES

TYPE

VARIABLES DESCRIPTION

CSLMID

Input

A scalar variable that is equal to the name-spaced
routine of the subscribing package and the numeric VistA HL7 message ID
(assigned to the exported message) separated by a semi-colon.  example: CSLMID
= "CSLFBnn;123456789"

The structure of the temporary global array shall be built as:
^XTMP(CSLMID,0)=PurgeDate^CreateDate^descriptive message

where Purge Date shall be greater than 2 days but not more than 7 days.

^XTMP(CSLMID, field_subscipt) = data

The second subscript represented, as 'field_subscript' are literal values.
Data will be stored at the second subscript of the array.  The literal value
defined at the second subscript will represent the data value stored at that
node.  The second subscript literal values are listed as follows:
EVENT_CODE
VETERAN_NAME
VETERAN_SSN
VETERAN_ICN
AUTHORIZATION_ID
JE_NAME
JE_STATUS
TREATMENT_FROM_DATE
TREATMENT_TO_DATE
ESTIMATED_AMOUNT
ERROR_DESCRIPTION

$$GLUPD

Output

1 == the transaction was processed successfully
0^error text  == the transaction received an exception and did not update
VistA.

$$APUPD(CSLMID)

Logic is an extrinsic function with a single argument
in the formal parameter list, which is a scalar variable.  The returned
argument represents whether or not processing was successful.

The function shall be invoked by the subscribing package after receipt and
processing of the the Invoice Creation Update message exported by CoreFLS.
The subscribing package shall place Invoice Creation results at ^XTMP(CSLMID)
where CSLMID is equal to the name-spaced routine of the subscribing package
and the numeric VistA HL7 message ID separated by a semi-colon (e.g.,
"CSLrtname;nnnnnnn"). The function shall be invoked by the SET or WRITE
command as: $$APUPD^FBCSL01(CSLMID).

VARIABLES

TYPE

VARIABLES DESCRIPTION

CSLMID

Input

A scalar variable that is equal to the name-spaced
routine of the subscribing package and the numeric VistA HL7 message ID
(assigned to the exported message) separated by a semi-colon.  example: CSLMID
= "CSLFBnn;123456789"

The structure of the temporary global array shall be built as:
^XTMP(CSLMID,0)=PurgeDate^CreateDate^descriptive message

where purge date shall be greater than 30 days but not more than 40 days.

^XTMP(CSLMID, field_subscipt) = data

The second subscript represented as 'field_subscript' are literal values.
Data will be stored at the second subscript of the array.  The literal value
defined at the second subscript will represent the data value stored at that
node.  The second subscript literal values are listed as follows:
EVENT_CODE
VETERAN_NAME
VETERAN_SSN
VETERAN_ICN
BATCH_ID
INVOICE_NUMBER
INVOICE_AMOUNT
INVOICE_STATUS
HOLD_REASON
HOLD_STATUS
ERROR_DESCRIPTION

$$APUPD

Output

1 == the transaction was processed successfully
0^error text  == the transaction received an exception and did not update
VistA.

$$CONF(CSLMID)

Logic is an extrinsic function with a single argument
in the formal parameter list, which is a scalar variable.  The returned
argument represents whether or not processing was successful.

The function shall be invoked by the subscribing package after receipt and
processing of the the payment confirmation/cancellation message exported by
CoreFLS.  The subscribing package shall place Confirmation/Cancellation
results at ^XTMP(CSLMID) where CSLMID is equal to the name-spaced routine of
the subscribing package and the numeric VistA HL7 message ID separated by a
semi-colon (e.g.,"CSLrtname;nnnnnnn"). The function shall be invoked by the
SET or WRITE command as: $$CONF^FBCSL01(CSLMID).

VARIABLES

TYPE

VARIABLES DESCRIPTION

CSLMID

Input

A scalar variable that is equal to the name-spaced
routine of the subscribing package and the numeric VistA HL7 message ID
(assigned to the exported message) separated by a semi-colon.  example:
CSLMID = "CSLFBnn;123456789"

The structure of the temporary global array shall be built as:
^XTMP(CSLMID,0)=PurgeDate^CreateDate^descriptive text

where Purge Date shall be greater than 30 days but not more than 40 days.

^XTMP(CSLMID, field_subscipt) = data

The second subscript represented as 'field_subscript' are literal values.
Data will be stored at the second subscript of the array.  The literal value
defined at the second subscript will represent the data value stored at that
node.  The second subscript literal values are listed as follows:
FEE_PROGRAM
ACTIVITY_CODE
INVOICE_STATUS
INVOICE_NO
LINE_NUM
LINE_AMT
CHECK_NO
CHECK_DATE
DISBURSED_AMT
INTEREST_AMT
CANCEL_DT
REASON_CODE
CANCEL_CODE
VETERAN_NAME
VETERAN_ID
VETERAN_ICN

$$CONF

Output

1 == the transaction was processed successfully
0^error text  == the transaction received an exception and did not update
VistA

SUBSCRIBING PACKAGE

SUBSCRIBING DETAILS

COMMUNICATIONS SERVICE LIBRARY

Fee Basis shall exchange data with the CoreFLS Oracle
database through an M Service Library.  The M Service Library is a collection
of M routines consisting of several APIs.  The collection of routines exists
in VistA as the COMMUNICATIONS SERVICE LIBRARY (CSL) package.