REST API for Clinical One Platform

Integrate data into Clinical One via Digital Gateway

Use Rest APIs to set up an IWR integration and import subject data into an Oracle Clinical One Platform study.

Overview

This use case aims to present the steps to perform an IWR integration using the Oracle Clinical One Digital Gateway web service. An IWR integration is a near real-time integration that allows you to import subject data sent by an external IVR system, in a standard ODM format, to an Oracle Clinical One Platform study. To learn more see Multi-IWR Integration.

Before you begin

Define the configuration identifiers for the web service client (tenant, study name, study mode, vendor name) and reach out to Oracle Services to define the integration configuration with the required study mappings in Digital Gateway.

Provision required users for vendor (Rest API client) and integration (Clinical One user):

Rest API client (created for vendor) Clinical One integration user (configured with the integration)

Rest API client (created for vendor)	Clinical One integration user (configured with the integration)
This users needs to have the appropriate permissions to access the corresponding microservices and generate a token for authentication. See Generate a client ID and secret and Get a token for authentication. The client scope for authentication must include the following microservices: `ib-ext-svc` `inthub-svc` `ec-designer-svc` `ec-site-svc` The Clinical One study user for this client must be assigned to all sites and depots and have the following roles: Study Design Mode: View Study Design Testing/Production/Training mode: Site User	This Clinical One study level user is configured with the integration and must be assigned to all sites and depots and have the Site User role, or a custom role that includes the following permissions: Answer queries Integrate Subject Data View Classified Subject Data Only View Sites Edit Form Data for Subjects Edit Visit Dates For the Study Design mode, this user must be assigned the View Study Design role.

This users needs to have the appropriate permissions to access the corresponding microservices and generate a token for authentication. See Generate a client ID and secret and Get a token for authentication. The client scope for authentication must include the following microservices:
- ib-ext-svc
- inthub-svc
- ec-designer-svc
- ec-site-svc
The Clinical One study user for this client must be assigned to all sites and depots and have the following roles:
- Study Design Mode: View Study Design
- Testing/Production/Training mode: Site User

This Clinical One study level user is configured with the integration and must be assigned to all sites and depots and have the Site User role, or a custom role that includes the following permissions:
- Answer queries
- Integrate Subject Data
- View Classified Subject Data Only
- View Sites
- Edit Form Data for Subjects
- Edit Visit Dates
For the Study Design mode, this user must be assigned the View Study Design role.

Set up your environment to start making Rest API calls, see Get started as an API developer.

Table of Contents

To set up an IWR integration, complete the following tasks: