Siebel Innovation Pack 2016: LS Clinical Subject Information Interface Service

Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >

LS Clinical Subject Information Interface Service

Use this generic ASI-based Web service to to pull all the subject statuses in a given date range for the protocol, region, or site. An external application invokes this Web service with details such as Protocol Id, Protocol Title, Protocol Number, Protocol Site Id, Region, and so on. No error message is returned in cases where the Web service search criteria fails to return the required subject information.

LS Clinical Subject Information Interface Service Operations

For a list of operations associated with this Web service, see Table 357.

Table 349. LS Clinical Subject Information Interface Service Operations
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: QueryById

For a description of this request message, see Table 358.

Table 350. Request Message Description: QueryById
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 Table 351.

Table 351. Request Message Description: QueryByExample
Node	Description	Type
ClinicalProtocolSite. PlannedSubjects	Count of the subjects for which the status tracking visit is completed.	Number
ClinicalProtocolSite. AmoungCurrencyCode	Amount currency code.	Character data
ClinicalProtocolSite. AmountExchange	Amount exchange date.	Date
ClinicalProtocolSite. FirstSubjectEnroll	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. ProtocolNumberSites Planned	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.Site AccountRowId	Site row ID.	Character data
ClinicalProtocolSite.Site AccountName	Site name.	Character data
ClinicalProtocolSite.Site Number	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.Screen FailureReason	Reason excluded.	Character data
ClinicalSubject.Screen FailureDate	Screen failure date.	Date
ClinicalSubject.SubjectId	Subject initials.	Character data
ClinicalSubject.Subject Number	Subject number.	Character data
ClinicalSubject.WithdrawnDate	Withdrawn date.	Date
ClinicalSubject.WithdrawnReason	Withdrawn reason.	Character data
ClinicalSubject. Searchspec	Search specification.	Character data
ClinicalSubject_Clinical SubjectStatus.Status	Subject status.	Character data
ClinicalSubject_Clinical SubjectStatus.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_ ClinicalSubjectStatus. StatusRegionId	Status Region ID.	Character data
ClinicalSubject_ ClinicalSubjectStatus. StatusRegion	Status Region.	Character data
ClinicalSubject_ ClinicalSubjectStatus. StatusSiteId	Status Site Id.	Character data
ClinicalSubject_ ClinicalSubjectStatus. StatusSiteNumber	Status Site Number.	Character data

Request Message Description: QueryPage

For a description of this request message, see Table 358.

Table 352. Request Message Description: QueryPage
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.ProtocolNumberSubjectsPlanned	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.StatusComments	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_ClinicalSubjectStatus.StatusRegionId	Status Region Id.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusRegion	Status Region.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusSiteId	Status Site Id.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusSiteNumber	Status Site Number.	Character data

Response Message Description: All LS Clinical Subject Information Interface Service

For a description of this request message, see Table 353.

Table 353. Response Message Description: All LS Clinical Subject Information Interface Service
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_ClinicalSubjectStatus.StatusComments	Status comments.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusDate	Status date.	Date
ClinicalSubject_ClinicalSubjectStatus.VisitType	Visit type.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusRegionId	Status Region Id.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusRegion	Status Region.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusSiteId	Status Site Id.	Character data
ClinicalSubject_ClinicalSubjectStatus.StatusSiteNumber	Status Site Number.	Character data

LS Clinical Subject Information Interface Service Application Interface

This topic describes the application objects called by this Web service. For more information on application implementation, refer to your application development documentation on Oracle Technology Network.

Service Object (Business Service or Workflow)

For a description of the service objects for this Web service, see Table 366

Table 354. LS Clinical Protocol Site Interface Service Service Object
Name	Boundary Object Type	Class
LS Clinical Subject Information Interface Service	LS Clinical Subject Information Interface Service	CSSEAIDataSyncService

Data Object (Integration Object)

For a description of the data objects for this Web service, see Table 367.

Table 355. LS Clinical Protocol Site Interface Service Data Object
Siebel Repository Name	External Name
LS Clinical Subject Information Interface Service	Clinical Protocol Site

Methods

For a description of the methods for this Web service, see Table 340.

Table 356. LS Clinical Subject Information Interface Service Methods
Operation	Method
LSClinicalSubjectInformationInterfaceServiceQueryByExample	QueryByExample
LSClinicalSubjectInformationInterfaceServiceQueryById	QueryById
LSClinicalSubjectInformationInterfaceServiceQueryPage	QueryPage

Example Package for LS Clinical Subject Information Interface Service

To view an example of messages for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

Request

See the following file to view the sample code:

...\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Subject_Information_Interface_Service-QueryByExample-request.xml

...\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Subject_Information_Interface_Service-QueryById-request.xml

...\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Subject_Information_Interface_Service-QueryPage-request.xml

Response

See the following file to view the sample code:

...\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Protocol_Site_Interface_Service-response.xml

Interface Description (WSDL) for LS Clinical Subject Information Interface Service

To view the interface description for this Web service, navigate to the documentation library for Siebel Business Applications on Oracle Technology Network, and click the Related Files link next to the link for Siebel CRM Web Services Reference to access a zip file. Extract the files in the zip file.

...\LSClinical_Subject_Information_Interface_Service\LS_Clinical_Subject_Information_Interface_Service-QueryByExample.WSDL

Siebel CRM Web Services Reference		Copyright © 2016, Oracle and/or its affiliates. All rights reserved. Legal Notices.