REST API for Clinical One Platform

Upsert EHR Data for a particular subject and a visit

put

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

This API would act as upsert: it would insert if the data is not present or update if present.
Rights: DataCaptureSubjectPost, SubjectDataClassificationPost

Request

Path Parameters

mode(required): string

Mode of the study. Accepts test, active, or training.
studyId(required): string

ID of the study to which the subject belongs.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

context: object ContextEhr
forms: array forms

{
    "type":"object",
    "properties":{
        "context":{
            "$ref":"#/components/schemas/ContextEhr"
        },
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CoreDataEHRFormElementRequestDto"
            }
        }
    }
}

Nested Schema : ContextEhr

Type: object

Show Source

eventId: string
eventInstanceNum: integer
siteId: string
studyName(required): string

Minimum Length: 0

Maximum Length: 100
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string
validateOCCData: boolean

{
    "required":[
        "studyName",
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "studyVersion":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "studyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "validateOCCData":{
            "type":"boolean"
        }
    }
}

Nested Schema : forms

Type: array

Show Source

Array of: object CoreDataEHRFormElementRequestDto

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

Nested Schema : CoreDataEHRFormElementRequestDto

Type: object

Show Source

dataElements: array dataElements
formId: string

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string"
        },
        "dataElements":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CoreDataElementEhr"
            }
        }
    }
}

Nested Schema : dataElements

Type: array

Show Source

Array of: object CoreDataElementEhr

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

Nested Schema : CoreDataElementEhr

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
dayValue: integer
floatValue: number
formSectionId: string
hdiId: string
hourValue: integer
id: string (uuid)
innerRepeat: integer
itemId: string
measureUnit: string
minuteValue: integer
monthValue: integer
numValue: integer
occCodes: array occCodes
originatorId: string
outerRepeat: integer
reason: string

Minimum Length: 0

Maximum Length: 255
recordedDate: string
repeatSequenceNumber: integer
secondValue: integer
sourceUnit: string
sourceValue: string
transactionEnd: string (date-time)
transactionStart: string (date-time)
utcDateTimeValue: string (date-time)
validationFailure: string
validationStatus: string
value: string

Minimum Length: 0

Maximum Length: 4000
variableId: string
vendorCode: string

Minimum Length: 0

Maximum Length: 100
yearValue: integer

{
    "type":"object",
    "properties":{
        "utcDateTimeValue":{
            "type":"string",
            "format":"date-time"
        },
        "monthValue":{
            "type":"integer"
        },
        "dayValue":{
            "type":"integer"
        },
        "yearValue":{
            "type":"integer"
        },
        "hourValue":{
            "type":"integer"
        },
        "minuteValue":{
            "type":"integer"
        },
        "secondValue":{
            "type":"integer"
        },
        "validationStatus":{
            "type":"string"
        },
        "validationFailure":{
            "type":"string"
        },
        "hdiId":{
            "type":"string"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "recordedDate":{
            "type":"string"
        },
        "occCodes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "transactionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "formSectionId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "variableId":{
            "type":"string"
        },
        "originatorId":{
            "type":"string"
        },
        "vendorCode":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "itemId":{
            "type":"string"
        },
        "value":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "measureUnit":{
            "type":"string"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "numValue":{
            "type":"integer"
        },
        "floatValue":{
            "type":"number"
        },
        "sourceValue":{
            "type":"string"
        },
        "sourceUnit":{
            "type":"string"
        }
    }
}

Nested Schema : occCodes

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

application/json

200 Response

Subjects success.

Root Schema : DataElementDto15

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048
dataFlag: string (uuid)
dateTimeValueUTC: string (date-time)
dayValue: integer
eventId: string
eventInstanceNum: integer
floatValue: number
formId: string
formSectionId: string
freezedStatus: string
hdiId: string
hourValue: integer
id: string (uuid)
innerRepeat: integer
itemD: string
itemF: string
itemId: string
itemR: string
itemType: string
measureUnit: string

Minimum Length: 0

Maximum Length: 64
minuteValue: integer
monthValue: integer
normalizedUnitId: string
normalizedValue: string

Minimum Length: 0

Maximum Length: 100
numValue: integer
objectVersionNumber: number
operation: string
operationType: string
originatorId: string
outerRepeat: integer
parentId: string
propertyId: string
propertyVersionStart: string (date-time)
reason: string

Minimum Length: 0

Maximum Length: 255
repeatFormNumber: integer
repeatSequenceNumber: integer
rootId: string
secondValue: integer
signedStatus: string
siteId: string
softwareVersionNumber: number
sourceTimeStamp: string (date-time)
studyId: string
studyName: string

Minimum Length: 0

Maximum Length: 100
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string
targets: array targets
transactionEnd: string (date-time)
transactionStart: string (date-time)
userId: string (uuid)
validationFailure: string

Minimum Length: 0

Maximum Length: 32767
validationStatus: string

Minimum Length: 0

Maximum Length: 25
value: string

Minimum Length: 0

Maximum Length: 4000
variableId: string
vendorCode: string

Minimum Length: 0

Maximum Length: 100
verifiedStatus: string
versionEnd: string (date-time)
versionStart: string (date-time)
yearValue: integer

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionStart":{
            "type":"string",
            "format":"date-time"
        },
        "transactionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "validationStatus":{
            "maxLength":"25",
            "minLength":"0",
            "type":"string"
        },
        "validationFailure":{
            "maxLength":"32767",
            "minLength":"0",
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "studyName":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "studyVersion":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "formId":{
            "type":"string"
        },
        "formSectionId":{
            "type":"string"
        },
        "repeatSequenceNumber":{
            "type":"integer"
        },
        "itemId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "variableId":{
            "type":"string"
        },
        "originatorId":{
            "type":"string"
        },
        "vendorCode":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "value":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string"
        },
        "measureUnit":{
            "maxLength":"64",
            "minLength":"0",
            "type":"string"
        },
        "normalizedValue":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "normalizedUnitId":{
            "type":"string"
        },
        "numValue":{
            "type":"integer"
        },
        "floatValue":{
            "type":"number"
        },
        "dateTimeValueUTC":{
            "type":"string",
            "format":"date-time"
        },
        "monthValue":{
            "type":"integer"
        },
        "dayValue":{
            "type":"integer"
        },
        "yearValue":{
            "type":"integer"
        },
        "hourValue":{
            "type":"integer"
        },
        "minuteValue":{
            "type":"integer"
        },
        "secondValue":{
            "type":"integer"
        },
        "parentId":{
            "type":"string"
        },
        "rootId":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "eventInstanceNum":{
            "type":"integer"
        },
        "targets":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "dataFlag":{
            "type":"string",
            "format":"uuid"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "propertyId":{
            "type":"string"
        },
        "propertyVersionStart":{
            "type":"string",
            "format":"date-time"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "itemType":{
            "type":"string"
        },
        "itemD":{
            "type":"string"
        },
        "itemF":{
            "type":"string"
        },
        "itemR":{
            "type":"string"
        },
        "repeatFormNumber":{
            "type":"integer"
        },
        "innerRepeat":{
            "type":"integer"
        },
        "outerRepeat":{
            "type":"integer"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        },
        "hdiId":{
            "type":"string"
        },
        "operation":{
            "type":"string"
        }
    }
}

Nested Schema : targets

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

400 Response

Bad request.

Root Schema : DcsResponse

Type: object

Show Source

errorData: object ErrorResponseData
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

Show Source

details: object details
errorCode: string
errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Nested Schema : details

Type: object