Jump to

• Request
• Response

V1.0

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/repeatinginstances/multiple/subjectId/{subjectId}

Consolidated API for Rule Service to fetch repeatinginstances and multiple data elements in one call.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts test, active, or training.
• studyId(required): string
  ID of the study for which you want to retrieve the audit history of a data element.
• subjectId(required): string
  ID of the subject.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request payload for consolidated DC calls used by Rule Service.

Show Source

• multiple: array multiple
  Input for multiple (equivalent to dataelements/multiple endpoint).
• repeatinginstances: array repeatinginstances
  Input for repeatinginstances (equivalent to repeatinginstances endpoint).

{
    "type":"object",
    "properties":{
        "repeatinginstances":{
            "type":"array",
            "description":"Input for repeatinginstances (equivalent to repeatinginstances endpoint).",
            "items":{
                "$ref":"#/components/schemas/RepeatingDataElementDetails"
            }
        },
        "multiple":{
            "type":"array",
            "description":"Input for multiple (equivalent to dataelements/multiple endpoint).",
            "items":{
                "$ref":"#/components/schemas/DataElementDetails30"
            }
        }
    },
    "description":"Request payload for consolidated DC calls used by Rule Service."
}

Nested Schema : multiple

Type: array

Input for multiple (equivalent to dataelements/multiple endpoint).

Show Source

• Array of: object DataElementDetails30
  Data element details (v3) including flag to indicate whether previous value is requested.

{
    "type":"array",
    "description":"Input for multiple (equivalent to dataelements/multiple endpoint).",
    "items":{
        "$ref":"#/components/schemas/DataElementDetails30"
    }
}

Nested Schema : repeatinginstances

Type: array

Input for repeatinginstances (equivalent to repeatinginstances endpoint).

Show Source

• Array of: object RepeatingDataElementDetails
  Identifiers to locate a specific data element for which repeating instances may exist

{
    "type":"array",
    "description":"Input for repeatinginstances (equivalent to repeatinginstances endpoint).",
    "items":{
        "$ref":"#/components/schemas/RepeatingDataElementDetails"
    }
}

Nested Schema : DataElementDetails30

Type: object

Data element details (v3) including flag to indicate whether previous value is requested.

Show Source

• eventId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: CBCDEF1234567890ABCDEF1234567890
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

  Example: 1
• formId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 40DB4EF4847849CCB24EFCCB71CDA436
• formSectionId: string (UUID)
  Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: 50DB4EF4847849CCB24EFCCB71CDA436
• isPrevValue: boolean
  If true, indicates the request refers to previous value

  Example: false
• itemId: string (UUID)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.

  Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
• repeatSequenceNumber: integer (int32)
  Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

  Example: 1
• repeatTwoSectionFormNumber: integer (int32)
  Repeat section form number, if applicable.

  Example: 1
• subjectId: string (UUID)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: BBCDEF1234567890ABCDEF1234567890

{
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"BBCDEF1234567890ABCDEF1234567890"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"CBCDEF1234567890ABCDEF1234567890"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "repeatSequenceNumber":{
            "type":"integer",
            "description":"Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.",
            "format":"int32",
            "example":1
        },
        "itemId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.",
            "format":"UUID",
            "example":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "repeatTwoSectionFormNumber":{
            "type":"integer",
            "description":"Repeat section form number, if applicable.",
            "format":"int32",
            "example":1
        },
        "formSectionId":{
            "type":"string",
            "description":"Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"50DB4EF4847849CCB24EFCCB71CDA436"
        },
        "isPrevValue":{
            "type":"boolean",
            "description":"If true, indicates the request refers to previous value",
            "example":false
        }
    },
    "description":"Data element details (v3) including flag to indicate whether previous value is requested."
}

Nested Schema : RepeatingDataElementDetails

Type: object

Identifiers to locate a specific data element for which repeating instances may exist

Show Source

• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: A3F27C5D9B1E4D55A8E0C4F19A2D7F31
• formId(required): string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 7C1E5AB4D9F648E4A93B21EF0A67C9D2
• itemId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.

  Example: 3F9D2A7C6E1B4C35B8D0F1239A45E8CD

{
    "required":[
        "formId",
        "itemId"
    ],
    "type":"object",
    "properties":{
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"A3F27C5D9B1E4D55A8E0C4F19A2D7F31"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"7C1E5AB4D9F648E4A93B21EF0A67C9D2"
        },
        "itemId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.",
            "example":"3F9D2A7C6E1B4C35B8D0F1239A45E8CD"
        }
    },
    "description":"Identifiers to locate a specific data element for which repeating instances may exist"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : RuleConsolidatedResponseDto10

Type: object

Consolidated DC response containing results for repeatinginstances and multiple data element fetches.

Show Source

• resultMultiple: array resultMultiple
• resultRepeatinginstances: array resultRepeatinginstances
• statusMultiple: string
• statusRepeatinginstances: string

{
    "type":"object",
    "properties":{
        "statusRepeatinginstances":{
            "type":"string"
        },
        "resultRepeatinginstances":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "$ref":"#/components/schemas/DataElementDto11"
                }
            }
        },
        "statusMultiple":{
            "type":"string"
        },
        "resultMultiple":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DataElementDto11"
            }
        }
    },
    "description":"Consolidated DC response containing results for repeatinginstances and multiple data element fetches."
}

Nested Schema : resultMultiple

Type: array

Show Source

• Array of: object DataElementDto11
  Data element details for visit-level retrieval extending DataElementDto90 without form status

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

Nested Schema : resultRepeatinginstances

Type: array

Show Source

• Array of: array items

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

Nested Schema : DataElementDto11

Type: object

Data element details for visit-level retrieval extending DataElementDto90 without form status

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment for the data element change

  Example: Captured by device
• dataFlag: string (UUID)
  Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• dateTimeValueUTC: string (date-time)
  Date-time value in UTC

  Example: 2025-10-16T14:30:31.892Z
• dayValue: integer (int32)
  Day part of date

  Example: 16
• eventId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ADF5A7800A954FA5B831E7B6B9CA39A9
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

  Example: 1
• floatValue: number (decimal)
  Numeric decimal value

  Example: 12.34
• formId: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.

  Example: 40DB4EF4847849CCB24EFCCB71CDA436
• formSectionId: string (UUID)
  Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: B6E0C7D5A1F3428C8B8B6A77C5E9D4AA
• freezedStatus: string
  Freeze status of the data element,can have Values NOT_APPLICABLE, FROZEN

  Example: FROZEN
• hourValue: integer (int32)
  Hour part of time

  Example: 14
• id: string (UUID)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• itemD: string
  The decoded value of the raw value, which provides a more meaningful representation of the data. For dates, it follows the ISO 8601 standard. For questions with multiple choice options, it uses the corresponding code from the codelist. Additionally, ItemD decodes special flags like NA, ND, and UNK to their corresponding meanings, making it easier to understand the data.

  Example: DETAIL
• itemF: string
  The formatted value that matches the data type of the question, such as a date in a specific format or a number with correct decimal places. If the user didn't provide a valid response, ItemF will be null.

  Example: FLAG
• itemId: string (UUID)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.

  Example: DEADBEEFDEADBEEFDEADBEEFDEADBEEF
• itemR: string
  The raw value entered by the user, which can be a text, number, or date, and is stored as alphanumeric data. It may also contain special flags such as NA (Not Applicable), ND (Not Done), UNK (Unknown), or Not Answered if the user didn't provide a response.

  Example: REASON
• itemType: string
  Type of item represented by this data element

  Example: TEXT
• measureUnit: string
  Minimum Length: 0

  Maximum Length: 64

  Measurement unit

  Example: mg/dL
• minuteValue: integer (int32)
  Minute part of time

  Example: 30
• monthValue: integer (int32)
  Month part of date

  Example: 10
• normalizedUnitId: string
  Identifier of normalized unit

  Example: A78AD8C31CD843CD8B847C06C0420FF5
• normalizedValue: string
  Minimum Length: 0

  Maximum Length: 100

  Normalized value if applicable

  Example: 120
• numValue: integer (int32)
  Numeric integer value

  Example: 120
• objectVersionNumber: number
  Audit trail field that represents the version number of the data.

  Example: 14
• operationType: string
  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: MODIFIED
• originatorId: string (UUID)
  An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).

  Example: FEDCBA9876543210FEDCBA9876543210
• parentId: string (UUID)
  Identifier (UUID, 32-character uppercase hexadecimal string) of the parent data element in uppercase hex.

  Example: ABCDEF1234567890ABCDEF1234567890
• propertyId: string
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the property.

  Example: 40DB4EF4847849CCB24EFCCB71CDA436
• propertyVersionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2025-10-16T14:30:31.892Z
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason associated with the data element change

  Example: Initial entry
• repeatFormNumber: integer (int32)
  Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.

  Example: 2
• repeatSequenceNumber: integer (int32)
  Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.

  Example: 1
• rootId: string (UUID)
  Identifier of root data element in UUID, 32-character uppercase hexadecimal string.

  Example: 1234567890ABCDEF1234567890ABCDEF
• secondValue: integer (int32)
  Second part of time

  Example: 31
• signedStatus: string
  Signature status of the data element, can have Values NOT_APPLICABLE, SIGNED

  Example: SIGNED
• siteId: string (UUID)
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• softwareVersionNumber: number
  Software version number

  Example: 14
• studyId: string (UUID)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• studyName: string
  Minimum Length: 0

  Maximum Length: 100

  Study name

  Example: STUDY-ABC
• studyVersion(required): string
  Minimum Length: 0

  Maximum Length: 100

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

  Example: 3.0.0.1
• subjectId: string (UUID)
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: 10F75668189F422F9A461A315D211111
• transactionEnd: string (date-time)
  The date and time at which the transaction processing completed.

  Example: 2025-10-16T14:30:31.892Z
• transactionStart: string (date-time)
  The date and time at which the transaction processing began.

  Example: 2025-10-16T14:30:31.892Z
• validationFailure: string
  Minimum Length: 0

  Maximum Length: 32767

  Validation failure details if any

  Example: Incorrect values not allowed
• validationStatus: string
  Minimum Length: 0

  Maximum Length: 25

  Validation status of the data element. The validation status can be null or SUCCESS.

  Example: SUCCESS
• value: string
  Minimum Length: 0

  Maximum Length: 4000

  Raw value captured for the item

  Example: 120
• variableId: string (UUID)
  Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.

  Example: 0123456789ABCDEF0123456789ABCDEF
• vendorCode: string
  Minimum Length: 0

  Maximum Length: 100

  Vendor code if provided

  Example: VENDOR1
• verifiedStatus: string
  Verification status of the data element can have Values NOT_APPLICABLE, VERIFIED

  Example: VERIFIED
• versionEnd: string (date-time)
  End timestamp of the data element version

  Example: 2025-10-16T14:30:31.892Z
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2025-10-16T14:30:31.892Z
• yearValue: integer (int32)
  Year part of date

  Example: 2025

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element",
            "format":"UUID",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "transactionStart":{
            "type":"string",
            "description":"The date and time at which the transaction processing began.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "transactionEnd":{
            "type":"string",
            "description":"The date and time at which the transaction processing completed.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "validationStatus":{
            "maxLength":25,
            "minLength":0,
            "type":"string",
            "description":"Validation status of the data element. The validation status can be null or SUCCESS.",
            "example":"SUCCESS"
        },
        "validationFailure":{
            "maxLength":32767,
            "minLength":0,
            "type":"string",
            "description":"Validation failure details if any",
            "example":"Incorrect values not allowed"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Study name",
            "example":"STUDY-ABC"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"10F75668189F422F9A461A315D211111"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"ADF5A7800A954FA5B831E7B6B9CA39A9"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "formSectionId":{
            "type":"string",
            "description":"Unique identifier of the table within a two section form or lab form. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"B6E0C7D5A1F3428C8B8B6A77C5E9D4AA"
        },
        "repeatSequenceNumber":{
            "type":"integer",
            "description":"Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.",
            "format":"int32",
            "example":1
        },
        "itemId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.",
            "format":"UUID",
            "example":"DEADBEEFDEADBEEFDEADBEEFDEADBEEF"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"UUID",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "variableId":{
            "type":"string",
            "description":"Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.",
            "format":"UUID",
            "example":"0123456789ABCDEF0123456789ABCDEF"
        },
        "originatorId":{
            "type":"string",
            "description":"An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).",
            "format":"UUID",
            "example":"FEDCBA9876543210FEDCBA9876543210"
        },
        "vendorCode":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Vendor code if provided",
            "example":"VENDOR1"
        },
        "value":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Raw value captured for the item",
            "example":"120"
        },
        "measureUnit":{
            "maxLength":64,
            "minLength":0,
            "type":"string",
            "description":"Measurement unit",
            "example":"mg/dL"
        },
        "normalizedValue":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Normalized value if applicable",
            "example":"120"
        },
        "normalizedUnitId":{
            "type":"string",
            "description":"Identifier of normalized unit",
            "example":"A78AD8C31CD843CD8B847C06C0420FF5"
        },
        "numValue":{
            "type":"integer",
            "description":"Numeric integer value",
            "format":"int32",
            "example":120
        },
        "floatValue":{
            "type":"number",
            "description":"Numeric decimal value",
            "format":"decimal",
            "example":12.34
        },
        "dateTimeValueUTC":{
            "type":"string",
            "description":"Date-time value in UTC",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "monthValue":{
            "type":"integer",
            "description":"Month part of date",
            "format":"int32",
            "example":10
        },
        "dayValue":{
            "type":"integer",
            "description":"Day part of date",
            "format":"int32",
            "example":16
        },
        "yearValue":{
            "type":"integer",
            "description":"Year part of date",
            "format":"int32",
            "example":2025
        },
        "hourValue":{
            "type":"integer",
            "description":"Hour part of time",
            "format":"int32",
            "example":14
        },
        "minuteValue":{
            "type":"integer",
            "description":"Minute part of time",
            "format":"int32",
            "example":30
        },
        "secondValue":{
            "type":"integer",
            "description":"Second part of time",
            "format":"int32",
            "example":31
        },
        "parentId":{
            "type":"string",
            "description":"Identifier (UUID, 32-character uppercase hexadecimal string) of the parent data element in uppercase hex.",
            "format":"UUID",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "rootId":{
            "type":"string",
            "description":"Identifier of root data element in UUID, 32-character uppercase hexadecimal string.",
            "format":"UUID",
            "example":"1234567890ABCDEF1234567890ABCDEF"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason associated with the data element change",
            "example":"Initial entry"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment for the data element change",
            "example":"Captured by device"
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"MODIFIED"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Audit trail field that represents the version number of the data.",
            "example":14
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number",
            "example":14
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "dataFlag":{
            "type":"string",
            "description":"Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).",
            "format":"UUID",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "signedStatus":{
            "type":"string",
            "description":"Signature status of the data element, can have Values NOT_APPLICABLE, SIGNED",
            "example":"SIGNED"
        },
        "verifiedStatus":{
            "type":"string",
            "description":"Verification status of the data element can have Values NOT_APPLICABLE, VERIFIED",
            "example":"VERIFIED"
        },
        "freezedStatus":{
            "type":"string",
            "description":"Freeze status of the data element,can have Values NOT_APPLICABLE, FROZEN",
            "example":"FROZEN"
        },
        "propertyId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the property.",
            "example":"40DB4EF4847849CCB24EFCCB71CDA436"
        },
        "propertyVersionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "versionEnd":{
            "type":"string",
            "description":"End timestamp of the data element version",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "itemType":{
            "type":"string",
            "description":"Type of item represented by this data element",
            "example":"TEXT"
        },
        "itemD":{
            "type":"string",
            "description":"The decoded value of the raw value, which provides a more meaningful representation of the data. For dates, it follows the ISO 8601 standard. For questions with multiple choice options, it uses the corresponding code from the codelist. Additionally, ItemD decodes special flags like NA, ND, and UNK to their corresponding meanings, making it easier to understand the data.",
            "example":"DETAIL"
        },
        "itemF":{
            "type":"string",
            "description":"The formatted value that matches the data type of the question, such as a date in a specific format or a number with correct decimal places. If the user didn't provide a valid response, ItemF will be null.",
            "example":"FLAG"
        },
        "itemR":{
            "type":"string",
            "description":"The raw value entered by the user, which can be a text, number, or date, and is stored as alphanumeric data. It may also contain special flags such as NA (Not Applicable), ND (Not Done), UNK (Unknown), or Not Answered if the user didn't provide a response.",
            "example":"REASON"
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.",
            "format":"int32",
            "example":2
        }
    },
    "description":"Data element details for visit-level retrieval extending DataElementDto90 without form status"
}

Nested Schema : items

Type: array

Show Source

• Array of: object DataElementDto11
  Data element details for visit-level retrieval extending DataElementDto90 without form status

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

400 Response

Bad request.

Body ()

Root Schema : DcsResponse

Type: object

Show Source

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

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

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

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

Nested Schema : result

Type: object

Nested Schema : details

Type: object

Back to Top