REST API for Clinical One Cloud Service

v1.0

get

/ec-dataintegration-svc/rest/v1.0/studies/{studyId}/{mode}/visitstatus/history

Retrieves the list of visit statuses for a visit. If the event ID is null, then it lists all the visit statuses records for a subject.This API also provides unscheduled events details.

Request

Path Parameters

mode(required): string
Indicates the operational mode of the study. Accepted values: active, test, or training.
Example:
```
test
```
studyId(required): string
Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.
Example:
```
3F2504E04F8911D39A0C0305E82C3301
```

Query Parameters

eventId(required): 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:
```
5D5F9311C591424F852B99FD902E98A4
```
eventInstanceNumber: 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
```
limit(required): integer(int32)
Minimum Value: 0

Number of subjects limit.
Example:
```
50
```
offset(required): integer(int32)
Starting offset.
Example:
```
0
```
subjectId(required): 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:
```
42CE52A1AF9A48EBABA25A361F6EC0FE
```
updateStatus: boolean
Reevaluates the visit status with the current design, if set to true.
Example:
```
false
```

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 VisitsStatusDto10

Visit status with display text and leading data element identifier for UI rendering

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

Nested Schema : VisitsStatusDto10

Type: object

Visit status with display text and leading data element identifier for UI rendering

Show Source

associatedStudyVersion: string

Study version with which the visit status is associated

Example: 3.0.0.1
comment: string

Minimum Length: 0

Maximum Length: 2048

Additional comment for the visit status

Example: All data verified
display: string

Display label of the visit status

Example: Baseline Visit
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: ABCDEF1234567890ABCDEF1234567890
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
eventType: string

Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.

Example: Visit_Not_Started
freezedStatus: string

Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.

Example: FROZEN
id: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
leadingDataelementId: string

Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the leading data element for the visit.

Example: 93CC828113AC439181071CB44D2C6FE5
reason: string

Minimum Length: 0

Maximum Length: 255

Reason associated with the visit status

Example: Subject completed the visit successfully
repeatingFormCount: number

Number of repeating form instances for the visit.

Example: 2
scheduledWindowEndDate: string (date-time)

Scheduled window end date for the visit

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

Scheduled window start date for the visit

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

Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.

Example: SIGNED
siteId: string

Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

Example: ABCDEF1234567890ABCDEF1234567890
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100

String representing the version of the study. Helps track changes in form or study design.

Example: 3.0.0.1
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: ABCDEF1234567890ABCDEF1234567890
verifiedStatus: string

Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.

Example: VERIFIED
versionStart: string

Start timestamp of the version record

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

Visit start date timestamp

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

Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.

Example: COMPLETE
visitType: string

Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.

Example: SCREENING

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"Start timestamp of the version record",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "subjectId":{
            "type":"string",
            "description":"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":"ABCDEF1234567890ABCDEF1234567890"
        },
        "eventId":{
            "type":"string",
            "description":"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":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "visitStatus":{
            "type":"string",
            "description":"Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.",
            "example":"COMPLETE"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason associated with the visit status",
            "example":"Subject completed the visit successfully"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment for the visit status",
            "example":"All data verified"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date timestamp",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "visitType":{
            "type":"string",
            "description":"Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.",
            "example":"SCREENING"
        },
        "eventType":{
            "type":"string",
            "description":"Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.",
            "example":"Visit_Not_Started"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "example":1
        },
        "signedStatus":{
            "type":"string",
            "description":"Signed status for workflow, the acceptable values are:  NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.",
            "example":"SIGNED"
        },
        "verifiedStatus":{
            "type":"string",
            "description":"Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.",
            "example":"VERIFIED"
        },
        "freezedStatus":{
            "type":"string",
            "description":"Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.",
            "example":"FROZEN"
        },
        "repeatingFormCount":{
            "type":"number",
            "description":"Number of repeating form instances for the visit.",
            "example":2
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "description":"Scheduled window start date for the visit",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "description":"Scheduled window end date for the visit",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "associatedStudyVersion":{
            "type":"string",
            "description":"Study version with which the visit status is associated",
            "example":"3.0.0.1"
        },
        "display":{
            "type":"string",
            "description":"Display label of the visit status",
            "example":"Baseline Visit"
        },
        "leadingDataelementId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the leading data element for the visit.",
            "example":"93CC828113AC439181071CB44D2C6FE5"
        }
    },
    "description":"Visit status with display text and leading data element identifier for UI rendering"
}

Examples

400 Response

Bad request.

Root Schema : RestResponse

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