AddUpdateParticipant
Description:
-
Creates a new LV_Participant SDI or finds an existing LV_Participant SDI and updates its column values.
Input Properties
studyid
Description:
-
Identifier of the Study in which to enroll the Participant.
Required:
-
Required if a Participant is to be added (mode is add or unknown) and studyalias and externalparticipantid are not provided. If a Participant is to be edited (mode is edit or unknown) this property is required if participantid, studyalias and externalparticipantid are not provided.
studycode
Description:
-
Unique alias identifier for the Study.
Required:
-
Required if a Participant is to be added (mode is add or unknown) and studyid and externalparticipantid are not provided. If a Participant is to be edited (mode is edit or unknown) this property is required if participantid, studyid and externalparticipantid are not provided.
siteid
Description:
-
Identifier of the Study Site in which to enroll the Participant.
Required:
-
Required if a Participant is to be added (mode is add or unknown) and sitename, departmentid and subjectid are not provided. If a Participant is to be edited (mode is edit or unknown) this property is required if participantid, sitename, departmentid and subjectid are not provided.
departmentid
Description:
-
Identifier of the Department associated with the Study Site in which to enroll the Participant. Used to determine the Site Id.
Required:
-
Required if a Participant is to be added (mode is add or unknown) and siteid, sitename and subjectid are not provided. If a Participant is to be edited (mode is edit or unknown) this property is required if participantid, siteid, sitename and subjectid are not provided.
sitename
Description:
-
Name of the Study Site in which to enroll the Participant. Used to determine the Site Id.
protocolrevision
Description:
-
Identifier of Protocol Revision to associate with the enrolling Participant. Defaults to the Protocol Revision of the Site.
Required:
-
No
cohortid
Description:
-
Identifier of the Protocol Cohort to associate with the enrolling Participant.
Required:
-
Required if a Participant is to be added (mode is add or unknown) and autopartenrollment is Yes.
participantid
Description:
-
Identifier of the Participant to update. Not to be used if a Participant is to be added.
Required:
-
No
externalparticipantid
Description:
-
Assigned externally by the Site to identify the Participant to enroll.
Required:
-
Required if a Participant is to be added (mode is add or unknown) and subjectid is not provided. If a Participant is to be edited (mode is edit or unknown) this property is required if participantid and subjectid are not provided.
subjectid
Description:
-
Identifier of the Subject to associate with the enrolling Participant.
Required:
-
Required if a Participant is to be added (mode is add or unknown) and the Auto Create Subject policy is No. If a Participant is to be edited (mode is edit or unknown) this property is required if participantid, siteid, sitename, departmentid and externalparticipantid are not provided.
autopartenrollment
Description:
-
A value of Yes (default) specifies that when a new Participant is created, its status will be set to Enrolled, otherwise the status will be Pending.
Required:
-
No
participantenrollmentdt
Description:
-
Date on which the Participant enrolled in the Study. Defaults to now if unknown.
mode
Description:
-
Operational mode of the Action (add, edit or unknown). Defaults to unknown.
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.
Output Properties
newparticipantid
Description:
-
Identifier of the newly added LV_Participant SDI or the modified LV_Participant SDI. If more than one SDI has been added or modified, this is a semicolon-delimited list.
Additional Information
Additional information concerning this Action:
-
When found or created, the Participant Id is returned.
When creating a new LV_Participant SDI, if the autopartenrollment property is Yes then the new Participant is automatically enrolled into the provided Study. Always returns the new or updated Participant Id(s).
This action has 3 different modes:
1. add - Creates a new Participant SDI if the Participant is not found in the Study, otherwise an error is thrown.
2. edit - Updates an existing Participant SDI. If the Participant is not found then an error is thrown.
3. unknown - If the Participant is not found a new Participant SDI is created, otherwise the Participant SDI is updated. (Default)
If a Subject Id is not provided for a new Participant, then one is created only if the BioBanking Auto Create Subject policy is set to Yes. Otherwise an error is thrown.
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 Participant.
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 Participant SDI.
All arguments are expressed to the same width, or a single value. Example:
externalparticipantid = p01;p02;p03
siteid = site01;site02;site03
studyid = Diabetes
autoparticipantenrollment = Yes
cohortid = c01;c02;c03
In the above example, studyid is expanded as if it was passed as Diabetes;Diabetes;Diabetes, and 3 participants are created for the study Diabetes.
This Action affects records in the LV_Participant, and LV_Subject SDC tables.
Copyright © 1999-2016 LABVANTAGE Solutions, Inc.