REST API for Clinical One Platform

Get visit summary with form and item IDs

post

/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/visitsforms/formitems

Retrieves visit summary with form and item IDs.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

excludeItemType: string

Form Item type to exclude from response

Allowed Values: [ "instructionalText" ]
formCategory: string

Return forms with this Form Category.

Default Value: ALL

Allowed Values: [ "DCS", "NSF", "ALL" ]
forms: boolean

Include froms in response

Default Value: true
items: string
mode(required): string

Study mode to filter study forms.

Allowed Values: [ "test", "training", "active" ]
visits: boolean

Include visits in response

Default Value: true

Supported Media Types

Root Schema : schema

Type: array

Show Source

Array of: object StudyVersionVisitDtoV9

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

Nested Schema : StudyVersionVisitDtoV9

Type: object

Show Source

studyId: string (uuid)
studyTitle: string

Study name

Example: Study 03
version: string

version

Example: 1.3.0.6
versionPreviousStatus: string

Allowed Values: [ "DRAFT", "TESTING", "APPROVED", "ARCHIVED" ]

Previous study status

Example: TESTING
versionStatus: string

Study version status

Example: Active, not recruiting
visitId: string (uuid)

Visit GUID

{
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "version":{
            "type":"string",
            "description":"version",
            "example":"1.3.0.6"
        },
        "studyTitle":{
            "type":"string",
            "description":"Study name",
            "example":"Study 03"
        },
        "versionStatus":{
            "type":"string",
            "description":"Study version status",
            "example":"Active, not recruiting"
        },
        "versionPreviousStatus":{
            "type":"string",
            "description":"Previous study status",
            "example":"TESTING",
            "enum":[
                "DRAFT",
                "TESTING",
                "APPROVED",
                "ARCHIVED"
            ]
        },
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : schema

Type: array

Show Source

Array of: object VisitsFormsSummaryDto

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

Nested Schema : VisitsFormsSummaryDto

Type: object

Show Source

forms: array forms
studyVersion: string
visits: array visits

{
    "type":"object",
    "properties":{
        "studyVersion":{
            "type":"string"
        },
        "visits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/VisitSummaryWithFormIdsDto"
            }
        },
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormSummaryFlatDtoV2"
            }
        }
    }
}

Nested Schema : forms

Type: array

Show Source

Array of: object FormSummaryDto v2.0

Title: FormSummaryDto v2.0

Reduced form properties

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

Nested Schema : visits

Type: array

Show Source

Array of: object VisitSummaryWithFormIdsDto

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

Nested Schema : FormSummaryDto v2.0

Type: object

Title: FormSummaryDto v2.0

Reduced form properties

Show Source

id: string (uuid)

Form Unique GUID
items: array items
refname: string

Form refname

Example: FORM_01
repeat: boolean

Form repeating

Example: true
title: string

Form title

Example: Demography

{
    "title":"FormSummaryDto v2.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "refname":{
            "type":"string",
            "description":"Form refname",
            "example":"FORM_01"
        },
        "title":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "repeat":{
            "type":"boolean",
            "description":"Form repeating",
            "example":true
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemSummaryDTOV2"
            }
        }
    },
    "description":"Reduced form properties"
}

Nested Schema : items

Type: array

Show Source

Array of: object FormItemSummaryFlatDto v2.0

Title: FormItemSummaryFlatDto v2.0

This DTO is used by an internal API where only limited form item attributes are included dynamically based on a query param.

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

Nested Schema : FormItemSummaryFlatDto v2.0

Type: object

Title: FormItemSummaryFlatDto v2.0

This DTO is used by an internal API where only limited form item attributes are included dynamically based on a query param.

Show Source

allowFutureDate: integer (int32)

Allow future date

Example: 1
allowPartialDate: integer (int32)

Allow partial Dates

Example: 1
cohortFactor: boolean
dataClassificationIds: array dataClassificationIds
display: string

Choice Box display

Example: selectbox
dynamic: integer (int32)

How many leading questions in this form have to be answered by user correctly before Item is included into the form.

Example: 1
format: string

Date time format

Example: MON-YYYY
formula: string

Smart item formula.

Example: [{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]
groupId: string (uuid)

Form Unique GUID
hidden: boolean

Is form item hidden?

Example: false
id: string (uuid)

Form Item Unique GUID
isCohortFactor: boolean

Flag that indicates whether this form item is used as a factor for randomization cohort or not.

Example: false
isStrataFactor: boolean

Flag that indicates whether this form item is used as a factor for randomization stratum or not.

Example: false
itemType: string

Item Type

Example: table
partialDate: string

Partial Date Format

Example: MON-YYYY
precision: integer (int32)
questionHint: string

Form question hint

Example: What is your age?
questionLabel: string

Form question label

Example: Age
questionType: string

Title: FormItemType

Allowed Values: [ "text", "instructionalText", "numeric", "datetime", "choice", "questionGroup", "table", "label", "section", "existingData" ]

Question type

Example: numeric
randomizationTag: boolean

Flag that indicates whether this form item should be used for randomization stratification or not.

Example: true
readOnly: boolean

Is form item read only?

Example: false
refname: string

Form item reference name.

Example: NUMBER_01
required: boolean

Whether this form item is requiered or not.

Example: true
sasLabel: string

Form Item sasLabel

Example: Adverse Event
sasVariable: string

Form Item SASVariable

Example: AE
sdvRequired: string

Allowed Values: [ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]

Source Data Verification Type

Example: NEVER(0),ALWAYS(1),CRITICAL(2)
smartItemId: string (uuid)

Smart item Unique GUID
strataFactor: boolean
units: string

{
    "title":"FormItemSummaryFlatDto v2.0",
    "type":"object",
    "properties":{
        "strataFactor":{
            "type":"boolean"
        },
        "cohortFactor":{
            "type":"boolean"
        },
        "id":{
            "type":"string",
            "description":"Form Item Unique GUID",
            "format":"uuid"
        },
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData"
            ]
        },
        "questionLabel":{
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "randomizationTag":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item should be used for randomization stratification or not.",
            "example":true
        },
        "isStrataFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization stratum or not.",
            "example":false
        },
        "isCohortFactor":{
            "type":"boolean",
            "description":"Flag that indicates whether this form item is used as a factor for randomization cohort or not.",
            "example":false
        },
        "refname":{
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "required":{
            "type":"boolean",
            "description":"Whether this form item is requiered or not.",
            "example":true
        },
        "dynamic":{
            "type":"integer",
            "description":"How many leading questions in this form have to be answered by user correctly before Item is included into the form.",
            "format":"int32",
            "example":"1"
        },
        "hidden":{
            "type":"boolean",
            "description":"Is form item hidden?",
            "example":false
        },
        "readOnly":{
            "type":"boolean",
            "description":"Is form item read only?",
            "example":false
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source Data Verification Type",
            "example":"NEVER(0),ALWAYS(1),CRITICAL(2)",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item Unique GUID",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]"
        },
        "dataClassificationIds":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtoV7"
            }
        },
        "precision":{
            "type":"integer",
            "format":"int32"
        },
        "units":{
            "type":"string"
        },
        "format":{
            "type":"string",
            "description":"Date time format",
            "example":"MON-YYYY"
        },
        "allowPartialDate":{
            "type":"integer",
            "description":"Allow partial Dates",
            "format":"int32",
            "example":"1"
        },
        "partialDate":{
            "type":"string",
            "description":"Partial Date Format",
            "example":"MON-YYYY"
        },
        "allowFutureDate":{
            "type":"integer",
            "description":"Allow future date",
            "format":"int32",
            "example":"1"
        },
        "display":{
            "type":"string",
            "description":"Choice Box display",
            "example":"selectbox"
        },
        "groupId":{
            "type":"string",
            "description":"Form Unique GUID",
            "format":"uuid"
        },
        "itemType":{
            "type":"string",
            "description":"Item Type",
            "example":"table"
        }
    },
    "description":"This DTO is used by an internal API where only limited form item attributes are included dynamically based on a query param."
}

Nested Schema : dataClassificationIds

Type: array

Show Source

Array of: object From Item Advanced Property v7.0

Title: From Item Advanced Property v7.0

Form Item Advanced Property

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

Nested Schema : From Item Advanced Property v7.0

Type: object

Title: From Item Advanced Property v7.0

Form Item Advanced Property

Show Source

id: string (uuid)

Advanced property id
label: string

Advanced property label in UI, i.e. studyName

Example: Study BT-31
name: string

Advanced property name, mapped to the ECD_EXTENDED_PROPERTIES.PROPERTY_NAME column

Example: RolloverQuestion
parentObjectId: string (uuid)
parentObjectLabel: string
parentObjectLevel: string
rules: array rules
type: string

Advanced property type, mapped to the ECD_EXTENDED_PROPERTIES.RESPONSE_MAP_JSON column 'valueType' field

Example: Dropdown
value: string

Advanced property value of studyId

Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v7.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Advanced property id",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Advanced property type, mapped to the ECD_EXTENDED_PROPERTIES.RESPONSE_MAP_JSON column 'valueType' field",
            "example":"Dropdown"
        },
        "name":{
            "type":"string",
            "description":"Advanced property name, mapped to the ECD_EXTENDED_PROPERTIES.PROPERTY_NAME column",
            "example":"RolloverQuestion"
        },
        "value":{
            "type":"string",
            "description":"Advanced property value of studyId",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Advanced property label in UI, i.e. studyName",
            "example":"Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtoV7"
            }
        },
        "parentObjectId":{
            "type":"string",
            "format":"uuid"
        },
        "parentObjectLevel":{
            "type":"string"
        },
        "parentObjectLabel":{
            "type":"string"
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

Array of: object From Item Advanced Property Rule v7.0

Title: From Item Advanced Property Rule v7.0

Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v7.0

Type: object

Title: From Item Advanced Property Rule v7.0

Form Item Advanced Property Rule

Show Source

label: string

For RolloverQuestion property it is an ECD_CODELISTITEM.OBJECT_DESCRIPTION

Example: Yes
name: string

name

Example: Answer for Rollover
value: string

For RolloverQuestion property it is an ECD_CODELISTITEM.CODELISTITEM_ID

Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v7.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"Answer for Rollover"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECD_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECD_CODELISTITEM.OBJECT_DESCRIPTION",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Nested Schema : VisitSummaryWithFormIdsDto

Type: object

Show Source

branchCycleCount(required): number
branchId: string (uuid)
branchIndex: integer (int32)
branchIsCycle: boolean
branchShortName: string
branchStartCycle(required): integer (int32)
branchTier: integer (int32)
branchTitle: string
eventType: string
formIds: array formIds
fullName: string
id: string (uuid)
isDispensed(required): boolean
shortName(required): string
studyVersion(required): string
title(required): string
visitSeq: integer (int32)

{
    "required":[
        "branchCycleCount",
        "branchStartCycle",
        "isDispensed",
        "shortName",
        "studyVersion",
        "title"
    ],
    "type":"object",
    "properties":{
        "visitSeq":{
            "type":"integer",
            "format":"int32"
        },
        "branchTier":{
            "type":"integer",
            "format":"int32"
        },
        "branchIndex":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "title":{
            "type":"string"
        },
        "shortName":{
            "type":"string"
        },
        "fullName":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "branchId":{
            "type":"string",
            "format":"uuid"
        },
        "branchTitle":{
            "type":"string"
        },
        "branchShortName":{
            "type":"string"
        },
        "branchIsCycle":{
            "type":"boolean"
        },
        "branchStartCycle":{
            "type":"integer",
            "format":"int32"
        },
        "branchCycleCount":{
            "type":"number"
        },
        "isDispensed":{
            "type":"boolean"
        },
        "studyVersion":{
            "type":"string"
        },
        "formIds":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : formIds

Type: array

Show Source

Array of: string(uuid)

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

500 Response

Error

Root 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 : details

Type: object