Generate deep links

Create deep links that open specific Clinical One Cloud Service pages and subject forms from integrated applications, documents, emails, and other external resources.

A deep link is a URL that opens a specific Clinical One Cloud Service page or subject form directly.

Sponsor users can create deep link URLs to open specific Study Settings tabs, the Subject List page, the Query List page, and subject forms. Deep linking is supported in Active (Production), Testing, and Training modes, and for training studies.

Applications that integrate with Clinical One Cloud Service, such as Oracle Central Coding, include deep link URLs that open the most specific available source context. For example, using the deep link URL for a verbatim term opens the associated repeating form entry or section entry when that information is available.
  • Clinical One Cloud Service automatically generates the appropriate deep link URLs for Oracle Central Coding. Sponsor users don't need to manually create these URLs.
  • Selecting the Study name link for a verbatim term in Oracle Central Coding opens the corresponding subject form in Clinical One Cloud Service. When available, the link opens the most specific source context, such as a repeating form entry or repeating section entry.
  • Deep link URLs are not available in Oracle Central Coding for verbatim terms entered before this feature was introduced.

Before you create deep links

  • Users must have valid Clinical One Cloud Service credentials and be authorized to access the target study, site, subject, visit, and form.
  • If a user doesn't already have an active Clinical One Cloud Service session, they're prompted to sign in before the requested page or subject form opens.
  • If a deep link URL is invalid, or the user isn't authorized to access the requested resource, Clinical One Cloud Service redirects the user to the Home page.

To create deep links

  1. Determine the type of deep link URL to create and copy the appropriate deep link URL template below.

    Table 4-12 Deep link URL templates by target

    Deep link target Deep link URL template
    General tab under Study Settings 
    {BaseURL}?ojr=clinicalone/settings&mode={mode}&studyId={studyId}
    Sites & Labs tab under Study Settings 
    {BaseURL}?ojr=clinicalone/settings/sites&mode={mode}&studyId={studyId}
    Queries List page 
    {BaseURL}?ojr=clinicalone/runtime/querymanagement&mode={mode}&studyId={studyId}
    Subjects List page 
    {BaseURL}?ojr=clinicalone/runtime/subjects&mode={mode}&studyId={studyId}
    Subject forms 
    {BaseURL}?ojr=clinicalone/runtime/subjects/dataCapture&mode={mode}&studyId={studyId}&subjectId={subjectId}&visitId={visitId}&eventInstanceNum={eventInstanceNum}&formId={formId}&formEntry={formEntry}&formInstanceId={formInstanceId}&sectionEntry={sectionEntry}&sectionInstanceId={sectionInstanceId}
    Subject form deep link URLs require specific parameters depending on your target.

    Table 4-13 Subject form deep link URL parameters

    Deep link type Required URL parameters
    Form-level
    The URL must include the following parameters:
    • studyId
    • mode
    • subjectId
    • visitId
    • formId

    Omit formEntry, formInstanceId, sectionEntry, and sectionInstanceId, or set those parameters to false.
    Repeating form entry
    The URL must include the following parameters:
    • form-level parameters
    • formEntry=true
    • formInstanceId
    Repeating section entry The URL must include the following parameters:
    • form-level parameters
    • sectionEntry=true (for a two-section form this must always be true.)
    • sectionInstanceId
    • formInstanceId (include when the section entry belongs to a specific form instance.)
  2. Obtain the base URL

    Sign in to Clinical One Cloud Service and copy the Home page URL from your browser's address bar. This URL becomes the {BaseURL} used to create all deep links.

  3. Using the table below, replace each placeholder value enclosed in braces ({}) with the appropriate value for your study. For example, replace {mode} with active so the parameter becomes mode=active.

    Some parameter values are not available directly from the Clinical One Cloud Service user interface. To obtain values such as subjectId, visitId, and formId, refer to the Dataset descriptions section in the Analytics User Guide or review the REST API for Clinical One Cloud Service guide to locate the appropriate API.

    Table 4-14 Parameter descriptions

    Deep link URL parameters Description
    studyId The study GUID. To obtain this value, Open the study settings and go to the General tab.
    mode

    Enter the desired study mode: active, test, or training. For a training study, set the mode parameter to all.

    subjectId Subject identifier
    visitId Visit identifier
    eventInstanceNum

    Visit instance identifier. This is required when the target form belongs to a repeating visit, such as an Unscheduled visit or Cycle. Obtain this value from the Clinical One Cloud Service user interface.

    Omit eventInstanceNum from deep link URLs created for forms in non-repeating visits.

    formId Form identifier
    formEntry Set to true to open a repeating form entry. Use only when the sectionEntry parameter is set to false or omitted.
    formInstanceId Repeating form instance identifier. Obtain this value from the Clinical One Cloud Service user interface.
    sectionEntry Set to true to open a repeating section entry. Use only when the formEntry parameter is set to false or omitted.
    sectionInstanceId Repeating section instance identifier. Obtain this value from the Clinical One Cloud Service user interface.
    isTraining
    Add the following parameter when creating a deep link URL for a training study:
    &isTraining=true

    A training study is a dedicated study environment in Clinical One Cloud Service used solely for training purposes. Don't confuse a training study with Training mode.

  4. Use the deep link URL

    Copy the completed deep link URL and use it in an integrated application, document, email, or other external resource. Authorized users can then select the deep link URL to open the specified Clinical One Cloud Service page or subject form.

    If a deep link URL is incorrectly constructed, the user attempting to use it is taken to the Home page of Clinical One Cloud Service. The system does not inform the user which of the following issues was encountered.
    • Typo in the URL
    • User does not have access to study, site, subject, visit, or form.
    • The URL is constructed correctly, but one or more IDs are incorrect.

Parent topic: Configure a study