Siebel CRM Web Services Reference > Siebel CRM Primary Web Services >
ClinicalSubject
Use this Web service to perform the following:
- Create a subject record in the Siebel database from details provided by an external application. The Screen and Enrollment template is applied to each new record with a default informed consent date, if a date is not provided by the external application. If a valid informed consent date is provided by the external application, then the Web service updates the default value with the valid informed consent date.
- Create additional Siebel Life Science statuses for a subject apart from the statuses Screened and Enrolled.
- Mark a subject visit as missed.
- Override the subject visit completion or missed value.
- Create subject statuses using Visit Type.
- Delete the subject status.
- Designate the latest subject status as Primary.
- Designate any record at Primary.
- Mark Visits/Activities as completed with the Completed Date details, and other information provided by the external application.
- Generate an error when the IntegrationId is not sent in the Web service for Visit Completion.
- Use new custom tags: ActCustom1 through ActCustom25 in the Action (No Owner Lock) and SubCustom1 through SubCustom23 on the Clinical Subject integration component.
NOTE: SubCustom24 and SubCustom25 are reserved for Delete Non Applicable Visits flag and SVT Effective Date.
- Use special status values: Randomized Date, Early Terminated Date, Screen Failure Date and Screen Failure Reason.
- Mark Visits/Activities as completed with the Completed Date details, and other information provided by the external application.
NOTE: This Web service assumes that the Visits/Activities Clinical Item is unique for the given Subject Visit Template.
- Support Subject Transfer from one Study site to another.
This Web service returns the Integration ID when a subject creation is successful. The Integration ID is used for identifying the subject for any future operations. An error message is presented in the event of an error. ClinicalSubject Operations
For a list of operations associated with this Web service, see Table 80.
Table 80. ClinicalSubject Operations
|
|
Upsert |
Creates a Subject record in the Siebel database with the minimum required details, along with performing relevant updates. |
Request Message Description: Upsert
For a description of this request message, see Table 81.
Table 81. Request Message Description: Upsert
|
|
|
ClinicalSubject.Comments |
Optional. |
Character data |
ClinicalSubject.DateofBirth |
Required. |
Date |
ClinicalSubject.EarlyTerminatedDate |
Optional. |
Date |
ClinicalSubject.EarlyTerminatedReason |
Optional. |
Character data |
ClinicalSubject.Comments |
Optional. |
Character data |
ClinicalSubject.EligibleFlag |
Optional. |
Boolean flag |
ClinicalSubject.EmailAddress |
Optional. |
Character data |
ClinicalSubject.EnrollmentDate |
Optional. |
Date |
ClinicalSubject.EnrollmentId |
Optional. |
Character data |
ClinicalSubject.FaxNumber |
Optional. |
Character data |
ClinicalSubject.IntegrationId |
Optional. |
Character data |
ClinicalSubject.PhoneNumber |
Optional. |
Character data |
ClinicalSubject.ProtocolDeviation |
Optional. |
Character data |
ClinicalSubject.ProtocolNumber |
Optional. |
Character data |
ClinicalSubject.ProtocolSiteId |
Optional. |
Character data |
ClinicalSubject.ProtocolViolation |
Optional. |
Character data |
ClinicalSubject.RandomizationId |
Optional. |
Character data |
ClinicalSubject.RandomizedDate |
Optional. |
Date |
ClinicalSubject.ReasonExcluded |
Optional. |
Character data |
ClinicalSubject.SDVRequired |
Optional. |
Character data |
ClinicalSubject.ScreenDate |
Optional. |
Date |
ClinicalSubject.ScreenFailureDate |
Optional. |
Date |
ClinicalSubject.SubCustom1 through SubCustom 23 |
Optional. New custom fields. |
Character data |
ClinicalSubject.SubCustom24 |
Optional. Flag to decide deletion of Non Applicable Visits. |
Character data |
ClinicalSubject.SubCustom25 |
Optional. SVT Effective Date. |
Character data |
ClinicalSubject.TransferComments |
Optional. |
Character data |
ClinicalSubject.TransferReason |
Optional. |
Character data |
ClinicalSubject.SubjectInitials |
Required. |
Character data |
ClinicalSubject.WithdrawnDate |
Optional. |
Boolean |
ClinicalSubject.WithdrawnReason |
Optional. |
Character data |
ClinicalSubject_InformedConsent.InformedConsentSignedDate |
Optional. |
Date |
VisitPlan.OverrideStatus |
Optional. |
Character data |
VisitPlan.VisitMissed |
Optional. |
Boolean |
ClinicalSubjectStatus.Comments2 |
Optional. |
Character data |
ClinicalSubjectStatus.DeleteFlag |
Optional. |
Boolean |
ClinicalSubjectStatus.Status |
Optional. |
Character data |
ClinicalSubjectStatus.StatusDate |
Optional. |
Date |
ClinicalSubjectStatus.VisitType |
Optional. |
Character data |
ActionNoOwnerLock.ActCustom1 through ActCustom25 |
Optional. New custom fields. |
Character data |
ActionNoOwnerLock.Done |
Optional. |
Date |
ActionNoOwnerLock.VisitClinicalItem |
Optional. |
Character data |
ActionNoOwnerLock.ActivityClinicalItem |
Optional. |
Character data |
Response Message Description: Upsert
For a description of this response message, see Table 82.
Table 82. Response Message Description: Upsert
|
|
|
ClinicalSubject.IntegrationId |
Required. Returns the process instance ID if the subject creation is successful. |
Character data |
ClinicalSubject 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 83.
Table 83. ClinicalSubject Service Object
|
|
|
SWI LS Clinical Subject Inbound-Subject |
Workflow |
Not applicable |
Data Object (Integration Object)
For a description of data objects for this Web service, see Table 84.
Table 84. ClinicalSubject Data Object
|
|
Clinical Subject External |
Clinical Subject |
Example Package for ClinicalSubject
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: ...\ClinicalSubject\ClinicalSubject_request.xml
Interface Description (WSDL) for ClinicalSubject
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. ...\ClinicalSubject\ClinicalSubject_asi_ClinicalSubject.wsdl
|