V3.0
put
/ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/ehrdata
Saves EHR data and returns data elements in the saved visit impacted by rule targets.
Request
Path Parameters
-
mode(required): string
Mode of the study. Accepts test, active, or training.
-
studyId(required): string
ID of the study to which the subject belongs.
Query Parameters
-
skipTargets: boolean
Skip data elements impacted by rule targets.Default Value:
true
Supported Media Types
- application/json
Root Schema : schema
Type:
objectRequest payload for saving EHR data elements for a subject in a study visit event, including context and a list of EHR form data submissions.
Show Source
-
context: object
ContextEhr
Submission context for an EHR data operation, identifying the study, subject, event, and site details.
-
forms: object
CoreDataEHRFormElementRequestDto
Represents a form definition and set of core data elements to be submitted as part of an EHR save operation.
Nested Schema : ContextEhr
Type:
objectSubmission context for an EHR data operation, identifying the study, subject, event, and site details.
Show Source
-
eventId: string
Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
2E4567890ABCDEF1234567890ABCDEF0 -
eventInstanceNum: integer
(int32)
Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.Example:
1 -
siteId: string
Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
65DFE0E1F48C4097A0F6B1F7A1F9F8C8 -
studyName(required): string
Minimum Length:
0Maximum Length:100The user-friendly name of the study.Example:Clinical Study ABC -
studyVersion(required): string
Minimum Length:
0Maximum Length:100String representing the version of the study. Helps track changes in form or study design.Example:1.0.0.0 -
subjectId: string
Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
AEBC7137B253422D8A23C8C12B8DF125 -
validateOCCData: boolean
Pass true if submitted data should be OCC validated, otherwise false.Example:
false
Nested Schema : CoreDataEHRFormElementRequestDto
Type:
objectRepresents a form definition and set of core data elements to be submitted as part of an EHR save operation.
Show Source
-
dataElements: object
CoreDataElementEhr
Represents a single EHR data element instance submitted as part of a form with supporting metadata and identifiers.
-
formId: string
Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.Example:
85B29A9062BD4C8B9584E0907A37A84A
Nested Schema : CoreDataElementEhr
Type:
objectRepresents a single EHR data element instance submitted as part of a form with supporting metadata and identifiers.
Show Source
-
comment: string
Minimum Length:
0Maximum Length:2048Any general comments for the data element instance.Example:Measured after fasting -
formSectionId: string
Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
D9876543D9876543D9876543D9876543 -
hdiId: string
Stores the ID as received from Oracle Clinical Conector (OCC). It could be different for each data element in a form, but can also be the same. Uses UUID, 32-character uppercase hexadecimal string format.Example:
C1234567C1234567C1234567C1234567 -
id: string
Primary uuid identifier for the data element instance (HEX, upper case).Example:
C1234567C1234567C1234567C1234567 -
innerRepeat: integer
(int32)
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 -
itemId: string
Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.Example:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
measureUnit: string
Unit of measurement for this value (if applicable).Example:
mg/dL -
occCodes: array
occCodes
List of OCC codes associated with this data element instance.
-
originatorId: string
An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).Example:
F4443333F4443333F4443333F4443333 -
outerRepeat: integer
(int32)
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: string
Minimum Length:
0Maximum Length:255Reason for this data entry/edit.Example:Other -
recordedDate: string
(date-time)
Calendar date/time the data was originally recorded.Example:
2023-01-01T07:00:00Z -
repeatSequenceNumber: integer
(int32)
Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.Example:
2 -
sourceUnit: string
Source units for this value.Example:
258677007 -
sourceValue: string
(date-time)
Source value for this element as provided in upstream system.Example:
2024-08-26T14:57:36.039373-07:00 -
transactionEnd: string
(date-time)
Transaction end date/time for this observation.Example:
2024-01-01T13:00:00Z -
transactionStart: string
(date-time)
Transaction start date/time for this observation.Example:
2024-01-01T12:00:00Z -
value: string
Minimum Length:
0Maximum Length:4000Measured value captured for this data element.Example:42.0 -
variableId: string
Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.Example:
E5554444E5554444E5554444E5554444 -
vendorCode: string
Minimum Length:
0Maximum Length:100Code supplied by vendor.Example:VENDOR42
Nested Schema : occCodes
Type:
arrayList of OCC codes associated with this data element instance.
Show Source
-
Array of:
string
List of OCC codes associated with this data element instance.Example:
["2.16.840.1.113883.5.50"]
Example:
[
"2.16.840.1.113883.5.50"
]Response
Supported Media Types
- application/json
200 Response
Subjects success.
Root Schema : EHRDataResponseTargetsDto
Type:
objectEHR save response with rule-target-impacted data elements.
Show Source
-
dataElements: array
dataElements
-
formsStatus: array
formsStatus
-
targetsImpactedDataElements: array
targetsImpactedDataElements
Latest read-only data elements in the saved visit referenced by rule targets.
Nested Schema : dataElements
Type:
Show Source
array-
Array of:
object DataElementDto15
Represents a single data element involved in an EHR form association request/response, with identifying and status fields.
Nested Schema : formsStatus
Type:
Show Source
array-
Array of:
object FormsStatusResponseDto
Form status with outer repeat hierarchy.
Nested Schema : targetsImpactedDataElements
Type:
arrayLatest read-only data elements in the saved visit referenced by rule targets.
Show Source
-
Array of:
object DataElementDto123
Data element with document linkage, validation rules, cleared labs and child elements, and visit start date lock metadata.
Nested Schema : DataElementDto15
Type:
objectRepresents a single data element involved in an EHR form association request/response, with identifying and status fields.
Show Source
-
comment: string
Minimum Length:
0Maximum Length:2048Comment for the data element changeExample:Captured by device -
dataFlag: string
(UUID)
Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).Example:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
dateTimeValueUTC: string
(date-time)
Date-time value in UTCExample:
2025-10-16T14:30:31.892Z -
dayValue: integer
(int32)
Day part of dateExample:
16 -
eventId: string
(UUID)
Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
ADF5A7800A954FA5B831E7B6B9CA39A9 -
eventInstanceNum: integer
(int32)
Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.Example:
1 -
floatValue: number
(decimal)
Numeric decimal valueExample:
12.34 -
formId: string
(UUID)
Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.Example:
40DB4EF4847849CCB24EFCCB71CDA436 -
formSectionId: string
(UUID)
Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
B6E0C7D5A1F3428C8B8B6A77C5E9D4AA -
freezedStatus: string
Freeze status of the data element,can have Values NOT_APPLICABLE, FROZENExample:
FROZEN -
hdiId: string
Stores the ID as received from Oracle Clinical Conector (OCC). It could be different for each data element in a form, but can also be the same. Uses UUID, 32-character uppercase hexadecimal string format.Example:
D2E9219A568740A78CC570066F56C2D6 -
hourValue: integer
(int32)
Hour part of timeExample:
14 -
id: string
(UUID)
Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data elementExample:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
innerRepeat: integer
(int32)
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 -
itemD: string
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 -
itemF: string
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 -
itemId: string
(UUID)
Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.Example:
DEADBEEFDEADBEEFDEADBEEFDEADBEEF -
itemR: string
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 -
itemType: string
Type of item represented by this data elementExample:
TEXT -
measureUnit: string
Minimum Length:
0Maximum Length:64Measurement unitExample:mg/dL -
minuteValue: integer
(int32)
Minute part of timeExample:
30 -
monthValue: integer
(int32)
Month part of dateExample:
10 -
normalizedUnitId: string
Identifier of normalized unitExample:
A78AD8C31CD843CD8B847C06C0420FF5 -
normalizedValue: string
Minimum Length:
0Maximum Length:100Normalized value if applicableExample:120 -
numValue: integer
(int32)
Numeric integer valueExample:
120 -
objectVersionNumber: number
Audit trail field that represents the version number of the data.Example:
14 -
operation: string
Indicates the type of operation performed on a data element like update, clear, insertExample:
insert -
operationType: string
Operation type on the record, can have values CREATED, MODIFIED or REMOVEDExample:
MODIFIED -
originatorId: string
(UUID)
An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).Example:
FEDCBA9876543210FEDCBA9876543210 -
outerRepeat: integer
(int32)
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 -
parentId: string
(UUID)
Identifier (UUID, 32-character uppercase hexadecimal string) of the parent data element in uppercase hex.Example:
ABCDEF1234567890ABCDEF1234567890 -
propertyId: string
Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the property.Example:
40DB4EF4847849CCB24EFCCB71CDA436 -
propertyVersionStart: string
(date-time)
The timestamp marking the beginning of the validity period for this record version within the system.Example:
2025-10-16T14:30:31.892Z -
reason: string
Minimum Length:
0Maximum Length:255Reason associated with the data element changeExample:Initial entry -
repeatFormNumber: integer
(int32)
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 -
repeatSequenceNumber: integer
(int32)
Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.Example:
1 -
rootId: string
(UUID)
Identifier of root data element in UUID, 32-character uppercase hexadecimal string.Example:
1234567890ABCDEF1234567890ABCDEF -
secondValue: integer
(int32)
Second part of timeExample:
31 -
signedStatus: string
Signature status of the data element, can have Values NOT_APPLICABLE, SIGNEDExample:
SIGNED -
siteId: string
(UUID)
Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
ABCDEF1234567890ABCDEF1234567890 -
softwareVersionNumber: number
Software version numberExample:
14 -
sourceTimeStamp: string
(date-time)
Source timestamp for this data element version.Example:
2024-03-15T10:22:11Z -
studyId: string
(UUID)
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
ABCDEF1234567890ABCDEF1234567890 -
studyName: string
Minimum Length:
0Maximum Length:100Study nameExample:STUDY-ABC -
studyVersion(required): string
Minimum Length:
0Maximum Length:100String representing the version of the study. Helps track changes in form or study design.Example:3.0.0.1 -
subjectId: string
(UUID)
Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
10F75668189F422F9A461A315D211111 -
targets: array
targets
List of display or rule targets associated with this data element
-
transactionEnd: string
(date-time)
The date and time at which the transaction processing completed.Example:
2025-10-16T14:30:31.892Z -
transactionStart: string
(date-time)
The date and time at which the transaction processing began.Example:
2025-10-16T14:30:31.892Z -
userId: string
(uuid)
Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.
-
validationFailure: string
Minimum Length:
0Maximum Length:32767Validation failure details if anyExample:Incorrect values not allowed -
validationStatus: string
Minimum Length:
0Maximum Length:25Validation status of the data element. The validation status can be null or SUCCESS.Example:SUCCESS -
value: string
Minimum Length:
0Maximum Length:4000Raw value captured for the itemExample:120 -
variableId: string
(UUID)
Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.Example:
0123456789ABCDEF0123456789ABCDEF -
vendorCode: string
Minimum Length:
0Maximum Length:100Vendor code if providedExample:VENDOR1 -
verifiedStatus: string
Verification status of the data element can have Values NOT_APPLICABLE, VERIFIEDExample:
VERIFIED -
versionEnd: string
(date-time)
End timestamp of the data element versionExample:
2025-10-16T14:30:31.892Z -
versionStart: string
(date-time)
The timestamp marking the beginning of the validity period for this record version within the system.Example:
2025-10-16T14:30:31.892Z -
yearValue: integer
(int32)
Year part of dateExample:
2025
Nested Schema : targets
Type:
arrayList of display or rule targets associated with this data element
Show Source
Example:
[
"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
]Nested Schema : FormsStatusResponseDto
Type:
objectForm status with outer repeat hierarchy.
Show Source
-
formId: string
Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.Example:
40DB4EF4847849CCB24EFCCB71CDA436 -
formStatus: string
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: array
outerRepeats
Outer repeat entries for this form
Nested Schema : outerRepeats
Type:
arrayOuter repeat entries for this form
Show Source
-
Array of:
object FormsStatusOuterRepeatDto
Outer repeat status with inner repeat entries.
Nested Schema : FormsStatusOuterRepeatDto
Type:
objectOuter repeat status with inner repeat entries.
Show Source
-
formStatus: string
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: array
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.
-
outerRepeat: integer
(int32)
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:
arrayIndicates 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
-
Array of:
object FormsStatusInnerRepeatDto
Inner repeat status for a specific outer repeat.
Nested Schema : FormsStatusInnerRepeatDto
Type:
objectInner repeat status for a specific outer repeat.
Show Source
-
formStatus: string
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 -
innerRepeat: integer
(int32)
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 -
outerRepeat: integer
(int32)
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 : DataElementDto123
Type:
objectData element with document linkage, validation rules, cleared labs and child elements, and visit start date lock metadata.
Show Source
-
affidavitCodeValue: string
Affidavit code value when affidavit appliesExample:
Electronic Signature Affidavit -
clearedChildDataElements: array
clearedChildDataElements
List of cleared child data elements
-
clearedLabs: array
clearedLabs
List of laboratory properties associated with the data element
-
comment: string
Minimum Length:
0Maximum Length:2048Comment for the data element changeExample:Captured by device -
dataEventType: string
Event type indicating data change lifecycle.Example:
FORM_RESTORED -
dataFlag: string
(UUID)
Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).Example:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
dateTimeValueUTC: string
(date-time)
Date-time value in UTCExample:
2025-10-16T14:30:31.892Z -
dayValue: integer
(int32)
Day part of dateExample:
16 -
documentId: string
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 -
documentVersion: number
Document version numberExample:
1 -
eventId: string
(UUID)
Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
ADF5A7800A954FA5B831E7B6B9CA39A9 -
eventInstanceNum: integer
(int32)
Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.Example:
1 -
floatValue: number
(decimal)
Numeric decimal valueExample:
12.34 -
formId: string
(UUID)
Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.Example:
40DB4EF4847849CCB24EFCCB71CDA436 -
formSectionId: string
(UUID)
Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
B6E0C7D5A1F3428C8B8B6A77C5E9D4AA -
formStatus: string
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 -
freezedStatus: string
Freeze status of the data element,can have Values NOT_APPLICABLE, FROZENExample:
FROZEN -
hdiId: string
Stores the ID as received from Oracle Clinical Conector (OCC). It could be different for each data element in a form, but can also be the same. Uses UUID, 32-character uppercase hexadecimal string format.Example:
93CC828113AC439181071CB44D2C6FE5 -
hourValue: integer
(int32)
Hour part of timeExample:
14 -
id: string
(UUID)
Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data elementExample:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
innerRepeat: integer
(int32)
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 -
itemD: string
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 -
itemF: string
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 -
itemId: string
(UUID)
Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.Example:
DEADBEEFDEADBEEFDEADBEEFDEADBEEF -
itemR: string
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 -
itemType: string
Type of item represented by this data elementExample:
TEXT -
lockedDateTime: string
(date-time)
Timestamp when the data element was lockedExample:
2025-10-16T14:30:31.892Z -
lockedStatus: string
Lock status of the data element. Acceptable Values are LOCKED, NOT_APPLICABLEExample:
LOCKED -
measureUnit: string
Minimum Length:
0Maximum Length:64Measurement unitExample:mg/dL -
minuteValue: integer
(int32)
Minute part of timeExample:
30 -
monthValue: integer
(int32)
Month part of dateExample:
10 -
normalizedUnitId: string
Identifier of normalized unitExample:
A78AD8C31CD843CD8B847C06C0420FF5 -
normalizedValue: string
Minimum Length:
0Maximum Length:100Normalized value if applicableExample:120 -
numValue: integer
(int32)
Numeric integer valueExample:
120 -
objectVersionNumber: number
Audit trail field that represents the version number of the data.Example:
14 -
operationType: string
Operation type on the record, can have values CREATED, MODIFIED or REMOVEDExample:
LOCK -
originatorId: string
(UUID)
An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).Example:
FEDCBA9876543210FEDCBA9876543210 -
outerRepeat: integer
(int32)
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 -
parentId: string
(UUID)
Identifier (UUID, 32-character uppercase hexadecimal string) of the parent data element in uppercase hex.Example:
ABCDEF1234567890ABCDEF1234567890 -
propertyId: string
Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the property.Example:
40DB4EF4847849CCB24EFCCB71CDA436 -
propertyVersionStart: string
(date-time)
The timestamp marking the beginning of the validity period for this record version within the system.Example:
2025-10-16T14:30:31.892Z -
reason: string
Minimum Length:
0Maximum Length:255Reason associated with the data element changeExample:Initial entry -
repeatFormNumber: integer
(int32)
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 -
repeatSequenceNumber: integer
(int32)
Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.Example:
1 -
rootId: string
(UUID)
Identifier of root data element in UUID, 32-character uppercase hexadecimal string.Example:
1234567890ABCDEF1234567890ABCDEF -
secondValue: integer
(int32)
Second part of timeExample:
31 -
signedStatus: string
Signature status of the data element, can have Values NOT_APPLICABLE, SIGNEDExample:
SIGNED -
siteId: string
(UUID)
Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
ABCDEF1234567890ABCDEF1234567890 -
softwareVersionNumber: number
Software version numberExample:
14 -
sourceTimeStamp: string
(date-time)
Timestamp when the data element was captured in the source systemExample:
2025-10-16T14:30:31.892Z -
studyId: string
(UUID)
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
ABCDEF1234567890ABCDEF1234567890 -
studyName: string
Minimum Length:
0Maximum Length:100Study nameExample:STUDY-ABC -
studyVersion(required): string
Minimum Length:
0Maximum Length:100String representing the version of the study. Helps track changes in form or study design.Example:3.0.0.1 -
subjectId: string
(UUID)
Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.Example:
10F75668189F422F9A461A315D211111 -
targets: array
targets
List of display or rule targets associated with this data element
-
transactionEnd: string
(date-time)
The date and time at which the transaction processing completed.Example:
2025-10-16T14:30:31.892Z -
transactionStart: string
(date-time)
The date and time at which the transaction processing began.Example:
2025-10-16T14:30:31.892Z -
userId: string
(uuid)
Unique user identifier representing the clinicalone user who modified or interacted with the subject record. Uses UUID in a 32-character uppercase hexadecimal string format.
-
validationFailure: string
Minimum Length:
0Maximum Length:32767Validation failure details if anyExample:Incorrect values not allowed -
validationRules: array
validationRules
Validation rules evaluated for this data element
-
validationStatus: string
Minimum Length:
0Maximum Length:25Validation status of the data element. The validation status can be null or SUCCESS.Example:SUCCESS -
value: string
Minimum Length:
0Maximum Length:4000Raw value captured for the itemExample:120 -
variableId: string
(UUID)
Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.Example:
0123456789ABCDEF0123456789ABCDEF -
vendorCode: string
Minimum Length:
0Maximum Length:100Vendor code if providedExample:VENDOR1 -
verifiedStatus: string
Verification status of the data element can have Values NOT_APPLICABLE, VERIFIEDExample:
VERIFIED -
versionEnd: string
(date-time)
End timestamp of the data element versionExample:
2025-10-16T14:30:31.892Z -
versionStart: string
(date-time)
The timestamp marking the beginning of the validity period for this record version within the system.Example:
2025-10-16T14:30:31.892Z -
visitStartDateLockedDateTime: string
(date-time)
Locked timestamp for visit start dateExample:
2023-01-01T09:00:00Z -
visitStartDateLockedStatus: string
Action taken on the visit start date value. Acceptable values are LOCKED, UNLOCKED, NEVER_LOCKED.Example:
LOCKED -
yearValue: integer
(int32)
Year part of dateExample:
2025
Nested Schema : clearedChildDataElements
Type:
arrayList of cleared child data elements
Show Source
-
Array of:
object DataElementDto123
Data element with document linkage, validation rules, cleared labs and child elements, and visit start date lock metadata.
Nested Schema : clearedLabs
Type:
arrayList of laboratory properties associated with the data element
Show Source
-
Array of:
object DCPropertyDto
Laboratory property details associated with a data element.
Nested Schema : targets
Type:
arrayList of display or rule targets associated with this data element
Show Source
Example:
[
"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE5",
"93CC828113AC439181071CB44D2C6FE5.93CC828113AC439181071CB44D2C6FE7"
]Nested Schema : validationRules
Type:
arrayValidation rules evaluated for this data element
Show Source
-
Array of:
object ValidationRuleDto
Validation rule details associated with a specific data element.
Nested Schema : DCPropertyDto
Type:
objectLaboratory property details associated with a data element.
Show Source
-
comment: string
CommentExample:
Cleared due to verified lab correction -
id: string
Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the recordExample:
1BC29B36F5D64B1B95F4BDBBCEA481BE -
labId: string
Unique identifier (UUID, 32-character uppercase hexadecimal string) of the lab normals record. Include for update requests; omit for new create.Example:
40DB4EF4847849CCB24EFCCB71CDA436 -
outerRepeat: integer
(int32)
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: string
ReasonExample:
Data cleared by monitor
Nested Schema : ValidationRuleDto
Type:
objectValidation rule details associated with a specific data element.
Show Source
-
queryId: string
Query identifier (UUID, 32-character uppercase hexadecimal string) generated by the validation rule.Example:
45B982CDC4604AF5A354AAAF7BEEB93B -
queryStatus: string
Status of the query associated with this rule and values can be Candidate, Answered, Closed, Opened, DeletedExample:
Opened -
ruleId: string
Unique Identifier (UUID, 32-character uppercase hexadecimal string) for the validation rule.Example:
45B982CDC4604AF5A354AAAF7BEEB93B
400 Response
Bad request.
Root Schema : DcsResponse
Type:
Show Source
object-
errorData: object
ErrorResponseData
Title:
ErrorResponseDataError Response Details Information -
result: object
result
-
status: string
-
version: integer
(int32)
Nested Schema : ErrorResponseData
Type:
objectTitle:
ErrorResponseDataError Response Details Information
Show Source
-
details: object
Object
Title:
ObjectObject with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003 -
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : result
Type:
objectNested Schema : Object
Type:
objectTitle:
ObjectObject with error details information.
Example:
{
"field":"studyId",
"reason":"Invalid value"
}