REST API for Clinical One Platform

Get dispensation history

get

/ec-ors-svc/rest/v9.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history

Retrieves dispensation history for a study, by subject and visit ID. Rights: OrsSubjectVisitGet. Added additional fields userId, originalKit, titration and inventoryStatusName.

Request

Path Parameters

externalSubjectId(required): string(uuid)

ID of the subject
mode(required): string

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

ID of the study

Query Parameters

asofdate(required): string

Get data as of the given date
visitId(required): string

ID of the visit

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Type: array

Show Source

Array of: object DispensationHistoryResponse

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

Nested Schema : DispensationHistoryResponse

Type: object

Show Source

allowReplacement: boolean

Indicate if the kit is allowed for replacement.

Example: true
balanceUnits: number (double)

Balance Units of Kit

Example: 1
barcode: string

barcode.

Example: 1236
conserved: boolean

Indicate if the kit has been reused/conserved.

Example: true
deviceConnection: string

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

Indicates device connection in case of device kit

Example: DevicetoCloud
deviceType: string

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

Indicates type of device in case of device kit

Example: WearablePatch
dispensationConfirmed: boolean

dispensationConfirmed.

Example: true
dispensationDate: string (date-time)

Dispensation date
dose: number (double)

Dose.

Example: 5
dosingUnblinded: boolean

dosingUnblinded.

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
instanceNumber: number (BigDecimal)

Instance number of the unscheduled visit

Example: 2
inventoryId: string (uuid)

Inventory Id.
inventoryStatus: number (double)

Allowed Values: [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "19", "20" ]

Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).

Example: 5
inventoryStatusName: string

Name of the inventory status

Example: Dispensed
kitDescription: string

Kit Type Description

Example: Kit A
kitNumber: number (double)

Kit nuumber.

Example: 5
kitNumberUTF: string

kitNumberUTF

Example: 000AB123
lastModifiedDate: string (date-time)

Last modified date
measurement: string

Dose Measurement.

Example: ml
mHealthDeviceId: string

mHealth Device Id

Example: B1B8327AFAA6412287106192AB5984EF
missingUnits: number (double)

Missing Units of Kit

Example: 1
originalKit: string

Original kit number for the replaced kit

Example: Kit-345
packageTypeId: number (double)

Allowed Values: [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ]

Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).

Example: 5
returnedUnits: number (double)

Returned Units of Kit

Example: 1
siteId: string (uuid)

ID of the site
titration: string

Titration options to dispense kits. For example: up/down/maintain.

Example: maintain
trialSupplyType: string

Trial Supply Type for the kit

Example: BOTTLE
unitsPerKit: number (double)

Units per Kit

Example: 1
userId: string (uuid)

User Id
visitId: string (uuid)

ID of the visit

{
    "type":"object",
    "properties":{
        "kitNumber":{
            "type":"number",
            "description":"Kit nuumber.",
            "format":"double",
            "example":"5"
        },
        "inventoryStatus":{
            "type":"number",
            "description":"Unique ID corresponding to each inventory status value (1 for Available, 2 for Damaged, 3 for Destroyed, 4 for Dispensed, 5 for Expired, 6 for Not in Use, 7 for Misallocated, 8 for Missing, 9 for In Transit, 10 for Quarantined, 11 for Pre-quarantined, 12 for Pending Destruction, 13 for Lost by Subject, 14 for Temporarily Unavailable, 15 for Damaged by Subject, 16 for New, 17 for Not Dispensed to Subject, 18 for Returned to Site, 19 for Conserved, 20 for Received for Destruction).",
            "format":"double",
            "example":"5",
            "enum":[
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10",
                "11",
                "12",
                "13",
                "14",
                "15",
                "16",
                "17",
                "18",
                "19",
                "20"
            ]
        },
        "dispensationDate":{
            "type":"string",
            "description":"Dispensation date",
            "format":"date-time"
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory Id.",
            "format":"uuid"
        },
        "packageTypeId":{
            "type":"number",
            "description":"Unique ID corresponding to each package type value (1 for BLISTERPACK, 2 for BOTTLE, 3 for DEVICE, 4 for SYRINGE, 5 for OINTMENT, 6 for VIAL, 7 for INHALER, 8 for INFUSION, 9 for BOX, 10 for OTHER).",
            "format":"double",
            "example":"5",
            "enum":[
                "1",
                "2",
                "3",
                "4",
                "5",
                "6",
                "7",
                "8",
                "9",
                "10"
            ]
        },
        "unitsPerKit":{
            "type":"number",
            "description":"Units per Kit",
            "format":"double",
            "example":"1"
        },
        "returnedUnits":{
            "type":"number",
            "description":"Returned Units of Kit",
            "format":"double",
            "example":"1"
        },
        "missingUnits":{
            "type":"number",
            "description":"Missing Units of Kit",
            "format":"double",
            "example":"1"
        },
        "balanceUnits":{
            "type":"number",
            "description":"Balance Units of Kit",
            "format":"double",
            "example":"1"
        },
        "siteId":{
            "type":"string",
            "description":"ID  of the site",
            "format":"uuid"
        },
        "lastModifiedDate":{
            "type":"string",
            "description":"Last modified date",
            "format":"date-time"
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit Type 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"
            ]
        },
        "visitId":{
            "type":"string",
            "description":"ID of the visit",
            "format":"uuid"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type for the kit",
            "example":"BOTTLE"
        },
        "deviceType":{
            "type":"string",
            "description":"Indicates type of device in case of device kit",
            "example":"WearablePatch",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "type":"string",
            "description":"Indicates device connection in case of device kit",
            "example":"DevicetoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "mHealthDeviceId":{
            "type":"string",
            "description":"mHealth Device Id",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "conserved":{
            "type":"boolean",
            "description":"Indicate if the kit has been reused/conserved.",
            "example":true
        },
        "allowReplacement":{
            "type":"boolean",
            "description":"Indicate if the kit is allowed for replacement.",
            "example":true
        },
        "instanceNumber":{
            "type":"number",
            "description":"Instance number of the unscheduled visit",
            "format":"BigDecimal",
            "example":"2"
        },
        "barcode":{
            "type":"string",
            "description":"barcode.",
            "example":"1236"
        },
        "dispensationConfirmed":{
            "type":"boolean",
            "description":"dispensationConfirmed.",
            "example":true
        },
        "dosingUnblinded":{
            "type":"boolean",
            "description":"dosingUnblinded.",
            "example":true
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"kitNumberUTF",
            "example":"000AB123"
        },
        "inventoryStatusName":{
            "type":"string",
            "description":"Name of the inventory status",
            "example":"Dispensed"
        },
        "userId":{
            "type":"string",
            "description":"User Id",
            "format":"uuid"
        },
        "titration":{
            "type":"string",
            "description":"Titration options to dispense kits. For example: up/down/maintain.",
            "example":"maintain"
        },
        "originalKit":{
            "type":"string",
            "description":"Original kit number for the replaced kit",
            "example":"Kit-345"
        }
    }
}

400 Response

Invalid parameters

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 Subject 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

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