Jump to

• Request
• Response

Get Clinical Data which is part of ODMSubmit

get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/odmsubmit/clinicaldata/{subjectId}

Returns history for the specified subject as multiple subject records for each change that was made, including current details. Rights: DataCaptureSubjectGet and SubjectDataClassificationGet.

Request

Path Parameters

• subjectId(required): string(uuid)
  ID of the subject for whom you want to retrieve history.

Query Parameters

• date: string(date-time)
• siteId: string(uuid)

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Subjects success.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object ClinicalData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ClinicalData"
    }
}

Nested Schema : ClinicalData

Type: object

Show Source

• Annotations: array Annotations
• AuditRecords: array AuditRecords
• MetaDataVersionOID: string
• Signatures: array Signatures
• StudyOID: string
• SubjectData: array SubjectData

{
    "type":"object",
    "properties":{
        "SubjectData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SubjectData"
            }
        },
        "AuditRecords":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditRecords"
            }
        },
        "Signatures":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Signatures"
            }
        },
        "Annotations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotations"
            }
        },
        "StudyOID":{
            "type":"string"
        },
        "MetaDataVersionOID":{
            "type":"string"
        }
    }
}

Nested Schema : Annotations

Type: array

Show Source

• Array of: object Annotations

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotations"
    }
}

Nested Schema : AuditRecords

Type: array

Show Source

• Array of: object AuditRecords

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AuditRecords"
    }
}

Nested Schema : Signatures

Type: array

Show Source

• Array of: object Signatures

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Signatures"
    }
}

Nested Schema : SubjectData

Type: array

Show Source

• Array of: object SubjectData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SubjectData"
    }
}

Nested Schema : Annotations

Type: object

Show Source

• Annotation: array Annotation

{
    "type":"object",
    "properties":{
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : Annotation

Type: object

Show Source

• Comment: object Comment
• Flag: array Flag
• ID: string
• SeqNum: integer
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

{
    "type":"object",
    "properties":{
        "Comment":{
            "$ref":"#/components/schemas/Comment"
        },
        "Flag":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Flag"
            }
        },
        "SeqNum":{
            "type":"integer"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : Comment

Type: object

Show Source

• SponsorOrSite: string
  Allowed Values: [ "SPONSOR", "SITE" ]
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "SponsorOrSite":{
            "type":"string",
            "enum":[
                "SPONSOR",
                "SITE"
            ]
        }
    }
}

Nested Schema : Flag

Type: array

Show Source

• Array of: object Flag

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Flag"
    }
}

Nested Schema : Flag

Type: object

Show Source

• FlagType: object FlagType
• FlagValue: object FlagValue

{
    "type":"object",
    "properties":{
        "FlagValue":{
            "$ref":"#/components/schemas/FlagValue"
        },
        "FlagType":{
            "$ref":"#/components/schemas/FlagType"
        }
    }
}

Nested Schema : FlagType

Type: object

Show Source

• CodeListOID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "CodeListOID":{
            "type":"string"
        }
    }
}

Nested Schema : FlagValue

Type: object

Show Source

• CodeListOID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "CodeListOID":{
            "type":"string"
        }
    }
}

Nested Schema : AuditRecords

Type: object

Show Source

• AuditRecord: array AuditRecord

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditRecord"
            }
        }
    }
}

Nested Schema : AuditRecord

Type: array

Show Source

• Array of: object AuditRecord

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AuditRecord"
    }
}

Nested Schema : AuditRecord

Type: object

Show Source

• DateTimeStamp: object DateTimeStamp
• ID: string
• LocationRef: object LocationRef
• ReasonForChange: object ReasonForChange
• SourceID: object SourceID
• UserRef: object UserRef

{
    "type":"object",
    "properties":{
        "UserRef":{
            "$ref":"#/components/schemas/UserRef"
        },
        "LocationRef":{
            "$ref":"#/components/schemas/LocationRef"
        },
        "DateTimeStamp":{
            "$ref":"#/components/schemas/DateTimeStamp"
        },
        "ReasonForChange":{
            "$ref":"#/components/schemas/ReasonForChange"
        },
        "SourceID":{
            "$ref":"#/components/schemas/SourceID"
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : DateTimeStamp

Type: object

Show Source

• FormattedValue: string
• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        },
        "FormattedValue":{
            "type":"string"
        }
    }
}

Nested Schema : LocationRef

Type: object

Show Source

• LocationOID: string

{
    "type":"object",
    "properties":{
        "LocationOID":{
            "type":"string"
        }
    }
}

Nested Schema : ReasonForChange

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : SourceID

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : UserRef

Type: object

Show Source

• UserOID: string

{
    "type":"object",
    "properties":{
        "UserOID":{
            "type":"string"
        }
    }
}

Nested Schema : Signatures

Type: object

Show Source

• Signature: array Signature

{
    "type":"object",
    "properties":{
        "Signature":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Signature"
            }
        }
    }
}

Nested Schema : Signature

Type: array

Show Source

• Array of: object Signature

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Signature"
    }
}

Nested Schema : Signature

Type: object

Show Source

• CryptoBindingManifest: object CryptoBindingManifest
• DateTimeStamp: object DateTimeStamp
• ID: string
• LocationRef: object LocationRef
• SignatureRef: object SignatureRef
• UserRef: object UserRef

{
    "type":"object",
    "properties":{
        "UserRef":{
            "$ref":"#/components/schemas/UserRef"
        },
        "LocationRef":{
            "$ref":"#/components/schemas/LocationRef"
        },
        "SignatureRef":{
            "$ref":"#/components/schemas/SignatureRef"
        },
        "DateTimeStamp":{
            "$ref":"#/components/schemas/DateTimeStamp"
        },
        "CryptoBindingManifest":{
            "$ref":"#/components/schemas/CryptoBindingManifest"
        },
        "ID":{
            "type":"string"
        }
    }
}

Nested Schema : CryptoBindingManifest

Type: object

Show Source

• Value: string

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : SignatureRef

Type: object

Show Source

• SignatureOID: string

{
    "type":"object",
    "properties":{
        "SignatureOID":{
            "type":"string"
        }
    }
}

Nested Schema : SubjectData

Type: object

Show Source

• Annotation: array Annotation
• AuditRecord: object AuditRecord
• Initials: string
• InvestigatorRef: object InvestigatorRef
• Signature: object Signature
• SiteRef: object SiteRef
• StudyEventData: array StudyEventData
• SubjectHistory: array SubjectHistory
• SubjectKey: string
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
• TransferData: array TransferData

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "InvestigatorRef":{
            "$ref":"#/components/schemas/InvestigatorRef"
        },
        "SiteRef":{
            "$ref":"#/components/schemas/SiteRef"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "StudyEventData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyEventData"
            }
        },
        "SubjectKey":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "Initials":{
            "type":"string"
        },
        "TransferData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TransferData"
            }
        },
        "SubjectHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/History"
            }
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : InvestigatorRef

Type: object

Show Source

• UserOID: string

{
    "type":"object",
    "properties":{
        "UserOID":{
            "type":"string"
        }
    }
}

Nested Schema : SiteRef

Type: object

Show Source

• LocationOID: string
• Name: string

{
    "type":"object",
    "properties":{
        "LocationOID":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        }
    }
}

Nested Schema : StudyEventData

Type: array

Show Source

• Array of: object StudyEventData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/StudyEventData"
    }
}

Nested Schema : SubjectHistory

Type: array

Show Source

• Array of: object History

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/History"
    }
}

Nested Schema : TransferData

Type: array

Show Source

• Array of: object TransferData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TransferData"
    }
}

Nested Schema : StudyEventData

Type: object

Show Source

• Annotation: array Annotation
• AuditRecord: object AuditRecord
• EventHistory: array EventHistory
• FormData: array FormData
• RepeatingFormSummary: object RepeatingFormSummary
• Signature: object Signature
• StudyEventOID: string
• StudyEventRepeatKey: string

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "FormData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormData"
            }
        },
        "StudyEventOID":{
            "type":"string"
        },
        "StudyEventRepeatKey":{
            "type":"string"
        },
        "RepeatingFormSummary":{
            "$ref":"#/components/schemas/RepeatingFormSummary"
        },
        "EventHistory":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/History"
            }
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : EventHistory

Type: array

Show Source

• Array of: object History

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/History"
    }
}

Nested Schema : FormData

Type: array

Show Source

• Array of: object FormData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormData"
    }
}

Nested Schema : RepeatingFormSummary

Type: object

Show Source

• RepeatingFormData: array RepeatingFormData

{
    "type":"object",
    "properties":{
        "RepeatingFormData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/RepeatingFormData"
            }
        }
    }
}

Nested Schema : History

Type: object

Show Source

• action: string
• actionDate: string (date-time)
• details: array details

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string"
        },
        "details":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "actionDate":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : details

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : FormData

Type: object

Show Source

• Annotation: array Annotation
• ArchiveLayoutRef: object ArchiveLayoutRef
• AuditRecord: object AuditRecord
• FormOID: string
• FormRepeatKey: string
• FormStatus: string
• ItemGroupData: array ItemGroupData
• NotDoneValue: string
• Signature: object Signature
• Signatures: object Signatures
• Status: string
• TitleAddendum: string
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "ArchiveLayoutRef":{
            "$ref":"#/components/schemas/ArchiveLayoutRef"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "ItemGroupData":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemGroupData"
            }
        },
        "FormOID":{
            "type":"string"
        },
        "FormRepeatKey":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "Status":{
            "type":"string"
        },
        "TitleAddendum":{
            "type":"string"
        },
        "FormStatus":{
            "type":"string"
        },
        "NotDoneValue":{
            "type":"string"
        },
        "Signatures":{
            "$ref":"#/components/schemas/Signatures"
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : ArchiveLayoutRef

Type: object

Show Source

• ArchiveLayoutOID: string

{
    "type":"object",
    "properties":{
        "ArchiveLayoutOID":{
            "type":"string"
        }
    }
}

Nested Schema : ItemGroupData

Type: array

Show Source

• Array of: object ItemGroupData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ItemGroupData"
    }
}

Nested Schema : ItemGroupData

Type: object

Show Source

• Annotation: array Annotation
• AuditRecord: object AuditRecord
• ItemGroupOID: string
• ItemGroupRepeatKey: string
• Items: array Items
• Signature: object Signature
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "Items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemData"
            }
        },
        "ItemGroupOID":{
            "type":"string"
        },
        "ItemGroupRepeatKey":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : Items

Type: array

Show Source

• Array of: object ItemData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ItemData"
    }
}

Nested Schema : ItemData

Type: object

Show Source

• Annotation: array Annotation
• AuditRecord: object AuditRecord
• ItemOID: string
• MeasurementUnitRef: object MeasurementUnitRef
• NotDone: string
• ParentItemOID: string
• SelectedCodeListItemsType: string
• Signature: object Signature
• TransactionType: string
  Allowed Values: [ "INSERT", "UPDATE", "REMOVE", "UPSERT", "CONTEXT" ]
• Value: string

{
    "type":"object",
    "properties":{
        "AuditRecord":{
            "$ref":"#/components/schemas/AuditRecord"
        },
        "Signature":{
            "$ref":"#/components/schemas/Signature"
        },
        "MeasurementUnitRef":{
            "$ref":"#/components/schemas/MeasurementUnitRef"
        },
        "Annotation":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Annotation"
            }
        },
        "ItemOID":{
            "type":"string"
        },
        "TransactionType":{
            "type":"string",
            "enum":[
                "INSERT",
                "UPDATE",
                "REMOVE",
                "UPSERT",
                "CONTEXT"
            ]
        },
        "ParentItemOID":{
            "type":"string"
        },
        "NotDone":{
            "type":"string"
        },
        "SelectedCodeListItemsType":{
            "type":"string"
        },
        "Value":{
            "type":"string"
        }
    }
}

Nested Schema : Annotation

Type: array

Show Source

• Array of: object Annotation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Annotation"
    }
}

Nested Schema : MeasurementUnitRef

Type: object

Show Source

• MeasurementUnitOID: string

{
    "type":"object",
    "properties":{
        "MeasurementUnitOID":{
            "type":"string"
        }
    }
}

Nested Schema : RepeatingFormData

Type: array

Show Source

• Array of: object RepeatingFormData

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/RepeatingFormData"
    }
}

Nested Schema : RepeatingFormData

Type: object

Show Source

• FormHeader: array FormHeader
• FormID: string
• FormOID: string
• Row: array Row
• SummaryNote: string

{
    "type":"object",
    "properties":{
        "FormOID":{
            "type":"string"
        },
        "FormID":{
            "type":"string"
        },
        "FormHeader":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormHeader"
            }
        },
        "Row":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Row"
            }
        },
        "SummaryNote":{
            "type":"string"
        }
    }
}

Nested Schema : FormHeader

Type: array

Show Source

• Array of: object FormHeader

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormHeader"
    }
}

Nested Schema : Row

Type: array

Show Source

• Array of: object Row

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Row"
    }
}

Nested Schema : FormHeader

Type: object

Show Source

• Itemset: boolean
• ItemsetHeader: string
• Name: string
• OID: string

{
    "type":"object",
    "properties":{
        "Itemset":{
            "type":"boolean"
        },
        "ItemsetHeader":{
            "type":"string"
        },
        "Name":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : Row

Type: object

Show Source

• Associated: boolean
• AssociatedFormList: array AssociatedFormList
• Deleted: boolean
• FormIndex: number
• Item: array Item
• RowNo: string

{
    "type":"object",
    "properties":{
        "AssociatedFormList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AssociatedFormList"
            }
        },
        "RowNo":{
            "type":"string"
        },
        "FormIndex":{
            "type":"number"
        },
        "Associated":{
            "type":"boolean"
        },
        "Deleted":{
            "type":"boolean"
        },
        "Item":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Item"
            }
        }
    }
}

Nested Schema : AssociatedFormList

Type: array

Show Source

• Array of: object AssociatedFormList

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AssociatedFormList"
    }
}

Nested Schema : Item

Type: array

Show Source

• Array of: object Item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Item"
    }
}

Nested Schema : AssociatedFormList

Type: object

Show Source

• AuditTrail: array AuditTrail
• Deleted: boolean
• FormIndex: number
• FormName: string
• FormOID: string
• InstanceNumber: integer
• VisitIndex: number
• VisitName: string
• VisitOID: string

{
    "type":"object",
    "properties":{
        "AuditTrail":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AuditTrail"
            }
        },
        "FormOID":{
            "type":"string"
        },
        "FormIndex":{
            "type":"number"
        },
        "FormName":{
            "type":"string"
        },
        "VisitOID":{
            "type":"string"
        },
        "VisitIndex":{
            "type":"number"
        },
        "VisitName":{
            "type":"string"
        },
        "Deleted":{
            "type":"boolean"
        },
        "InstanceNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : AuditTrail

Type: array

Show Source

• Array of: object AuditTrail

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AuditTrail"
    }
}

Nested Schema : AuditTrail

Type: object

Show Source

• DateTimeStamp: string
• Deleted: boolean
• Note: string
• User: string

{
    "type":"object",
    "properties":{
        "DateTimeStamp":{
            "type":"string"
        },
        "User":{
            "type":"string"
        },
        "Deleted":{
            "type":"boolean"
        },
        "Note":{
            "type":"string"
        }
    }
}

Nested Schema : Item

Type: object

Show Source

• Itemset: boolean
• ItemsetRows: string
• OID: string
• Value: string

{
    "type":"object",
    "properties":{
        "Itemset":{
            "type":"boolean"
        },
        "ItemsetRows":{
            "type":"string"
        },
        "Value":{
            "type":"string"
        },
        "OID":{
            "type":"string"
        }
    }
}

Nested Schema : TransferData

Type: object

Show Source

• FromSiteName: string
• ToSiteName: string
• TransferDate: string

{
    "type":"object",
    "properties":{
        "FromSiteName":{
            "type":"string"
        },
        "ToSiteName":{
            "type":"string"
        },
        "TransferDate":{
            "type":"string"
        }
    }
}

Back to Top