REST API for Clinical One Platform

Get data elements by subject and event ID

get

/ec-dc-svc/rest/v3.0/studies/{studyId}/{mode}/subject/{subjectId}/event/{eventId}/dataelements/visitdata

Retrieves data elements by subject and event ID for a given study and mode. Up-versioned to add hdiId field in DataElement

Request

Path Parameters

eventId(required): string

ID of the visit.
mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study.
subjectId(required): string

ID of the subject.

Query Parameters

eventInstanceNum: integer(int32)

Instance of the visit.
sortBy: string

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: array

Show Source

Array of: object VisitDataDto30

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

Nested Schema : VisitDataDto30

Type: object

Show Source

dataElements: array dataElements
forms: array forms
formsAssociations: array formsAssociations
labAssociations: object LabAssociationsDto
visit: object VisitLockDto

{
    "type":"object",
    "properties":{
        "dataElements":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataElementDto122"
            }
        },
        "formsAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormsAssociationsDto2"
            }
        },
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormLockDto10"
            }
        },
        "labAssociations":{
            "$ref":"#/components/schemas/LabAssociationsDto"
        },
        "visit":{
            "$ref":"#/components/schemas/VisitLockDto"
        }
    }
}

Nested Schema : dataElements

Type: array

Show Source

Array of: object DataElementDto122

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

Nested Schema : forms

Type: array

Show Source

Array of: object FormLockDto10

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

Nested Schema : formsAssociations

Type: array

Show Source

Array of: object FormsAssociationsDto2

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

Nested Schema : LabAssociationsDto

Type: object

Show Source

forms: array forms

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

Nested Schema : VisitLockDto

Type: object

Show Source

lockedDateTime: string (date-time)
lockedStatus: string
visitStartDateLockedDateTime: string (date-time)
visitStartDateLockedStatus: string

{
    "type":"object",
    "properties":{
        "lockedStatus":{
            "type":"string"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitStartDateLockedStatus":{
            "type":"string"
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : DataElementDto122

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
dataFlag: string (uuid)
dateTimeValueUTC: string (date-time)
dayValue: integer
eventId: string
eventInstanceNum: integer
floatValue: number
formId: string
formSectionId: string
formStatus: string

Allowed Values: [ "NOT_STARTED", "COMPLETED", "COMPLETED_WITH_ERROR", "IN_PROGRESS", "INCOMPLETE_WITH_ERROR", "INCOMPLETE", "REMOVED" ]
freezedStatus: string
hdiId: string
hourValue: integer
id: string (uuid)
innerRepeat: integer
itemD: string
itemF: string
itemId: string
itemR: string
itemType: string
lockedDateTime: string (date-time)
lockedStatus: string
measureUnit: string

Minimum Length: 0

Maximum Length: 64
minuteValue: integer
monthValue: integer
normalizedUnitId: string
normalizedValue: string

Minimum Length: 0

Maximum Length: 100
numValue: integer
objectVersionNumber: number
operationType: string
originatorId: string
outerRepeat: integer
parentId: string
propertyId: string
propertyVersionStart: string (date-time)
reason: string

Minimum Length: 0

Maximum Length: 255
repeatFormNumber: integer
repeatSequenceNumber: integer
rootId: string
secondValue: integer
signedStatus: string
siteId: string
softwareVersionNumber: number
sourceTimeStamp: string (date-time)
studyId: string
studyName: string

Minimum Length: 0

Maximum Length: 100
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string
targets: array targets
transactionEnd: string (date-time)
transactionStart: string (date-time)
userId: string (uuid)
validationFailure: string

Minimum Length: 0

Maximum Length: 32767
validationStatus: string

Minimum Length: 0

Maximum Length: 25
value: string

Minimum Length: 0

Maximum Length: 4000
variableId: string
vendorCode: string

Minimum Length: 0

Maximum Length: 100
verifiedStatus: string
versionEnd: string (date-time)
versionStart: string (date-time)
yearValue: integer

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "maxLength":"25",
            "minLength":"0",
            "type":"string"
        },
        "validationFailure":{
            "maxLength":"32767",
            "minLength":"0",
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "studyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "studyVersion":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "formSectionId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "variableId":{
            "type":"string"
        },
        "originatorId":{
            "type":"string"
        },
        "vendorCode":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "value":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "measureUnit":{
            "maxLength":"64",
            "minLength":"0",
            "type":"string"
        },
        "normalizedValue":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "normalizedUnitId":{
            "type":"string"
        },
        "numValue":{
            "type":"integer"
        },
        "floatValue":{
            "type":"number"
        },
        "dateTimeValueUTC":{
            "type":"string",
            "format":"date-time"
        },
        "monthValue":{
            "type":"integer"
        },
        "dayValue":{
            "type":"integer"
        },
        "yearValue":{
            "type":"integer"
        },
        "hourValue":{
            "type":"integer"
        },
        "minuteValue":{
            "type":"integer"
        },
        "secondValue":{
            "type":"integer"
        },
        "parentId":{
            "type":"string"
        },
        "rootId":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "targets":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "dataFlag":{
            "type":"string",
            "format":"uuid"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "propertyId":{
            "type":"string"
        },
        "propertyVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "itemType":{
            "type":"string"
        },
        "itemD":{
            "type":"string"
        },
        "itemF":{
            "type":"string"
        },
        "itemR":{
            "type":"string"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "formStatus":{
            "type":"string",
            "enum":[
                "NOT_STARTED",
                "COMPLETED",
                "COMPLETED_WITH_ERROR",
                "IN_PROGRESS",
                "INCOMPLETE_WITH_ERROR",
                "INCOMPLETE",
                "REMOVED"
            ]
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        },
        "lockedStatus":{
            "type":"string"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "hdiId":{
            "type":"string"
        }
    }
}

Nested Schema : targets

Type: array

Show Source

Array of: string

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

Nested Schema : FormLockDto10

Type: object

Show Source

formId: string (uuid)
innerRepeat: integer
lockedDateTime: string (date-time)
lockedStatus: string
outerRepeat: integer
sectionId: string (uuid)

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "sectionId":{
            "type":"string",
            "format":"uuid"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "lockedStatus":{
            "type":"string"
        }
    }
}

Nested Schema : FormsAssociationsDto2

Type: object

Show Source

associatedEventId: string
associatedEventInstanceNum: integer (int32)
associatedFormId: string
associatedFormSectionId: string
associatedRepeatFormNumber: integer
associatedRepeatSequenceNumber: integer
associatedStudyVersion: string
comment: string
id: string (uuid)
objectVersionNumber: number
reason: string
siteId: string
srcEventId: string
srcEventInstanceNum: integer (int32)
srcFormId: string
srcFormSectionId: string
srcItemId: string
srcRepeatFormNumber: integer
srcRepeatSequenceNumber: integer
srcStudyVersion: string
subjectId: string
versionStart: string (date-time)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "subjectId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "srcEventId":{
            "type":"string"
        },
        "srcEventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "srcFormId":{
            "type":"string"
        },
        "srcRepeatSequenceNumber":{
            "type":"integer"
        },
        "srcStudyVersion":{
            "type":"string"
        },
        "associatedEventId":{
            "type":"string"
        },
        "associatedEventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "associatedFormId":{
            "type":"string"
        },
        "associatedRepeatSequenceNumber":{
            "type":"integer"
        },
        "associatedStudyVersion":{
            "type":"string"
        },
        "reason":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "srcItemId":{
            "type":"string"
        },
        "srcFormSectionId":{
            "type":"string"
        },
        "associatedFormSectionId":{
            "type":"string"
        },
        "associatedRepeatFormNumber":{
            "type":"integer"
        },
        "srcRepeatFormNumber":{
            "type":"integer"
        }
    }
}

Nested Schema : forms

Type: array

Show Source

Array of: object LabAssociationFormDto

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

Nested Schema : LabAssociationFormDto

Type: object

Show Source

formId: string (uuid)
formRepeats: array formRepeats

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "format":"uuid"
        },
        "formRepeats":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/LabAssociationRepeatingDto"
            }
        }
    }
}

Nested Schema : formRepeats

Type: array

Show Source

Array of: object LabAssociationRepeatingDto

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

Nested Schema : LabAssociationRepeatingDto

Type: object

Show Source

labId: string (uuid)
outerRepeat: integer
propertyId: string (uuid)

{
    "type":"object",
    "properties":{
        "outerRepeat":{
            "type":"integer"
        },
        "propertyId":{
            "type":"string",
            "format":"uuid"
        },
        "labId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
result: object result
status: string
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "version":{
            "type":"integer",
            "format":"int32",
            "writeOnly":true
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object