LS Clinical Subject Information Interface Service Operations

For a list of operations associated with this Web service, see the following table.

Name	Description
QueryById	This operation returns the subjects with status information for the specified Protocol Site Id in the "Id" tag.
QueryByExample	Used to query status for Subjects based on given filter criteria.
QueryPage	Used to query all the Subject status information in pages based on given filter criteria.

Request Message Description: Query ById

For a description of this request message, see the following table.

Name	Description	Type
PrimaryRowId	Required. Specify the Protocol Site RowId value for which the Protocol Site information should be returned.	Character data
UTCCanonical	This flag is N by default. If this flag is enabled (Y), then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel Object Manager format as determined by the value of the UTCCanonical flag.	Boolean

Request Message Description: QueryByExample

For a description of this request message, see the following table.

Node	Description	Type
ClinicalProtocolSite.PlannedSubjects	Count of the subjects for which the status tracking visit is completed.	Number
ClinicalProtocolSite.Amoung CurrencyCode	Amount currency code.	Character data
ClinicalProtocolSite.Amount Exchange	Amount exchange date.	Date
ClinicalProtocolSite.FirstSubject Enroll	First subject enrolled date.	Date
ClinicalProtocolSite.SiteRowId	Site row ID.	Character data
ClinicalProtocolSite.Initiation CompletedDate	Site initiation date.	Date
ClinicalProtocolSite.Investigator FirstName	Investigator’s first name.	Number
ClinicalProtocolSite.Investigator FirstName	Investigator last name.	Character data
ClinicalProtocolSite.LastSubject OffStudyDate	Last subject terminated date for the site.	Date
ClinicalProtocolSite.Primary InvestigatorId	ID of the primary investigator.	Character data
ClinicalProtocolSite.ProtocolId	Protocol ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolNumber SitesPlanned	Number of sites planned for the protocol.	Number
ClinicalProtocolSite.ProtocolNumber SubjectsPlanned	Number of subjects planned for the protocol.	Number
ClinicalProtocolSite.ProtocolSiteId	Protocol site ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region.	Character data
ClinicalProtocolSite.Region PlannedSites	Number of planned sites for the region.	Number
ClinicalProtocolSite.Region PlannedSubjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.Site AccountRowId	Site row ID.	Character data
ClinicalProtocolSite.Site AccountName	Site name.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Status.	Character data
ClinicalProtocolSite.TerminatedDate	Site termination date.	Date
ClinicalProtocolSite.TotalContract Amount	Total contract amount.	Number
ClinicalSubject.Searchspec	Search specification.	Character data
ClinicalSubject.Comments	Comments.	Character data
ClinicalSubject.EncounterDate	Date of birth.	Date
ClinicalSubject.EarlyTerminatedDate	Early terminated date.	Date
ClinicalSubject.EligibleFlag	Eligible flag.	Boolean
ClinicalSubject.EnrollmentId	Enrollment ID.	Character data
ClinicalSubject.SubjectRowId	Row ID of the subject.	Character data
ClinicalSubject.PrimaryInformed ConsentDate	Primary informed consent date for the subject.	Date
ClinicalSubject.ProtocolDeviation	Protocol deviation.	Boolean
ClinicalSubject.ProtocolNumber	Protocol number.	Character data
ClinicalSubject.ProtocolViolation	Protocol violation.	Boolean
ClinicalSubject.RandomizationId	Randomization ID.	Character data
ClinicalSubject.RandomizedDate	Randomized date.	Character data
ClinicalSubject.ScreenFailure Reason	Reason excluded.	Character data
ClinicalSubject.ScreenFailureDate	Screen failure date.	Date
ClinicalSubject.SubjectId	Subject initials.	Character data
ClinicalSubject.SubjectNumber	Subject number.	Character data
ClinicalSubject.WithdrawnDate	Withdrawn date.	Date
ClinicalSubject.WithdrawnReason	Withdrawn reason.	Character data
ClinicalSubject.Searchspec	Search specification.	Character data
ClinicalSubject_ClinicalSubject Status.Status	Subject status.	Character data
ClinicalSubject_ClinicalSubject Status.StatusComments	Status comments.	Character data
ClinicalSubject_ClinicalSubject Status.StatusDate	Status date.	Date
ClinicalSubject_ClinicalSubject Status.VisitType	Visit type.	Character data
ClinicalSubject_ClinicalSubject Status.Searchspec	Search specficification.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegionId	Status Region ID.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegion	Status Region.	Character data
ClinicalSubject_ClinicalSubject Status.StatusSiteId	Status Site Id.	Character data
ClinicalSubject_ClinicalSubject Status.StatusSiteNumber	Status Site Number.	Character data

Request Message Description: QueryPage

For a description of this request message, see the following table.

Node	Description	Type
UTCCanonical	This flag is N by default. If this flag is Y, then data from the Siebel application must be in UTC (Coordinated Universal Time) and canonical format. The data in UTC and canonical format is converted to Siebel object manager format as determined by the value of the UTCCanonical flag.	Boolean
SortSpec	Determines whether the sort order is ascending or descending. Valid values are ASC or DEC.	Character Data
StartRowNum	Determines the starting point for record retrieval. The 0-based index of the record within the record set.	Number
PageSize	The number of records to be returned for a component. The default page size is 10. Note that there is a server parameter that controls the maximum page size (MaximumPageSize). If the pagesize attribute is greater than the maximum pagesize defined in the server parameter, an error occurs.	Number
ClinicalProtocolSite.PlannedSubjects	Count of the subjects for which the status tracking visit is completed.	Number
ClinicalProtocolSite.AmountCurrencyCode	Amount currency code.	Character data
ClinicalProtocolSite.AmountExchange	Amount exchange date.	Date
ClinicalProtocolSite.FirstSubjectEnrolledDate	First subject enrolled date.	Date
ClinicalProtocolSite.SiteRowId	Site row ID.	Character data
ClinicalProtocolSite.InitiationCompletedDate	Site initiation date.	Date
ClinicalProtocolSite.InvestigatorFirstName	Investigator's first name.	Number
ClinicalProtocolSite.InvestigatorFirstName	Investigator last name.	Character data
ClinicalProtocolSite.LastSubjectOffStudyDate	Last subject terminated date for the site.	Date
ClinicalProtocolSite.PrimaryInvestigatorId	ID of the primary investigator.	Character data
ClinicalProtocolSite.ProtocolId	Protocol ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolNumberSitesPlanned	Number of sites planned for the protocol.	Number
ClinicalProtocolSite.ProtocolNumberSubjects Planned	Number of subjects planned for the protocol.	Number
ClinicalProtocolSite.ProtocolSiteId	Protocol site ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region.	Character data
ClinicalProtocolSite.RegionPlannedSites	Number of planned sites for the region.	Number
ClinicalProtocolSite.RegionPlannedSubjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.SiteAccountRowId	Site row ID.	Character data
ClinicalProtocolSite.SiteAccountName	Site name.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Status.	Character data
ClinicalProtocolSite.TerminatedDate	Site termination date.	Date
ClinicalProtocolSite.TotalContractAmount	Total contract amount.	Number
ClinicalSubject.Searchspec	Search specification.	Character data
ClinicalSubject.Comments	Comments.	Character data
ClinicalSubject.EncounterDate	Date of birth.	Date
ClinicalSubject.EarlyTerminatedDate	Early terminated date.	Date
ClinicalSubject.EligibleFlag	Eligible flag.	Boolean
ClinicalSubject.EnrollmentId	Enrollment ID.	Character data
ClinicalSubject.SubjectRowId	Row ID of the subject.	Character data
ClinicalSubject.PrimaryInformedConsentDate	Primary informed consent date for the subject.	Date
ClinicalSubject.ProtocolDeviation	Protocol deviation.	Boolean
ClinicalSubject.ProtocolNumber	Protocol number.	Character data
ClinicalSubject.ProtocolViolation	Protocol violation.	Boolean
ClinicalSubject.RandomizationId	Randomization ID.	Character data
ClinicalSubject.RandomizedDate	Randomized date.	Character data
ClinicalSubject.ScreenFailureReason	Reason excluded.	Character data
ClinicalSubject.ScreenFailureDate	Screen failure date.	Date
ClinicalSubject.SubjectId	Subject initials.	Character data
ClinicalSubject.SubjectNumber	Subject number.	Character data
ClinicalSubject.WithdrawnDate	Withdrawn date.	Date
ClinicalSubject.WithdrawnReason	Withdrawn reason.	Character data
ClinicalSubject.Searchspec	Search specification.	Character data
ClinicalSubject_ClinicalSubjectStatus.Status	Subject status.	Character data
ClinicalSubject_ClinicalSubjectStatus.Status Comments	Status comments.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusDate	Status date.	Date
ClinicalSubject_ClinicalSubjectStatus.VisitType	Visit type.	Character data
ClinicalSubject_ClinicalSubjectStatus.Searchspec	Search specficification.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegionId	Status Region Id.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegion	Status Region.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusSiteId	Status Site Id.	Character data
ClinicalSubject_ClinicalSubject Status.StatusSiteNumber	Status Site Number.	Character data

Response Message Description: All LS Clinical Subject Information Interface Service

For a description of this request message, see the following table.

Name	Description	Type
ClinicalProtocolSite.PlannedSubjects	Count of the subjects for which the status tracking visit is completed.	Number
ClinicalProtocolSite.AmountCurrencyCode	Amount currency code.	Character data
ClinicalProtocolSite.AmountExchange	Amount exchange date.	Date
ClinicalProtocolSite.FirstSubjectEnrolledDate	First subject enrolled date.	Date
ClinicalProtocolSite.InitiationCompletedDate	Site initiation date.	Date
ClinicalProtocolSite.InvestigatorFirstName	Investigator's first name.	Number
ClinicalProtocolSite.InvestigatorFirstName	Investigator last name.	Character data
ClinicalProtocolSite.LastSubjectOffStudyDate	Last subject terminated date for the site.	Date
ClinicalProtocolSite.PrimaryInvestigatorId	ID of the primary investigator.	Character data
ClinicalProtocolSite.ProtocolId	Protocol ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolSiteId	Protocol site ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region.	Character data
ClinicalProtocolSite.RegionPlannedSites	Number of planned sites for the region.	Number
ClinicalProtocolSite.RegionPlannedSubjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.SiteAccountRowId	Site row ID.	Character data
ClinicalProtocolSite.SiteAccountName	Site name.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Status.	Character data
ClinicalProtocolSite.TerminatedDate	Site termination date.	Date
ClinicalProtocolSite.TotalContractAmount	Total contract amount.	Number
ClinicalSubject.Comments	Comments.	Character data
ClinicalSubject.EncounterDate	Date of birth.	Date
ClinicalSubject.EarlyTerminatedDate	Early terminated date.	Date
ClinicalSubject.EarlyTerminationReason	Early termination Reason	Character data
ClinicalSubject.EligibleFlag	Eligible flag.	Boolean
ClinicalSubject.EnrollmentId	Enrollment ID.	Character data
ClinicalSubject.PrimaryInformedConsentDate	Primary informed consent date for the subject.	Date
ClinicalSubject.ProtocolDeviation	Protocol deviation.	Boolean
ClinicalSubject.ProtocolNumber	Protocol number.	Character data
ClinicalSubject.ProtocolViolation	Protocol violation.	Boolean
ClinicalSubject.RandomizationId	Randomization ID.	Character data
ClinicalSubject.RandomizedDate	Randomized date.	Character data
ClinicalSubject.ScreenFailureReason	Reason excluded.	Character data
ClinicalSubject.ScreenFailureDate	Screen failure date.	Date
ClinicalSubject.SubjectId	Subject initials.	Character data
ClinicalSubject.SubjectNumber	Subject number.	Character data
ClinicalSubject.WithdrawnDate	Withdrawn date.	Date
ClinicalSubject.WithdrawnReason	Withdrawn reason.	Character data
ClinicalSubject_ClinicalSubjectStatus.Status	Subject status.	Character data
ClinicalSubject_ClinicalSubject Status.StatusComments	Status comments.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusDate	Status date.	Date
ClinicalSubject_ClinicalSubjectStatus.VisitType	Visit type.	Character data
ClinicalSubject_ClinicalSubject Status.StatusRegionId	Status Region Id.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusRegion	Status Region.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusSiteId	Status Site Id.	Character data
ClinicalSubject_ClinicalSubject Status.StatusSiteNumber	Status Site Number.	Character data