REST API for Clinical One Platform

Get a subject's events within a date range

get

/ec-dataintegration-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/dateRange/{subjectId}

Retrieves the events for a specific subject within a specified date range. New properties are withdrawal or completion date and EHR link status. Used by Integration Hub to retrieve events associated with a specific subject.
Rights: DataCaptureSubjectIntegrationGet and SubjectDataClassificationGet.

Request

Path Parameters

subjectId(required): string(uuid)

ID for the subject whose events you want to retrieve, as it appears in Clinical One.

Query Parameters

endDate: string(date-time)

The ending date and time (optional) for which you want to get events. If you don't specify the time, the date range stops before midnight (23:59:59 UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.
startDate: string(date-time)

The starting date and time (optional) for which you want to get events. If you don't specify the time, the date range begins after midnight (UTC) for the specified date. The accepted date and time formats are: dd-MMM-yyyy HH:mm:ss.SSS, dd-MMM-yyyy HH:mm:ss, dd-MMM-yyyy HH:mm, or dd-MMM-yyyy.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Subjects success.

Root Schema : schema

Type: array

Show Source

Array of: object SubjectRespDto13

Subject details including screening, randomization, completion status and withdrawal information

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

Nested Schema : SubjectRespDto13

Type: object

Subject details including screening, randomization, completion status and withdrawal information

Show Source

canBeCompleted: boolean

Indicates if the subject has met conditions to be completed

Example: true
codeBreak: string

Code break note if applicable

Example: N
comment: string

Minimum Length: 0

Maximum Length: 2048

Comment for latest subject update

Example: Initial enrollment
description: string

Minimum Length: 0

Maximum Length: 500

Free text description for the subject

Example: Screened subject
dob: string (date-time)

Date of birth
ehrLinkStatus: number

EHR link status code for the subject

Example: 1
enrollmentFailure: string

Minimum Length: 0

Maximum Length: 255

Reason for enrollment failure, if any

Example: Consent withdrawn
enrollmentOverride: string

Minimum Length: 0

Maximum Length: 255

Enrollment override note if applied

Example: Subject Enrollment Overridden
eventType: string

Type of event associated with the subject

Example: Screened
freezedStatus: string

Freeze status of the subject

Example: FROZEN
fromStudyId: string (uuid)

Origin study identifier from which the subject was transferred
gender: string

Minimum Length: 0

Maximum Length: 10

Gender value

Example: [{"value":"1","label":"male"}]
hasLockData: boolean

Indicates whether lock related data exists for the subject

Example: false
id: string (uuid)

Unique identifier of the subject
informedConsentDate: string (date-time)

Informed consent date

Example: 2025-09-25T09:00:00Z
lastSigned: string (date-time)

Timestamp when the subject was last signed

Example: 2025-10-16T14:30:31.892Z
lockedDateTime: string (date-time)

Timestamp when the subject was locked

Example: 2025-10-16T14:30:31.892Z
lockedInStudyVersion: string

Study version in which the subject is locked

Example: 3.0.0.4
lockedStatus: string

Lock status of the subject

Example: UNLOCKED
mhealthSubjectId: string (uuid)

Identifier of the subject in mHealth system
objectVersionNumber: number

Object version number used for concurrency control

Example: 14
operationType: string

Operation type for the subject event

Example: MODIFIED
previousSubjectNumber: string

Previous subject number if renumbered or transferred

Example: SUBJECT-0001-OLD
randomizationNumber: string

Randomization number for the subject

Example: RND-001
reason: string

Minimum Length: 0

Maximum Length: 255

Reason for latest subject update

Example: Protocol break happened
screenFailureComment: string

Additional comment for screen failure

Example: Subject breached protocols
screenFailureDate: string (date-time)

Date when the subject was marked as screen failure

Example: 2025-10-16T14:30:31.892Z
screeningDate: string (date-time)

Screening date if applicable

Example: 2025-10-01T10:00:00Z
screeningFailure: string

Minimum Length: 0

Maximum Length: 255

Reason for screening failure, if any

Example: Inclusion criteria not met
screeningNumber: string

Screening number assigned to the subject

Example: SCR-0001
signedStatus: string

Signed status of the subject

Example: SIGNED
siteId: string

Site identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
softwareVersionNumber: number

Software version number associated with the event

Example: 14
sourceTimeStamp: string (date-time)

Source system timestamp for the subject payload

Example: 2025-10-16T14:30:31.892Z
state(required): string

Minimum Length: 0

Maximum Length: 100

Lifecycle state of the subject

Example: ACTIVE
stateDate: string (date-time)

Timestamp when the subject transitioned to current state

Example: 2025-10-16T14:30:31.892Z
studyCompletionDate: string (date-time)

Date when the subject completed the study

Example: 2025-10-16T14:30:31.892Z
studyId: string

Study identifier in uppercase hex format

Example: ABCDEF1234567890ABCDEF1234567890
studyVersion(required): string

Study version string

Example: 3.0.0.1
subjectNumber(required): string

Minimum Length: 0

Maximum Length: 500

Human readable subject number

Example: SUBJ-0001
subjectSiteSerialNumber: string

Site-level serial number assigned to the subject

Example: SITE-0001-001
subjectStudySerialNumber: string

Study-level serial number assigned to the subject

Example: STUDY-0001-001
subjectTransferId: string (uuid)

Identifier of a subject transfer if applicable
subjNumSiteOrgId: string

Subject number site organization identifier

Example: SITE-ORG-0001
userId: string (uuid)

User identifier associated with the subject modification
verifiedStatus: string

Verified status of the subject

Example: VERIFIED
versionEnd: string (date-time)

End timestamp of the subject version record

Example: 2025-10-16T14:30:31.892Z
versionStart: string (date-time)

Start timestamp of the subject version

Example: 2025-10-16T14:30:31.892Z
withdrawalComment: string

Additional comment provided for withdrawal

Example: Subject breached protocols
withdrawalDate: string (date-time)

Date when the subject was withdrawn

Example: 2025-10-16T14:30:31.892Z
withdrawalReason: string

Reason provided when the subject is withdrawn

Example: Not applicable

{
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "description":"Screening date if applicable",
            "format":"date-time",
            "example":"2025-10-01T10:00:00Z"
        },
        "codeBreak":{
            "type":"string",
            "description":"Code break note if applicable",
            "example":"N"
        },
        "userId":{
            "type":"string",
            "description":"User identifier associated with the subject modification",
            "format":"uuid"
        },
        "eventType":{
            "type":"string",
            "description":"Type of event associated with the subject",
            "example":"Screened"
        },
        "subjectTransferId":{
            "type":"string",
            "description":"Identifier of a subject transfer if applicable",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Object version number used for concurrency control",
            "example":14
        },
        "mhealthSubjectId":{
            "type":"string",
            "description":"Identifier of the subject in mHealth system",
            "format":"uuid"
        },
        "fromStudyId":{
            "type":"string",
            "description":"Origin study identifier from which the subject was transferred",
            "format":"uuid"
        },
        "subjNumSiteOrgId":{
            "type":"string",
            "description":"Subject number site organization identifier",
            "example":"SITE-ORG-0001"
        },
        "signedStatus":{
            "type":"string",
            "description":"Signed status of the subject",
            "example":"SIGNED"
        },
        "verifiedStatus":{
            "type":"string",
            "description":"Verified status of the subject",
            "example":"VERIFIED"
        },
        "freezedStatus":{
            "type":"string",
            "description":"Freeze status of the subject",
            "example":"FROZEN"
        },
        "lastSigned":{
            "type":"string",
            "description":"Timestamp when the subject was last signed",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number associated with the event",
            "example":14
        },
        "operationType":{
            "type":"string",
            "description":"Operation type for the subject event",
            "example":"MODIFIED"
        },
        "subjectStudySerialNumber":{
            "type":"string",
            "description":"Study-level serial number assigned to the subject",
            "example":"STUDY-0001-001"
        },
        "subjectSiteSerialNumber":{
            "type":"string",
            "description":"Site-level serial number assigned to the subject",
            "example":"SITE-0001-001"
        },
        "versionEnd":{
            "type":"string",
            "description":"End timestamp of the subject version record",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "previousSubjectNumber":{
            "type":"string",
            "description":"Previous subject number if renumbered or transferred",
            "example":"SUBJECT-0001-OLD"
        },
        "screenFailureDate":{
            "type":"string",
            "description":"Date when the subject was marked as screen failure",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "lockedStatus":{
            "type":"string",
            "description":"Lock status of the subject",
            "example":"UNLOCKED"
        },
        "hasLockData":{
            "type":"boolean",
            "description":"Indicates whether lock related data exists for the subject",
            "example":false
        },
        "lockedDateTime":{
            "type":"string",
            "description":"Timestamp when the subject was locked",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "canBeCompleted":{
            "type":"boolean",
            "description":"Indicates if the subject has met conditions to be completed",
            "example":true
        },
        "lockedInStudyVersion":{
            "type":"string",
            "description":"Study version in which the subject is locked",
            "example":"3.0.0.4"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of the subject",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Start timestamp of the subject version",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "description":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Free text description for the subject",
            "example":"Screened subject"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Human readable subject number",
            "example":"SUBJ-0001"
        },
        "studyId":{
            "type":"string",
            "description":"Study identifier in uppercase hex format",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Site identifier in uppercase hex format",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "dob":{
            "type":"string",
            "description":"Date of birth",
            "format":"date-time"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Lifecycle state of the subject",
            "example":"ACTIVE"
        },
        "stateDate":{
            "type":"string",
            "description":"Timestamp when the subject transitioned to current state",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "screeningFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for screening failure, if any",
            "example":"Inclusion criteria not met"
        },
        "enrollmentFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for enrollment failure, if any",
            "example":"Consent withdrawn"
        },
        "enrollmentOverride":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Enrollment override note if applied",
            "example":"Subject Enrollment Overridden"
        },
        "informedConsentDate":{
            "type":"string",
            "description":"Informed consent date",
            "format":"date-time",
            "example":"2025-09-25T09:00:00Z"
        },
        "gender":{
            "maxLength":10,
            "minLength":0,
            "type":"string",
            "description":"Gender value",
            "example":"[{\"value\":\"1\",\"label\":\"male\"}]"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for latest subject update",
            "example":"Protocol break happened"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment for latest subject update",
            "example":"Initial enrollment"
        },
        "studyVersion":{
            "type":"string",
            "description":"Study version string",
            "example":"3.0.0.1"
        },
        "sourceTimeStamp":{
            "type":"string",
            "description":"Source system timestamp for the subject payload",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "screeningNumber":{
            "type":"string",
            "description":"Screening number assigned to the subject",
            "example":"SCR-0001"
        },
        "randomizationNumber":{
            "type":"string",
            "description":"Randomization number for the subject",
            "example":"RND-001"
        },
        "withdrawalReason":{
            "type":"string",
            "description":"Reason provided when the subject is withdrawn",
            "example":"Not applicable"
        },
        "ehrLinkStatus":{
            "type":"number",
            "description":"EHR link status code for the subject",
            "example":1
        },
        "withdrawalDate":{
            "type":"string",
            "description":"Date when the subject was withdrawn",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "studyCompletionDate":{
            "type":"string",
            "description":"Date when the subject completed the study",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "withdrawalComment":{
            "type":"string",
            "description":"Additional comment provided for withdrawal",
            "example":"Subject breached protocols"
        },
        "screenFailureComment":{
            "type":"string",
            "description":"Additional comment for screen failure",
            "example":"Subject breached protocols"
        }
    },
    "description":"Subject details including screening, randomization, completion status and withdrawal information"
}

400 Response

Bad request.

Root Schema : RestResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object