REST API for Clinical One Cloud Service

V1.0

post

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

Returns EHR mapping details for forms associated with the requested study-version visits. The request body is an array where each object identifies a study version and visit. The response is an EDC envelope whose result contains visits, forms, items, and the EHR mappings configured for those items.

Request

Path Parameters

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

Query Parameters

mode(required): string
Study mode filter.

Allowed Values: [ "test", "training", "active" ]
Example:
```
test
```

Supported Media Types

application/json

Root Schema : schema

Type: array

Show Source

Array of: object RqstStudyVersionVisitDto

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

Nested Schema : RqstStudyVersionVisitDto

Type: object

Show Source

studyId: string (uuid)
studyTitle: string
studyVersion: string
visitId: string (uuid)

Visit GUID

{
    "type":"object",
    "properties":{
        "visitId":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "studyTitle":{
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "studyId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Examples

Response

Supported Media Types

application/json

200 Response

Visits/forms EHR mappings were returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object ResponseVisitsFormsEhrMappingDto

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

Nested Schema : ResponseVisitsFormsEhrMappingDto

Type: object

Show Source

studyVersion: string

Title: String

study version.
VisitFormsEhrMappingDto: object VisitFormsEhrMappingDto v1.0

Title: VisitFormsEhrMappingDto v1.0

Information about EhrMappings of items of the forms associated with a visit

{
    "type":"object",
    "properties":{
        "studyVersion":{
            "title":"String",
            "type":"string",
            "description":"study version."
        },
        "VisitFormsEhrMappingDto":{
            "title":"VisitFormsEhrMappingDto v1.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Visit GUID",
                    "format":"uuid"
                },
                "FormsEhrMappingDto":{
                    "title":"FormsEhrMappingDto v1.0",
                    "type":"object",
                    "properties":{
                        "formId":{
                            "type":"string",
                            "description":"Form GUID",
                            "format":"uuid"
                        },
                        "ItemsEhrMappingDto":{
                            "title":"ItemsEhrMappingDto v1.0",
                            "type":"object",
                            "properties":{
                                "itemId":{
                                    "type":"string",
                                    "description":"Item GUID",
                                    "format":"uuid"
                                },
                                "FormItemAdvancedPropDto":{
                                    "title":"From Item Advanced Property v17.0",
                                    "type":"object",
                                    "properties":{
                                        "id":{
                                            "type":"string",
                                            "description":"Extended Property ID",
                                            "format":"uuid"
                                        },
                                        "name":{
                                            "maxLength":255,
                                            "minLength":1,
                                            "type":"string",
                                            "description":"Advanced property name",
                                            "example":"RolloverQuestionStudyId"
                                        },
                                        "value":{
                                            "maxLength":2048,
                                            "minLength":1,
                                            "type":"string",
                                            "description":"Advanced property value. For example, rollover study UUID",
                                            "example":"B1B8327AFAA6412287106192AB5984EF"
                                        },
                                        "label":{
                                            "type":"string",
                                            "description":"Rollover study name",
                                            "example":"Rollover Study BT-31"
                                        },
                                        "rules":{
                                            "type":"array",
                                            "items":{
                                                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov17"
                                            }
                                        }
                                    },
                                    "description":"Form Item Advanced Property"
                                }
                            },
                            "description":"Information about EhrMappings of form item"
                        }
                    },
                    "description":"Information about EhrMappings of items of the form"
                }
            },
            "description":"Information about EhrMappings of items of the forms associated with a visit"
        }
    }
}

Nested Schema : VisitFormsEhrMappingDto v1.0

Type: object

Title: VisitFormsEhrMappingDto v1.0

Information about EhrMappings of items of the forms associated with a visit

Show Source

FormsEhrMappingDto: object FormsEhrMappingDto v1.0

Title: FormsEhrMappingDto v1.0

Information about EhrMappings of items of the form
id: string (uuid)

Visit GUID

{
    "title":"VisitFormsEhrMappingDto v1.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Visit GUID",
            "format":"uuid"
        },
        "FormsEhrMappingDto":{
            "title":"FormsEhrMappingDto v1.0",
            "type":"object",
            "properties":{
                "formId":{
                    "type":"string",
                    "description":"Form GUID",
                    "format":"uuid"
                },
                "ItemsEhrMappingDto":{
                    "title":"ItemsEhrMappingDto v1.0",
                    "type":"object",
                    "properties":{
                        "itemId":{
                            "type":"string",
                            "description":"Item GUID",
                            "format":"uuid"
                        },
                        "FormItemAdvancedPropDto":{
                            "title":"From Item Advanced Property v17.0",
                            "type":"object",
                            "properties":{
                                "id":{
                                    "type":"string",
                                    "description":"Extended Property ID",
                                    "format":"uuid"
                                },
                                "name":{
                                    "maxLength":255,
                                    "minLength":1,
                                    "type":"string",
                                    "description":"Advanced property name",
                                    "example":"RolloverQuestionStudyId"
                                },
                                "value":{
                                    "maxLength":2048,
                                    "minLength":1,
                                    "type":"string",
                                    "description":"Advanced property value. For example, rollover study UUID",
                                    "example":"B1B8327AFAA6412287106192AB5984EF"
                                },
                                "label":{
                                    "type":"string",
                                    "description":"Rollover study name",
                                    "example":"Rollover Study BT-31"
                                },
                                "rules":{
                                    "type":"array",
                                    "items":{
                                        "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov17"
                                    }
                                }
                            },
                            "description":"Form Item Advanced Property"
                        }
                    },
                    "description":"Information about EhrMappings of form item"
                }
            },
            "description":"Information about EhrMappings of items of the form"
        }
    },
    "description":"Information about EhrMappings of items of the forms associated with a visit"
}

Nested Schema : FormsEhrMappingDto v1.0

Type: object

Title: FormsEhrMappingDto v1.0

Information about EhrMappings of items of the form

Show Source

formId: string (uuid)

Form GUID
ItemsEhrMappingDto: object ItemsEhrMappingDto v1.0

Title: ItemsEhrMappingDto v1.0

Information about EhrMappings of form item

{
    "title":"FormsEhrMappingDto v1.0",
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Form GUID",
            "format":"uuid"
        },
        "ItemsEhrMappingDto":{
            "title":"ItemsEhrMappingDto v1.0",
            "type":"object",
            "properties":{
                "itemId":{
                    "type":"string",
                    "description":"Item GUID",
                    "format":"uuid"
                },
                "FormItemAdvancedPropDto":{
                    "title":"From Item Advanced Property v17.0",
                    "type":"object",
                    "properties":{
                        "id":{
                            "type":"string",
                            "description":"Extended Property ID",
                            "format":"uuid"
                        },
                        "name":{
                            "maxLength":255,
                            "minLength":1,
                            "type":"string",
                            "description":"Advanced property name",
                            "example":"RolloverQuestionStudyId"
                        },
                        "value":{
                            "maxLength":2048,
                            "minLength":1,
                            "type":"string",
                            "description":"Advanced property value. For example, rollover study UUID",
                            "example":"B1B8327AFAA6412287106192AB5984EF"
                        },
                        "label":{
                            "type":"string",
                            "description":"Rollover study name",
                            "example":"Rollover Study BT-31"
                        },
                        "rules":{
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov17"
                            }
                        }
                    },
                    "description":"Form Item Advanced Property"
                }
            },
            "description":"Information about EhrMappings of form item"
        }
    },
    "description":"Information about EhrMappings of items of the form"
}

Nested Schema : ItemsEhrMappingDto v1.0

Type: object

Title: ItemsEhrMappingDto v1.0

Information about EhrMappings of form item

Show Source

FormItemAdvancedPropDto: object From Item Advanced Property v17.0

Title: From Item Advanced Property v17.0

Form Item Advanced Property
itemId: string (uuid)

Item GUID

{
    "title":"ItemsEhrMappingDto v1.0",
    "type":"object",
    "properties":{
        "itemId":{
            "type":"string",
            "description":"Item GUID",
            "format":"uuid"
        },
        "FormItemAdvancedPropDto":{
            "title":"From Item Advanced Property v17.0",
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Extended Property ID",
                    "format":"uuid"
                },
                "name":{
                    "maxLength":255,
                    "minLength":1,
                    "type":"string",
                    "description":"Advanced property name",
                    "example":"RolloverQuestionStudyId"
                },
                "value":{
                    "maxLength":2048,
                    "minLength":1,
                    "type":"string",
                    "description":"Advanced property value. For example, rollover study UUID",
                    "example":"B1B8327AFAA6412287106192AB5984EF"
                },
                "label":{
                    "type":"string",
                    "description":"Rollover study name",
                    "example":"Rollover Study BT-31"
                },
                "rules":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov17"
                    }
                }
            },
            "description":"Form Item Advanced Property"
        }
    },
    "description":"Information about EhrMappings of form item"
}

Nested Schema : From Item Advanced Property v17.0

Type: object

Title: From Item Advanced Property v17.0

Form Item Advanced Property

Show Source

id: string (uuid)

Extended Property ID
label: string

Rollover study name

Example: Rollover Study BT-31
name: string

Minimum Length: 1

Maximum Length: 255

Advanced property name

Example: RolloverQuestionStudyId
rules: array rules
value: string

Minimum Length: 1

Maximum Length: 2048

Advanced property value. For example, rollover study UUID

Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property v17.0",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Extended Property ID",
            "format":"uuid"
        },
        "name":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"Advanced property name",
            "example":"RolloverQuestionStudyId"
        },
        "value":{
            "maxLength":2048,
            "minLength":1,
            "type":"string",
            "description":"Advanced property value. For example, rollover study UUID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"Rollover study name",
            "example":"Rollover Study BT-31"
        },
        "rules":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormItemAdvancedPropRuleDtov17"
            }
        }
    },
    "description":"Form Item Advanced Property"
}

Nested Schema : rules

Type: array

Show Source

Array of: object From Item Advanced Property Rule v17.0

Title: From Item Advanced Property Rule v17.0

Form Item Advanced Property Rule

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

Nested Schema : From Item Advanced Property Rule v17.0

Type: object

Title: From Item Advanced Property Rule v17.0

Form Item Advanced Property Rule

Show Source

label: string

For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE

Example: Yes
name: string

name

Example: RolloverQuestionAnswer
value: string

For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID

Example: B1B8327AFAA6412287106192AB5984EF

{
    "title":"From Item Advanced Property Rule v17.0",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name",
            "example":"RolloverQuestionAnswer"
        },
        "value":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.CODELISTITEM_ID",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "label":{
            "type":"string",
            "description":"For RolloverQuestion property it is an ECDV_CODELISTITEM.VALUE",
            "example":"Yes"
        }
    },
    "description":"Form Item Advanced Property Rule"
}

Examples

400 Response

The request payload is missing studyVersion or visitId, or contains invalid values.

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

500 Response

Error

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