Bookshelf Home | Contents | Index | PDF     

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.
  • Designate any record at Primary.
  • 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.

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 81.

Table 81. ClinicalSubject Operations
Name
Description

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 82.

Table 82. Request Message Description: Upsert
Node
Description
Type

IntegrationId

Required. Process instance ID.

Character data.

VisitClinicalItem

Required. Text used to map a visit from the external application.

Character data.

Done

Required. Completion date.

UTC Date Time.

ActivityClinicalItem

Required. Text used to map an activity from other application.

Character data.

EnrollmentDate

Optional.

Date.

DateofBirth

Required.

Date.

ScreenDate

Optional.

Date.

SubjectInitials

Required.

Character data.

PhoneNumber

Optional.

Character data.

FaxNumber

Optional.

Character data.

EmailAddress

Optional.

Character data.

EnrollmentId

Optional.

Character data.

Comments

Optional.

Character data.

EligibleFlag

Optional.

Boolean (character).

ProtocolDeviation

Optional.

Boolean (character).

ProtocolViolation

Optional.

Boolean (character).

ReasonExcluded

Optional.

Character data.

WithdrawnReason

Optional.

Character data.

RandomizationId

Optional.

Character data.

ProtocolSiteId

Required.

Character data.

InformedConsentSignedDate

Optional.

Date.

Status

Optional.

Character data.

StatusDate

Optional.

Date.

Response Message Description: Upsert

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

Table 83. Response Message Description: Upsert
Node
Description
Type

IntegrationId

Required. Returns the process instance ID in case 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 84.

Table 84. ClinicalSubject Service Object
Siebel Repository Name
Boundary Object Type
Class

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 85.

Table 85. ClinicalSubject Data Object
Siebel Repository Name
External Name

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

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