REST API for Clinical One Platform

V1.0

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/codingstatus

Retrieve data elements to be coded based on 'codeType' parameter and list of source IDs.

Request

Path Parameters

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:
```
3F2504E04F8911D39A0C0305E82C3301
```

Query Parameters

codeType: string
Type of coded questions to be fetched. Allowed values: NeedsCodingOrDeleted, NeedsCoding.
Example:
```
NeedsCodingOrDeleted
```

Supported Media Types

application/json

Root Schema : schema

Type: object

Request object for retrieving coded data using a set of source IDs.

Show Source

sourceIds: array sourceIds

A list of upper-case hexadecimal UUID strings identifying source objects for coding.

{
    "type":"object",
    "properties":{
        "sourceIds":{
            "type":"array",
            "description":"A list of upper-case hexadecimal UUID strings identifying source objects for coding.",
            "example":[
                "123E4567E89B12D3A456426655440000",
                "123E4567E89B12D3A45642665544AAAA"
            ],
            "items":{
                "type":"string",
                "description":"A list of upper-case hexadecimal UUID strings identifying source objects for coding.",
                "example":"[\"123E4567E89B12D3A456426655440000\",\"123E4567E89B12D3A45642665544AAAA\"]"
            }
        }
    },
    "description":"Request object for retrieving coded data using a set of source IDs."
}

Nested Schema : sourceIds

Type: array

A list of upper-case hexadecimal UUID strings identifying source objects for coding.

Show Source

Array of: string

A list of upper-case hexadecimal UUID strings identifying source objects for coding.

Example: ["123E4567E89B12D3A456426655440000","123E4567E89B12D3A45642665544AAAA"]

{
    "type":"array",
    "description":"A list of upper-case hexadecimal UUID strings identifying source objects for coding.",
    "example":[
        "123E4567E89B12D3A456426655440000",
        "123E4567E89B12D3A45642665544AAAA"
    ],
    "items":{
        "type":"string",
        "description":"A list of upper-case hexadecimal UUID strings identifying source objects for coding.",
        "example":"[\"123E4567E89B12D3A456426655440000\",\"123E4567E89B12D3A45642665544AAAA\"]"
    }
}

Example:

[
    "123E4567E89B12D3A456426655440000",
    "123E4567E89B12D3A45642665544AAAA"
]

Examples

Response

Supported Media Types

application/json

200 Response

Coded question data for the requested sources.

Root Schema : schema

Type: array

Show Source

Array of: object CodedDataDTO

Title: CodedDataDTO

Represents coded data details for a verbatim term including identifiers for study, subject, visit, form, item and associated metadata.

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

Nested Schema : CodedDataDTO

Type: object

Title: CodedDataDTO

Represents coded data details for a verbatim term including identifiers for study, subject, visit, form, item and associated metadata.

Show Source

context: string

Additional context information for the coded value.

Example: {}
dataElementId: string

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the underlying data element.

Example: 318148C517104168B7F7AA90EA888DDA
eventName(required): string

Display name of the study event.

Example: Visit 1
eventRefName(required): string

Reference name of the study event as defined in the study design.

Example: VISIT_1
formId(required): string

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

Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
formName(required): string

Display name of the form.

Example: Adverse Events
formRefName(required): string

Reference name of the form as defined in the study design.

Example: AE_FORM
Id(required): string

Unique identifier (UUID, 32-character uppercase hexadecimal string) for the coded data record.

Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
itemId(required): string

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

Example: D4E5F6A1B2C347839ABCDEF012345678
itemName(required): string

Display name of the data item.

Example: Adverse Event Term
itemRefName(required): string

Reference name of the data item as defined in the study design.

Example: AE_TERM
siteId(required): string

Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.

Example: 938D23FA6B7241CCA41BD627E5DB60DA
siteMnemonic(required): string

Mnemonic code of the site.

Example: SITE001
siteName(required): string

Name of the clinical site.

Example: Main Site
studyVersion(required): string

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

Example: 1.0.0.3
subjectId(required): string

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

Example: A1B2C3D4E5F647839ABCDEF012345678
subjectInitials(required): string

Subject initials as captured in study.

Example: JD
subjectNumber(required): string

Subject number assigned within the study.

Example: SUBJ-0001
value(required): string

Verbatim or coded value captured for the item.

Example: Headache
verstionStart: string (date-time)

Record version start timestamp.

Example: 2023-01-01T09:00:00Z
visitId(required): string

Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

Example: 699EF3745FC545589F186D2198F3C65E

{
    "title":"CodedDataDTO",
    "required":[
        "Id",
        "eventName",
        "eventRefName",
        "formId",
        "formName",
        "formRefName",
        "itemId",
        "itemName",
        "itemRefName",
        "siteId",
        "siteMnemonic",
        "siteName",
        "studyVersion",
        "subjectId",
        "subjectInitials",
        "subjectNumber",
        "value",
        "visitId"
    ],
    "type":"object",
    "properties":{
        "subjectInitials":{
            "type":"string",
            "description":"Subject initials as captured in study.",
            "example":"JD"
        },
        "siteName":{
            "type":"string",
            "description":"Name of the clinical site.",
            "example":"Main Site"
        },
        "siteMnemonic":{
            "type":"string",
            "description":"Mnemonic code of the site.",
            "example":"SITE001"
        },
        "formRefName":{
            "type":"string",
            "description":"Reference name of the form as defined in the study design.",
            "example":"AE_FORM"
        },
        "formName":{
            "type":"string",
            "description":"Display name of the form.",
            "example":"Adverse Events"
        },
        "itemRefName":{
            "type":"string",
            "description":"Reference name of the data item as defined in the study design.",
            "example":"AE_TERM"
        },
        "itemName":{
            "type":"string",
            "description":"Display name of the data item.",
            "example":"Adverse Event Term"
        },
        "eventRefName":{
            "type":"string",
            "description":"Reference name of the study event as defined in the study design.",
            "example":"VISIT_1"
        },
        "eventName":{
            "type":"string",
            "description":"Display name of the study event.",
            "example":"Visit 1"
        },
        "Id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) for the coded data record.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"1.0.0.3"
        },
        "subjectId":{
            "type":"string",
            "description":"Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.",
            "example":"A1B2C3D4E5F647839ABCDEF012345678"
        },
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "example":"699EF3745FC545589F186D2198F3C65E"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.",
            "example":"938D23FA6B7241CCA41BD627E5DB60DA"
        },
        "itemId":{
            "type":"string",
            "description":"Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.",
            "example":"D4E5F6A1B2C347839ABCDEF012345678"
        },
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "value":{
            "type":"string",
            "description":"Verbatim or coded value captured for the item.",
            "example":"Headache"
        },
        "subjectNumber":{
            "type":"string",
            "description":"Subject number assigned within the study.",
            "example":"SUBJ-0001"
        },
        "context":{
            "type":"string",
            "description":"Additional context information for the coded value.",
            "example":"{}"
        },
        "verstionStart":{
            "type":"string",
            "description":"Record version start timestamp.",
            "format":"date-time",
            "example":"2023-01-01T09:00:00Z"
        },
        "dataElementId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the underlying data element.",
            "example":"318148C517104168B7F7AA90EA888DDA"
        }
    },
    "description":"Represents coded data details for a verbatim term including identifiers for study, subject, visit, form, item and associated metadata."
}

Examples

400 Response

Bad Request

Root Schema : DcsResponse

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