REST API for Clinical One Platform

Get kits allowed for dose hold

get

/ec-ors-svc/rest/v2.0/studies/{studyId}/{mode}/subjects/{subjectId}/allowed-doseholds

Get kits allowed for dose hold in the current visit for a given subject. Rights: OrsSubjectVisitGet.

Request

Path Parameters

mode(required): string

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

ID of the study
subjectId(required): string(uuid)

ID of the subject

Query Parameters

instanceNumber: number

Instance number for unscheduled visit.
studyVersion(required): string

Version of the study
visitId(required): string(uuid)

ID of the visit

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : DoseHoldKitsResponse

Type: object

Show Source

kitsAllowedForDoseHold: array kitsAllowedForDoseHold
kitsNotAllowedForDoseHold: array kitsNotAllowedForDoseHold
status(required): string

Allowed Values: [ "ALLOW_DOSE_HOLD, DOSE_HELD, DISPENSED_AND_DOSE_HELD, DISPENSED, DOSE_HOLD_SETTINGS_OFF, DOSE_HOLD_NOT_ALLOWED_ON_RAND_VISIT, DOSE_HOLD_NOT_ALLOWED_ON_ANY_KITS" ]

dose hold allowed or not

Example: ALLOW_DOSE_HOLD

{
    "required":[
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"dose hold allowed or not",
            "example":"ALLOW_DOSE_HOLD",
            "enum":[
                "ALLOW_DOSE_HOLD, DOSE_HELD, DISPENSED_AND_DOSE_HELD, DISPENSED, DOSE_HOLD_SETTINGS_OFF, DOSE_HOLD_NOT_ALLOWED_ON_RAND_VISIT, DOSE_HOLD_NOT_ALLOWED_ON_ANY_KITS"
            ]
        },
        "kitsAllowedForDoseHold":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DoseHoldKit"
            }
        },
        "kitsNotAllowedForDoseHold":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DoseHoldKit"
            }
        }
    }
}

Nested Schema : kitsAllowedForDoseHold

Type: array

Show Source

Array of: object DoseHoldKit

Title: DoseHoldKit

Response containing dose hold kit details

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

Nested Schema : kitsNotAllowedForDoseHold

Type: array

Show Source

Array of: object DoseHoldKit

Title: DoseHoldKit

Response containing dose hold kit details

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

Nested Schema : DoseHoldKit

Type: object

Title: DoseHoldKit

Response containing dose hold kit details

Show Source

blindedTItrationLabel: string

Blinded TItration Label

Example: Low dose
deviceType: string

mHealth Device Type

Example: ActivityWatch
isTitration: boolean

Indicate if titration

Example: true
kitDescription: string

Kit description

Example: Kit A
kitTypeSrcId: string

Kit Type Id

Example: D313327EF13845169A8ADADDA435431E
reason: string

Reason for kits not allowed for dose hold

Example: DOSE_HOLD_VISIT_NOT_STARTED
trialSupplyType: string

Trial Supply Type

Example: BOTTLE

{
    "title":"DoseHoldKit",
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "type":"string",
            "description":"Kit Type Id",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description",
            "example":"Kit A"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type",
            "example":"BOTTLE"
        },
        "deviceType":{
            "type":"string",
            "description":" mHealth Device Type",
            "example":"ActivityWatch"
        },
        "blindedTItrationLabel":{
            "type":"string",
            "description":"Blinded TItration Label",
            "example":"Low dose"
        },
        "isTitration":{
            "type":"boolean",
            "description":"Indicate if titration",
            "example":true
        },
        "reason":{
            "type":"string",
            "description":"Reason for kits not allowed for dose hold",
            "example":"DOSE_HOLD_VISIT_NOT_STARTED"
        }
    },
    "description":"Response containing dose hold kit details"
}

400 Response

Invalid subject OR Scheduled visit with instance number OR Unscheduled visit with no instance number

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

Internal server error

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