Enhancement to dataset APIs to support incremental data extraction

Data Hub dataset API introduces new timestamp-related columns in the Subject Form Items dataset. These columns enable incremental extraction by capturing updates from secondary tables for previously populated form-item rows.

This enhancement is applied to the version 14 of the Get subject form item data details API, in the Data Hub category. The new columns are:
Column Description
DH_TS_ROW_CHANGE To track updates to the following:
  • Columns in the primary table of the Subject Form Items dataset (the DH_TIMESTAMP data element).
  • SDV Selection status
  • Overall signed status (the ALL_SIGNED data element).
DH_TS_STUDY_VERSIONS_HISTORY To track updates of columns related to Study versions.
DH_TS_SUBJECTS To track updates of columns related to subject data.
DH_TS_SUBJECTS_VISITS To track updates of columns related to subject visits.
DH_TS_SITE To track updates of columns related to sites.
DH_TS_USER_STUDY_ROLES To track updates of columns related to user study role.
DH_TS_SUBJECT_FORM To track updates to the form status.
The existing DH_TIMESTAMP column still tracks updates of columns related to the primary table of Subject Form Items.

Note:

This enhancement is exclusive to Data Hub APIs, and it is not available in Oracle Clinical One Analytics.

Systems that consume the Subject Form Items dataset API and rely on updates to its secondary tables must perform a full data refresh before using the newly introduced columns for incremental data extraction. A full refresh on the consumer side ensures that existing records, including data stored in the secondary tables, are synchronized with the updated dataset structure.

After the full refresh is completed successfully, you can resume the standard incremental extraction process. For this, you may use either one of the newly introduced columns in the filter criteria, as applicable, or keep using the existing DH_TIMESTAMP column. Considering DH_TIMESTAMP exclusively tracks changes to the primary table of Subject Form Items data and does not track changes made to the secondary tables.

For more information about the newly introduced columns, refer to the REST API for Clinical One Cloud Service documentation after the assessment environment upgrade.