Jump to

• Request
• Response

V1.0

get

/ec-dataaction-svc/rest/v1.0/studies/{studyId}/{mode}/dataelements/sdv

API allows you to retrieve a list of items (data fields) within a clinical study that require Source Data Verification (SDV) for a specified subject, event, and study version. SDV is a critical process that ensures data accuracy by cross-checking entries against original source documents.

Request

Path Parameters

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

  Example:

  test

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

  Example:

  5D3F2567B4D34514A44B69F1E3668C1F

Query Parameters

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

  Example:

  7978B7DD0A0A4CA899C485990994300C

• studyVersion(required): string
  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example:

  2.0.0.38

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

  Example:

  AF77C6450BE94DE293C9630142E0AFAD

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object SdvItemSelectionResponse
  DTO representing selected SDV items for subject/event/form context.

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

Nested Schema : SdvItemSelectionResponse

Type: object

DTO representing selected SDV items for subject/event/form context.

Show Source

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

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

  Example: 33CAF3CB1DF64DF5A353A337CBE6B50A
• sdvSelectionNatureEnum: string
  Nature of SDV selection for the item result may containg OPTIONAL_CRITICAL, IRRELEVANT, OLD,OBLIGATORY, OPTIONAL, IRRELEVANT_OLD.

  Example: OPTIONAL_CRITICAL

{
    "type":"object",
    "properties":{
        "sdvSelectionNatureEnum":{
            "type":"string",
            "description":"Nature of SDV selection for the item result may containg OPTIONAL_CRITICAL, IRRELEVANT, OLD,OBLIGATORY, OPTIONAL, IRRELEVANT_OLD.",
            "example":"OPTIONAL_CRITICAL"
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "format":"UUID",
            "example":"33CAF3CB1DF64DF5A353A337CBE6B50A"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"UUID",
            "example":"AF77C6450BE94DE293C9630142E0AFAD"
        }
    },
    "description":"DTO representing selected SDV items for subject/event/form context."
}

Examples

Select an example Sign dara verification Item Selection Response List Example

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