1. REST API for Clinical One Platform
  2. Tasks
  3. Data Capture
  4. Data Elements
  5. Create multiple data elements for repeating form

V4.0

post

/ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/dataelements/multirepeatingform

Creates multiple data elements in a repeating form for a particular subject, visit and form, with file upload support. Returns form statuses in the response.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Request to save multiple data elements for repeating forms within a context
Show Source
Nested Schema : Context
Type: object
Context information including study, subject, event, form, site and event instance.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: 699EF3745FC545589F186D2198F3C65E
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 299BC76CF0F943E6BAC1D209BC3D1CDC
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: A86F2D0BB610404DB62D37AFA9C20B50
  • Minimum Length: 0
    Maximum Length: 100
    Name of the study
    Example: DEMO_STUDY
  • 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: 1.0.0.1
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: B1B8327AFAA6412287106192AB5984EF
Nested Schema : repeatingForms
Type: array
List of repeating form payloads with their repeat numbers and data elements
Show Source
Nested Schema : RepeatingFormsDataElementReqDto10
Type: object
Payload for a single repeating form instance with its repeat numbers and data elements
Show Source
  • dataElements
    List of core data element values to store for this repeating form instance
  • 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
  • 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
Nested Schema : dataElements
Type: array
List of core data element values to store for this repeating form instance
Show Source
Nested Schema : CoreDataElementV50
Type: object
Core data element payload with optional document linkage information
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Any general comments for the data element instance.
    Example: Measured after fasting
  • Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).
    Example: B1B8327AFAA6412287106192AB5984EF
  • Unique identifier of the associated source document (hex UUID, 32-character uppercase), enabling traceability between the data element and its original supporting document or file.
  • Version of the source or supporting document linked to this data element.
    Example: 1
  • ID (UUID, 32-character uppercase hexadecimal string) of the form section.
    Example: D9876543D9876543D9876543D9876543
  • Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.
    Example: A86F2D0BB610404DB62D37AFA9C20B50
  • Primary uuid identifier for the data element instance (HEX, upper case).
    Example: C1234567C1234567C1234567C1234567
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Unit of measurement for this value (if applicable).
    Example: mg/dL
  • An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).
    Example: F4443333F4443333F4443333F4443333
  • Unique Identfier (UUID, 32-character uppercase hexadecimal string) of data capture properties
    Example: 299BC76CF0F943E6BAC1D209BC3D1CDC
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2024-01-01T00:00:00Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason for this data entry/edit.
    Example: Other
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 2
  • Transaction end date/time for this observation.
    Example: 2024-01-01T13:00:00Z
  • Transaction start date/time for this observation.
    Example: 2024-01-01T12:00:00Z
  • Minimum Length: 0
    Maximum Length: 4000
    Measured value captured for this data element.
    Example: 42.0
  • Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.
    Example: E5554444E5554444E5554444E5554444
  • Minimum Length: 0
    Maximum Length: 100
    Code supplied by vendor.
    Example: VENDOR42
Examples

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : DataElementListFormStatusesDto
Type: object
Response wrapper containing data elements and their corresponding form statuses.
Show Source
Nested Schema : dataElements
Type: array
List of data elements captured/updated
Show Source
Nested Schema : formsStatus
Type: array
List of form status entries with repeat hierarchy
Show Source
Nested Schema : DataElementDto123
Type: object
Data element with document linkage, validation rules, cleared labs and child elements, and visit start date lock metadata.
Show Source
  • Affidavit code value when affidavit applies
    Example: Electronic Signature Affidavit
  • clearedChildDataElements
    List of cleared child data elements
  • clearedLabs
    List of laboratory properties associated with the data element
  • Minimum Length: 0
    Maximum Length: 2048
    Comment for the data element change
    Example: Captured by device
  • Event type indicating data change lifecycle.
    Example: FORM_RESTORED
  • 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 of the associated source document (hex UUID, 32-character uppercase), enabling traceability between the data element and its original supporting document or file.
    Example: 93CC828113AC439181071CB44D2C6FE5
  • Document version number
    Example: 1
  • 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
  • Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.
    Example: 93CC828113AC439181071CB44D2C6FE5
  • 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 was locked
    Example: 2025-10-16T14:30:31.892Z
  • Lock status of the data element. Acceptable Values are LOCKED, NOT_APPLICABLE
    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: LOCK
  • 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
  • validationRules
    Validation rules evaluated for this data element
  • 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
  • Locked timestamp for visit start date
    Example: 2023-01-01T09:00:00Z
  • Action taken on the visit start date value. Acceptable values are LOCKED, UNLOCKED, NEVER_LOCKED.
    Example: LOCKED
  • Year part of date
    Example: 2025
Nested Schema : clearedChildDataElements
Type: array
List of cleared child data elements
Show Source
Nested Schema : clearedLabs
Type: array
List of laboratory properties associated with the data element
Show Source
Nested Schema : validationRules
Type: array
Validation rules evaluated for this data element
Show Source
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 : ValidationRuleDto
Type: object
Validation rule details associated with a specific data element.
Show Source
  • Query identifier (UUID, 32-character uppercase hexadecimal string) generated by the validation rule.
    Example: 45B982CDC4604AF5A354AAAF7BEEB93B
  • Status of the query associated with this rule and values can be Candidate, Answered, Closed, Opened, Deleted
    Example: Opened
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) for the validation rule.
    Example: 45B982CDC4604AF5A354AAAF7BEEB93B
Nested Schema : FormsStatusResponseDto
Type: object
Form status with outer repeat hierarchy.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • 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: IN_PROGRESS
  • outerRepeats
    Outer repeat entries for this form
Nested Schema : outerRepeats
Type: array
Outer repeat entries for this form
Show Source
Nested Schema : FormsStatusOuterRepeatDto
Type: object
Outer repeat status with inner repeat entries.
Show Source
  • 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: IN_PROGRESS
  • innerRepeats
    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.
  • 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
Nested Schema : innerRepeats
Type: array
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.
Show Source
Nested Schema : FormsStatusInnerRepeatDto
Type: object
Inner repeat status for a specific outer repeat.
Show Source
  • 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: IN_PROGRESS
  • 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
  • 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
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