Inserting SVT from External Application to Siebel Clinical
“Subject Visit Template” can also be created in Siebel Clinical using this REST API call apart from UI. This API allows you to insert the SVT with multiple versions, Visits and Activities. The Versions will be inserted with Approved Status and hence no modification will be allowed on these versions.
Note: The user invoking this API should have “Digital Gateway Integration Responsibility” or
“Siebel Administrator” responsibility.
A sample payload is given below. The payload has the following required fields:
- "SVT"- Name, ProtocolNumber (Name uniquely identifies SVT record)
- "Versions"- Version (Version uniquely identifies Versions record)
- "Visits"- ClinicalItem, Name, VisitType (ClinicalItem + Name combination uniquely identifies Visit record in the SVT). ClinicalItem is a 255 character length field.
- "Activities"- ClinicalItem, Description, FormId (ClinicalItem + FormId combination uniquely identifies Activities record). ClinicalItem is a 255 character length field. FormId is a 50 character length field.
- Repeating and Repeating Max count indicate that this particular Visit can be repeated for the specified number of times. However, this is neither restricted nor enforced based on these values.
External application uses below URI to insert SVT in to Siebel Clinical:
- URI: https://ServerName:port/siebel/v1.0/service/LS Clinical SVT Service/upsert/
- HTTP Method: POST
- Content-Type: application/json
- Authorization: Basic
-
Request body:
{
"body" : {
"SVTData" : {
"IntObjectFormat" : "Siebel Hierarchical",
"MessageId" : "1-51I",
"IntObjectName" : "LS Clinical SVT IO",
"MessageType" : "Integration Object",
"ListOfLS Clinical SVT IO" : {
"SVT" : [ {
"Name" : "SVT_001",
"ProtocolNumber" : "PT_Protocol_001",
"ListOfVersions" : {
"Versions" : [ {
"EndDate" : "09/08/2021",
"Version" : "Version 1",
"StartDate" : "09/08/2021",
"ChangeSummary" : "TestSummary",
"Comments" : "TestComments",
"ListOfVisits" : {
"Visits" : [ {
"Lead" : "0",
"ClinicalItem" : "ScreeningVisit_601",
"Name" : "SCR",
"Min" : "0",
"Repeating" : "N",
"LeadUnits" : "days",
"RepeatingMaxCount" : "",
"Priority" : "1",
"MinMaxUnits" : "days",
"Max" : "0",
"VisitType" : "Screening",
"CRFPages" : "10",
"Status" : "Screened",
"StatusTrackingVisitFlag" : "Y",
"SDVRequired" : "N",
"PageNumberstoVerify" : "8",
"ListOfActivities" : {
"Activities" : [ {
"Description" : "Date of Birth",
"ClinicalItem" : "ScreeningAct601",
"Required" : "Y",
"FormName" : "Demographics",
"FormId" : "Act601",
"Comments" : "TestActivityComments",
"Type" : "Procedure",
"Status" : "Active",
"PaymentFlag" : "Y",
"DurationMinutes" : "15"
}, {
"Description" : "Gender",
"ClinicalItem" : "ScreeningAct602",
"Required" : "Y",
"FormName" : "Demographics",
"ItemSDVRequired" : "N",
"FormId" : "Act602",
"Comments" : "TestActivityComments2",
"Type" : "Procedure",
"Status" : "Active",
"PaymentFlag" : "Y",
"DurationMinutes" : "30"
} ]
}
}, {
"Lead" : "4198",
"ClinicalItem" : "ScheduleableVisit601",
"Name" : "BWOCV3-BWOC(9)",
"Min" : "1",
"Repeating" : "Y",
"LeadUnits" : "days",
"RepeatingMaxCount" : "10",
"Priority" : "41",
"MinMaxUnits" : "days",
"Max" : "1",
"VisitType" : "Scheduleable",
"CRFPages" : "1",
"Status" : "Completed",
"StatusTrackingVisitFlag" : "Y",
"SDVRequired" : "N",
"PageNumberstoVerify" : "8",
"ListOfActivities" : {
"Activities" : [ {
"Description" : "Would you like to register visit?",
"ClinicalItem" : "ScheduleableAct601",
"Required" : "Y",
"FormName" : "Register Visit",
"FormId" : "Activity601",
"Comments" : "TestActivityComments",
"Type" : "Procedure",
"Status" : "Active",
"PaymentFlag" : "Y",
"DurationMinutes" : "15"
} ]
}
}, {
"ClinicalItem" : "UnScheduleableVisit601",
"Name" : "UNSV",
"Repeating" : "N",
"LeadUnits" : "days",
"RepeatingMaxCount" : "",
"Priority" : "42",
"MinMaxUnits" : "days",
"VisitType" : "UnScheduleable",
"CRFPages" : "1",
"Status" : "FollowupDone",
"StatusTrackingVisitFlag" : "Y",
"SDVRequired" : "N",
"PageNumberstoVerify" : "8",
"ListOfActivities" : {
"Activities" : [ {
"Description" : "Would you like to register visit?",
"ClinicalItem" : "UnScheduleableAct601",
"Required" : "Y",
"FormName" : "Register Visit",
"FormId" : "Acti601",
"Comments" : "TestActivityComments",
"Type" : "Procedure",
"Status" : "Active",
"PaymentFlag" : "Y",
"DurationMinutes" : "15"
} ]
}
} ]
}
},
{
"EndDate" : "10/11/2021",
"Version" : "Version 2",
"StartDate" : "10/11/2021",
"ChangeSummary" : "TestSummary",
"Comments" : "TestComments",
"ListOfVisits" : {
"Visits" : [ {
"Lead" : "0",
"ClinicalItem" : "ScreeningVisit602",
"Name" : "SCR",
"Min" : "0",
"Repeating" : "N",
"LeadUnits" : "days",
"RepeatingMaxCount" : "",
"Priority" : "1",
"MinMaxUnits" : "days",
"Max" : "0",
"VisitType" : "Screening",
"CRFPages" : "4",
"Status" : "Screened",
"StatusTrackingVisitFlag" : "Y",
"SDVRequired" : "N",
"PageNumberstoVerify" : "8",
"ListOfActivities" : {
"Activities" : [ {
"Description" : "Date of Birth",
"ClinicalItem" : "ScreeningAct602_1",
"Required" : "Y",
"FormName" : "Demographics",
"ItemSDVRequired" : "N",
"FormId" : "FormId602",
"Comments" : "TestActivityComments",
"Type" : "Procedure",
"Status" : "Active",
"PaymentFlag" : "Y",
"DurationMinutes" : "15"
}, {
"Description" : "Phase",
"ClinicalItem" : "ScreeningAct602_2",
"Required" : "Y",
"FormName" : "Phase",
"FormId" : "FormId0602",
"Comments" : "TestActivityComments",
"Type" : "Procedure",
"Status" : "Active",
"PaymentFlag" : "Y",
"DurationMinutes" : "15"
} ]
}
}, {
"Lead" : "527",
"ClinicalItem" : "ScheduleableVisit602",
"Name" : "BWOCV3-BWOC(9)",
"Min" : "1",
"Repeating" : "Y",
"LeadUnits" : "days",
"RepeatingMaxCount" : "10",
"Priority" : "43",
"MinMaxUnits" : "days",
"Max" : "1",
"VisitType" : "Scheduleable",
"CRFPages" : "1",
"Status" : "Screened",
"StatusTrackingVisitFlag" : "Y",
"SDVRequired" : "N",
"PageNumberstoVerify" : "8",
"ListOfActivities" : {
"Activities" : [ {
"Description" : "Would you like to register visit?",
"ClinicalItem" : "ScheduleableActivity602",
"Required" : "Y",
"FormName" : "Register Visit",
"FormId" : "FormId00602",
"Comments" : "TestActivityComments",
"Type" : "Procedure",
"Status" : "Active",
"PaymentFlag" : "Y",
"DurationMinutes" : "15"
} ]
}
}, {
"ClinicalItem" : "UnScheduleableVisit602",
"Name" : "UNSV",
"Repeating" : "N",
"LeadUnits" : "days",
"RepeatingMaxCount" : "",
"Priority" : "44",
"MinMaxUnits" : "days",
"VisitType" : "UnScheduleable",
"CRFPages" : "1",
"Status" : "Screened",
"StatusTrackingVisitFlag" : "Y",
"SDVRequired" : "N",
"PageNumberstoVerify" : "8",
"ListOfActivities" : {
"Activities" : [ {
"Description" : "Would you like to register visit?",
"ClinicalItem" : "UnScheduleableActivity602",
"Required" : "Y",
"FormName" : "Register Visit",
"FormId" : "FormId604",
"Comments" : "TestActivityComments",
"Type" : "Procedure",
"Status" : "Active",
"PaymentFlag" : "Y",
"DurationMinutes" : "15"
} ]
}
} ]
}
} ]
}
} ]
}
}
}
}Once the payload is inserted successfully:
- SVT is created with Versions, Visits and Activities.
- Unique Activities from the Payload (ClinicalItem + FormId) will also be inserted under new View 'EDC Item Mapping'.
For more info on EDC Item Mapping View, refer Siebel Clinical Trial Management System Guide.
The user can also enable the email notifications on successful insertion of SVT via API, by following the instructions provided in the “Setting Up Integration Between CTMS and Oracle Clinical One” chapter of Siebel Clinical Trial Management System Guide.
Here are the response details for a successful request:
- HTTP Code: 200
- Content-Type: application/json
- Response body:
{ "ResponseMessage": "Success" }