AddUpdProtocolSample
Description:
Creates and/or updates Sample and LV_SampleFamily SDIs
Input Properties
sampleid
Description:
Identifier of existing Sample to associate with a Sample Family.
Required:
Required if externalsampleid, and visitedsiteid are not provided.
externalsampleid
Description:
Externally assigned identifier of the Sample to create and associate with a Sample Family.
Required:
Required if sampleid is not provided. If no sampleid is provided then new Samples will be created and the externalsampleid value will become the Sample's external alias.
studyid
Description:
Identifier of the Study in which to register Samples.
Required:
No
studycode
Description:
Unique alias identifier for the Study. Used to determine the studyid.
Required:
No
visitedsiteid
Description:
Identifier of the Study Site which the Participant visited to collect the Samples.
Required:
Required if sampleid is not provided.
visiteddepartmentid
Description:
Identifier of the Department associated with the Study Site which the Participant visited to collect the Samples. Used to determine the Visited Site Id.
Required:
No
visitedsitename
Description:
Name of the Study Site which the Participant visited to collect the Samples. Used to determine the Visited Site Id.
Required:
No
participantid
Description:
Identifier of the Participant to associate with the registered Samples. Used to determine the External Participant Id as well as the visitedsiteid (if visitedsiteid, visitesitename and visiteddepartmentid are not provided) for the Participant to set in a new LV_SampleFamily SDI.
Required:
No
externalparticipantid
Description:
Assigned externally by the Enrolling Site to identify the Participant associated with the Samples. Used to determine the Participant Id, as well as set the External Subject in a new LV_SampleFamily SDI.
Required:
No
eventid
Description:
Identifier of the Event that created the Samples. Used to find relevant LV_SampleFamily SDIs to associate with the Samples as well as find the Participant Id associated with the Event if participantid and externalparticipantid are not provided.
Required:
No
eventlabel
Description:
Label of the Event in the Protocol to which the Samples are associated.
Required:
No
collectiondate
Description:
Date on which the registered Samples were collected and should be recorded with the Samples.
Required:
No
sampletypeid
Description:
Identifier of the Sample Type to assign to the registered Samples.
Required:
No
auditreason
Description:
Auditing information recorded in the "Reason" column of the TraceLog table.
Required:
No
auditactivity
Description:
Auditing information recorded in the "Activity" column of the TraceLog table.
Required:
No
auditsignedflag
Description:
Auditing information recorded in the "SignedFlag" column of the TraceLog table.
Required:
No
kitid
Description:
Identifier of the collection Kit used by the registered Samples. The Kit status will be updated to Used. This property is relevant only if the kittrackitemid is not provided.
Required:
No
kittrackitemid
Description:
Identifier of the TrackItem that is associated with the collection Kit used by the registered Samples. The Kit status will be updated to Used.
Required:
No
specimentype
Description:
Identifier of the Specimen Type (such as Container Type) to assign to the registered Samples.
Required:
No
restrictclassid
Description:
Identifier of the Study Restriction Class to assign to the LV_SampleFamily SDI. Must have an Active status otherwise an error is generated.
Required:
No
Output Properties
newsamplefamilyid
Description:
Identifier of the newly added LV_SampleFamily SDI or the modified LV_SampleFamily SDI. If more than one SDI has been added or modified, this is a semicolon-delimited list.
newsampleid
Description:
Identifier of the newly added Sample SDI or the modified Sample SDI. If more than one SDI has been added or modified, this is a semicolon-delimited list.
Additional Information
Additional information concerning this Action:
If no Sample SDI can be found in the database, either from matching the sampleid property or the externalsampleid, studyid and visitedsiteid properties, then a new Sample SDI is created using the provided property values. Otherwise the found Sample SDI is updated using the provided property values.

New Sample SDIs, will be linked to a newly created LV_SampleFamily SDI. When a LV_SampleFamily SDI is created, the provided properties are used to set the column values as well as link the LV_SampleFamily SDI to the specified Study, Subject (via Participant), Protocol and Restriction Class.

If Kit information is provided the Kit status is updated to Used and the Kit is associated with the LV_SampleFamily SDI.

This action is normally called from the RegisterProtocolSamp action or from Form processing when a completed Document is submitted. The RegisterProtocolSamp action is called during the processing of saving the TISM page when the newly received Samples are created. At this time the necessary Participants, Events and Sample Families are also created. This is when this action is called to create or update the Samples and Sample Families.

Similarly, when a completed Document of the appropriate type is submitted, the Form processing rules could be configured to call this action to create or update a Sample and Sample Family.

All arguments are expressed to the same width, or a single value. Example:
externalsampleid = s01;s02;s03
siteid = site01;site02;site03
studyid = Diabetes
sampletypeid = Blood
participanteventid = pe01
In this case studyid is expanded as if it was passed as Diabetes;Diabetes;Diabetes. Similarly sampletypeid and participanteventid is expanded. The action will create 3 samples.

This Action affects records in the Sample, LV_SampleFamily SDC tables and the SDIAlias table.

Copyright © 1999-2016 LABVANTAGE Solutions, Inc.