STANDARD DATA DICTIONARY #350.6 -- IB ARCHIVE/PURGE LOG FILE 9/29/25 PAGE 1
STORED IN ^IBE(350.6, *** NO DATA STORED YET *** SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 2.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
This file will be used to track the archiving and purging operations of the following three data files used in billing:
#350 INTEGRATED BILLING ACTION
#351 CATEGORY C BILLING CLOCK
#399 BILL/CLAIMS
A log entry will be filed when an archival "search" is initiated for one of these files. Once the search end date is logged,
archiving will be permitted, and subsequently purging will be allowed when the archive end date is logged. The log entry is thus
used to assure that all the necessary steps for archiving and purging are performed in their entirety in the correct order.
Per VHA Directive 10-93-142, this file definition should not be modified.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
IDENTIFIED BY: ARCHIVE FILE (#.03), LOG STATUS (#.05), SEARCH BEGIN DATE/TIME (#1.01)
CROSS
REFERENCED BY: ARCHIVE FILE(AF), SEARCH BEGIN DATE/TIME(AF1), ARCHIVE LOG #(B), SEARCH TEMPLATE(C), ARCHIVE FILE(D),
LOG STATUS(E)
350.6,.01 ARCHIVE LOG # 0;1 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>999999999999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: APR 08, 1992
HELP-PROMPT: Type a Number between 1 and 999999999999999, 0 Decimal Digits
DESCRIPTION: The Log # number is used to identify a unique archive/purge operation for a single file. The
number will be equal to the internal entry number of the Log entry.
CROSS-REFERENCE: 350.6^B
1)= S ^IBE(350.6,"B",$E(X,1,30),DA)=""
2)= K ^IBE(350.6,"B",$E(X,1,30),DA)
350.6,.02 SEARCH TEMPLATE 0;2 FREE TEXT
INPUT TRANSFORM: K:X[""""!($A(X)=45) X I $D(X) K:$L(X)>33!($L(X)<6) X
LAST EDITED: APR 08, 1992
HELP-PROMPT: Answer must be 6-33 characters in length.
DESCRIPTION: This field contains the name of the Search Template used to contain the list of entries to be
archived/purged. This name is the .01 field for the template entry in the SORT TEMPLATE file
(#.401). The name of the template is stored instead of a hard pointer to the SORT TEMPLATE file
because the template is deleted from the file after the entries have been purged. The name of the
template is the string "IB ARCHIVE/PURGE #" concatenated with the Archive Log # (field .01).
CROSS-REFERENCE: 350.6^C
1)= S ^IBE(350.6,"C",$E(X,1,30),DA)=""
2)= K ^IBE(350.6,"C",$E(X,1,30),DA)
350.6,.03 ARCHIVE FILE 0;3 POINTER TO FILE FILE (#1)
LAST EDITED: APR 08, 1992
DESCRIPTION: This field points to the FILE file (#1) and represents the file to be archived/purged. The Billing
data files subject to archiving/purging currently are:
350 INTEGRATED BILLING ACTION
351 CATEGORY C BILLING CLOCK
399 BILL/CLAIMS
CROSS-REFERENCE: 350.6^D
1)= S ^IBE(350.6,"D",$E(X,1,30),DA)=""
2)= K ^IBE(350.6,"D",$E(X,1,30),DA)
CROSS-REFERENCE: 350.6^AF^MUMPS
1)= I $D(^IBE(350.6,DA,1)),^(1) S ^IBE(350.6,"AF",X,-^(1),DA)=""
2)= I $D(^IBE(350.6,DA,1)),^(1) K ^IBE(350.6,"AF",X,-^(1),DA)
Cross-reference of all ARCHIVE/PURGE LOG entries (by Archive file [#.03] and the inverse Search
Begin Date/Time [#1.01]) for which a search has been initiated. The cross-reference will be used
to find the most recent log entry for a file. The "AF1" cross-reference on the Search Begin
Date/Time field (#1.01) is the companion to this cross-reference.
350.6,.04 # RECORDS ARCHIVED 0;4 NUMBER
INPUT TRANSFORM: K:+X'=X!(X>999999999999999)!(X<1)!(X?.E1"."1N.N) X
LAST EDITED: APR 08, 1992
HELP-PROMPT: Type a Number between 1 and 999999999999999, 0 Decimal Digits
DESCRIPTION: This field will contain the number of entries which have been processed in each sequential
archive/purge operation. The 'Search' option will update the field with the number of entries
which have met the search criteria. The 'Archive' option will update this field with the number of
entries archived. The 'Purge' option will update the field with the number of entries purged.
Also, the 'Delete Entry From Search Template' option will update the field when entries from the
template are deleted.
350.6,.05 LOG STATUS 0;5 SET
'1' FOR OPEN;
'2' FOR CLOSED;
'3' FOR CANCELLED;
LAST EDITED: APR 08, 1992
DESCRIPTION: This field contains the current status of the archive/purge operation. The status will be OPEN
when the log entry is created, and CLOSED after successfully purging archived entries. The entry
will be CANCELLED if an error is detected during processing which invalidates the operation.
CROSS-REFERENCE: 350.6^E
1)= S ^IBE(350.6,"E",$E(X,1,30),DA)=""
2)= K ^IBE(350.6,"E",$E(X,1,30),DA)
350.6,1.01 SEARCH BEGIN DATE/TIME 1;1 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUN 10, 2004
DESCRIPTION: The date/time at which the search was initiated is automatically stuffed into this field by the
'Search' option.
CROSS-REFERENCE: ^^TRIGGER^350.6^1.03
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^IBE(350.6,D0,1)):^(1),1:"") S X=$P(Y(1),U,3),X=X S
DIU=X K Y S X=DIV S X=DUZ S DIH=$G(^IBE(350.6,DIV(0),1)),DIV=X S $P(^(1),U,3)=DIV,DIH=350.6,DIG=1.0
3 D ^DICR
2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^IBE(350.6,D0,1)):^(1),1:"") S X=$P(Y(1),U,3),X=X S
DIU=X K Y S X="" S DIH=$G(^IBE(350.6,DIV(0),1)),DIV=X S $P(^(1),U,3)=DIV,DIH=350.6,DIG=1.03 D ^DICR
CREATE VALUE)= S X=DUZ
DELETE VALUE)= @
FIELD)= SEARCH INITIATOR
CROSS-REFERENCE: 350.6^AF1^MUMPS
1)= I $D(^IBE(350.6,DA,0)),$P(^(0),"^",3) S ^IBE(350.6,"AF",$P(^(0),"^",3),-X,DA)=""
2)= I $D(^IBE(350.6,DA,0)),$P(^(0),"^",3) K ^IBE(350.6,"AF",$P(^(0),"^",3),-X,DA)
Cross-reference of all ARCHIVE/PURGE LOG entries (by Archive file [#.03] and the inverse Search
Begin Date/Time [#1.01]) for which a search has been initiated. The cross-reference will be used
to find the most recent log entry for a file. The "AF" cross-reference on the Archive File field
(#.03) is the companion to this cross-reference.
350.6,1.02 SEARCH END DATE/TIME 1;2 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
DESCRIPTION: The date/time at which the search was completed is automatically stuffed into this field by the
'Search' option. The existence of this field in the log entry assures that the search on the file
was successful, and thus the field is used as the flag to allow archiving.
350.6,1.03 SEARCH INITIATOR 1;3 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: APR 08, 1992
DESCRIPTION: This field conatins the individual who queued the search on the file. The field is updated by a
trigger when the SEARCH BEGIN DATE/TIME field is updated.
NOTES: TRIGGERED by the SEARCH BEGIN DATE/TIME field of the IB ARCHIVE/PURGE LOG File
350.6,2.01 ARCHIVE BEGIN DATE/TIME 2;1 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUN 10, 2004
DESCRIPTION: The date/time that the archiving of data is initiated is automatically stuffed into this field by
the 'Archive' option.
CROSS-REFERENCE: ^^TRIGGER^350.6^2.03
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^IBE(350.6,D0,2)):^(2),1:"") S X=$P(Y(1),U,3),X=X S
DIU=X K Y S X=DIV S X=DUZ S DIH=$G(^IBE(350.6,DIV(0),2)),DIV=X S $P(^(2),U,3)=DIV,DIH=350.6,DIG=2.0
3 D ^DICR
2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^IBE(350.6,D0,2)):^(2),1:"") S X=$P(Y(1),U,3),X=X S
DIU=X K Y S X="" S DIH=$G(^IBE(350.6,DIV(0),2)),DIV=X S $P(^(2),U,3)=DIV,DIH=350.6,DIG=2.03 D ^DICR
CREATE VALUE)= S X=DUZ
DELETE VALUE)= @
FIELD)= #2.03
350.6,2.02 ARCHIVE END DATE/TIME 2;2 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
DESCRIPTION: The date/time that the archiving of data was completed is automatically stuffed into this field by
the 'Archive' option. The existence of this field in the log entry assures that archiving was
successful, and thus the field is used as a flag to allow purging.
350.6,2.03 ARCHIVE INITIATOR 2;3 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: APR 08, 1992
DESCRIPTION: This field contains the individual who archived the file. The field is updated by a trigger when
the ARCHIVE BEGIN DATE/TIME field is updated.
NOTES: TRIGGERED by the ARCHIVE BEGIN DATE/TIME field of the IB ARCHIVE/PURGE LOG File
350.6,3.01 PURGE BEGIN DATE/TIME 3;1 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
LAST EDITED: JUN 10, 2004
DESCRIPTION: The date/time that purging is initiated is automatically stuffed into this field by the 'Purge'
option.
CROSS-REFERENCE: ^^TRIGGER^350.6^3.03
1)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^IBE(350.6,D0,3)):^(3),1:"") S X=$P(Y(1),U,3),X=X S
DIU=X K Y S X=DIV S X=DUZ S DIH=$G(^IBE(350.6,DIV(0),3)),DIV=X S $P(^(3),U,3)=DIV,DIH=350.6,DIG=3.0
3 D ^DICR
2)= K DIV S DIV=X,D0=DA,DIV(0)=D0 S Y(1)=$S($D(^IBE(350.6,D0,3)):^(3),1:"") S X=$P(Y(1),U,3),X=X S
DIU=X K Y S X="" S DIH=$G(^IBE(350.6,DIV(0),3)),DIV=X S $P(^(3),U,3)=DIV,DIH=350.6,DIG=3.03 D ^DICR
CREATE VALUE)= S X=DUZ
DELETE VALUE)= @
FIELD)= #3.03
350.6,3.02 PURGE END DATE/TIME 3;2 DATE
INPUT TRANSFORM: S %DT="ESTXR" D ^%DT S X=Y K:Y<1 X
DESCRIPTION: The date/time that the purging of data was completed is automatically stuffed into this field by
the 'Purge' option. When this field is updated the status of the log entry is updated to CLOSED.
350.6,3.03 PURGE INITIATOR 3;3 POINTER TO NEW PERSON FILE (#200)
LAST EDITED: APR 08, 1992
DESCRIPTION: This field contains the individual who purged the file. The field is updated by a trigger when the
PURGE BEGIN DATE/TIME field is updated.
NOTES: TRIGGERED by the PURGE BEGIN DATE/TIME field of the IB ARCHIVE/PURGE LOG File
FILES POINTED TO FIELDS
FILE (#1) ARCHIVE FILE (#.03)
NEW PERSON (#200) SEARCH INITIATOR (#1.03)
ARCHIVE INITIATOR (#2.03)
PURGE INITIATOR (#3.03)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
IB PURGE LIST LOG ENTRIES APR 23, 1992@14:08 USER #10865 INTEGRATED BILLING ARCHIVE/PURGE LOG ENTRIES
Integrated Billing Archive/Purge Log List.
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):