Jump to

• Request
• Response

V1.0

get

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

Returns all E2B R3 mapping options that can be assigned to form questions in a study. The response is grouped by E2B category and includes available mapping items, display labels, mandatory indicators, and display order.

Request

Path Parameters

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

  Example:

  F054C951EB74443C93716CA714AB686E

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

E2B R3 mapping options were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object E2B R3 Mapping Item v1.0
  Title: E2B R3 Mapping Item v1.0

  E2B R3 mapping category or mapping item returned for form question mapping. Top-level categories contain child mapping items in values.

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

Nested Schema : E2B R3 Mapping Item v1.0

Type: object

Title: E2B R3 Mapping Item v1.0

E2B R3 mapping category or mapping item returned for form question mapping. Top-level categories contain child mapping items in values.

Show Source

• id: string (uuid)
  Advanced property item ID. UUID, 32-character uppercase hexadecimal string.
• label: string
  Display label for the EHR mapping item.

  Example: Lab Result
• mandatory: boolean
• name: string
  Minimum Length: 1

  Maximum Length: 255

  EHR code list or attribute group name.

  Example: EHRLabsAttributes
• order: string
• rules: array rules
• type: string
  Minimum Length: 1

  Maximum Length: 30

  Advanced property type. EHR mapping responses use EHRMapping.

  Example: EHRMapping
• value: string
  Minimum Length: 1

  Maximum Length: 2048

  EHR category, item, or option code represented by this mapping item.

  Example: LabResult
• values: array values

{
    "title":"E2B R3 Mapping Item v1.0",
    "type":"object",
    "properties":{
        "mandatory":{
            "type":"boolean"
        },
        "order":{
            "type":"string"
        },
        "values":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/E2BR3ItemAdvancedPropDtov1"
            }
        },
        "id":{
            "type":"string",
            "description":"Advanced property item ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "type":{
            "maxLength":30,
            "minLength":1,
            "type":"string",
            "description":"Advanced property type. EHR mapping responses use EHRMapping.",
            "example":"EHRMapping"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"EHR code list or attribute group name.",
            "example":"EHRLabsAttributes"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"EHR category, item, or option code represented by this mapping item.",
            "example":"LabResult"
        },
        "label":{
            "type":"string",
            "description":"Display label for the EHR mapping item.",
            "example":"Lab Result"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov18"
            }
        }
    },
    "description":"E2B R3 mapping category or mapping item returned for form question mapping. Top-level categories contain child mapping items in values.",
    "example":{
        "name":"E2BR3Categories",
        "value":"E2BD.PatientCharacteristics",
        "label":"D. Patient Characteristics",
        "mandatory":false,
        "order":"10",
        "values":[
            {
                "name":"D.1",
                "value":"patientinitial",
                "label":"D.1 Patient (name or initials)",
                "mandatory":true,
                "order":"10",
                "values":[
                ]
            }
        ]
    }
}

Example:

{
    "name":"E2BR3Categories",
    "value":"E2BD.PatientCharacteristics",
    "label":"D. Patient Characteristics",
    "mandatory":false,
    "order":"10",
    "values":[
        {
            "name":"D.1",
            "value":"patientinitial",
            "label":"D.1 Patient (name or initials)",
            "mandatory":true,
            "order":"10",
            "values":[
            ]
        }
    ]
}

Nested Schema : rules

Type: array

Show Source

• Array of: object Form Item Advanced Property Rule v18.0
  Title: Form Item Advanced Property Rule v18.0

  Optional rule metadata for a form item advanced property.

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

Nested Schema : values

Type: array

Show Source

• Array of: object E2BR3ItemAdvancedPropDto v1.0
  Title: E2BR3ItemAdvancedPropDto v1.0

  E2B3 Mapping Details Information

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

Nested Schema : Form Item Advanced Property Rule v18.0

Type: object

Title: Form Item Advanced Property Rule v18.0

Optional rule metadata for a form item advanced property.

Show Source

• label: string
  Display label for the rule value.

  Example: Yes
• name: string
  Rule name.

  Example: Answer
• value: string
  Rule value. When the value is an ID, it is a UUID, 32-character uppercase hexadecimal string.

  Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"Form Item Advanced Property Rule v18.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Rule name.",
            "example":"Answer"
        },
        "value":{
            "type":"string",
            "description":"Rule value. When the value is an ID, it is a UUID, 32-character uppercase hexadecimal string.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Display label for the rule value.",
            "example":"Yes"
        }
    },
    "description":"Optional rule metadata for a form item advanced property.",
    "example":{
        "name":"Answer",
        "value":"B1B8327AFAA6412287106192AB5984EF",
        "label":"Yes"
    }
}

Example:

{
    "name":"Answer",
    "value":"B1B8327AFAA6412287106192AB5984EF",
    "label":"Yes"
}

Nested Schema : E2BR3ItemAdvancedPropDto v1.0

Type: object

Title: E2BR3ItemAdvancedPropDto v1.0

E2B3 Mapping Details Information

Show Source

• id: string (uuid)
  Advanced property item ID. UUID, 32-character uppercase hexadecimal string.
• label: string
  Display label for the EHR mapping item.

  Example: Lab Result
• mandatory: boolean
• name: string
  Minimum Length: 1

  Maximum Length: 255

  EHR code list or attribute group name.

  Example: EHRLabsAttributes
• order: string
• rules: array rules
• type: string
  Minimum Length: 1

  Maximum Length: 30

  Advanced property type. EHR mapping responses use EHRMapping.

  Example: EHRMapping
• value: string
  Minimum Length: 1

  Maximum Length: 2048

  EHR category, item, or option code represented by this mapping item.

  Example: LabResult

{
    "title":"E2BR3ItemAdvancedPropDto v1.0",
    "type":"object",
    "properties":{
        "mandatory":{
            "type":"boolean"
        },
        "order":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "description":"Advanced property item ID. UUID, 32-character uppercase hexadecimal string.",
            "format":"uuid"
        },
        "type":{
            "maxLength":30,
            "minLength":1,
            "type":"string",
            "description":"Advanced property type. EHR mapping responses use EHRMapping.",
            "example":"EHRMapping"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"EHR code list or attribute group name.",
            "example":"EHRLabsAttributes"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"EHR category, item, or option code represented by this mapping item.",
            "example":"LabResult"
        },
        "label":{
            "type":"string",
            "description":"Display label for the EHR mapping item.",
            "example":"Lab Result"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov18"
            }
        }
    },
    "description":"E2B3 Mapping Details Information"
}

Nested Schema : rules

Type: array

Show Source

• Array of: object Form Item Advanced Property Rule v18.0
  Title: Form Item Advanced Property Rule v18.0

  Optional rule metadata for a form item advanced property.

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

Examples

Select an example e2bMappingAllResponseV1

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.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example serverError

Back to Top