Jump to

• Request
• Response

V1.0

get

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/subject/{subjectId}/visit/{visitId}/forms/{formId}/validate/dataelements

API validates all data elements within a specific form for a given subjects visit in a clinical study. It assesses each data item in the form, evaluating status such as whether it is locked, frozen

Request

Path Parameters

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

  Example:

  0A1B2C3D4E5F60718293A4BCCFA7EE82

• mode(required): string
  Mode of the study, accepts: test, active, or training.

  Example:

  test

• studyId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  B1D8B2BA9DD84F0BAEF700387265AC8A

• subjectId(required): string(uuid)
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example:

  0123456789ABCDEF0123456789ABCDEF

• visitId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

  Example:

  AB1234567890CDEFAB1234567890CDEF

Query Parameters

• eventInstanceNum: integer
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

  Example:

  1

• innerRepeatNum: integer
  Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.

  Example:

  1

• outerRepeatNum: integer
  Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Validation completed - returns list of DataElementValidationDto objects as result.

Body ()

Root Schema : DataElementValidationDto

Type: object

Representing validation result/status for a specific data element instance, including lock and repeat status information.

Show Source

• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.

  Example: 9A201C440D40426080C825762206D64B
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.

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

  Example: 12197E724A1C47C8A740153E5948AB19
• id: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element given in format of UUID.

  Example: 64C57ED1076F47078C8E5AD537244989
• innerRepeat: integer (int32)
  Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.

  Example: 1
• isItemFrozen: boolean
  Whether the item is frozen for this record.

  Example: true
• isItemLocked: boolean
  Whether the item is locked for this record.

  Example: true
• isParentLocked: boolean
  Whether the parent is locked for this record.

  Example: false
• isSubjectLocked: boolean
  Whether the subject is locked for this record.

  Example: false
• itemId: string
  Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.

  Example: F7F805CA51B545BFB5808EF7952ED597
• outerRepeat: integer (int32)
  Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.

  Example: 1
• repeatFormNumber: integer (int32)
  Form repeat number if applicable.

  Example: 1
• 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
• subjectId: string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.

  Example: C5E90E4184BC4205978759A808245E98

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the data element given in format of UUID.",
            "example":"64C57ED1076F47078C8E5AD537244989"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"C5E90E4184BC4205978759A808245E98"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.",
            "example":"9A201C440D40426080C825762206D64B"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"12197E724A1C47C8A740153E5948AB19"
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"F7F805CA51B545BFB5808EF7952ED597"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.",
            "format":"int32",
            "example":2
        },
        "repeatFormNumber":{
            "type":"integer",
            "description":"Form repeat number if applicable.",
            "format":"int32",
            "example":1
        },
        "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
        },
        "innerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.",
            "format":"int32",
            "example":1
        },
        "outerRepeat":{
            "type":"integer",
            "description":"Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.",
            "format":"int32",
            "example":1
        },
        "isSubjectLocked":{
            "type":"boolean",
            "description":"Whether the subject is locked for this record.",
            "example":false
        },
        "isItemLocked":{
            "type":"boolean",
            "description":"Whether the item is locked for this record.",
            "example":true
        },
        "isParentLocked":{
            "type":"boolean",
            "description":"Whether the parent is locked for this record.",
            "example":false
        },
        "isItemFrozen":{
            "type":"boolean",
            "description":"Whether the item is frozen for this record.",
            "example":true
        }
    },
    "description":"Representing validation result/status for a specific data element instance, including lock and repeat status information."
}

Examples

Select an example DataElementValidationDtoResponse

400 Response

Bad request.

Body ()

Root Schema : RestResponse

Type: object

Show Source

• errorData: object ErrorResponseData
  Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
• result: object result
• status: string
• version: integer (int32)

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

Nested Schema : ErrorResponseData

Type: object

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

Show Source

• details: object details
  Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
• errorCode: string
  Application or business-specific error code representing the error type.

  Example: REPT_401
• errorMessage: string
  Human-readable error message describing the failure or issue.

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

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

Nested Schema : result

Type: object

Nested Schema : details

Type: object

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

Example:

User role is missing required permission REPORTING_VIEW. Field: userId

Back to Top