1. REST API for Clinical One Platform
  2. Tasks
  3. Data Capture
  4. Data Elements
  5. Clear data elements scope by study ID and mode

V3.0

put

/ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/dataelements/clear/{scope}

Clears the given scope of data elements for a visit. Scope can be:
  • VSD, to clear visit start date.
  • ITEM, to clear a specific item.

This call returns refreshVisit as true when it is a last item to clear for the given visit.

Request

Path Parameters
Query Parameters
  • If the call is from Digital Gateway / Digital Gateway Builder, isDgCall set to true, Cleardynamics won't be supported.
    Example:
    true
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request to clear data elements for a subject at visit/form/item scope
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Comment
    Example: Incorrect entry; clearing to re-enter
  • Minimum Length: 0
    Maximum Length: 255
    Reason
    Example: Data correction
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: ABCDEF1234567890ABCDEF1234567890
  • visits
    List of visit-level clear requests containing event, instance number and forms to clear
Nested Schema : visits
Type: array
List of visit-level clear requests containing event, instance number and forms to clear
Show Source
Nested Schema : CoreClearVisitRequestDto
Type: object
Visit-level clear request that includes visit identifiers and the list of forms/items to clear
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: CBCDEF1234567890ABCDEF1234567890
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • forms
    List of form-level clear requests to process in this visit
  • String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 1.0.0.0
  • Identifier of the Visit Start Date data element (UUID, 32-character uppercase hexadecimal string)
    Example: DBCDEF1234567890ABCDEF1234567890
Nested Schema : forms
Type: array
List of form-level clear requests to process in this visit
Show Source
Nested Schema : CoreClearFormsRequestDto
Type: object
Form-level clear request that identifies the form, repeats and optionally a specific item or section to clear
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • ID (UUID, 32-character uppercase hexadecimal string) of the form section.
    Example: 50DB4EF4847849CCB24EFCCB71CDA436
  • Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.
    Example: 1
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 1
  • Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.
    Example: 1
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 1
Examples

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : ClearDataResponseDto20
Type: object
Response wrapper containing cleared data details
Show Source
Nested Schema : clearedData
Type: array
List of cleared data details
Show Source
Nested Schema : ClearedDataDto20
Type: object
Container for cleared data including visit details, cleared data elements, and lab property IDs
Show Source
Nested Schema : dataElements
Type: array
List of cleared data elements
Show Source
  • DataElementDto131
    DataElementDto is a wrapper containing DataElementDto130 and additional fields like lockedStatus, lockedDateTime, visitStartDateLockedStatus and visitStartDateLockedDateTime.
Nested Schema : labs
Type: array
List of cleared lab property details
Show Source
Nested Schema : Visits
Type: object
Visit status targets and refresh indicator.
Show Source
Nested Schema : DataElementDto131
Type: object
DataElementDto is a wrapper containing DataElementDto130 and additional fields like lockedStatus, lockedDateTime, visitStartDateLockedStatus and visitStartDateLockedDateTime.
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Comment for the data element change
    Example: Captured by device
  • Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Date-time value in UTC
    Example: 2025-10-16T14:30:31.892Z
  • Day part of date
    Example: 16
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: ADF5A7800A954FA5B831E7B6B9CA39A9
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Numeric decimal value
    Example: 12.34
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • ID (UUID, 32-character uppercase hexadecimal string) of the form section.
    Example: B6E0C7D5A1F3428C8B8B6A77C5E9D4AA
  • Status of the form. Status can be NEW, OPTIONAL, COMPLETED, COMPLETED_WITH_ERROR, IN_PROGRESS, IN_PROGRESS_WITH_ERROR, INCOMPLETE, INCOMPLETE_WITH_ERROR or DELETED.
    Example: COMPLETED
  • Freeze status of the data element,can have Values NOT_APPLICABLE, FROZEN
    Example: FROZEN
  • Hour part of time
    Example: 14
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.
    Example: 1
  • The decoded value of the raw value, which provides a more meaningful representation of the data. For dates, it follows the ISO 8601 standard. For questions with multiple choice options, it uses the corresponding code from the codelist. Additionally, ItemD decodes special flags like NA, ND, and UNK to their corresponding meanings, making it easier to understand the data.
    Example: DETAIL
  • The formatted value that matches the data type of the question, such as a date in a specific format or a number with correct decimal places. If the user didn't provide a valid response, ItemF will be null.
    Example: FLAG
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
  • The raw value entered by the user, which can be a text, number, or date, and is stored as alphanumeric data. It may also contain special flags such as NA (Not Applicable), ND (Not Done), UNK (Unknown), or Not Answered if the user didn't provide a response.
    Example: REASON
  • Type of item represented by this data element
    Example: TEXT
  • Timestamp when the data element lock state last changed
    Example: 2023-01-01T09:00:00Z
  • Lock state of the data element. Values LOCKED, UNLOCKED, NEVER_LOCKED
    Example: LOCKED
  • Minimum Length: 0
    Maximum Length: 64
    Measurement unit
    Example: mg/dL
  • Minute part of time
    Example: 30
  • Month part of date
    Example: 10
  • Identifier of normalized unit
    Example: A78AD8C31CD843CD8B847C06C0420FF5
  • Minimum Length: 0
    Maximum Length: 100
    Normalized value if applicable
    Example: 120
  • Numeric integer value
    Example: 120
  • Object version number used for concurrency control.
    Example: 14
  • Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: MODIFIED
  • An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).
    Example: FEDCBA9876543210FEDCBA9876543210
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 1
  • Identifier (UUID, 32-character uppercase hexadecimal string) of the parent data element in uppercase hex.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the property.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason associated with the data element change
    Example: Initial entry
  • Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.
    Example: 2
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 1
  • Identifier of root data element in UUID, 32-character uppercase hexadecimal string.
    Example: 1234567890ABCDEF1234567890ABCDEF
  • Second part of time
    Example: 31
  • Signature status of the data element, can have Values NOT_APPLICABLE, SIGNED
    Example: SIGNED
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Software version number
    Example: 14
  • Timestamp when the data element was captured in the source system
    Example: 2025-10-16T14:30:31.892Z
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Minimum Length: 0
    Maximum Length: 100
    Study name
    Example: STUDY-ABC
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: 10F75668189F422F9A461A315D211111
  • The date and time at which the transaction processing completed.
    Example: 2025-10-16T14:30:31.892Z
  • The date and time at which the transaction processing began.
    Example: 2025-10-16T14:30:31.892Z
  • Minimum Length: 0
    Maximum Length: 32767
    Validation failure details if any
    Example: Incorrect values not allowed
  • Minimum Length: 0
    Maximum Length: 25
    Validation status of the data element. The validation status can be null or SUCCESS.
    Example: SUCCESS
  • Minimum Length: 0
    Maximum Length: 4000
    Raw value captured for the item
    Example: 120
  • Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.
    Example: 0123456789ABCDEF0123456789ABCDEF
  • Minimum Length: 0
    Maximum Length: 100
    Vendor code if provided
    Example: VENDOR1
  • Verification status of the data element can have Values NOT_APPLICABLE, VERIFIED
    Example: VERIFIED
  • End timestamp of the data element version
    Example: 2025-10-16T14:30:31.892Z
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2025-10-16T14:30:31.892Z
  • Timestamp when the visit start date lock state last changed
    Example: 2023-01-01T09:00:00Z
  • Action taken on the visit start date value. Acceptable values are LOCKED, UNLOCKED, NEVER_LOCKED.
    Example: NEVER_LOCKED
  • Year part of date
    Example: 2025
Nested Schema : DCPropertyDto
Type: object
Laboratory property details associated with a data element.
Show Source
  • Comment
    Example: Cleared due to verified lab correction
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) of the lab normals record. Include for update requests; omit for new create.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 1
  • Reason
    Example: Data cleared by monitor
Nested Schema : VisitsStatusRuleTargetsDto7
Type: object
Visit status update response including visit action and inherited rule targets
Show Source
  • String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Minimum Length: 0
    Maximum Length: 2048
    Additional comment for the visit status
    Example: All data verified
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.
    Example: Visit_Not_Started
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Minimum Length: 0
    Maximum Length: 255
    Reason associated with the visit status
    Example: Subject completed the visit successfully
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: ABCDEF1234567890ABCDEF1234567890
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 3.0.0.1
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: ABCDEF1234567890ABCDEF1234567890
  • targets
    List of rule targets affected by this operation
  • Start timestamp of the version record
    Example: 2025-10-16T14:30:31.892Z
  • Action taken on the visit start date value. Acceptable values are SCREEN_ENABLE ,SCREEN_DISABLE ,RANDOMIZE_ENABLE ,RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE, COMPLETE_STUDY_DISABLE.
    Example: SCREEN_ENABLE
  • Visit start date timestamp
    Example: 2025-10-16T14:30:31.892Z
  • Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.
    Example: COMPLETE
  • Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.
    Example: SCREENING
Nested Schema : targets
Type: array
List of rule targets affected by this operation
Show Source
  • List of rule targets affected by this operation
    Example: ["DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC"]
Example:
[
    "DDEEFF00112233445566778899AABBCC.1DEEFF00112233445566778899AABBCC"
]
Examples

400 Response

Bad request.
Body ()
Root Schema : DcsResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Nested Schema : details
Type: object
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
Example:
User role is missing required permission REPORTING_VIEW. Field: userId
Back to Top