REST API for Clinical One Platform

Get visits with partial dispensation for all subjects

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/subject-partial-dispensations

Retrieves visits marked with partial dispensation for all subjects

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 : PartialDispensationSubjectsRequest v1.0

Type: object

Title: PartialDispensationSubjectsRequest v1.0

Contains a list of subjects to get Partial Dispensation details

Show Source

subjects(required): array subjects

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Unique Items Required: true

Contains subjects.

{
    "title":"PartialDispensationSubjectsRequest v1.0",
    "required":[
        "subjects"
    ],
    "type":"object",
    "properties":{
        "subjects":{
            "maxItems":"2147483647",
            "minItems":"1",
            "uniqueItems":true,
            "type":"array",
            "description":"Contains subjects.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Contains a list of subjects to get Partial Dispensation details"
}

Nested Schema : subjects

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Unique Items Required: true

Contains subjects.

Show Source

Array of: string(uuid)

{
    "maxItems":"2147483647",
    "minItems":"1",
    "uniqueItems":true,
    "type":"array",
    "description":"Contains subjects.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : SubjectReplaceKitsResponse

Type: object

Title: SubjectReplaceKitsResponse

Response containing kit replacement for subject.

Show Source

replacedKits: array replacedKits

{
    "title":"SubjectReplaceKitsResponse",
    "type":"object",
    "properties":{
        "replacedKits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/replacedKits"
            }
        }
    },
    "description":"Response containing kit replacement for subject."
}

Nested Schema : replacedKits

Type: array

Show Source

Array of: object replacedKits

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

Nested Schema : replacedKits

Type: object

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

{
    "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"
        }
    }
}