STANDARD DATA DICTIONARY #2006.914 -- RETENTION POLICY FILE 3/24/25 PAGE 1
STORED IN ^MAGV(2006.914, (1 ENTRY) SITE: WWW.BMIRWIN.COM UCI: VISTA,VISTA (VERSION 3.0)
DATA NAME GLOBAL DATA
ELEMENT TITLE LOCATION TYPE
-----------------------------------------------------------------------------------------------------------------------------------
+---------------------------------------------------------------+
| |
| Property of the US Government. |
| No permission to copy or redistribute this software is given. |
| Use of unreleased versions of this software requires the user |
| to execute a written test agreement with the VistA Imaging |
| Development Office of the Department of Veterans Affairs, |
| telephone (301) 734-0100. |
| |
| The Food and Drug Administration classifies this software as |
| a medical device. As such, it may not be changed in any way. |
| Modifications to this software may result in an adulterated |
| medical device under 21CFR820, the use of which is considered |
| to be a violation of US Federal Statutes. |
| |
+---------------------------------------------------------------+
This file holds the various retention policies available to the storage subsystem. They come in two varieties: user-definable, and
business.
User-definable retention policies can be created and mapped to artifact descriptors, to serve as intrinsic retention policies. They
can be inactivated, or "logically deleted", but only if no artifact descriptors are pointing to them. They can never be physically
deleted, since there are artifacts that still point to the old retention policies, and we need to keep the historical record of
retention policies that have been applied to this artifact over time.
Business retention policies are designed to be called by business code for certain patients (e.g., Agent Orange retention policy,
Employee retention policy, etc.). These retention policies will be installed with the patch and can be "replaced" with updated
versions, but not deleted, since business logic will presumably expect to find them.
DD ACCESS: @
RD ACCESS: @
WR ACCESS: @
DEL ACCESS: @
LAYGO ACCESS: @
AUDIT ACCESS: @
POINTED TO BY: RETENTION POLICY field (#.01) of the ARTIFACT DESCRIPTOR File (#2006.915)
RETENTION POLICY field (#2) of the ARTIFACT RETENTION POLICY File (#2006.921)
RETENTION POLICY field (#.01) of the RETENTION POLICY STORAGE PROVIDER MAP File (#2006.923)
CROSS
REFERENCED BY: DISPLAY NAME(B)
INDEXED BY: BUSINESS KEY & ACTIVE (BKEYACT)
2006.914,.01 DISPLAY NAME 0;1 FREE TEXT (Required)
INPUT TRANSFORM: K:$L(X)>64!($L(X)<1)!'(X'?1P.E) X
LAST EDITED: MAR 08, 2010
HELP-PROMPT: Answer must be 1-64 characters in length.
DESCRIPTION:
A text description of the policy for display by configuration user interface.
TECHNICAL DESCR:
Added in patch MAG*3.0*34
CROSS-REFERENCE: 2006.914^B
1)= S ^MAGV(2006.914,"B",$E(X,1,64),DA)=""
2)= K ^MAGV(2006.914,"B",$E(X,1,64),DA)
2006.914,2 ARCHIVE DURATION YEARS 0;2 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>999)!(X<0)!(X?.E1"."1N.N) X
LAST EDITED: APR 08, 2010
HELP-PROMPT: Type a Number between 0 and 999, 0 Decimal Digits.
DESCRIPTION:
The number of years from the duration trigger date that an artifact must be available.
TECHNICAL DESCR:
Added in patch MAG*3.0*34
2006.914,3 ARCHIVE DURATION TRIGGER 0;3 SET (Required)
'CD' FOR Create Date;
'LAD' FOR Last Accessed Date;
'DD' FOR Deceased Date;
LAST EDITED: MAR 12, 2010
HELP-PROMPT: Enter Archive Duration Trigger.
DESCRIPTION:
The trigger event for initiating the countdown for archive duration.
TECHNICAL DESCR:
Added in patch MAG*3.0*34
2006.914,4 MINIMUM ARCHIVE COPIES 0;4 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<0)!(X?.E1"."1.N) X
LAST EDITED: MAY 12, 2010
HELP-PROMPT: Type a number between 0 and 99, 0 Decimal Digits.
DESCRIPTION:
Number of archive copies required by this retention policy.
TECHNICAL DESCR:
Added in patch MAG*3.0*34
2006.914,5 MINIMUM OFFSITE COPIES 0;5 NUMBER (Required)
INPUT TRANSFORM: K:+X'=X!(X>99)!(X<0)!(X?.E1"."1.N) X
LAST EDITED: MAY 12, 2010
HELP-PROMPT: Type a number between 0 and 99, 0 Decimal Digits.
DESCRIPTION:
Number of offsite copies required by this retention policy.
TECHNICAL DESCR:
Added in patch MAG*3.0*34
2006.914,6 BUSINESS KEY 0;6 FREE TEXT
INPUT TRANSFORM: K:$L(X)>64!($L(X)<1) X
LAST EDITED: MAY 13, 2010
HELP-PROMPT: Answer must be 1-64 characters in length.
DESCRIPTION: Holds a key that can be used by clients to look up retention policies for specific business
scenarios, e.g. Agent Orange cases, employees, etc.
Business Key is not unique across all records, but must be unique among active records. In other
words, you could have deactivated versions of old business keys (if already-captured artifacts are
grandfathered in on the old policy), and a new, active record with the same key, so that newly
acquired records follow the new policy.
TECHNICAL DESCR:
Added in patch MAG*3.0*34
RECORD INDEXES: BKEYACT (#1109)
2006.914,7 ACTIVE 0;7 SET (Required)
'0' FOR Inactive;
'1' FOR Active;
LAST EDITED: AUG 04, 2011
HELP-PROMPT: Select retention policy status.
DESCRIPTION: Since many artifacts may be linked to a retention policy, it is not safe to delete records.
However, the policy can be deactivated by setting this flag to false ("0"), so that it won't be
assigned to newly acquired artifacts.
TECHNICAL DESCR:
Added in patch MAG*3.0*34
RECORD INDEXES: BKEYACT (#1109)
File #2006.914
Record Indexes:
BKEYACT (#1109) RECORD REGULAR IR LOOKUP & SORTING
Short Descr: To enforce the rule that only one business key could be active.
Set Logic: S ^MAGV(2006.914,"BKEYACT",X(1),DA)=""
Set Cond: S X=(X(2)=1)
Kill Logic: K ^MAGV(2006.914,"BKEYACT",X(1),DA)
Whole Kill: K ^MAGV(2006.914,"BKEYACT")
X(1): BUSINESS KEY (2006.914,6) (Subscr 1) (forwards)
X(2): ACTIVE (2006.914,7) (forwards)
INPUT TEMPLATE(S):
PRINT TEMPLATE(S):
SORT TEMPLATE(S):
FORM(S)/BLOCK(S):