Print Page as PDF
DBIA4396 ICR (4396)

DBIA4396    ICR (4396)

Name Value
NUMBER 4396
IA # 4396
DATE CREATED 2004/05/04
CUSTODIAL PACKAGE FEE BASIS
CUSTODIAL ISC Washington
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE FBUTL
NAME DBIA4396
GENERAL DESCRIPTION
FEE BASIS APIs.
STATUS Active
DURATION Till Otherwise Agreed
ID FBUTL
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$AUTHL(PATIENT,STATION_NUMBER,CUTOFF_DATE,ARRAY_NAME)
This extrinsic function returns authorization data
for a specified patient.  Authorizations that have been Austin Deleted will
not be returned. Format:
$$AUTHL^FBUTL(PATIENT,STATION_NUMBER,CUTOFF_DATE,ARRAY_NAME) Examples:
1. Retrieve authorizations for patient with DFN = 23456 in MYARRAY().
>W $$AUTHL^FBUTL(23456,,,"MYARRAY")
2
>ZW MYARRAY
MYARRAY(0)=2
MYARRAY(1,"FDT")=3011021
MYARRAY(1,"TDT")=3011030
MYARRAY(2,"FDT")=3000101
MYARRAY(2,"TDT")=3031231

2. An exception.
>W $$AUTHL^FBUTL()
-1^101^Patient DFN not specified.
>ZW FBAUTH
VARIABLES TYPE VARIABLES DESCRIPTION
PATIENT Input
(Required) Patient identifier,  internal entry number
of Patient (#2) file (i.e. DFN).
STATION_NUMBER Input
(Optional) If specified, the station number will be
used to select authorizations from the national Fee Replacement system.  Only
authorizations whose issuing station Starts With this parameter value will be
returned.  This parameter will not be evaluated until the API is modified to
obtain data from the fee replacement system.
CUTOFF_DATE Input
(Optional) Date in VA FileMan internal format.  If
specified, only authorizations whose To Date is equal to or after the cutoff
date will be returned.
ARRAY_NAME Input
(Optional) Name of output array, closed root. If not
specified then a default value of "FBAUTH" will be used.  The array will be
initialized by this API.  The array name must not be the same as variables
newed by this API (e.g. FBDFN, FBAR, FBC, FBDA, FBDT, FBICN, FBSN, FBY).
Examples of a valid array name: "FBAUTH", "DGAUTH(12)", "^TMP($J)", etc.
$$AUTHL Output
This function returns a string value
= count of authorizations in the output array
OR
= -1 ^ exception_number ^ exception_text
OUTPUT_ARRAY Output
If an exception did not occur, there will also be an
output array of authorization data subscripted by sequential canonic numbers
and a header node subscripted by 0.
array(0) = count of authorizations in the output array
array(#,"FDT") = authorization # From Date (internal format)
array(#,"TDT") = authorization # To Date (internal format)

Note that additional subscripts may be added in the future to provide more
authorization data. The calling application should kill the entire output
array so any added subscripts will be cleaned-up (e.g. K FBAUTH).
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC SUBSCRIBING DETAILS
SCHEDULING Albany
Scheduling has subscribed to the $$AUTHL component.
SPINAL CORD DYSFUNCTION
Added 11/28/2006