REST API for Clinical One Platform

Get reusable kits from a list of kit types

post

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits

Retrieves previously dispensed kits, form a list of kit types passed in the request body, that can be reused in the current visit for a given subject. Support for unblinded pharmacist kits which are put on dose hold. UTF8 format support for KitNumber.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

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

instanceNumber: number (BigDecimal)

Minimum Value: 1

Instance number of the unscheduled visit

Example: 2
kitTypesForDoseHold: array kitTypesForDoseHold
screeningDate: string (date-time)

screening date
studyVersion(required): string

ID of the study

Example: 1.0.0.5
titrationOption: string

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

Pattern: up|down|maintain

Titration Option

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

ID of the visit
visitStartDate: string (date-time)

visit start date

{
    "required":[
        "studyVersion",
        "visitId"
    ],
    "type":"object",
    "properties":{
        "studyVersion":{
            "type":"string",
            "description":"ID of the study",
            "example":"1.0.0.5"
        },
        "visitId":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        },
        "instanceNumber":{
            "minimum":1,
            "type":"number",
            "description":"Instance number of the unscheduled visit",
            "format":"BigDecimal",
            "example":2
        },
        "titrationOption":{
            "pattern":"up|down|maintain",
            "type":"string",
            "description":"Titration Option",
            "example":"up",
            "enum":[
                "up",
                "down",
                "maintain"
            ]
        },
        "kitTypesForDoseHold":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DoseHoldRequestV1"
            }
        },
        "screeningDate":{
            "type":"string",
            "description":"screening date",
            "format":"date-time"
        },
        "visitStartDate":{
            "type":"string",
            "description":"visit start date",
            "format":"date-time"
        }
    }
}

Nested Schema : kitTypesForDoseHold

Type: array

Show Source

Array of: object DoseHoldRequestV1

Contains details about kits which are to be hold or dispensed

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

Nested Schema : DoseHoldRequestV1

Type: object

Contains details about kits which are to be hold or dispensed

Show Source

deviceType: string

deviceType

Example: Scale
isTitration: boolean

isTitration
kitTypeSrcId: string (uuid)

kitTypeSrcId of the kit
trialSupplyType: string

trialSupplyType

Example: BOTTLE

{
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "type":"string",
            "description":"kitTypeSrcId of the kit",
            "format":"uuid"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"trialSupplyType",
            "example":"BOTTLE"
        },
        "deviceType":{
            "type":"string",
            "description":"deviceType",
            "example":"Scale"
        },
        "isTitration":{
            "type":"boolean",
            "description":"isTitration"
        }
    },
    "description":"Contains details about kits which are to be hold or dispensed"
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : ReusableKitsResponse v1.0

Type: object

Title: ReusableKitsResponse v1.0

Contains details of reusable kits.

Show Source

kits: array kits
status(required): string

Allowed Values: [ "ALLOW, REUSE_NOT_ALLOWED" ]

reuse allowed or not

Example: ALLOW

{
    "title":"ReusableKitsResponse v1.0",
    "required":[
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"reuse allowed or not",
            "example":"ALLOW",
            "enum":[
                "ALLOW, REUSE_NOT_ALLOWED"
            ]
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReusableKit"
            }
        }
    },
    "description":"Contains details of reusable kits."
}

Nested Schema : kits

Type: array

Show Source

Array of: object ReusableKit

Title: ReusableKit

Response containing reusable kit details

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

Nested Schema : ReusableKit

Type: object

Title: ReusableKit

Response containing reusable kit details

Show Source

consumeAcrossDoses: boolean

Indicate if consume across dosed allowed.

Example: true
dose: number (double)

Dose.

Example: 5
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
id: number (Integer)

Id of the reusable kit.

Example: 2
inventoryId: string

Inventory Id

Example: D313327EF13845169A8ADADDA435431E
kitDescription: string

Kit description

Example: Kit A
measurement: string

Dose Measurement.

Example: ml
trialSupplyType: string

Trial Supply Type

Example: BOTTLE

{
    "title":"ReusableKit",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"Id of the reusable kit.",
            "format":"Integer",
            "example":2
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory Id",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type",
            "example":"BOTTLE"
        },
        "consumeAcrossDoses":{
            "type":"boolean",
            "description":"Indicate if consume across dosed allowed.",
            "example":true
        },
        "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"
            ]
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description",
            "example":"Kit A"
        }
    },
    "description":"Response containing reusable 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object