Save data in a form
Follow the steps in this use case to learn how to create new visits and save data into a form using REST APIs.
The objective of this example is to save subject data into a form. There are prerequisites in order to be able to save data into a form that are also listed under this use case.
These steps can be completed programmatically with the Oracle Clinical One Platform APIs or through the Oracle Clinical One Platform UI. You also may have already completed them by setting up your study design already and in this case, you need to retrieve the correct IDs in order to programmatically save data into a predefined form.
Overview
To begin saving data in a form, you must complete either one of these three tasks. These are steps that only need to be completed once and not every time you save data to a form.
Option 1: Set up a study using the Clinical One APIs to save data in a form
Another Oracle Clinical One Platform user can perform the tasks listed below to setup a study before you can save data in a form using Oracle Clinical One Platform REST APIs listed in this guide.
- Create and activate a site
- Create a form
- Design the visit schedule
- Add a form to the visit
- Add a subject to a study
- Add a visit
Note:
Every one of these attributes are necessary in order to save data into a form.| Attribute name | Description | Definition |
|---|---|---|
| Study Name | This is what you chose to name your study. | Test Study |
| Study Version | This is the current study draft version you are working in. | 1.0.0.1 |
| Study ID | This is the study GUID that uniquely identifies your study. | 6516CC36A0E949989021A22633177C90 |
| Form ID | This is the form GUID that uniquely identifies the correct form to save data into in your study. | 7C68D67B1E154B9596181323B97160A6 |
| Subject ID | This is the subject GUID that uniquely identifies the subject you will save data for. | 52682768FEF54E9FAD8BEA630448B5EE |
| Adverse Event ID | This is the event GUID that uniquely identifies the visit associated with the form in which you want to save data. | 750739AD259347C8A37612A8D37538A4 |
| Site ID | This is the site GUID that uniquely identifies the site which the subject you are saving data for is at. | 84EE8610B5E6466D9B7B64FE99F6606A |
Option 2: Set up a study using the Oracle Clinical One Platform user interface
Note:
After you have completed your study setup, you need to obtain the correct study design information. For more details, see Obtain study information.Option 3: A study is already set up
- Get the study name, study ID, study version, site ID, subject ID, form ID, event ID. For more information, see Obtain study information.
- The user should keep record of this information and review Save data in a form.
Note:
If you are using a predefined study, your IDs will be different than the example ids that we are using for each API call. You should make sure your IDs are consistent throughout these API calls.Table of Contents
To create new visits and store data into a form, follow these steps:
| Task in the use case | Related Endpoint Documentation |
|---|---|
| Obtain study information | Provides a way to retrieve pre-existing study design information- multiple endpoints are required. |
| Create and activate a site | Create a site |
| Create a form | Add a form in a study version |
| Create a visit schedule | Create visit schedule |
| Add a form to the visit | Process visits to associate with a specific form |
| Add a subject to a study | Add a subject to a study |
| Add a visit | Create visit status record |
| Save form data in a form | Create multiple data elements for a subject |
| Update form data for a visit | Update single data element to clear rule error |