REST API for Clinical One Platform

~~[Deprecated]: Schedule visit~~

post

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/visits/subjectvisit

Deprecated: Schedules a new visit in the study. Rights: OrsVisitManagementPost.

Request

Path Parameters

mode(required): string

Mode of the study, accepts: test, active, or training
studyId(required): string(uuid)

ID of the study

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

Successful operation

Root 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 : 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
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"
        }
    },
    "description":"Contains information for the kit dispensation"
}

400 Response

Invalid visit timestamp. Or you must associate the randomization design with a visit before you can create/upload a randomization list for it Or the next step in this visit isn???t allowed for subject because the study version at your site isn???t compatible with the subject Or subject can't be re-randomized before randomization. Or this operation is not allowed in the current subject status

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

404 Response

Invalid study ID or version. Or randomization ist not found or design not found

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

500 Response

Unsupported visit. Or subject already completed the visit. Or subject is randomized in error Or invalid treatment found for the subject. Or visit out of order. Or this operation is not allowed in the current subject status Or visit is outside visit window. Or visit is outside visit window and at least one kit is configured not to dispense outside visit window Or not enough inventory.

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object