REST API for Clinical One Platform

Randomize or dispense subject

post

/ec-dc-svc/rest/v5.0/studies/{studyId}/{mode}/subjects/randomizeordispense

Randomizes or dispenses a subject based on visit type, activates a subject based on visit type and completes the visit status. ORS dispensation or randomization is called.

Request

Path Parameters

mode(required): string

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

ID of the study where a subject is being randomized or dispensed.

Supported Media Types

application/json

Root Schema : schema

Type: object

Request Object for visit.

Show Source

parameters: array parameters
siteId(required): string (uuid)

ID of the site
studyVersion(required): string

Version of the study

Example: 1.0.0.5
subjectId(required): string

ID of the subject

Example: B1B8327AFAA6412287106192AB5984EF
visitId(required): string (uuid)

ID of the visit
visitTimestamp: string

Pattern: (\d){4}-(\d){2}-(\d){2} (\d){2}:(\d){2}:(\d){2}

Visit date and time

Example: 2018-11-23 08:43:01

{
    "required":[
        "siteId",
        "studyVersion",
        "subjectId",
        "visitId"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"ID  of the subject",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Version of the study",
            "example":"1.0.0.5"
        },
        "visitTimestamp":{
            "pattern":"(\\d){4}-(\\d){2}-(\\d){2} (\\d){2}:(\\d){2}:(\\d){2}",
            "type":"string",
            "description":"Visit date and time",
            "example":"2018-11-23 08:43:01"
        },
        "parameters":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Parameter"
            }
        }
    },
    "description":"Request Object for visit."
}

Nested Schema : parameters

Type: array

Show Source

Array of: object Parameter

Contains details about parameters of the form

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

Nested Schema : Parameter

Type: object

Contains details about parameters of the form

Show Source

formId: string (uuid)

ID of the form
itemId: string (uuid)

ID of the item
value: string (uuid)

Value of the item

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"ID of the form",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"ID of the item",
            "format":"uuid"
        },
        "value":{
            "type":"string",
            "description":"Value of the item",
            "format":"uuid"
        }
    },
    "description":"Contains details about parameters of the form"
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : RandomizeDetails

Type: object

Show Source

randomization: object VisitResult
subject: object SubjectDto10
visit: object VisitsStatusDto13

{
    "type":"object",
    "properties":{
        "randomization":{
            "$ref":"#/components/schemas/VisitResult"
        },
        "subject":{
            "$ref":"#/components/schemas/SubjectDto10"
        },
        "visit":{
            "$ref":"#/components/schemas/VisitsStatusDto13"
        }
    }
}

Nested Schema : VisitResult

Type: object

Show Source

countOfKitTypesOnDoseHold: integer (int32)

countOfKitTypesOnDoseHold.

Example: 1
kits: array kits
needsToVisitPharmacist: boolean

Unblinded pharmacist kit

Example: true
pendingKitQuantity: integer (int32)

pendingKitQuantity.

Example: 1
randomNumber: string

Random Number

Example: 10
treatmentTitle: string

Treatment Title

Example: A
visitTimestamp: string (date-time)

Visit Timestamp

{
    "type":"object",
    "properties":{
        "randomNumber":{
            "type":"string",
            "description":"Random Number",
            "example":"10"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/kits"
            }
        },
        "visitTimestamp":{
            "type":"string",
            "description":"Visit Timestamp",
            "format":"date-time"
        },
        "treatmentTitle":{
            "type":"string",
            "description":"Treatment Title",
            "example":"A"
        },
        "needsToVisitPharmacist":{
            "type":"boolean",
            "description":"Unblinded pharmacist kit",
            "example":true
        },
        "countOfKitTypesOnDoseHold":{
            "type":"integer",
            "description":"countOfKitTypesOnDoseHold.",
            "format":"int32",
            "example":"1"
        },
        "pendingKitQuantity":{
            "type":"integer",
            "description":"pendingKitQuantity.",
            "format":"int32",
            "example":"1"
        }
    }
}

Nested Schema : SubjectDto10

Type: object

Show Source

codeBreak: string
comment: string

Minimum Length: 0

Maximum Length: 2048
description: string

Minimum Length: 0

Maximum Length: 500
dob: string (date-time)
enrollmentFailure: string

Minimum Length: 0

Maximum Length: 255
enrollmentOverride: string

Minimum Length: 0

Maximum Length: 255
eventType: string
freezedStatus: string
fromStudyId: string (uuid)
gender: string

Minimum Length: 0

Maximum Length: 10
id: string (uuid)
informedConsentDate: string (date-time)
lastSigned: string
mhealthSubjectId: string (uuid)
objectVersionNumber: number
operationType: string
previousSubjectNumber: string
reason: string

Minimum Length: 0

Maximum Length: 255
screenFailureDate: string (date-time)
screeningDate: string (date-time)
screeningFailure: string

Minimum Length: 0

Maximum Length: 255
signedStatus: string
siteId: string
softwareVersionNumber: number
sourceTimeStamp: string (date-time)
state(required): string

Minimum Length: 0

Maximum Length: 100
stateDate: string (date-time)
studyId: string
studyVersion(required): string
subjectNumber(required): string

Minimum Length: 0

Maximum Length: 500
subjectSiteSerialNumber: string
subjectStudySerialNumber: string
subjectTransferId: string (uuid)
subjNumSiteOrgId: string
userId: string (uuid)
verifiedStatus: string
versionEnd: string (date-time)
versionStart: string (date-time)

{
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "format":"date-time"
        },
        "codeBreak":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "eventType":{
            "type":"string"
        },
        "subjectTransferId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "mhealthSubjectId":{
            "type":"string",
            "format":"uuid"
        },
        "fromStudyId":{
            "type":"string",
            "format":"uuid"
        },
        "subjNumSiteOrgId":{
            "type":"string"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "lastSigned":{
            "type":"string"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "operationType":{
            "type":"string"
        },
        "subjectStudySerialNumber":{
            "type":"string"
        },
        "subjectSiteSerialNumber":{
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "previousSubjectNumber":{
            "type":"string"
        },
        "screenFailureDate":{
            "type":"string",
            "format":"date-time"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "description":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "subjectNumber":{
            "maxLength":"500",
            "minLength":"0",
            "type":"string"
        },
        "studyId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "dob":{
            "type":"string",
            "format":"date-time"
        },
        "state":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "stateDate":{
            "type":"string",
            "format":"date-time"
        },
        "screeningFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentFailure":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "enrollmentOverride":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "informedConsentDate":{
            "type":"string",
            "format":"date-time"
        },
        "gender":{
            "maxLength":"10",
            "minLength":"0",
            "type":"string"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "studyVersion":{
            "type":"string"
        },
        "sourceTimeStamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : VisitsStatusDto13

Type: object

Show Source

associatedStudyVersion: string
comment: string

Minimum Length: 0

Maximum Length: 2048
doseHoldAction: string
eventId: string
eventInstanceNum: integer (int32)
eventType: string
freezedStatus: string
id: string (uuid)
lockedDateTime: string (date-time)
lockedStatus: string
objectVersionNumber: number
operationType: string
reason: string

Minimum Length: 0

Maximum Length: 255
repeatingFormCount: number
scheduledWindowEndDate: string (date-time)
scheduledWindowStartDate: string (date-time)
signedStatus: string
siteId: string
softwareVersionNumber: number
studyVersion(required): string

Minimum Length: 0

Maximum Length: 100
subjectId: string
userId: string (uuid)
verifiedStatus: string
versionEnd: string (date-time)
versionStart: string (date-time)
visitAction: string
visitStartDate: string (date-time)
visitStartDateLockedDateTime: string (date-time)
visitStartDateLockedStatus: string
visitStatus: string
visitType: string
visitWindowWarning: string

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "subjectId":{
            "type":"string"
        },
        "eventId":{
            "type":"string"
        },
        "siteId":{
            "type":"string"
        },
        "studyVersion":{
            "maxLength":"100",
            "minLength":"0",
            "type":"string"
        },
        "visitStatus":{
            "type":"string"
        },
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "operationType":{
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "visitStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "visitType":{
            "type":"string"
        },
        "eventType":{
            "type":"string"
        },
        "eventInstanceNum":{
            "type":"integer",
            "format":"int32"
        },
        "signedStatus":{
            "type":"string"
        },
        "verifiedStatus":{
            "type":"string"
        },
        "freezedStatus":{
            "type":"string"
        },
        "repeatingFormCount":{
            "type":"number"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "format":"date-time"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "format":"date-time"
        },
        "associatedStudyVersion":{
            "type":"string"
        },
        "visitAction":{
            "type":"string"
        },
        "lockedStatus":{
            "type":"string"
        },
        "visitStartDateLockedStatus":{
            "type":"string"
        },
        "lockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitStartDateLockedDateTime":{
            "type":"string",
            "format":"date-time"
        },
        "visitWindowWarning":{
            "type":"string"
        },
        "doseHoldAction":{
            "type":"string"
        }
    }
}

Nested Schema : kits

Type: array

Show Source

Array of: object DispensationKit

Title: DispensationKit

Contains information for the kit dispensation

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

Nested Schema : DispensationKit

Type: object

Title: DispensationKit

Contains information for the kit dispensation

Show Source

barcode: string

Barcode for kit

Example: 1000
conserved: boolean

Conserved for dispensation

Example: true
consumeAcrossDoses: boolean

Indicate if consume across dosed allowed.

Example: true
deviceConnection: string

Allowed Values: [ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]

Device Connection Type

Example: DevicetoCloud
deviceType: string

Allowed Values: [ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]

Device Type

Example: ActivityWatch
dispensationConfirmed: string

Barcode confirmation while dispensing kit

Example: 1000
dose: number (double)

Dose.

Example: 5
dosingUnblinded: boolean

Indicate if unblinded or blinded.

Example: true
frequency: string

Allowed Values: [ "Once", "QD", "BID", "TID", "QID", "Q3", "Q4", "Q8", "Q12", "Q24", "Bedtime", "With meals", "With meals and at bedtime" ]

Dosing frequency.

Example: BID
groupingNumber: integer (int32)

Grouping number for a kit.

Example: 1
id: number (Integer)

Id of the dispensing kit.

Example: 2
inventoryId: string

Inventory Id

Example: D313327EF13845169A8ADADDA435431E
kitDescription: string

Kit description

Example: Kit A
kitNumberUTF: string

Alpha-numeric KitNumber

Example: A-1
locallySourced: boolean

Kit is locally sourced

Example: true
lotId: string

Lot Id

Example: D313327EF13845169A8ADADDA435431E
lotNumber: string

Lot Number

Example: LOT20240605A
measurement: string

Dose Measurement.

Example: ml
quantity: number (double)

kit quantity.

Example: 5
titrationKitLabel: string

Titration Kit Label

Example: High dose
titrationOption: string

Allowed Values: [ "up", "down", "maintain" ]

Titration Option

Example: up
trialSupplyType: string

Trial Supply Type

Example: BOTTLE

{
    "title":"DispensationKit",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"Id of the dispensing kit.",
            "format":"Integer",
            "example":"2"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description",
            "example":"Kit A"
        },
        "dose":{
            "type":"number",
            "description":"Dose.",
            "format":"double",
            "example":"5"
        },
        "measurement":{
            "type":"string",
            "description":"Dose Measurement.",
            "example":"ml"
        },
        "frequency":{
            "type":"string",
            "description":"Dosing frequency.",
            "example":"BID",
            "enum":[
                "Once",
                "QD",
                "BID",
                "TID",
                "QID",
                "Q3",
                "Q4",
                "Q8",
                "Q12",
                "Q24",
                "Bedtime",
                "With meals",
                "With meals and at bedtime"
            ]
        },
        "consumeAcrossDoses":{
            "type":"boolean",
            "description":"Indicate if consume across dosed allowed.",
            "example":true
        },
        "deviceType":{
            "type":"string",
            "description":"Device Type",
            "example":"ActivityWatch",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "type":"string",
            "description":"Device Connection Type",
            "example":"DevicetoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory Id",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type",
            "example":"BOTTLE"
        },
        "conserved":{
            "type":"boolean",
            "description":"Conserved for dispensation",
            "example":true
        },
        "titrationKitLabel":{
            "type":"string",
            "description":"Titration Kit Label",
            "example":"High dose"
        },
        "barcode":{
            "type":"string",
            "description":"Barcode for kit",
            "example":"1000"
        },
        "dispensationConfirmed":{
            "type":"string",
            "description":"Barcode confirmation while dispensing kit",
            "example":"1000"
        },
        "groupingNumber":{
            "type":"integer",
            "description":"Grouping number for a kit.",
            "format":"int32",
            "example":"1"
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Alpha-numeric KitNumber",
            "example":"A-1"
        },
        "dosingUnblinded":{
            "type":"boolean",
            "description":"Indicate if unblinded or blinded.",
            "example":true
        },
        "titrationOption":{
            "type":"string",
            "description":"Titration Option",
            "example":"up",
            "enum":[
                "up",
                "down",
                "maintain"
            ]
        },
        "locallySourced":{
            "type":"boolean",
            "description":"Kit is locally sourced",
            "example":true
        },
        "quantity":{
            "type":"number",
            "description":"kit quantity.",
            "format":"double",
            "example":"5"
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "lotNumber":{
            "type":"string",
            "description":"Lot Number",
            "example":"LOT20240605A"
        }
    },
    "description":"Contains information for the kit dispensation"
}

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

500 Response

Internal server error.

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