AddVisit
Description:
-
Creates a new LV_ParticipantEvent SDI of type Visit for the provided Participant.
Input Properties
participantid
Description:
-
Identifier of the Participant to which to add the new Visit Event.
Required:
-
Yes
eventlabel
Description:
-
Label of the Event in the Protocol to add.
Required:
-
Yes
eventdt
Description:
-
Date on which the specified Protocol Event occurred.
Required:
-
Required for recurring events
eventstatus
Description:
-
Status to be set for the new Event. Defaults to Completed.
Required:
-
No
visitedsite
Description:
-
Identifier of the Study Site which the Participant visited for the Visit Event.
Required:
-
No
visiteddepartment
Description:
-
Identifier of the Department associated with the Study Site which the Participant visited for the Visit Event. Used to determine the Visited Site Id.
Required:
-
No
visitedsitename
Description:
-
Name of the Study Site which the Participant visited for the Visit Event. Used to determine the Visited Site Id.
Required:
-
No
adhocevtflag
Description:
-
Y = specifies that the Event referred to in the eventlabel property may not be one currently defined for the Protocol, and if the Event cannot be found then a new ad-hoc Event should be created for the Participant.
N = (default) generates an error if the eventlabel is not found in the Protocol.
Required:
-
No
eventdefid
List of Event definition ids (identifiers of the Events defined in the Protocol).
Required:
-
No
Comments:
-
An Event is generated by the Action for the specified Event definition ids.
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
Output Properties
neweventid
Description:
-
Identifier of the newly added LV_ParticipantEvent SDI or the found LV_ParticipantEvent SDI. If more than one SDI has been added or found, this is a semicolon-delimited list.
Additional Information
Additional information concerning this Action:
-
If a matching Visit Event already exists for the Participant, and the Event definition does not allow multiple instances of the Event, then the existing Event Id is returned. When new Event SDIs are created then the new Event Ids are returned by the Action.
This action acts as a wrapper to the AddEvent Action.
This action is normally called from the RegisterProtocolSamp action, from the Participant List or Maintenance pages when new Adhoc Visits are created 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 a new Event for a 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 a LV_ParticipantEvent SDI.
All arguments are expressed to the same width, or a single value. Example:
participantid = p01
eventlabel = 1month;2month
eventdt = 4/6/2009
adhocevtflag = Yes
The action adds 2 visit events with labels 1month & 2month.
This Action affects records in the LV_ParticipantEvent SDC table.
Copyright © 1999-2025 LabVantage Solutions, Inc.