Jump to

• Request
• Response

V1.0

get

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

Returns EHR mappings filtered by question type and mapping key. Use /v20.0 form metadata endpoints for current mapping-capable payloads.

Request

Path Parameters

• studyId(required): string(uuid)
  Study ID (UUID, 32-character uppercase hexadecimal string). Required.

Query Parameters

• mapping: string
  EHR mapping key to filter by (optional).
• type: string
  Question type filter (optional). Allowed values: text, numeric, datetime, age, label, selectbox, checkbox, radioset.

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

EHR mappings returned successfully.

Body ()

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"
    }
}

Examples

Select an example ehrMappingResponseV1

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top