ApproveBiobankSample
Description:
-
Applies Study-specific Approval rules to Samples and, if the Samples pass Approval, updates the Approval fields and Sample storage status.
Input Properties
sampleid
Description:
-
Identifier of the Sample SDI to approve. If more than one Sample is to be approved, this is a semicolon-delimited list.
Required:
-
Yes
approvaltype
Description:
-
Type of approval to perform on the Sample. Possible values are 'Full' (default), 'Conditional', or 'Verification'. See the next 3 properties.
Required
raiseerror
Description:
-
By default, this Action never raises an error. Set this to Y to raise errors.
Required:
-
No
Additional Information
Additional information concerning this Action:
-
Each Study can specify which of the BioBanking Policy defined rules are required for Sample approval and conditional approval. Only those rules specified by the Study are applied to Samples in the Study. When a Sample passes approval, its storage status is updated to "In Circulation", unless the restriction class for the Sample specifies that additional verification is needed. In this case the Sample storage status is updated to "Verification Needed". If a Sample currently has a storage status of "Temporary In Lab", then upon approval its storage status is also updated to "In Circulation" (dependent on the restriction class in which case the storage status is updated to "Verification Needed"), but any child Samples that may have been created from the Sample also have their storage status updated to "In Circulation" (or "Verification Needed"). Depending on the approvaltype property, either the full approval or conditional approval fields will be updated for Samples that pass approval. If the approvaltype property is Verification, then this is equivalent to full approval with the storage status updated to "In Circulation". Verification can only be performed by the user specified in the Study to perform this operation. If no user or the wrong user tries to verify Samples an error is generated.
Copyright © 1999-2025 LabVantage Solutions, Inc.