[Deprecated]: V1
get
/ec-dc-svc/rest/v1/studies/{studyId}/{mode}/subjects/odmsubmit/clinicaldata/{subjectId}
Deprecated: Returns history for the specified subject as multiple subject records for each change that was made, including current details.
Rights: DataCaptureSubjectGet and SubjectDataClassificationGet. API has been deprecated and moved to DIS (Data Integration Service), Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/odmsubmit/clinicaldata/{subjectId}
Rights: DataCaptureSubjectGet and SubjectDataClassificationGet. API has been deprecated and moved to DIS (Data Integration Service), Path: /ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/odmsubmit/clinicaldata/{subjectId}
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training.Example:
test -
studyId(required): string
Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.Example:
ABCDEF1234567890ABCDEF1234567890 -
subjectId(required): string(uuid)
ID of the subject for whom you want to retrieve history.
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Subjects success.
Root Schema : schema
Type:
Show Source
array-
Array of:
object ClinicalData1
ODM ClinicalData section containing study OID, metadata version OID, and lists of subject data, audit records, signatures, and annotations.
Nested Schema : ClinicalData1
Type:
objectODM ClinicalData section containing study OID, metadata version OID, and lists of subject data, audit records, signatures, and annotations.
Show Source
-
Annotations: array
Annotations
List of annotations attached to the clinical data
-
auditRecords: array
auditRecords
List of audit records associated with clinical data
-
MetaDataVersionOID: string
Metadata version OID associated with the study designExample:
c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29 -
Signatures: array
Signatures
List of digital signatures applied to the clinical data
-
StudyOID: string
Study OID for which this clinical data appliesExample:
c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29 -
subjectData: array
subjectData
List of subject-level clinical data records
Nested Schema : Annotations
Type:
arrayList of annotations attached to the clinical data
Show Source
-
Array of:
object Annotations1
Container for a list of ODM Annotation entries.
Nested Schema : auditRecords
Type:
arrayList of audit records associated with clinical data
Show Source
-
Array of:
object AuditRecords1
Container for a list of ODM audit record entries.
Nested Schema : Signatures
Type:
arrayList of digital signatures applied to the clinical data
Show Source
-
Array of:
object Signatures1
Container for a list of ODM Signature entries.
Nested Schema : subjectData
Type:
arrayList of subject-level clinical data records
Show Source
-
Array of:
object SubjectData1
ODM SubjectData structure including audit, signature, references and event data for a subject.
Nested Schema : Annotations1
Type:
objectContainer for a list of ODM Annotation entries.
Show Source
-
annotation: array
annotation
List of Annotation entries associated to the ODM structure.
Nested Schema : annotation
Type:
arrayList of Annotation entries associated to the ODM structure.
Show Source
-
Array of:
object Annotation2
Note, query, or other annotation associated with a data point, including flags and a comment.
Nested Schema : Annotation2
Type:
objectNote, query, or other annotation associated with a data point, including flags and a comment.
Show Source
-
comment: object
Comment2
Comment DTO
-
flag: object
flag
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
-
id: string
Annotation identifier unique within the context.Example:
475454D6B7F247C88D401DB25CA2C7D2 -
seqNum: integer
(int64)
Sequence number ordering annotations within the same context.Example:
1 -
transactionType: string
Operation represented by this annotation (Example values are- INSERT, UPDATE, DELETE, REMOVE,UPSERT,CONTEXT).Example:
INSERT
Nested Schema : Comment2
Type:
objectComment DTO
Show Source
-
sponsorOrSite: string
Comment origin (Sponsor or Site)Example:
Site -
value: string
CommentExample:
User-entered comment
Nested Schema : flag
Type:
objectAnnotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
-
FlagType: object
FlagType1
Flag type
-
FlagValue: object
FlagValue1
Flag value
Nested Schema : FlagType1
Type:
objectFlag type
Show Source
-
codeListOID: string
CodeList OIDExample:
c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29 -
value: string
Flag display valueExample:
Y
Example:
{
"flagOID":"QUERY"
}Nested Schema : FlagValue1
Type:
objectFlag value
Show Source
-
codeListOID: string
CodeList OIDExample:
c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29 -
value: string
Flag valueExample:
Y
Example:
{
"value":"Review"
}Nested Schema : AuditRecords1
Type:
objectContainer for a list of ODM audit record entries.
Show Source
-
auditRecord: array
auditRecord
List of audit records associated with the subject or form.
Nested Schema : auditRecord
Type:
arrayList of audit records associated with the subject or form.
Show Source
-
Array of:
object AuditRecord100
Audit trail entry describing who performed a change, where it occurred, when it happened, and the justification.
Nested Schema : AuditRecord100
Type:
objectAudit trail entry describing who performed a change, where it occurred, when it happened, and the justification.
Show Source
-
dateTimeStamp: object
DateTimeStamp1
Date/time stamp value with formatted representation.
-
id: string
(identifier)
Audit record identifierExample:
AUD1 -
locationRef: object
LocationRef1
Reference to a study/site location for an ODM User.
-
reasonForChange: object
ReasonForChange1
Explanation provided to justify why a data value was created or modified.
-
sourceID: object
SourceID1
Identifier of the originating system or source that provided the data.
-
userRef: object
UserRef10
Reference to a user within the study.
Nested Schema : DateTimeStamp1
Type:
objectDate/time stamp value with formatted representation.
Show Source
-
formattedValue: string
Human-readable formatted date/time valueExample:
29-Oct-2025 20:24:09 India Time ( Asia/Kolkata ) -
value: string
Raw date/time valueExample:
2025-10-29T14:54:09
Nested Schema : LocationRef1
Type:
objectReference to a study/site location for an ODM User.
Show Source
-
LocationOID: string
OID/ID for the associated location.Example:
475454D6B7F247C88D401DB25CA2C7D2
Nested Schema : ReasonForChange1
Type:
objectExplanation provided to justify why a data value was created or modified.
Show Source
-
Value: string
Free-text reason describing the change.Example:
Correction of data entry error
Nested Schema : SourceID1
Type:
objectIdentifier of the originating system or source that provided the data.
Show Source
-
Value: string
(identifier)
Source identifier value (e.g., system code or external app ID).Example:
SYS
Nested Schema : UserRef10
Type:
objectReference to a user within the study.
Show Source
-
UserOID: string
(oid)
OID of the referenced userExample:
c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29
Nested Schema : Signatures1
Type:
objectContainer for a list of ODM Signature entries.
Show Source
-
signature: array
signature
List of signature entries associated with the ODM structure.
Nested Schema : signature
Type:
arrayList of signature entries associated with the ODM structure.
Show Source
-
Array of:
object Signature1
Digital signature record including signer, location, timestamp, and cryptographic binding manifest.
Nested Schema : Signature1
Type:
objectDigital signature record including signer, location, timestamp, and cryptographic binding manifest.
Show Source
-
CryptoBindingManifest: object
CryptoBindingManifest10
Cryptographic binding manifest that ties the signature to the signed payload.
-
DateTimeStamp: object
DateTimeStamp1
Date/time stamp value with formatted representation.
-
ID: string
(identifier)
Signature identifierExample:
SIG123 -
LocationRef: object
LocationRef1
Reference to a study/site location for an ODM User.
-
SignatureRef: object
SignatureRef1
Reference to a signature object used to approve or verify data.
-
UserRef: object
UserRef10
Reference to a user within the study.
Nested Schema : CryptoBindingManifest10
Type:
objectCryptographic binding manifest that ties the signature to the signed payload.
Show Source
-
value: string
Base64-encoded manifest payload.Example:
VGhpcyBpcyBhIG1hbmlmZXN0IHBheWxvYWQ=
Nested Schema : SignatureRef1
Type:
objectReference to a signature object used to approve or verify data.
Show Source
-
SignatureOID: string
Identifier (OID) of the referenced signature.Example:
SIG-0001
Nested Schema : SubjectData1
Type:
objectODM SubjectData structure including audit, signature, references and event data for a subject.
Show Source
-
annotation: array
annotation
List of annotations (queries, notes, flags) linked to the subject data.
-
auditRecord: object
AuditRecord100
Audit trail entry describing who performed a change, where it occurred, when it happened, and the justification.
-
initials: string
Subject initials if captured.Example:
JD -
investigatorRef: object
InvestigatorRef1
Reference to an investigator user participating in the study.
-
signature: object
Signature1
Digital signature record including signer, location, timestamp, and cryptographic binding manifest.
-
siteRef: object
SiteRef10
Reference to a study site/location.
-
studyEventData: array
studyEventData
All scheduled or unscheduled visit/event data for the subject.
-
subjectHistory: array
subjectHistory
Chronological history of key actions for this subject.
-
subjectKey: string
(identifier)
Unique key of the subject within the study/site.Example:
SUBJ-0001 -
transactionType: string
Operation represented by this payload, such as Insert, Update, or Delete.Example:
Update -
transferData: array
transferData
Data transfer records for this subject (e.g., imports or system migrations).
Nested Schema : annotation
Type:
arrayList of annotations (queries, notes, flags) linked to the subject data.
Show Source
-
Array of:
object Annotation2
Note, query, or other annotation associated with a data point, including flags and a comment.
Nested Schema : InvestigatorRef1
Type:
objectReference to an investigator user participating in the study.
Show Source
-
userOID: string
Identifier (OID) of the investigator user within the study.Example:
c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29
Nested Schema : SiteRef10
Type:
objectReference to a study site/location.
Show Source
-
LocationOID: string
(oid)
Identifier (OID) of the site location.Example:
475454D6B7F247C88D401DB25CA2C7D2 -
Name: string
Human-readable site name.Example:
475454D6B7F247C88D401DB25CA2C7D2
Nested Schema : studyEventData
Type:
arrayAll scheduled or unscheduled visit/event data for the subject.
Show Source
-
Array of:
object StudyEventData1
Subject visit or study event data block including forms, annotations and references.
Nested Schema : subjectHistory
Type:
arrayChronological history of key actions for this subject.
Show Source
-
Array of:
object History1
Historical record describing an action performed on an ODM entity, with optional details and timestamp.
Nested Schema : transferData
Type:
arrayData transfer records for this subject (e.g., imports or system migrations).
Show Source
-
Array of:
object TransferData1
Subject transfer details between sites
Nested Schema : StudyEventData1
Type:
objectSubject visit or study event data block including forms, annotations and references.
Show Source
-
annotation: array
annotation
Annotations (queries, comments, flags) on this study event.
-
auditRecord: object
AuditRecord100
Audit trail entry describing who performed a change, where it occurred, when it happened, and the justification.
-
EventHistory: array
EventHistory
History of actions performed on this study event.
-
formData: array
formData
Forms captured within this study event.
-
repeatingFormSummary: object
RepeatingFormSummary1
Summary container for sets of repeating forms within a study event.
-
signature: object
Signature1
Digital signature record including signer, location, timestamp, and cryptographic binding manifest.
-
studyEventOID: string
(oid)
Identifier (OID) of the study event definition.Example:
SE.VISIT1 -
studyEventRepeatKey: string
Repeat key when the same study event occurs multiple times.Example:
1
Nested Schema : annotation
Type:
arrayAnnotations (queries, comments, flags) on this study event.
Show Source
-
Array of:
object Annotation2
Note, query, or other annotation associated with a data point, including flags and a comment.
Nested Schema : EventHistory
Type:
arrayHistory of actions performed on this study event.
Show Source
-
Array of:
object History1
Historical record describing an action performed on an ODM entity, with optional details and timestamp.
Example:
[
{
"action":"Locked",
"actionDate":"2025-11-01T14:00:00Z"
}
]Nested Schema : formData
Type:
arrayForms captured within this study event.
Show Source
-
Array of:
object FormData10
Data captured for a single form within a study event, including items, annotations, signatures, and status.
Nested Schema : RepeatingFormSummary1
Type:
objectSummary container for sets of repeating forms within a study event.
Show Source
-
repeatingFormData: array
repeatingFormData
Collection of repeating form data entries.
Nested Schema : History1
Type:
objectHistorical record describing an action performed on an ODM entity, with optional details and timestamp.
Show Source
-
action: string
Action taken on the entity.Example:
Verification -
actionDate: string
(date-time)
Timestamp when the action occurred (ISO 8601).Example:
2025-11-01T14:00:00Z -
details: array
details
Additional details about the action.
Nested Schema : details
Type:
arrayAdditional details about the action.
Show Source
-
Array of:
string
Additional details about the action.Example:
["Verified by Data Manager","No discrepancies found"]
Example:
[
"Verified by Data Manager",
"No discrepancies found"
]Nested Schema : FormData10
Type:
objectData captured for a single form within a study event, including items, annotations, signatures, and status.
Show Source
-
Annotation: array
Annotation
Annotations (queries, notes, flags) for this form.
-
archiveLayoutRef: object
ArchiveLayoutRef1
Archive layout reference
-
AuditRecord: object
AuditRecord100
Audit trail entry describing who performed a change, where it occurred, when it happened, and the justification.
-
FormOID: string
Identifier (OID) of the form definition.Example:
c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29 -
FormRepeatKey: string
Repeat key when the same form occurs multiple times within an event.Example:
1 -
FormStatus: string
System-specific form status.Example:
LOCKED -
ItemGroupData: array
ItemGroupData
Groups of item data contained in this form.
-
NotDoneValue: string
Reason/value indicating form was not performed.Example:
SUBJECT_UNAVAILABLE -
signature: object
Signature1
Digital signature record including signer, location, timestamp, and cryptographic binding manifest.
-
Signatures: object
Signatures1
Container for a list of ODM Signature entries.
-
Status: string
High-level status of the form (e.g., In Progress, Completed).Example:
Completed -
TitleAddendum: string
Additional title information for display.Example:
Follow-up Visit -
TransactionType: string
Operation represented by this annotation (Example values are- INSERT, UPDATE, DELETE, REMOVE,UPSERT,CONTEXT).Example:
Update
Nested Schema : Annotation
Type:
arrayAnnotations (queries, notes, flags) for this form.
Show Source
-
Array of:
object Annotation2
Note, query, or other annotation associated with a data point, including flags and a comment.
Nested Schema : ArchiveLayoutRef1
Type:
objectArchive layout reference
Show Source
-
archiveLayoutOID: string
Archive Layout OIDExample:
c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29
Nested Schema : ItemGroupData
Type:
arrayGroups of item data contained in this form.
Show Source
-
Array of:
object ItemGroupData1
Data captured for a Item Group
Nested Schema : ItemGroupData1
Type:
objectData captured for a Item Group
Show Source
-
annotation: object
annotation
Note, query, or other annotation associated with a data point, including flags and a comment.
-
auditRecord: object
AuditRecord100
Audit trail entry describing who performed a change, where it occurred, when it happened, and the justification.
-
itemGroupOID: string
OID for this item groupExample:
c419c414-a0de-4ee4-a138-3b072aa1a00f.1_8_0_29 -
itemGroupRepeatKey: string
Repeat key for this groupExample:
RPT1 -
items: object
items
Data captured for a Item
-
signature: object
Signature1
Digital signature record including signer, location, timestamp, and cryptographic binding manifest.
-
transactionType: string
Allowed Values:
[ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]Transaction type for the groupExample:INSERT
Nested Schema : annotation
Type:
objectNote, query, or other annotation associated with a data point, including flags and a comment.
Show Source
-
comment: object
Comment2
Comment DTO
-
flag: object
flag
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
-
id: string
Annotation identifier unique within the context.Example:
475454D6B7F247C88D401DB25CA2C7D2 -
seqNum: integer
(int64)
Sequence number ordering annotations within the same context.Example:
1 -
transactionType: string
Operation represented by this annotation (Example values are- INSERT, UPDATE, DELETE, REMOVE,UPSERT,CONTEXT).Example:
INSERT
Nested Schema : items
Type:
objectData captured for a Item
Show Source
-
Annotation: object
Annotation
Note, query, or other annotation associated with a data point, including flags and a comment.
-
AuditRecord: object
AuditRecord100
Audit trail entry describing who performed a change, where it occurred, when it happened, and the justification.
-
DocumentId: string
Document ID referenceExample:
475454D6B7F247C88D401DB25CA2C7D2 -
DocumentVersion: number
Document versionExample:
1 -
ItemOID: string
OID of the itemExample:
33caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29 -
MeasurementUnitRef: object
MeasurementUnitRef1
Data captured for a Measurement Unit
-
NotDone: string
Whether item is not done (0 or 1)Example:
0 -
ParentItemOID: string
OID of parent itemExample:
475454D6B7F247C88D401DB25CA2C7D2 -
SelectedCodeListItemsType: string
Selected code list items typeExample:
CODE_A -
Signature: object
Signature1
Digital signature record including signer, location, timestamp, and cryptographic binding manifest.
-
TransactionType: string
Allowed Values:
[ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]Transaction type- INSERT, UPDATE, REMOVE, UPSERT or CONTEXTExample:UPDATE -
Value: string
Value for this itemExample:
130
Nested Schema : flag
Type:
objectAnnotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
-
FlagType: object
FlagType1
Flag type
-
FlagValue: object
FlagValue1
Flag value
Nested Schema : Annotation
Type:
objectNote, query, or other annotation associated with a data point, including flags and a comment.
Show Source
-
comment: object
Comment2
Comment DTO
-
flag: object
flag
Annotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
-
id: string
Annotation identifier unique within the context.Example:
475454D6B7F247C88D401DB25CA2C7D2 -
seqNum: integer
(int64)
Sequence number ordering annotations within the same context.Example:
1 -
transactionType: string
Operation represented by this annotation (Example values are- INSERT, UPDATE, DELETE, REMOVE,UPSERT,CONTEXT).Example:
INSERT
Nested Schema : MeasurementUnitRef1
Type:
objectData captured for a Measurement Unit
Show Source
-
MeasurementUnitOID: string
OID of the referenced measurement unitExample:
33caf3cb-1df6-4df5-a353-a337cbe6b50a.1_8_0_29
Nested Schema : flag
Type:
objectAnnotation flag consisting of a type and value to classify or qualify data (e.g., Query, Review Required).
Show Source
-
FlagType: object
FlagType1
Flag type
-
FlagValue: object
FlagValue1
Flag value
Nested Schema : repeatingFormData
Type:
arrayCollection of repeating form data entries.
Show Source
-
Array of:
object RepeatingFormData1
A single repeating form instance including headers and rows of item data.
Nested Schema : RepeatingFormData1
Type:
objectA single repeating form instance including headers and rows of item data.
Show Source
-
formHeader: array
formHeader
Header section for the repeating form instance (metadata about the form).
-
formID: string
Human-readable identifier for the form instance.Example:
475454D6B7F247C88D401DB25CA2C7D2 -
formOID: string
(oid)
Identifier (OID) of the repeating form definition.Example:
95dc21fd-e522-4cc6-9d94-92ece0f25120.1_8_0_29 -
Row: array
Row
Rows comprising items captured in this form instance.
-
summaryNote: string
Optional summary or note for the form instance.Example:
Patient reported mild headache.
Nested Schema : formHeader
Type:
arrayHeader section for the repeating form instance (metadata about the form).
Show Source
-
Array of:
object FormHeader1
Header metadata for a form instance, including basic identity and display information.
Nested Schema : Row
Type:
arrayRows comprising items captured in this form instance.
Show Source
-
Array of:
object Row2
A single row within a repeating form instance containing associated forms and item data.
Nested Schema : FormHeader1
Type:
objectHeader metadata for a form instance, including basic identity and display information.
Show Source
-
itemset: string
Indicates whether this header represents an itemset.Example:
false -
itemsetHeader: string
Optional label or identifier for the itemset header.Example:
Vital Signs Panel -
name: string
Human-readable form name.Example:
Vital Signs -
oid: string
(oid)
Object Identifier for the form (matches the form definition OID).Example:
FORM.VITALS
Nested Schema : Row2
Type:
objectA single row within a repeating form instance containing associated forms and item data.
Show Source
-
associated: boolean
Indicates whether the row is associated to another form or entity.Example:
true -
associatedFormList: array
associatedFormList
List of forms associated with this row, if any.
-
deleted: string
Marks the row as logically deleted.Example:
false -
formIndex: string
Index value used to order or group rows.Example:
1 -
item: array
item
Items captured within this row.
-
rowNo: string
Row sequence identifier within the repeating form.Example:
1
Nested Schema : associatedFormList
Type:
arrayList of forms associated with this row, if any.
Show Source
-
Array of:
object AssociatedFormList1
Associated form details including visit and audit metadata
Nested Schema : item
Type:
arrayItems captured within this row.
Show Source
-
Array of:
object Item1
ODM Item instance with value and identifiers
Nested Schema : AssociatedFormList1
Type:
objectAssociated form details including visit and audit metadata
Show Source
-
auditTrail: array
auditTrail
List of audit trail entries
-
deleted: boolean
Indicates whether the associated form is deletedExample:
false -
formIndex: number
Index of the form within the visitExample:
1 -
formName: string
Human readable name of the formExample:
Medical History -
formOID: string
Form IdentifierExample:
5ca47933-ab3c-4018-86c2-c6b77d2c5104.1_8_0_29 -
instanceNumber: integer
(int64)
Instance number of the unscheduled visitExample:
1 -
visitIndex: number
Index of the visit within the scheduleExample:
1 -
visitName: string
Human readable name of the visitExample:
Visit 1 -
visitOID: string
Visit IdentifierExample:
6ca47933-ab3c-4018-86c2-c6b77d2c5104.1_8_0_29
Nested Schema : auditTrail
Type:
arrayList of audit trail entries
Show Source
-
Array of:
object AuditTrail1
Audit trail entry with timestamp, user, deletion status and note
Nested Schema : AuditTrail1
Type:
objectAudit trail entry with timestamp, user, deletion status and note
Show Source
-
dateTimeStamp: string
Date and time of the change in ISO-8601 formatExample:
2025-01-01T12:34:56Z -
deleted: boolean
Indicates whether the record was deleted as part of this changeExample:
false -
note: string
Optional note associated with the changeExample:
Correction applied -
user: string
User who performed the actionExample:
john.doe
Nested Schema : Item1
Type:
objectODM Item instance with value and identifiers
Show Source
-
itemset: boolean
Indicates whether this item represents an itemset (grid or repeating values).Example:
false -
itemsetRows: string
Row identifiers or count for the itemset when itemset is true.Example:
1 -
oid: string
Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.Example:
3F2504E04F8911D39A0C0305E82C3301 -
value: 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:
SAMPLE_VALUE
Nested Schema : TransferData1
Type:
objectSubject transfer details between sites
Show Source
-
fromSiteName: string
Name of the site the subject is transferred fromExample:
Previous Site Name -
toSiteName: string
Name of the site the subject is transferred toExample:
New Site Name -
transferDate: string
Date when the subject transfer occurredExample:
2023-12-31