+---------------------------------------------------------------+ | | | 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.
.01display name(+)0;1FREE TEXTBA text description of the policy for display by configuration user interface.
2archive duration years(+)0;2NUMERICThe number of years from the duration trigger date that an artifact must be available.
3archive duration trigger(+)0;3SET OF CODESCD:Create Date
LAD:Last Accessed Date
DD:Deceased Date
The trigger event for initiating the countdown for archive duration.
4minimum archive copies(+)0;4NUMERICNumber of archive copies required by this retention policy.
5minimum offsite copies(+)0;5NUMERICNumber of offsite copies required by this retention policy.
6business key0;6FREE TEXTHolds 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.
7active(+)0;7SET OF CODES0:Inactive
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.

Referenced by 3 types

  1. ARTIFACT DESCRIPTOR (2006.915) -- retention policy
  2. ARTIFACT RETENTION POLICY (2006.921) -- retention policy
  3. RETENTION POLICY STORAGE PROVIDER MAP (2006.923) -- retention policy