REST API for Clinical One Platform

Get EHR Data mappings

get

/ec-designer-edc-svc/rest/v1.0/studies/{studyId}/ehrmapping

Retrieves the EHR mapping data by question type or mapping item.

Request

Path Parameters

studyId(required): string(uuid)

Study ID. Example: F054C951EB74443C93716CA714AB686E

Query Parameters

mapping: string

The mapping item to retrieve the EHR mapping data for.
type: string

The question type to retrieve the EHR mapping data for.

Allowed Values: [ "text", "numeric", "datetime", "age", "label", "selectbox", "checkbox", "radioset" ]

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : EHRCategoryItemDto

Type: object

Show Source

attributes: array attributes
categoryCode: string
categoryId: string (uuid)
categoryLabel: string
clCodeLabel: string
clCodeName: string
code: string
id: string (uuid)
label: string
values: array values

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "categoryId":{
            "type":"string",
            "format":"uuid"
        },
        "categoryCode":{
            "type":"string"
        },
        "categoryLabel":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "clCodeName":{
            "type":"string"
        },
        "clCodeLabel":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EHRCategoryItemDto"
            }
        },
        "attributes":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EHRCategoryItemDto"
            }
        }
    }
}

Nested Schema : attributes

Type: array

Show Source

Array of: object EHRCategoryItemDto

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

Nested Schema : values

Type: array

Show Source

Array of: object EHRCategoryItemDto

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

500 Response

Error

Root 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: string

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
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":"string",
            "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."
}