Jump to

• Request
• Response

V20.0

get

/ec-designer-edc-svc/rest/v20.0/studies/{studyId}/versions/{version}/visits/{visitid}/forms

Returns forms assigned to a visit in v20.0. Compared with v19.0, this endpoint uses v20 visit-form retrieval and supports details/summary response behavior.

Request

Path Parameters

• studyId(required): string
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.
• version(required): string
  Study version path segment. Required. Example: "1.0.0.1".

  Example:

  1.0.0.1

• visitid(required): string(uuid)
  Visit ID (UUID, 32-character uppercase hexadecimal string). Required.

Query Parameters

• asofdate: string
• dynamicData: boolean
  Include dynamic data in response (optional).

  Default Value: true
• excludeItemType: string
  Form item type to exclude (optional). Allowed value: instructionalText.

  Allowed Values: [ "instructionalText" ]
• mode(required): string
  Study mode filter. Required. Allowed values: test, training, active, design.

  Default Value: design

  Allowed Values: [ "test", "training", "active", "design" ]
• response: string
  Response mode (optional): summary or details.

  Default Value: summary

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Visit forms returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object FormDto v21.0
  Title: FormDto v21.0

  Form Info

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

Nested Schema : FormDto v21.0

Type: object

Title: FormDto v21.0

Form Info

Show Source

• allowMultipleInstances: boolean
  Allow multiple instances

  Example: true
• assignedVisits: array assignedVisits
  Branch-cycle details describing visits where this form is displayed.
• dynamic: integer (int32)
  Count of forms items that point to this form for Show Form feature

  Example: 4
• formCategory: string
  Form category

  Example: DCS
• formSubcategory: array formSubcategory
  Form subcategory list.
• formType: string
  Allowed Values: [ "STANDARD_FORM", "LAB_FORM", "TWO_SECTION_FORM", "DRUG_RECONCILIATION_FORM", "STANDARD_FORM, LAB_FORM, TWO_SECTION_FORM" ]

  Form type

  Example: STANDARD_FORM
• hasRevision: boolean
  Indicate whether any revisions from a newer study version have been applied

  Example: true
• id: string (uuid)
  Form ID (UUID).
• includeInSafetyCaseData: boolean
  Is form associated to Safety Case Forms

  Example: true
• items: array items
  Form item definitions.
• linkFrom: array linkFrom
  Forms linked to this form.
• logoFileName: string
  Logo file name.

  Example: study-logo.png
• logoFileUploadRequest: object FileUploadRequest
  Logo upload request details.
• refname(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form refname

  Example: FORM_01
• repeat: boolean
  Form repeating?

  Example: false
• showFrom: array showFrom
  Dynamic parent dependencies from forms on the same visit.
• source: object FormCopySourceDto v21.0
  Title: FormCopySourceDto v21.0

  Form Copy Source Information
• title(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form title

  Example: Demography
• versionStart: string (date-time)
  The form version start timestamp.

  Example: 2025-04-30T09:24:15Z

{
    "title":"FormDto v21.0",
    "required":[
        "refname",
        "title"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Form ID (UUID).",
            "format":"uuid"
        },
        "title":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "refname":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form refname",
            "example":"FORM_01"
        },
        "repeat":{
            "type":"boolean",
            "description":"Form repeating?",
            "example":false
        },
        "source":{
            "$ref":"#/components/schemas/FormCopySourceDtov21"
        },
        "items":{
            "type":"array",
            "description":"Form item definitions.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "formId":"B1B8327AFAA6412287106192AB5984EA",
                    "questionType":"numeric",
                    "questionLabel":"Age",
                    "refname":"AGE_01",
                    "required":true,
                    "sdvRequired":"NEVER"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemDtov21"
            }
        },
        "versionStart":{
            "type":"string",
            "description":"The form version start timestamp.",
            "format":"date-time",
            "example":"2025-04-30T09:24:15Z"
        },
        "allowMultipleInstances":{
            "type":"boolean",
            "description":"Allow multiple instances",
            "example":true
        },
        "dynamic":{
            "type":"integer",
            "description":"Count of forms items that point to this form for Show Form feature",
            "format":"int32",
            "example":4
        },
        "formType":{
            "type":"string",
            "description":"Form type",
            "example":"STANDARD_FORM",
            "enum":[
                "STANDARD_FORM",
                "LAB_FORM",
                "TWO_SECTION_FORM",
                "DRUG_RECONCILIATION_FORM",
                "STANDARD_FORM, LAB_FORM, TWO_SECTION_FORM"
            ]
        },
        "hasRevision":{
            "type":"boolean",
            "description":"Indicate whether any revisions from a newer study version have been applied",
            "example":true
        },
        "linkFrom":{
            "type":"array",
            "description":"Forms linked to this form.",
            "example":[
                {
                    "formId":"B1B8327AFAA6412287106192AB5984EF",
                    "items":[
                        "B1B8327AFAA6412287106192AB5984EA"
                    ]
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormLinkFromDtov21"
            }
        },
        "showFrom":{
            "type":"array",
            "description":"Dynamic parent dependencies from forms on the same visit.",
            "example":[
                {
                    "formId":"B1B8327AFAA6412287106192AB5984EF",
                    "items":[
                        {
                            "id":"B1B8327AFAA6412287106192AB5984EA",
                            "label":"PARENT_ITEM"
                        }
                    ],
                    "parentAssignedVisits":[
                        {
                            "id":"B1B8327AFAA6412287106192AB5984EB",
                            "label":"VISIT_1"
                        }
                    ]
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormLinkFromDtov21"
            }
        },
        "assignedVisits":{
            "type":"array",
            "description":"Branch-cycle details describing visits where this form is displayed.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"VISIT_1"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
            }
        },
        "includeInSafetyCaseData":{
            "type":"boolean",
            "description":"Is form associated to Safety Case Forms",
            "example":true
        },
        "formCategory":{
            "type":"string",
            "description":"Form category",
            "example":"DCS"
        },
        "formSubcategory":{
            "type":"array",
            "description":"Form subcategory list.",
            "example":[
                "SCREENING",
                "BASELINE"
            ],
            "items":{
                "type":"string",
                "description":"Form subcategory list.",
                "example":"[\"SCREENING\",\"BASELINE\"]"
            }
        },
        "logoFileName":{
            "type":"string",
            "description":"Logo file name.",
            "example":"study-logo.png"
        },
        "logoFileUploadRequest":{
            "$ref":"#/components/schemas/FileUploadRequest"
        }
    },
    "description":"Form Info"
}

Nested Schema : assignedVisits

Type: array

Branch-cycle details describing visits where this form is displayed.

Show Source

• Array of: object From Item Advanced Property With Parent v21.0
  Title: From Item Advanced Property With Parent v21.0

  Form Item Advanced Property with Parent Info

{
    "type":"array",
    "description":"Branch-cycle details describing visits where this form is displayed.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "label":"VISIT_1"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "label":"VISIT_1"
    }
]

Nested Schema : formSubcategory

Type: array

Form subcategory list.

Show Source

• Array of: string
  Form subcategory list.

  Example: ["SCREENING","BASELINE"]

{
    "type":"array",
    "description":"Form subcategory list.",
    "example":[
        "SCREENING",
        "BASELINE"
    ],
    "items":{
        "type":"string",
        "description":"Form subcategory list.",
        "example":"[\"SCREENING\",\"BASELINE\"]"
    }
}

Example:

[
    "SCREENING",
    "BASELINE"
]

Nested Schema : items

Type: array

Form item definitions.

Show Source

• Array of: object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information

{
    "type":"array",
    "description":"Form item definitions.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "formId":"B1B8327AFAA6412287106192AB5984EA",
            "questionType":"numeric",
            "questionLabel":"Age",
            "refname":"AGE_01",
            "required":true,
            "sdvRequired":"NEVER"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemDtov21"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "formId":"B1B8327AFAA6412287106192AB5984EA",
        "questionType":"numeric",
        "questionLabel":"Age",
        "refname":"AGE_01",
        "required":true,
        "sdvRequired":"NEVER"
    }
]

Nested Schema : linkFrom

Type: array

Forms linked to this form.

Show Source

• Array of: object FormLinkFromDto v21.0
  Title: FormLinkFromDto v21.0

  Linked From Form Details

{
    "type":"array",
    "description":"Forms linked to this form.",
    "example":[
        {
            "formId":"B1B8327AFAA6412287106192AB5984EF",
            "items":[
                "B1B8327AFAA6412287106192AB5984EA"
            ]
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormLinkFromDtov21"
    }
}

Example:

[
    {
        "formId":"B1B8327AFAA6412287106192AB5984EF",
        "items":[
            "B1B8327AFAA6412287106192AB5984EA"
        ]
    }
]

Nested Schema : FileUploadRequest

Type: object

Logo upload request details.

Show Source

• contentType: string
  File content type.

  Example: image/png
• fileName(required): string
  File name

  Example: File1001
• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example: test, active, or training
• name(required): string
  Random name for bucket where file uploaded

  Example: 1A73BC4FE4954AE4AC50DDF9729F80BE

{
    "required":[
        "fileName",
        "mode",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Random name for bucket where file uploaded",
            "example":"1A73BC4FE4954AE4AC50DDF9729F80BE"
        },
        "mode":{
            "type":"string",
            "description":"Indicates the operational mode of the study. Accepted values: active, test, or training.",
            "example":"test, active, or training"
        },
        "fileName":{
            "type":"string",
            "description":"File name",
            "example":"File1001"
        },
        "contentType":{
            "type":"string",
            "description":"File content type.",
            "example":"image/png"
        }
    },
    "description":"Logo upload request details.",
    "example":{
        "name":"1A73BC4FE4954AE4AC50DDF9729F80BE",
        "mode":"design",
        "fileName":"study-logo.png",
        "contentType":"image/png"
    }
}

Example:

{
    "name":"1A73BC4FE4954AE4AC50DDF9729F80BE",
    "mode":"design",
    "fileName":"study-logo.png",
    "contentType":"image/png"
}

Nested Schema : showFrom

Type: array

Dynamic parent dependencies from forms on the same visit.

Show Source

• Array of: object FormLinkFromDto v21.0
  Title: FormLinkFromDto v21.0

  Linked From Form Details

{
    "type":"array",
    "description":"Dynamic parent dependencies from forms on the same visit.",
    "example":[
        {
            "formId":"B1B8327AFAA6412287106192AB5984EF",
            "items":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EA",
                    "label":"PARENT_ITEM"
                }
            ],
            "parentAssignedVisits":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EB",
                    "label":"VISIT_1"
                }
            ]
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormLinkFromDtov21"
    }
}

Example:

[
    {
        "formId":"B1B8327AFAA6412287106192AB5984EF",
        "items":[
            {
                "id":"B1B8327AFAA6412287106192AB5984EA",
                "label":"PARENT_ITEM"
            }
        ],
        "parentAssignedVisits":[
            {
                "id":"B1B8327AFAA6412287106192AB5984EB",
                "label":"VISIT_1"
            }
        ]
    }
]

Nested Schema : FormCopySourceDto v21.0

Type: object

Title: FormCopySourceDto v21.0

Form Copy Source Information

Show Source

• formId: string (uuid)
  Source form ID (UUID).
• rules: boolean
  Indicates whether rules were copied from the source form.

  Example: false
• studyId: string (uuid)
  Source study ID (UUID).
• studyTitle: string
  Source study title.

  Example: Study-s1
• versionStart: string (date-time)
  Source version start timestamp.

  Example: 2025-04-30T09:24:15Z

{
    "title":"FormCopySourceDto v21.0",
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Source form ID (UUID).",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "description":"Source study ID (UUID).",
            "format":"uuid"
        },
        "studyTitle":{
            "type":"string",
            "description":"Source study title.",
            "example":"Study-s1"
        },
        "versionStart":{
            "type":"string",
            "description":"Source version start timestamp.",
            "format":"date-time",
            "example":"2025-04-30T09:24:15Z"
        },
        "rules":{
            "type":"boolean",
            "description":"Indicates whether rules were copied from the source form.",
            "example":false
        }
    },
    "description":"Form Copy Source Information",
    "example":{
        "studyId":"B1B8327AFAA6412287106192AB5984EF",
        "studyTitle":"Study-s1",
        "formId":"B1B8327AFAA6412287106192AB5984EA",
        "versionStart":"2025-04-30T09:24:15Z",
        "rules":false
    }
}

Example:

{
    "studyId":"B1B8327AFAA6412287106192AB5984EF",
    "studyTitle":"Study-s1",
    "formId":"B1B8327AFAA6412287106192AB5984EA",
    "versionStart":"2025-04-30T09:24:15Z",
    "rules":false
}

Nested Schema : From Item Advanced Property With Parent v21.0

Type: object

Title: From Item Advanced Property With Parent v21.0

Form Item Advanced Property with Parent Info

Show Source

• id: string (uuid)
  Extended property ID (UUID).
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name: string
  Advanced property name

  Example: RolloverQuestionStudyId
• parentObjectId: string (uuid)
  Parent object ID (UUID).
• parentObjectLabel: string
  parent object name

  Example: Form 1
• parentObjectLevel: string
  type of parent object

  Example: FORM
• rules: array rules
  Advanced property rules list.
• type: string
  Advanced property type.

  Example: RolloverQuestion
• value: string
  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property With Parent v21.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended property ID (UUID).",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Advanced property type.",
            "example":"RolloverQuestion"
        },
        "name":{
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "description":"Advanced property rules list.",
            "example":[
                {
                    "name":"RolloverQuestionAnswer",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Yes"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov21"
            }
        },
        "parentObjectId":{
            "type":"string",
            "description":"Parent object ID (UUID).",
            "format":"uuid"
        },
        "parentObjectLabel":{
            "type":"string",
            "description":"parent object name",
            "example":"Form 1"
        },
        "parentObjectLevel":{
            "type":"string",
            "description":"type of parent object",
            "example":"FORM"
        }
    },
    "description":"Form Item Advanced Property with Parent Info"
}

Nested Schema : rules

Type: array

Advanced property rules list.

Show Source

• Array of: object FormItemAdvancedPropRuleDto v21.0
  Title: FormItemAdvancedPropRuleDto v21.0

  Form Item Advanced Property Rule

{
    "type":"array",
    "description":"Advanced property rules list.",
    "example":[
        {
            "name":"RolloverQuestionAnswer",
            "value":"B1B8327AFAA6412287106192AB5984EF",
            "label":"Yes"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov21"
    }
}

Example:

[
    {
        "name":"RolloverQuestionAnswer",
        "value":"B1B8327AFAA6412287106192AB5984EF",
        "label":"Yes"
    }
]

Nested Schema : FormItemAdvancedPropRuleDto v21.0

Type: object

Title: FormItemAdvancedPropRuleDto v21.0

Form Item Advanced Property Rule

Show Source

• label: string
  Rule label.

  Example: Yes
• name: string
  Rule name.

  Example: RolloverQuestionAnswer
• value: string
  Rule value.

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"FormItemAdvancedPropRuleDto v21.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Rule name.",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"Rule value.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rule label.",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Nested Schema : FormItemDto v21.0

Type: object

Title: FormItemDto v21.0

Discriminator: questionType

Discriminator Values

• datetime
• numeric
• measurement
• text
• choice
• questionGroup
• table
• section
• label
• existingData
• fileUpload

{
    "title":"FormItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "id":{
            "type":"string",
            "description":"Form item ID (UUID).",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form ID (UUID).",
            "format":"uuid"
        },
        "visitIds":{
            "type":"array",
            "description":"Visits associated",
            "format":"List<UUID>",
            "example":"[B1B8327AFAA6412287106192AB5984EF, B1B8327AFAA6412287106192AB5984EA]",
            "items":{
                "type":"string",
                "description":"Visits associated",
                "format":"uuid"
            }
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "questionLabel":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "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":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "applyChangeToVersion":{
            "type":"string",
            "description":"For IPR apply change to version",
            "example":"1.0.0.1"
        },
        "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
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source Data Verification Type",
            "example":"NEVER(0),ALWAYS(1),CRITICAL(2)",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "groupSequence":{
            "type":"integer",
            "description":"Group sequence.",
            "format":"int32",
            "example":3
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item ID (UUID).",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]"
        },
        "smartObject":{
            "type":"string",
            "description":"Smart object.",
            "example":"AGE"
        },
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"Lab Normals Tag used in dialog tagging",
            "example":"LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult"
        },
        "clLabNormalsTag":{
            "type":"string",
            "description":"Code list Lab Normals Tag used in the code list dialog tagging",
            "example":"LabTest, LabUnit, LabGender, LabRace, LabStandardResult"
        },
        "dataClassificationIds":{
            "type":"array",
            "description":"Data classification entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"DATA_CLASSIFICATION",
                    "name":"CLASSIFICATION_ID",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Confidential"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "requiredScreening":{
            "type":"boolean",
            "description":"Form items tagged as screening will are used as the minimum data collected on a Screening Event.",
            "example":false
        },
        "requiredRandomization":{
            "type":"boolean",
            "description":"Form items tagged as randomization will are used as the minimum data collected on a Randomization Event.",
            "example":false
        },
        "requiredDispensation":{
            "type":"boolean",
            "description":"Form items tagged as dispensation will are used as the minimum data collected on a Dispensation Event.",
            "example":false
        },
        "requiredForCaseCreate":{
            "type":"boolean",
            "description":"Form items tagged as required for case create are mandatory as the minimum data collected on a Safety Case collection.",
            "example":false
        },
        "triggerFollowupCase":{
            "type":"boolean",
            "description":"Form items tagged as trigger followup case are having safety rules enabled for safety rules creation.",
            "example":false
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        },
        "e2br3Mapping":{
            "type":"array",
            "description":"E2B R3 mapping entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"E2BR3",
                    "name":"E2B_FIELD",
                    "value":"PATIENT_AGE",
                    "label":"Patient Age"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtov21",
            "numeric":"#/components/schemas/FormNumberItemDtov21",
            "measurement":"#/components/schemas/FormNumberItemDtov21",
            "text":"#/components/schemas/FormTextItemDtov21",
            "choice":"#/components/schemas/FormChoiceItemDtov21",
            "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21",
            "table":"#/components/schemas/FormTableItemDtov21",
            "section":"#/components/schemas/FormSectionalItemDtov21",
            "label":"#/components/schemas/FormInstructionalTextItemDtov21",
            "existingData":"#/components/schemas/FormExistingDataItemDtov21",
            "fileUpload":"#/components/schemas/FormFileUploadItemDtov21"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormSectionalItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        },
        {
            "$ref":"#/components/schemas/FormInstructionalTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormExistingDataItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormFileUploadItemDtov21"
        }
    ]
}

Form Item Information

Show Source

• advancedProps: array advancedProps
• applyChangeToVersion: string
  For IPR apply change to version

  Example: 1.0.0.1
• clLabNormalsTag: string
  Code list Lab Normals Tag used in the code list dialog tagging

  Example: LabTest, LabUnit, LabGender, LabRace, LabStandardResult
• dataClassificationIds: array dataClassificationIds
  Data classification entries.
• dataClassificationLevel: string
  Data classification level if applicable

  Example: edit, view
• 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
• e2br3Mapping: array e2br3Mapping
  E2B R3 mapping entries.
• formId: string (uuid)
  Form ID (UUID).
• formTitle: string
  Form title

  Example: Demography
• formula: string
  Smart item formula.

  Example: [{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]
• groupSequence: integer (int32)
  Group sequence.

  Example: 3
• hidden: boolean
  Is form item hidden?

  Example: false
• id: string (uuid)
  Form item ID (UUID).
• 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
• labNormalsTag: string
  Lab Normals Tag used in dialog tagging

  Example: LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult
• questionHint: string
  Minimum Length: 0

  Maximum Length: 4000

  Form question hint

  Example: What is your age?
• questionLabel(required): string
  Minimum Length: 1

  Maximum Length: 4000

  Form question label

  Example: Age
• questionType(required): string
  Title: FormItemType

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

  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(required): string
  Minimum Length: 1

  Maximum Length: 64

  Form item reference name.

  Example: NUMBER_01
• required(required): boolean
  Whether this form item is requiered or not.

  Example: true
• requiredDispensation: boolean
  Form items tagged as dispensation will are used as the minimum data collected on a Dispensation Event.

  Example: false
• requiredForCaseCreate: boolean
  Form items tagged as required for case create are mandatory as the minimum data collected on a Safety Case collection.

  Example: false
• requiredRandomization: boolean
  Form items tagged as randomization will are used as the minimum data collected on a Randomization Event.

  Example: false
• requiredScreening: boolean
  Form items tagged as screening will are used as the minimum data collected on a Screening Event.

  Example: false
• ruleSet: string
  A JSON-formatted set of rules to do validation of the answers.

  Example: {'logicalOperator':'NONE','rules':[],'numberIndex':1}
• sasLabel: string
  Form Item sasLabel

  Example: Adverse Event
• sasVariable: string
  Form Item SASVariable

  Example: AE
• sdvRequired(required): string
  Allowed Values: [ "NOTSET", "NEVER", "ALWAYS", "CRITICAL" ]

  Source Data Verification Type

  Example: NEVER(0),ALWAYS(1),CRITICAL(2)
• sequence: integer (int32)
  Item position in the form.

  Example: 1
• smartItemId: string (uuid)
  Smart item ID (UUID).
• smartObject: string
  Smart object.

  Example: AGE
• triggerFollowupCase: boolean
  Form items tagged as trigger followup case are having safety rules enabled for safety rules creation.

  Example: false
• visitIds: array visitIds
  Visits associated

{
    "title":"FormItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "id":{
            "type":"string",
            "description":"Form item ID (UUID).",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form ID (UUID).",
            "format":"uuid"
        },
        "visitIds":{
            "type":"array",
            "description":"Visits associated",
            "format":"List<UUID>",
            "example":"[B1B8327AFAA6412287106192AB5984EF, B1B8327AFAA6412287106192AB5984EA]",
            "items":{
                "type":"string",
                "description":"Visits associated",
                "format":"uuid"
            }
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "questionLabel":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "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":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "applyChangeToVersion":{
            "type":"string",
            "description":"For IPR apply change to version",
            "example":"1.0.0.1"
        },
        "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
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source Data Verification Type",
            "example":"NEVER(0),ALWAYS(1),CRITICAL(2)",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "groupSequence":{
            "type":"integer",
            "description":"Group sequence.",
            "format":"int32",
            "example":3
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item ID (UUID).",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]"
        },
        "smartObject":{
            "type":"string",
            "description":"Smart object.",
            "example":"AGE"
        },
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"Lab Normals Tag used in dialog tagging",
            "example":"LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult"
        },
        "clLabNormalsTag":{
            "type":"string",
            "description":"Code list Lab Normals Tag used in the code list dialog tagging",
            "example":"LabTest, LabUnit, LabGender, LabRace, LabStandardResult"
        },
        "dataClassificationIds":{
            "type":"array",
            "description":"Data classification entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"DATA_CLASSIFICATION",
                    "name":"CLASSIFICATION_ID",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Confidential"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "requiredScreening":{
            "type":"boolean",
            "description":"Form items tagged as screening will are used as the minimum data collected on a Screening Event.",
            "example":false
        },
        "requiredRandomization":{
            "type":"boolean",
            "description":"Form items tagged as randomization will are used as the minimum data collected on a Randomization Event.",
            "example":false
        },
        "requiredDispensation":{
            "type":"boolean",
            "description":"Form items tagged as dispensation will are used as the minimum data collected on a Dispensation Event.",
            "example":false
        },
        "requiredForCaseCreate":{
            "type":"boolean",
            "description":"Form items tagged as required for case create are mandatory as the minimum data collected on a Safety Case collection.",
            "example":false
        },
        "triggerFollowupCase":{
            "type":"boolean",
            "description":"Form items tagged as trigger followup case are having safety rules enabled for safety rules creation.",
            "example":false
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        },
        "e2br3Mapping":{
            "type":"array",
            "description":"E2B R3 mapping entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"E2BR3",
                    "name":"E2B_FIELD",
                    "value":"PATIENT_AGE",
                    "label":"Patient Age"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtov21",
            "numeric":"#/components/schemas/FormNumberItemDtov21",
            "measurement":"#/components/schemas/FormNumberItemDtov21",
            "text":"#/components/schemas/FormTextItemDtov21",
            "choice":"#/components/schemas/FormChoiceItemDtov21",
            "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21",
            "table":"#/components/schemas/FormTableItemDtov21",
            "section":"#/components/schemas/FormSectionalItemDtov21",
            "label":"#/components/schemas/FormInstructionalTextItemDtov21",
            "existingData":"#/components/schemas/FormExistingDataItemDtov21",
            "fileUpload":"#/components/schemas/FormFileUploadItemDtov21"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormSectionalItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        },
        {
            "$ref":"#/components/schemas/FormInstructionalTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormExistingDataItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormFileUploadItemDtov21"
        }
    ]
}

Match One Schema

Show Source

• object FormNumberItemDto v21.0
  Title: FormNumberItemDto v21.0

  Form Number Item Details Information
• object FormChoiceItemDto v21.0
  Title: FormChoiceItemDto v21.0

  Form Choice Item Details Information
• object FormTextItemDto v21.0
  Title: FormTextItemDto v21.0

  Form text Item Details Information
• object FormDatetimeItemDto v21.0
  Title: FormDatetimeItemDto v21.0

  Form DateTime Item Details Information
• object FormQuestionGroupItemDto v21.0
  Title: FormQuestionGroupItemDto v21.0

  Form Question Group Item Details Information
• object FormTableItemDto v21.0
  Title: FormTableItemDto v21.0

  Form Table Item Details Information
• object FormSectionalItemDto v21.0
  Title: FormSectionalItemDto v21.0

  Form Sectional Item Details Information
• object FormLabelItemDto
• object FormInstructionalTextItemDto v21.0
  Title: FormInstructionalTextItemDto v21.0

  Form Instructional Text Item Details Information
• object FormExistingDataItemDtov21
  Form existing data item Information
• object FormFileUploadItemDto v21.0
  Title: FormFileUploadItemDto v21.0

  Form File Upload Item Details Information

{
    "title":"FormItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "properties":{
        "questionType":{
            "title":"FormItemType",
            "type":"string",
            "description":"Question type",
            "example":"numeric",
            "enum":[
                "text",
                "instructionalText",
                "numeric",
                "datetime",
                "choice",
                "questionGroup",
                "table",
                "label",
                "section",
                "existingData",
                "fileUpload"
            ]
        },
        "id":{
            "type":"string",
            "description":"Form item ID (UUID).",
            "format":"uuid"
        },
        "formId":{
            "type":"string",
            "description":"Form ID (UUID).",
            "format":"uuid"
        },
        "visitIds":{
            "type":"array",
            "description":"Visits associated",
            "format":"List<UUID>",
            "example":"[B1B8327AFAA6412287106192AB5984EF, B1B8327AFAA6412287106192AB5984EA]",
            "items":{
                "type":"string",
                "description":"Visits associated",
                "format":"uuid"
            }
        },
        "formTitle":{
            "type":"string",
            "description":"Form title",
            "example":"Demography"
        },
        "questionLabel":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form question label",
            "example":"Age"
        },
        "questionHint":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Form question hint",
            "example":"What is your age?"
        },
        "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":{
            "maxLength":64,
            "minLength":1,
            "type":"string",
            "description":"Form item reference name.",
            "example":"NUMBER_01"
        },
        "applyChangeToVersion":{
            "type":"string",
            "description":"For IPR apply change to version",
            "example":"1.0.0.1"
        },
        "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
        },
        "ruleSet":{
            "type":"string",
            "description":"A JSON-formatted set of rules to do validation of the answers.",
            "example":"{'logicalOperator':'NONE','rules':[],'numberIndex':1}"
        },
        "sdvRequired":{
            "type":"string",
            "description":"Source Data Verification Type",
            "example":"NEVER(0),ALWAYS(1),CRITICAL(2)",
            "enum":[
                "NOTSET",
                "NEVER",
                "ALWAYS",
                "CRITICAL"
            ]
        },
        "sequence":{
            "type":"integer",
            "description":"Item position in the form.",
            "format":"int32",
            "example":1
        },
        "groupSequence":{
            "type":"integer",
            "description":"Group sequence.",
            "format":"int32",
            "example":3
        },
        "smartItemId":{
            "type":"string",
            "description":"Smart item ID (UUID).",
            "format":"uuid"
        },
        "formula":{
            "type":"string",
            "description":"Smart item formula.",
            "example":"[{'ruleName':'AGE','ruleExpression':'AgeInYears(AGE_DOB_01, visitDate)'}]"
        },
        "smartObject":{
            "type":"string",
            "description":"Smart object.",
            "example":"AGE"
        },
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "sasVariable":{
            "type":"string",
            "description":"Form Item SASVariable",
            "example":"AE"
        },
        "sasLabel":{
            "type":"string",
            "description":"Form Item sasLabel",
            "example":"Adverse Event"
        },
        "labNormalsTag":{
            "type":"string",
            "description":"Lab Normals Tag used in dialog tagging",
            "example":"LabTest, LabUnit, LabLowRange, LabHighRange, LabStandardResult"
        },
        "clLabNormalsTag":{
            "type":"string",
            "description":"Code list Lab Normals Tag used in the code list dialog tagging",
            "example":"LabTest, LabUnit, LabGender, LabRace, LabStandardResult"
        },
        "dataClassificationIds":{
            "type":"array",
            "description":"Data classification entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"DATA_CLASSIFICATION",
                    "name":"CLASSIFICATION_ID",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Confidential"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        },
        "requiredScreening":{
            "type":"boolean",
            "description":"Form items tagged as screening will are used as the minimum data collected on a Screening Event.",
            "example":false
        },
        "requiredRandomization":{
            "type":"boolean",
            "description":"Form items tagged as randomization will are used as the minimum data collected on a Randomization Event.",
            "example":false
        },
        "requiredDispensation":{
            "type":"boolean",
            "description":"Form items tagged as dispensation will are used as the minimum data collected on a Dispensation Event.",
            "example":false
        },
        "requiredForCaseCreate":{
            "type":"boolean",
            "description":"Form items tagged as required for case create are mandatory as the minimum data collected on a Safety Case collection.",
            "example":false
        },
        "triggerFollowupCase":{
            "type":"boolean",
            "description":"Form items tagged as trigger followup case are having safety rules enabled for safety rules creation.",
            "example":false
        },
        "dataClassificationLevel":{
            "type":"string",
            "description":"Data classification level if applicable",
            "example":"edit, view"
        },
        "e2br3Mapping":{
            "type":"array",
            "description":"E2B R3 mapping entries.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "type":"E2BR3",
                    "name":"E2B_FIELD",
                    "value":"PATIENT_AGE",
                    "label":"Patient Age"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
            }
        }
    },
    "description":"Form Item Information",
    "discriminator":{
        "propertyName":"questionType",
        "mapping":{
            "datetime":"#/components/schemas/FormDatetimeItemDtov21",
            "numeric":"#/components/schemas/FormNumberItemDtov21",
            "measurement":"#/components/schemas/FormNumberItemDtov21",
            "text":"#/components/schemas/FormTextItemDtov21",
            "choice":"#/components/schemas/FormChoiceItemDtov21",
            "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21",
            "table":"#/components/schemas/FormTableItemDtov21",
            "section":"#/components/schemas/FormSectionalItemDtov21",
            "label":"#/components/schemas/FormInstructionalTextItemDtov21",
            "existingData":"#/components/schemas/FormExistingDataItemDtov21",
            "fileUpload":"#/components/schemas/FormFileUploadItemDtov21"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/FormNumberItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormChoiceItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormDatetimeItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormQuestionGroupItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormTableItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormSectionalItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormLabelItemDto"
        },
        {
            "$ref":"#/components/schemas/FormInstructionalTextItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormExistingDataItemDtov21"
        },
        {
            "$ref":"#/components/schemas/FormFileUploadItemDtov21"
        }
    ]
}

Nested Schema : advancedProps

Type: array

Show Source

• Array of: object FormItemAdvancedPropDto v21.0
  Title: FormItemAdvancedPropDto v21.0

  Form Item Advanced Property

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

Nested Schema : dataClassificationIds

Type: array

Data classification entries.

Show Source

• Array of: object FormItemAdvancedPropDto v21.0
  Title: FormItemAdvancedPropDto v21.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"Data classification entries.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "type":"DATA_CLASSIFICATION",
            "name":"CLASSIFICATION_ID",
            "value":"B1B8327AFAA6412287106192AB5984EF",
            "label":"Confidential"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "type":"DATA_CLASSIFICATION",
        "name":"CLASSIFICATION_ID",
        "value":"B1B8327AFAA6412287106192AB5984EF",
        "label":"Confidential"
    }
]

Nested Schema : e2br3Mapping

Type: array

E2B R3 mapping entries.

Show Source

• Array of: object FormItemAdvancedPropDto v21.0
  Title: FormItemAdvancedPropDto v21.0

  Form Item Advanced Property

{
    "type":"array",
    "description":"E2B R3 mapping entries.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "type":"E2BR3",
            "name":"E2B_FIELD",
            "value":"PATIENT_AGE",
            "label":"Patient Age"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropDtov21"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "type":"E2BR3",
        "name":"E2B_FIELD",
        "value":"PATIENT_AGE",
        "label":"Patient Age"
    }
]

Nested Schema : visitIds

Type: array

Visits associated

Show Source

• Array of: string(uuid)
  Visits associated

{
    "type":"array",
    "description":"Visits associated",
    "format":"List<UUID>",
    "example":"[B1B8327AFAA6412287106192AB5984EF, B1B8327AFAA6412287106192AB5984EA]",
    "items":{
        "type":"string",
        "description":"Visits associated",
        "format":"uuid"
    }
}

Example:

[B1B8327AFAA6412287106192AB5984EF, B1B8327AFAA6412287106192AB5984EA]

Nested Schema : FormNumberItemDto v21.0

Type: object

Title: FormNumberItemDto v21.0

Form Number Item Details Information

Match All

Form Number Item Details Information

Form Number Item Details Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information
• object FormNumberItemDto v21.0-allOf[1]

{
    "title":"FormNumberItemDto v21.0",
    "required":[
        "precision",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Number Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "precision":{
                    "minimum":0,
                    "type":"integer",
                    "description":"Number value precision",
                    "format":"int32",
                    "example":1
                },
                "units":{
                    "type":"string",
                    "description":"Units of measure",
                    "example":"kg"
                }
            }
        }
    ]
}

Nested Schema : FormChoiceItemDto v21.0

Type: object

Title: FormChoiceItemDto v21.0

Form Choice Item Details Information

Match All

Form Choice Item Details Information

Form Choice Item Details Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information
• object FormChoiceItemDto v21.0-allOf[1]

{
    "title":"FormChoiceItemDto v21.0",
    "required":[
        "display",
        "options",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Choice Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "advancedProps":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
                    }
                },
                "display":{
                    "pattern":"selectbox|checkbox|radioset|label",
                    "type":"string",
                    "description":"Form choice item display in UI - Selectbox.",
                    "example":"selectbox"
                },
                "columnLayout":{
                    "type":"string",
                    "description":"Coumn Layout codelist ID",
                    "example":"EBCF17C5F8D4460AA4A9673485C79CF0"
                },
                "columnLayoutLabel":{
                    "type":"string",
                    "description":"Coumn Layout Label in UI",
                    "example":"Single"
                },
                "options":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormOptionDtov21"
                    }
                },
                "clTitle":{
                    "type":"string",
                    "description":"Codelist title only for choice type formitem",
                    "example":"Gender"
                },
                "clDescription":{
                    "maxLength":4000,
                    "minLength":0,
                    "type":"string",
                    "description":"Codelist description only for choice type formitem",
                    "example":"Standard gender codelist"
                },
                "isCodeListReplaced":{
                    "type":"boolean",
                    "description":"Indicates if the choice option codelist is replaced",
                    "example":true
                },
                "codelistType":{
                    "type":"string",
                    "description":"Form items field to indicate dynamic or static variant of the codelist mapped to item. ",
                    "enum":[
                        "STATIC, DYNAMIC"
                    ]
                },
                "codelistId":{
                    "type":"string",
                    "description":"ID of the codelist used in the question ",
                    "format":"uuid"
                },
                "codelistLang":{
                    "type":"string",
                    "description":"Language of the codelist used in the question ",
                    "example":"en-US"
                }
            }
        }
    ]
}

Nested Schema : FormTextItemDto v21.0

Type: object

Title: FormTextItemDto v21.0

Form text Item Details Information

Match All

Form text Item Details Information

Form text Item Details Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information
• object FormTextItemDto v21.0-allOf[1]

{
    "title":"FormTextItemDto v21.0",
    "required":[
        "maxlength",
        "multiline",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form text Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "maxlength":{
                    "maximum":4000,
                    "minimum":0,
                    "type":"integer",
                    "description":"Form text item max length",
                    "format":"int32",
                    "example":4000
                },
                "multiline":{
                    "type":"boolean",
                    "description":"Is form text item multiline",
                    "example":false
                }
            }
        }
    ]
}

Nested Schema : FormDatetimeItemDto v21.0

Type: object

Title: FormDatetimeItemDto v21.0

Form DateTime Item Details Information

Match All

Form DateTime Item Details Information

Form DateTime Item Details Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information
• object FormDatetimeItemDto v21.0-allOf[1]

{
    "title":"FormDatetimeItemDto v21.0",
    "required":[
        "format",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form DateTime Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "format":{
                    "type":"string",
                    "description":"Date time format",
                    "example":"DD-MON-YYYY"
                },
                "allowPartialDate":{
                    "maximum":1,
                    "minimum":0,
                    "type":"integer",
                    "description":"Allow partial date",
                    "format":"int32",
                    "example":1
                },
                "partialDate":{
                    "type":"string",
                    "description":"Partial date format",
                    "example":"Jan-1993"
                },
                "allowFutureDate":{
                    "maximum":1,
                    "minimum":0,
                    "type":"integer",
                    "description":"Allow future date",
                    "format":"int32",
                    "example":1
                }
            }
        }
    ]
}

Nested Schema : FormQuestionGroupItemDto v21.0

Type: object

Title: FormQuestionGroupItemDto v21.0

Form Question Group Item Details Information

Match All

Form Question Group Item Details Information

Form Question Group Item Details Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information
• object FormQuestionGroupItemDto v21.0-allOf[1]

{
    "title":"FormQuestionGroupItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Question Group Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemDtov21"
                    }
                }
            }
        }
    ]
}

Nested Schema : FormTableItemDto v21.0

Type: object

Title: FormTableItemDto v21.0

Form Table Item Details Information

Match All

Form Table Item Details Information

Form Table Item Details Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information
• object FormTableItemDto v21.0-allOf[1]

{
    "title":"FormTableItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Table Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "allowAdditionalRows":{
                    "type":"boolean"
                }
            }
        }
    ]
}

Nested Schema : FormSectionalItemDto v21.0

Type: object

Title: FormSectionalItemDto v21.0

Form Sectional Item Details Information

Match All

Form Sectional Item Details Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information

{
    "title":"FormSectionalItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Sectional Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        }
    ]
}

Nested Schema : FormLabelItemDto

Type: object

Match All

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information
• object FormLabelItemDto-allOf[1]

{
    "required":[
        "display",
        "options",
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "advancedProps":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
                    }
                },
                "display":{
                    "pattern":"selectbox|checkbox|radioset|label",
                    "type":"string",
                    "description":"Form choice item display in UI - Selectbox.",
                    "example":"selectbox"
                },
                "columnLayout":{
                    "type":"string",
                    "description":"Coumn Layout codelist ID",
                    "example":"EBCF17C5F8D4460AA4A9673485C79CF0"
                },
                "columnLayoutLabel":{
                    "type":"string",
                    "description":"Coumn Layout Label in UI",
                    "example":"Single"
                },
                "options":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormOptionDtov21"
                    }
                },
                "clTitle":{
                    "type":"string",
                    "description":"Codelist title only for choice type formitem",
                    "example":"Gender"
                },
                "clDescription":{
                    "maxLength":4000,
                    "minLength":0,
                    "type":"string",
                    "description":"Codelist description only for choice type formitem",
                    "example":"Standard gender codelist"
                },
                "isCodeListReplaced":{
                    "type":"boolean",
                    "description":"Indicates if the choice option codelist is replaced",
                    "example":true
                },
                "codelistType":{
                    "type":"string",
                    "description":"Form items field to indicate dynamic or static variant of the codelist mapped to item. ",
                    "enum":[
                        "STATIC, DYNAMIC"
                    ]
                },
                "codelistId":{
                    "type":"string",
                    "description":"ID of the codelist used in the question ",
                    "format":"uuid"
                },
                "codelistLang":{
                    "type":"string",
                    "description":"Language of the codelist used in the question ",
                    "example":"en-US"
                }
            }
        }
    ]
}

Nested Schema : FormInstructionalTextItemDto v21.0

Type: object

Title: FormInstructionalTextItemDto v21.0

Form Instructional Text Item Details Information

Match All

Form Instructional Text Item Details Information

Form Instructional Text Item Details Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information
• object FormInstructionalTextItemDto v21.0-allOf[1]

{
    "title":"FormInstructionalTextItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form Instructional Text Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "instructionalText":{
                    "type":"string",
                    "description":"Instructional text content",
                    "example":"Please fill this form carefully"
                }
            }
        }
    ]
}

Nested Schema : FormExistingDataItemDtov21

Type: object

Form existing data item Information

Match All

Form existing data item Information

Form existing data item Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information
• object FormExistingDataItemDtov21-allOf[1]

{
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form existing data item Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        },
        {
            "type":"object",
            "properties":{
                "codeName":{
                    "type":"string",
                    "description":"Codelist name for existing data, must be a value from ExistingDataLabels codelist",
                    "example":"EDLSite"
                },
                "codeValue":{
                    "type":"string",
                    "description":"Codelist value specifying existing data, must be a value from codelist defined in codeName",
                    "example":"SiteName"
                }
            }
        }
    ]
}

Nested Schema : FormFileUploadItemDto v21.0

Type: object

Title: FormFileUploadItemDto v21.0

Form File Upload Item Details Information

Match All

Form File Upload Item Details Information

Show Source

• object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information

{
    "title":"FormFileUploadItemDto v21.0",
    "required":[
        "questionLabel",
        "questionType",
        "refname",
        "required",
        "sdvRequired"
    ],
    "type":"object",
    "description":"Form File Upload Item Details Information",
    "allOf":[
        {
            "$ref":"#/components/schemas/FormItemDtov21"
        }
    ]
}

Nested Schema : FormItemAdvancedPropDto v21.0

Type: object

Title: FormItemAdvancedPropDto v21.0

Form Item Advanced Property

Show Source

• id: string (uuid)
  Extended property ID (UUID).
• label: string
  Rollover study name

  Example: Rollover Study BT-31
• name: string
  Advanced property name

  Example: RolloverQuestionStudyId
• rules: array rules
  Advanced property rules list.
• type: string
  Advanced property type.

  Example: RolloverQuestion
• value: string
  Advanced property value. For example, rollover study UUID

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"FormItemAdvancedPropDto v21.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended property ID (UUID).",
            "format":"uuid"
        },
        "type":{
            "type":"string",
            "description":"Advanced property type.",
            "example":"RolloverQuestion"
        },
        "name":{
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "description":"Advanced property rules list.",
            "example":[
                {
                    "name":"RolloverQuestionAnswer",
                    "value":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"Yes"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov21"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Advanced property rules list.

Show Source

• Array of: object FormItemAdvancedPropRuleDto v21.0
  Title: FormItemAdvancedPropRuleDto v21.0

  Form Item Advanced Property Rule

{
    "type":"array",
    "description":"Advanced property rules list.",
    "example":[
        {
            "name":"RolloverQuestionAnswer",
            "value":"B1B8327AFAA6412287106192AB5984EF",
            "label":"Yes"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov21"
    }
}

Example:

[
    {
        "name":"RolloverQuestionAnswer",
        "value":"B1B8327AFAA6412287106192AB5984EF",
        "label":"Yes"
    }
]

Nested Schema : FormNumberItemDto v21.0-allOf[1]

Type: object

Show Source

• precision: integer (int32)
  Minimum Value: 0

  Number value precision

  Example: 1
• units: string
  Units of measure

  Example: kg

{
    "type":"object",
    "properties":{
        "precision":{
            "minimum":0,
            "type":"integer",
            "description":"Number value precision",
            "format":"int32",
            "example":1
        },
        "units":{
            "type":"string",
            "description":"Units of measure",
            "example":"kg"
        }
    }
}

Nested Schema : FormChoiceItemDto v21.0-allOf[1]

Type: object

Show Source

• advancedProps: array advancedProps
• clDescription: string
  Minimum Length: 0

  Maximum Length: 4000

  Codelist description only for choice type formitem

  Example: Standard gender codelist
• clTitle: string
  Codelist title only for choice type formitem

  Example: Gender
• codelistId: string (uuid)
  ID of the codelist used in the question
• codelistLang: string
  Language of the codelist used in the question

  Example: en-US
• codelistType: string
  Allowed Values: [ "STATIC, DYNAMIC" ]

  Form items field to indicate dynamic or static variant of the codelist mapped to item.
• columnLayout: string
  Coumn Layout codelist ID

  Example: EBCF17C5F8D4460AA4A9673485C79CF0
• columnLayoutLabel: string
  Coumn Layout Label in UI

  Example: Single
• display: string
  Pattern: selectbox|checkbox|radioset|label

  Form choice item display in UI - Selectbox.

  Example: selectbox
• isCodeListReplaced: boolean
  Indicates if the choice option codelist is replaced

  Example: true
• options: array options

{
    "type":"object",
    "properties":{
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
            }
        },
        "display":{
            "pattern":"selectbox|checkbox|radioset|label",
            "type":"string",
            "description":"Form choice item display in UI - Selectbox.",
            "example":"selectbox"
        },
        "columnLayout":{
            "type":"string",
            "description":"Coumn Layout codelist ID",
            "example":"EBCF17C5F8D4460AA4A9673485C79CF0"
        },
        "columnLayoutLabel":{
            "type":"string",
            "description":"Coumn Layout Label in UI",
            "example":"Single"
        },
        "options":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormOptionDtov21"
            }
        },
        "clTitle":{
            "type":"string",
            "description":"Codelist title only for choice type formitem",
            "example":"Gender"
        },
        "clDescription":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Codelist description only for choice type formitem",
            "example":"Standard gender codelist"
        },
        "isCodeListReplaced":{
            "type":"boolean",
            "description":"Indicates if the choice option codelist is replaced",
            "example":true
        },
        "codelistType":{
            "type":"string",
            "description":"Form items field to indicate dynamic or static variant of the codelist mapped to item. ",
            "enum":[
                "STATIC, DYNAMIC"
            ]
        },
        "codelistId":{
            "type":"string",
            "description":"ID of the codelist used in the question ",
            "format":"uuid"
        },
        "codelistLang":{
            "type":"string",
            "description":"Language of the codelist used in the question ",
            "example":"en-US"
        }
    }
}

Nested Schema : advancedProps

Type: array

Show Source

• Array of: object From Item Advanced Property With Parent v21.0
  Title: From Item Advanced Property With Parent v21.0

  Form Item Advanced Property with Parent Info

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

Nested Schema : options

Type: array

Show Source

• Array of: object FormOptionDto v21.0
  Title: FormOptionDto v21.0

  Form choice item option details

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

Nested Schema : FormOptionDto v21.0

Type: object

Title: FormOptionDto v21.0

Form choice item option details

Show Source

• clCode: string
  Codelist code for a one specific choice.

  Example: 1
• clDescription: string
  Minimum Length: 1

  Maximum Length: 4000

  Codelist description for a one specific choice.

  Example: 1
• clItemId: string (uuid)
  Codelist item id for a one specific choice.
• clValue: string
  Codelist value for a one specific choice.

  Example: 1
• hidden: boolean
  Is form item option hidden?

  Example: false
• label: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice selectbox label for a one specific choice.

  Example: Female
• optionSeq: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice sequence value for a one specific choice.

  Example: 1
• value: string
  Minimum Length: 1

  Maximum Length: 4000

  Form choice selectbox value for a one specific choice.

  Example: 1

{
    "title":"FormOptionDto v21.0",
    "type":"object",
    "properties":{
        "label":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form choice selectbox label for a one specific choice.",
            "example":"Female"
        },
        "value":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form choice selectbox value for a one specific choice.",
            "example":"1"
        },
        "clCode":{
            "type":"string",
            "description":"Codelist code for a one specific choice.",
            "example":"1"
        },
        "clDescription":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Codelist description for a one specific choice.",
            "example":"1"
        },
        "clValue":{
            "type":"string",
            "description":"Codelist value for a one specific choice.",
            "example":"1"
        },
        "clItemId":{
            "type":"string",
            "description":"Codelist item id for a one specific choice.",
            "format":"uuid"
        },
        "hidden":{
            "type":"boolean",
            "description":"Is form item option hidden?",
            "example":false
        },
        "optionSeq":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Form choice sequence value for a one specific choice.",
            "example":"1"
        }
    },
    "description":"Form choice item option details"
}

Nested Schema : FormTextItemDto v21.0-allOf[1]

Type: object

Show Source

• maxlength: integer (int32)
  Minimum Value: 0

  Maximum Value: 4000

  Form text item max length

  Example: 4000
• multiline: boolean
  Is form text item multiline

  Example: false

{
    "type":"object",
    "properties":{
        "maxlength":{
            "maximum":4000,
            "minimum":0,
            "type":"integer",
            "description":"Form text item max length",
            "format":"int32",
            "example":4000
        },
        "multiline":{
            "type":"boolean",
            "description":"Is form text item multiline",
            "example":false
        }
    }
}

Nested Schema : FormDatetimeItemDto v21.0-allOf[1]

Type: object

Show Source

• allowFutureDate: integer (int32)
  Minimum Value: 0

  Maximum Value: 1

  Allow future date

  Example: 1
• allowPartialDate: integer (int32)
  Minimum Value: 0

  Maximum Value: 1

  Allow partial date

  Example: 1
• format: string
  Date time format

  Example: DD-MON-YYYY
• partialDate: string
  Partial date format

  Example: Jan-1993

{
    "type":"object",
    "properties":{
        "format":{
            "type":"string",
            "description":"Date time format",
            "example":"DD-MON-YYYY"
        },
        "allowPartialDate":{
            "maximum":1,
            "minimum":0,
            "type":"integer",
            "description":"Allow partial date",
            "format":"int32",
            "example":1
        },
        "partialDate":{
            "type":"string",
            "description":"Partial date format",
            "example":"Jan-1993"
        },
        "allowFutureDate":{
            "maximum":1,
            "minimum":0,
            "type":"integer",
            "description":"Allow future date",
            "format":"int32",
            "example":1
        }
    }
}

Nested Schema : FormQuestionGroupItemDto v21.0-allOf[1]

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object FormItemDto v21.0
  Title: FormItemDto v21.0

  Discriminator: { "propertyName":"questionType", "mapping":{ "datetime":"#/components/schemas/FormDatetimeItemDtov21", "numeric":"#/components/schemas/FormNumberItemDtov21", "measurement":"#/components/schemas/FormNumberItemDtov21", "text":"#/components/schemas/FormTextItemDtov21", "choice":"#/components/schemas/FormChoiceItemDtov21", "questionGroup":"#/components/schemas/FormQuestionGroupItemDtov21", "table":"#/components/schemas/FormTableItemDtov21", "section":"#/components/schemas/FormSectionalItemDtov21", "label":"#/components/schemas/FormInstructionalTextItemDtov21", "existingData":"#/components/schemas/FormExistingDataItemDtov21", "fileUpload":"#/components/schemas/FormFileUploadItemDtov21" } }

  Form Item Information

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

Nested Schema : FormTableItemDto v21.0-allOf[1]

Type: object

Show Source

• allowAdditionalRows: boolean

{
    "type":"object",
    "properties":{
        "allowAdditionalRows":{
            "type":"boolean"
        }
    }
}

Nested Schema : FormLabelItemDto-allOf[1]

Type: object

Show Source

• advancedProps: array advancedProps
• clDescription: string
  Minimum Length: 0

  Maximum Length: 4000

  Codelist description only for choice type formitem

  Example: Standard gender codelist
• clTitle: string
  Codelist title only for choice type formitem

  Example: Gender
• codelistId: string (uuid)
  ID of the codelist used in the question
• codelistLang: string
  Language of the codelist used in the question

  Example: en-US
• codelistType: string
  Allowed Values: [ "STATIC, DYNAMIC" ]

  Form items field to indicate dynamic or static variant of the codelist mapped to item.
• columnLayout: string
  Coumn Layout codelist ID

  Example: EBCF17C5F8D4460AA4A9673485C79CF0
• columnLayoutLabel: string
  Coumn Layout Label in UI

  Example: Single
• display: string
  Pattern: selectbox|checkbox|radioset|label

  Form choice item display in UI - Selectbox.

  Example: selectbox
• isCodeListReplaced: boolean
  Indicates if the choice option codelist is replaced

  Example: true
• options: array options

{
    "type":"object",
    "properties":{
        "advancedProps":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
            }
        },
        "display":{
            "pattern":"selectbox|checkbox|radioset|label",
            "type":"string",
            "description":"Form choice item display in UI - Selectbox.",
            "example":"selectbox"
        },
        "columnLayout":{
            "type":"string",
            "description":"Coumn Layout codelist ID",
            "example":"EBCF17C5F8D4460AA4A9673485C79CF0"
        },
        "columnLayoutLabel":{
            "type":"string",
            "description":"Coumn Layout Label in UI",
            "example":"Single"
        },
        "options":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormOptionDtov21"
            }
        },
        "clTitle":{
            "type":"string",
            "description":"Codelist title only for choice type formitem",
            "example":"Gender"
        },
        "clDescription":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Codelist description only for choice type formitem",
            "example":"Standard gender codelist"
        },
        "isCodeListReplaced":{
            "type":"boolean",
            "description":"Indicates if the choice option codelist is replaced",
            "example":true
        },
        "codelistType":{
            "type":"string",
            "description":"Form items field to indicate dynamic or static variant of the codelist mapped to item. ",
            "enum":[
                "STATIC, DYNAMIC"
            ]
        },
        "codelistId":{
            "type":"string",
            "description":"ID of the codelist used in the question ",
            "format":"uuid"
        },
        "codelistLang":{
            "type":"string",
            "description":"Language of the codelist used in the question ",
            "example":"en-US"
        }
    }
}

Nested Schema : advancedProps

Type: array

Show Source

• Array of: object From Item Advanced Property With Parent v21.0
  Title: From Item Advanced Property With Parent v21.0

  Form Item Advanced Property with Parent Info

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

Nested Schema : options

Type: array

Show Source

• Array of: object FormOptionDto v21.0
  Title: FormOptionDto v21.0

  Form choice item option details

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

Nested Schema : FormInstructionalTextItemDto v21.0-allOf[1]

Type: object

Show Source

• instructionalText: string
  Instructional text content

  Example: Please fill this form carefully

{
    "type":"object",
    "properties":{
        "instructionalText":{
            "type":"string",
            "description":"Instructional text content",
            "example":"Please fill this form carefully"
        }
    }
}

Nested Schema : FormExistingDataItemDtov21-allOf[1]

Type: object

Show Source

• codeName: string
  Codelist name for existing data, must be a value from ExistingDataLabels codelist

  Example: EDLSite
• codeValue: string
  Codelist value specifying existing data, must be a value from codelist defined in codeName

  Example: SiteName

{
    "type":"object",
    "properties":{
        "codeName":{
            "type":"string",
            "description":"Codelist name for existing data, must be a value from ExistingDataLabels codelist",
            "example":"EDLSite"
        },
        "codeValue":{
            "type":"string",
            "description":"Codelist value specifying existing data, must be a value from codelist defined in codeName",
            "example":"SiteName"
        }
    }
}

Nested Schema : FormLinkFromDto v21.0

Type: object

Title: FormLinkFromDto v21.0

Linked From Form Details

Show Source

• formId: string (uuid)
  Form ID (UUID).
• items: array items
  Linked parent item details.
• parentAssignedVisits: array parentAssignedVisits
  Parent assigned visit details.

{
    "title":"FormLinkFromDto v21.0",
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form ID (UUID).",
            "format":"uuid"
        },
        "items":{
            "type":"array",
            "description":"Linked parent item details.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"PARENT_ITEM"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
            }
        },
        "parentAssignedVisits":{
            "type":"array",
            "description":"Parent assigned visit details.",
            "example":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EF",
                    "label":"VISIT_1"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
            }
        }
    },
    "description":"Linked From Form Details",
    "example":[
        {
            "formId":"B1B8327AFAA6412287106192AB5984EF",
            "items":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EA",
                    "label":"PARENT_ITEM"
                }
            ],
            "parentAssignedVisits":[
                {
                    "id":"B1B8327AFAA6412287106192AB5984EB",
                    "label":"VISIT_1"
                }
            ]
        }
    ]
}

Example:

[
    {
        "formId":"B1B8327AFAA6412287106192AB5984EF",
        "items":[
            {
                "id":"B1B8327AFAA6412287106192AB5984EA",
                "label":"PARENT_ITEM"
            }
        ],
        "parentAssignedVisits":[
            {
                "id":"B1B8327AFAA6412287106192AB5984EB",
                "label":"VISIT_1"
            }
        ]
    }
]

Nested Schema : items

Type: array

Linked parent item details.

Show Source

• Array of: object From Item Advanced Property With Parent v21.0
  Title: From Item Advanced Property With Parent v21.0

  Form Item Advanced Property with Parent Info

{
    "type":"array",
    "description":"Linked parent item details.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "label":"PARENT_ITEM"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "label":"PARENT_ITEM"
    }
]

Nested Schema : parentAssignedVisits

Type: array

Parent assigned visit details.

Show Source

• Array of: object From Item Advanced Property With Parent v21.0
  Title: From Item Advanced Property With Parent v21.0

  Form Item Advanced Property with Parent Info

{
    "type":"array",
    "description":"Parent assigned visit details.",
    "example":[
        {
            "id":"B1B8327AFAA6412287106192AB5984EF",
            "label":"VISIT_1"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/FormItemAdvancedPropWithParentDtov21"
    }
}

Example:

[
    {
        "id":"B1B8327AFAA6412287106192AB5984EF",
        "label":"VISIT_1"
    }
]

Examples

Select an example visitFormsResponse

500 Response

Unexpected server error while retrieving visit forms.

Body ()

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

Back to Top