Use deep links to open subject forms

Users can now create deep links to open specific subject forms in Clinical One Cloud Service.

Previous releases introduced deep links for opening specific pages in Clinical One Cloud Service, including Study Settings tabs, the Subject List page, and the Query List page. For more information, see Open Clinical One Cloud Service directly to the page you need and New deep link pages.

Release 26.3 extends deep linking to subject forms. You can now create deep link URLs that open specific subject forms directly. When applicable, deep link URLs can also open specific repeating form entries and repeating section entries.

Details for sponsor users

Sponsor users can now create deep link URLs to open specific subject forms. Deep linking is supported in Active (Production), Testing, and Training study modes, and for training studies.

Note:

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 when creating deep link URLs.
You can create deep link URLs for the following subject form types and navigation targets:
  • One-section forms
  • Two-section forms
  • Lab forms
  • Repeating form instances
  • Repeating section instances

For more information, see Generate deep links in the Sponsor and CRO User Guide after the assessment environment is upgraded.

To create a deep link URL:
  • Determine the type of deep link URL to create. Use the following table to identify the required URL parameters.

    Table 1-2 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.)
  • Sign in to Clinical One Cloud Service and copy the Home page URL. This URL becomes the {BaseURL} used to create the deep link URL.

  • Copy the following subject form deep-link URL template and replace {BaseURL} with the Home page URL. Then, 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.

    {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}
    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 1-3 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. Available in 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. Available in 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.

Details for study users

Study users can now use deep link URLs to open specific subject forms. When a user selects a deep link URL, Clinical One Cloud Service authenticates and authorizes the user before opening the requested subject form. Deep link URLs are used only for navigation and don't create, update, or delete subject data.
  • Users must have valid Clinical One Cloud Service credentials to use deep link URLs.
  • If the user already has an active Clinical One Cloud Service session, the requested form opens directly. Otherwise, the user is prompted to sign in.
  • Clinical One Cloud Service opens the requested form only if the user is authorized to access the study, site, subject, visit, and form.
  • 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.

Impact on integrated applications

Oracle Central Coding now includes deep link URLs that open the corresponding form instance. 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 available only for new or updated verbatim terms entered after this feature is introduced. Existing verbatim terms are not updated with deep link URLs.

Parent topic: User experience