Siebel Innovation Pack 2017: LS Clinical CRF Tracking Interface Service

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

LS Clinical CRF Tracking Interface Service

Use this generic ASI-based Web service to query for Case Report Forms (CRFs) for a given Protocol, Region or Protocol 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 case the Web service search criteria fails to return CRF records.

LS Clinical CRF Tracking Interface Service Operations

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

Table 333. LS Clinical CRF Tracking Interface Service Operations
Name	Description
QueryById	Returns all Case Report Forms for a specified Protocol Site Id in the "Id" tag.
QueryByExample	Used to query Case Report Form records based on given filter criteria.
QueryPage	Used to query Case Report Form details in pages based on given filter criteria.

Request Message Description: QueryById

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

Table 334. Request Message Description: QueryById
Node	Description	Type
PrimaryRowId	Required. Specify the Protocol Site RowId value for which the CRF records should be returned.	String
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: QueryById

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

Table 335. Request Message Description: QueryById
Node	Description	Type
ClinicalProtocolSite.PlannedSubjects	Number of planned subjects for the site.	Number
ClinicalProtocolSite.AmountCurrencyCode	Current code of the site.	Currency
ClinicalProtocolSite.AmountExchangeDate	Exchange date for the amount at the site.	Date
ClinicalProtocolSite.FirstSubjectEnrolled Date	Date when the subject was first enrolled.	Date
ClinicalProtocolSite.SiteRowId	Protocol site row ID.	Character data
ClinicalProtocolSite.InitiationCompleted Date	Date when the site was initiated.	Date
ClinicalProtocolSite.InvestigatorFirstName	Principal investigator first name.	Character data
ClinicalProtocolSite.InvestigatorLastName	Principal investigator last name	Character data
ClinicalProtocolSite.LastSubjectOffStudy Date	Date when the last subject was terminated.	Date
ClinicalProtocolSite.PrimaryInvestigatorId	Primary investigator's row ID.	Character data
ClinicalProtocolSite.ProtocolId	Protocol row ID.	Character data
ClinicalProtocolSite.ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite.ProtocolSiteId	Protocol site row ID.	Character data
ClinicalProtocolSite.ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite.ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region name.	Character data
ClinicalProtocolSite.RegionPlannedSites	Number of planned sites for the region.	Number
ClinicalProtocolSite.RegionPlanned Subjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.SiteAccountRowId	Account row ID for the associated site.	Character data
ClinicalProtocolSite.SiteAccountName	Account name for the associated site.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Protocol site status.	Character data
ClinicalProtocolSite.TerminatedDate	Site terminated date.	Date
ClinicalProtocolSite.TotalContractAmount	Total contract amount rolled up for the site.	Currency
LsCrfTrackingBc.NumberofPages	Total number of pages for the CRF record.	Number
LsCrfTrackingBc.ActivityType	Type of activity.	Character data
LsCrfTrackingBc.Category	Category.	Character data
LsCrfTrackingBc.ChartsReviewed	When was the charts reviewed.	UTC Date Time
LsCrfTrackingBc.Comments	Comments.	Character data
LsCrfTrackingBc.CRFRowIdId	CRF Row ID.	Character data
LsCrfTrackingBc.Name2	Name of the CRF.	Character data
LsCrfTrackingBc.PagesVerified	Number of pages verified.	Number
LsCrfTrackingBc.ProtocolRegionId	Region row ID.	Character data
LsCrfTrackingBc.ProtocolSiteId	Protocol site ID.	Character data
LsCrfTrackingBc.ReceivedbyData Management	Date when received by the data management.	UTC Date Time
LsCrfTrackingBc.Receivedinhouse	Date when the CRF was received by in-house.	UTC Date Time
LsCrfTrackingBc.Retrieved	Boolen flag indicating whether or not the CRF information was retrieved.	Boolean
LsCrfTrackingBc.RetrievedDate	When the CRF was retrieved.	UTC Date Time
LsCrfTrackingBc.SignedForms	Whether the CRF are signed.	Boolean
LsCrfTrackingBc.SourceVerfied	The CRF is source verified.	Boolean
LsCrfTrackingBc.SourceVerifiedDate	When the CRF was source verified.	UTC Date Time
LsCrfTrackingBc.SubjectId	Subject row ID.	Character data
LsCrfTrackingBc.SubjectNumber	Subject number.	Character data

Request Message Description: QueryPage

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

Table 336. Request Message Description: QueryPage
Node	Description	Type
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
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 recordset.	Number
LastPage	Indicates whether the record being returned is the last record in the record set. Valid values are true or false.	Character Data
PageSize	The number of records to be returned for a component. The default page size is 10. NOTE: 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	Required. Number of planned subjects for the site. Can be either '*' or a valid number.	Number
ClinicalProtocolSite. Searchspec	An optional search specification.	Character Data
ClinicalProtocolSite. AmountCurrencyCode	Required. Currency Code of the site. Can be either '*' or a valid currency amount.	Currency
ClinicalProtocolSite. AmountExchangeDate	Required. Can be either '*' or a valid exchange date for the amount at the site.	Date
ClinicalProtocolSite. FirstSubjectEnrolledDate	Required. Can be either '*' or a valid date when the subject was first enrolled.	Date
ClinicalProtocolSite. SiteRowId	Required. Can be either '*' or a valid protocol site row ID.	Character data
ClinicalProtocolSite. InitiationCompletedDate	Required. Can be either '*' or a valid date when the site was initiated.	Date
ClinicalProtocolSite. InvestigatorFirstName	Required. Can be either '*' or a valid principal investigator first name.	Character data
ClinicalProtocolSite. InvestigatorLastName	Required. Can be either '*' or a valid principal investigator last name.	Character data
ClinicalProtocolSite. LastSubjectOffStudyDate	Required. Can be either '*' or a valid date when the last subject was terminated.	Date
ClinicalProtocolSite. PrimaryInvestigatorId	Required. Can be either '*' or a valid primary investigator's row ID.	Character data
ClinicalProtocolSite. ProtocolId	Required. Can be either '*' or a valid protocol row ID.	Character data
ClinicalProtocolSite. ProtocolNumber	Required. Can be either '*' or a valid protocol number.	Character data
ClinicalProtocolSite. ProtocolSiteId	Required. Can be either '*' or a valid protocol site row ID.	Character data
ClinicalProtocolSite. ProtocolStatus	Required. Can be either '*' or a valid protocol status.	Character data
ClinicalProtocolSite. ProtocolTitle	Required. Can be either '*' or a valid protocol title.	Character data
ClinicalProtocolSite. Region	Required. Can be either '*' or a valid region name.	Character data
ClinicalProtocolSite. RegionPlannedSites	Required. Can be either '*' or a valid number of planned sites for the region.	Number
ClinicalProtocolSite. RegionPlannedSubjects	Required. Can be either '*' or a valid number of planned subjects for the region.	Number
ClinicalProtocolSite. RegionId	Required. Can be either '*' or a valid region row ID.	Character data
ClinicalProtocolSite. RegionStatus	Required. Can be either '*' or a valid region status.	Character data
ClinicalProtocolSite. SiteAccountRowId	Required. Can be either '*' or a valid account row ID for the site associated.	Character data
ClinicalProtocolSite. SiteAccountName	Required. Can be either '*' or a valid account name for the site associated.	Character data
ClinicalProtocolSite. SiteNumber	Required. Can be either '*' or a valid site number.	Character data
ClinicalProtocolSite. Status	Required. Can be either '*' or a valid protocol site status.	Character data
ClinicalProtocolSite. TerminatedDate	Required. Can be either '*' or a valid site terminated date.	Date
ClinicalProtocolSite. TotalContractAmount	Required. Can be either '*' or a valid total contract amount rolled up for the site.	Currency
LsCrfTrackingBc.NumberofPages	Required. Can be either '*' or a valid total number of pages for the CRF record.	Number
LsCrfTrackingBc.Activity Type	Required. Can be either '*' or a valid type of activity.	Character data
LsCrfTrackingBc. Category	Required. Can be either '*' or a valid category.	Character data
LsCrfTrackingBc.ChartsReviewed	Required. Can be either '*' or a valid charts reviewed date.	UTC Date Time
LsCrfTrackingBc. Comments	Required. Can be either '*' or a valid comments.	Character data
LsCrfTrackingBc.CRF RowIdId	Required. Can be either '*' or a valid CRF row ID.	Character data
LsCrfTrackingBc.Name2	Required. Can be either '*' or a valid name of the CRF.	Character data
LsCrfTrackingBc.Pages Verified	Required. Can be either '*' or a valid number of pages verified.	Number
LsCrfTrackingBc.ProtocolRegionId	Required. Can be either '*' or a valid region row ID.	Character data
LsCrfTrackingBc.ProtocolSiteId	Required. Can be either '*' or a valid protocol site ID.	Character data
LsCrfTrackingBc. ReceivedbyData Management	Required. Can be either '*' or a valid Date when received by the data management.	UTC Date Time
LsCrfTrackingBc. Receivedinhouse	Required. Can be either '*' or a valid Date when the CRF was received by the Inhouse.	UTC Date Time
LsCrfTrackingBc. Retrieved	Required. Can be either '*' or a valid Boolen flag if the CRF information is retrieved or not..	Boolean
LsCrfTrackingBc. RetrievedDate	Required. Can be either '*' or a valid CRF retrieved date.	UTC Date Time
LsCrfTrackingBc. SignedForms	Required. Can be either '*' or a valid Boolean value indicating if the CRF is signed.	Boolean
LsCrfTrackingBc.Source Verfied	Required. Can be either '*' or a valid Boolean value indicating if the CRF is source verified.	Boolean
LsCrfTrackingBc.Source VerifiedDate	Required. Can be either '*' or a valid date when the CRF was source verified.	UTC Date Time
LsCrfTrackingBc. SubjectId	Required. Can be either '*' or a valid subject row ID.	Character data
LsCrfTrackingBc. SubjectNumber	Required. Can be either '*' or a valid subject number.	Character data

Response Message Description: All LS Clinical CRF Tracking Interface Service Operations

For a description of this response message, see Table 337.

Table 337. ResponseMessage Description: All LS Clinical CRF Tracking Interface Service Operations
Node	Description	Type
ClinicalProtocolSite. PlannedSubjects	Number of planned subjects for the site.	Number
ClinicalProtocolSite.AmountCurrencyCode	Current code of the site.	Currency
ClinicalProtocolSite.AmountExchangeDate	Exchange date for the amount at the site.	Date
ClinicalProtocolSite.FirstSubjectEnrolledDate	Date when the subject was first enrolled.	Date
ClinicalProtocolSite.SiteRowId	Protocol site row ID.	Character data
ClinicalProtocolSite.Initiation CompletedDate	Date when the site was initiated.	Date
ClinicalProtocolSite.InvestigatorFirst Name	Principal investigator first name.	Character data
ClinicalProtocolSite.InvestigatorLast Name	Principal investigator last name.	Character data
ClinicalProtocolSite.LastSubjectOff StudyDate	Date when the last subject was terminated.	Date
ClinicalProtocolSite.Primary InvestigatorId	Primary investigator's row ID.	Character data
ClinicalProtocolSite. ProtocolId	Protocol row ID.	Character data
ClinicalProtocolSite. ProtocolNumber	Protocol number.	Character data
ClinicalProtocolSite. ProtocolSiteId	Protocol site row ID.	Character data
ClinicalProtocolSite. ProtocolStatus	Protocol status.	Character data
ClinicalProtocolSite. ProtocolTitle	Protocol title.	Character data
ClinicalProtocolSite.Region	Region name.	Character data
ClinicalProtocolSite.RegionPlanned Sites	Number of planned sites for the region.	Number
ClinicalProtocolSite.RegionPlanned Subjects	Number of planned subjects for the region.	Number
ClinicalProtocolSite.RegionId	Region row ID.	Character data
ClinicalProtocolSite.RegionStatus	Region status.	Character data
ClinicalProtocolSite.SiteAccountRowId	Account row ID for the site associated.	Character data
ClinicalProtocolSite.SiteAccountName	Account name for the site associated.	Character data
ClinicalProtocolSite.SiteNumber	Site number.	Character data
ClinicalProtocolSite.Status	Protocol site status.	Character data
ClinicalProtocolSite. TerminatedDate	Site terminated date.	Date
ClinicalProtocolSite.Total ContractAmount	Total contract amount rolledup for the site.	Currency
LsCrfTrackingBc.NumberofPages	Total number of pages for the CRF record.	Number
LsCrfTrackingBc.Activity Type	Type of activity.	Character data
LsCrfTrackingBc.Category	Category.	Character data
LsCrfTrackingBc.Charts Reviewed	When was the charts reviewed.	UTC Date Time
LsCrfTrackingBc.Comments	Comments.	Character data
LsCrfTrackingBc.CRFRowIdId	CRF row ID.	Character data
LsCrfTrackingBc.Name2	Name of the CRF.	Character data
LsCrfTrackingBc.Pages Verified	Number of pages verified.	Number
LsCrfTrackingBc.Protocol RegionId	Region Row ID.	Character data
LsCrfTrackingBc.Protocol SiteId	Protocol site ID.	Character data
LsCrfTrackingBc.Received byDataManagement	Date when received by the data management.	UTC Date Time
LsCrfTrackingBc.Received inhouse	Date when the CRF was received by the in-house.	UTC Date Time
LsCrfTrackingBc.Retrieved	Boolen flag if the CRF information is retrieved or not.	Boolean
LsCrfTrackingBc.RetrievedDate	When the CRF was retrieved.	UTC Date Time
LsCrfTrackingBc.Signed Forms	Whether the CRF are signed.	Boolean
LsCrfTrackingBc.Source Verfied	The CRF is source verified.	Boolean
LsCrfTrackingBc.Source VerifiedDate	When the CRF was source verified.	UTC Date Time
LsCrfTrackingBc.SubjectId	Subject row ID.	Character data
LsCrfTrackingBc.Subject Number	Subject number.	Character data

LS Clinical CRF Tracking 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 338

Table 338. LS Clinical CRF Tracking Interface Service Service Object
Name	Boundary Object Type	Class
LS Clinical CRF Tracking Interface Service	LS Clinical CRF Tracking Interface Service	CSSEAIUIDataSyncService

Data Object (Integration Object)

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

Table 339. LS Clinical CRF Tracking Interface Service Data Object
Siebel Repository Name	External Name
LS Clinical CRF Tracking IO	Clinical Protocol Site

Methods

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

Table 340. LS Clinical CRF Tracking Interface Service Methods
Operation	Method
LSClinicalCRFTrackingInterfaceServiceQueryByExample	QueryByExample
LSClinicalCRFTrackingInterfaceServiceQueryById	QueryById
LSClinicalCRFTrackingInterfaceServiceQueryPage	QueryPage

Example Package for LS Clinical CRF Tracking 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_CRFTracking\LS Clinical CRF Tracking Interface Service-QueryByExample-request.xml

...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service-QueryById-request.xml

...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service-QueryPage-request.xml

Response

See the following file to view the sample code:

...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service-response.xml

Interface Description (WSDL) for LS Clinical CRF Tracking 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_CRFTracking\LS Clinical CRF Tracking Interface Service_QueryByExample.WSDL

...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service_QueryById.WSDL

...\LSClinical_CRFTracking\LS Clinical CRF Tracking Interface Service_QueryPage.WSDL

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