V7.0
get
/ec-designer-ors-svc/rest/v7.0/studies/{studyId}/versions/{version}/dispensings
Retrieves dispensing visit assignments for the specified study version. The optional kitType query parameter filters the kit categories returned. The response includes rows with the kit, visit, treatment arm, quantity, do-not-dispense days, titration details, and whether dispensing outside the visit window is allowed.
Request
Path Parameters
-
studyId(required): string(uuid)
Study unique identifier.Example:
CF1E6500073D4AD298F4DA93DA670786 -
version(required): string
Study version identifier.Example:
1.0.0.1
Query Parameters
-
kitType: string
Minimum Length:
3Maximum Length:9Optional. Kit type filter for dispensation visits. Allowed values: ALL = all supported kit types, STANDARD = standard kits, TITRATION = titration kits, DEVICE = device kits. Defaults to ALL when omitted.Default Value:ALLAllowed Values:[ "ALL", "STANDARD", "TITRATION", "DEVICE" ]Example:ALL
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation.
Root Schema : schema
Type:
Show Source
array-
Array of:
object DispensingRowResponseV7
Dispensing visit row returned by the v7 get and update dispensings endpoints.
Nested Schema : DispensingRowResponseV7
Type:
objectDispensing visit row returned by the v7 get and update dispensings endpoints.
Show Source
-
adGroupId: string
(uuid)
Minimum Length:
32Maximum Length:32Advanced dosing group unique identifier when advanced dosing selected this row. -
allowTitration: boolean
Indicates whether titration is allowed for the row.Example:
true -
armid: string
(uuid)
Minimum Length:
32Maximum Length:32Treatment arm unique identifier. -
blindedInfo: object
Kits GET Kit v10.0
Title:
Kits GET Kit v10.0Kit details returned by the GET kits endpoint. -
dispenseoutsidewindow: boolean
Indicates whether the kit can be dispensed outside the visit window.Example:
false -
dnd: integer
(int64)
Minimum Value:
0Maximum Value:9999Do-not-dispense threshold in days before kit expiration. Allowed numeric range is 0 through 9999. Negative values are not allowed.Example:5 -
dosingId: string
(uuid)
Minimum Length:
32Maximum Length:32Dosing unique identifier associated with the row. -
errorParamList: array
errorParamList
Validation or resolution error parameter groups associated with the dispensation row.
-
id: string
(uuid)
Minimum Length:
32Maximum Length:32Dispensing row unique identifier. -
kitid: string
(uuid)
Minimum Length:
32Maximum Length:32Kit unique identifier. -
quantity: integer
(int64)
Minimum Value:
1Maximum Value:9999Quantity of kits or dose to dispense. Allowed numeric range is 1 through 9999. Zero and negative values are not allowed.Example:1 -
titrationKits: array
titrationKits
Titration kits associated with the dispensation row.
-
visitid: string
(uuid)
Minimum Length:
32Maximum Length:32Visit unique identifier.
Nested Schema : Kits GET Kit v10.0
Type:
objectTitle:
Kits GET Kit v10.0Kit details returned by the GET kits endpoint.
Show Source
-
advancedDosing: integer
(int32)
Minimum Value:
0Maximum Value:1Advanced dosing flag for the kit. `0` means disabled and `1` means enabled.Example:1 -
advancedDosingGroups: array
advancedDosingGroups
Minimum Number of Items:
0Advanced dosing groups that define criteria-based kit selection rules. -
dosage: number
(double)
Minimum Value:
0Legacy dosage value returned for backward compatibility.Example:50 -
dosings: array
dosings
Minimum Number of Items:
0Calculated dosing definitions associated with the kit. -
exceptions: array
exceptions
Minimum Number of Items:
0Titration exceptions configured for the kit. -
isDefault: boolean
Whether this kit is the default kit for the current configuration.Example:
true -
kitId: string
(uuid)
Minimum Length:
32Maximum Length:32Kit identifier. -
kitSettings: object
Kits GET Kit Settings v10.0
Title:
Kits GET Kit Settings v10.0Kit settings returned by GET kits. -
kitTitrations: array
kitTitrations
Minimum Number of Items:
0Titration rows configured for the kit. -
kitUnitSettings: object
Kits GET Kit Unit Settings v10.0
Title:
Kits GET Kit Unit Settings v10.0Unit settings returned by GET kits. -
libraryKitId: string
(uuid)
Minimum Length:
32Maximum Length:32Library kit identifier when the kit is based on a library kit. -
poolingId: string
Minimum Length:
1Maximum Length:64Pooling identifier for pooled kits.Example:POOL12 -
studyId: string
(uuid)
Minimum Length:
32Maximum Length:32Study identifier. -
studyVersionEnd: string
(date-time)
Minimum Length:
20Maximum Length:40Study version end timestamp.Example:3099-12-31T00:00:00Z -
studyVersionStart: string
(date-time)
Minimum Length:
20Maximum Length:40Study version start timestamp.Example:2026-01-15T10:15:30Z -
versionEnd: string
(date-time)
Minimum Length:
20Maximum Length:40Version end timestamp for the kit record.Example:3099-12-31T00:00:00Z -
versionStart: string
(date-time)
Minimum Length:
20Maximum Length:40Version start timestamp for the kit record.Example:2026-01-15T10:15:30Z
Example:
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSettings":{
"deviceType":"ActivityWatch",
"deviceConn":"DevicetoCloud",
"calculatingDoses":true,
"titratingDoses":false,
"titrationKit":false,
"distributionSetting":"BLINDED",
"kitTypeId":"KIT_STD_001",
"kitDescription":"Standard treatment kit",
"storageSetting":"AMBIENT",
"trialSupplyType":"BOTTLE",
"minShipUnits":10,
"serialized":true,
"hazardousMaterial":false,
"controlSubstance":false,
"bufferdays":5,
"dispenseOutsideWindow":false
},
"kitUnitSettings":{
"unitsPerKit":20,
"singleUnitDose":{
"value":10,
"units":"mg"
}
},
"dosings":[
{
"id":"D1B8327AFAA6412287106192AB5984EF",
"name":"Weight-based dose",
"question":{
"formId":"E1B8327AFAA6412287106192AB5984EF",
"itemId":"F1B8327AFAA6412287106192AB5984EF"
},
"visit":{
"id":"A1B8327AFAA6412287106192AB5984EF",
"type":"ScreeningVisit"
},
"dose":{
"precision":1,
"roundUp":1,
"frequency":"Daily",
"leftOverUnits":false
},
"measurement":{
"kit":{
"value":10,
"units":"mg"
},
"subject":{
"value":70,
"units":"kg"
}
}
}
],
"exceptions":[
{
"id":"91B8327AFAA6412287106192AB5984EF",
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"sequence":1,
"startingDoseJson":{
"titrationKitExceptionItems":[
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSeq":1,
"kitDosage":"QD",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]
},
"endingDoseJson":{
"titrationKitExceptionItems":[
{
"kitId":"C1B8327AFAA6412287106192AB5984EF",
"kitSeq":2,
"kitDosage":"BID",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]
},
"minTimeBetweenDoseChangesUnit":"Days",
"minTimeBetweenDoseChanges":2,
"exceptionType":"UP_EXCEPTION"
}
],
"advancedDosing":1,
"advancedDosingGroups":[
{
"id":"71B8327AFAA6412287106192AB5984EF",
"groupName":"Adults",
"groupCriteria":[
{
"id":"72B8327AFAA6412287106192AB5984EF",
"criteriaType":"Question",
"visitName":"Screening",
"visitId":"A1B8327AFAA6412287106192AB5984EF",
"formName":"Demographics",
"formId":"E1B8327AFAA6412287106192AB5984EF",
"questionName":"Age",
"questionId":"F1B8327AFAA6412287106192AB5984EF",
"variable":"System Screening Date",
"variableId":"73B8327AFAA6412287106192AB5984EF",
"timePeriod":"Before",
"dateValue":"2026-01-15",
"answer":[
{
"value":"18_PLUS",
"label":"18 years or older"
}
],
"rule":{
"id":"74B8327AFAA6412287106192AB5984EF",
"ruleName":"Greater Than Or Equal To",
"value":"18",
"valueList":[
{
"value":"18",
"label":"18"
}
],
"lower":{
"value":"18",
"inclusive":true
},
"upper":{
"value":"120",
"inclusive":true
}
}
}
],
"kitSettings":[
{
"id":"75B8327AFAA6412287106192AB5984EF",
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitName":"Standard treatment kit",
"dosingId":"D1B8327AFAA6412287106192AB5984EF",
"kitUnitSettings":{
"unitsPerKit":20,
"singleUnitDose":{
"value":10,
"units":"mg"
}
},
"dosings":[
{
"id":"D1B8327AFAA6412287106192AB5984EF",
"name":"Weight-based dose",
"question":{
"formId":"E1B8327AFAA6412287106192AB5984EF",
"itemId":"F1B8327AFAA6412287106192AB5984EF"
},
"visit":{
"id":"A1B8327AFAA6412287106192AB5984EF",
"type":"ScreeningVisit"
},
"dose":{
"precision":1,
"roundUp":1,
"frequency":"Daily",
"leftOverUnits":false
},
"measurement":{
"kit":{
"value":10,
"units":"mg"
},
"subject":{
"value":70,
"units":"kg"
}
}
}
],
"dosingLabel":"Dose 1",
"quantity":1
}
],
"instructions":"Dispense one kit when the adult criteria are met."
}
],
"versionStart":"2026-01-15T10:15:30Z",
"versionEnd":"3099-12-31T00:00:00Z",
"studyId":"CF1E6500073D4AD298F4DA93DA670786",
"studyVersionStart":"2026-01-15T10:15:30Z",
"studyVersionEnd":"3099-12-31T00:00:00Z",
"libraryKitId":"C1B8327AFAA6412287106192AB5984EF",
"poolingId":"POOL12",
"isDefault":true,
"dosage":50
}Nested Schema : errorParamList
Type:
arrayValidation or resolution error parameter groups associated with the dispensation row.
Show Source
-
Array of:
object DispensingErrorParamListV7
Collection of error parameters associated with a dispensation row.
Example:
[
{
"ErrorParam":[
{
"key":"A1B8327AFAA6412287106192AB5984EF",
"type":"Visit",
"id":"A1B8327AFAA6412287106192AB5984EF",
"name":"Week 1"
}
]
}
]Nested Schema : titrationKits
Type:
arrayTitration kits associated with the dispensation row.
Show Source
-
Array of:
object DispensingTitrationKitV7
Titration kit summary associated with a dispensation row.
Example:
[
{
"kitTypeId":"KIT_STD_001",
"kitid":"B1B8327AFAA6412287106192AB5984EF",
"kitQuantity":1
}
]Nested Schema : advancedDosingGroups
Type:
arrayMinimum Number of Items:
0Advanced dosing groups that define criteria-based kit selection rules.
Show Source
-
Array of:
object Kits GET Advanced Dosing Group v10.0
Title:
Kits GET Advanced Dosing Group v10.0Advanced dosing group definition.
Nested Schema : dosings
Type:
arrayMinimum Number of Items:
0Calculated dosing definitions associated with the kit.
Show Source
-
Array of:
object Kits GET Kit Dosing v10.0
Title:
Kits GET Kit Dosing v10.0Calculated dosing definition returned by GET kits.
Nested Schema : exceptions
Type:
arrayMinimum Number of Items:
0Titration exceptions configured for the kit.
Show Source
-
Array of:
object Kits GET Titration Exception v10.0
Title:
Kits GET Titration Exception v10.0Titration exception returned by GET kits.
Nested Schema : Kits GET Kit Settings v10.0
Type:
objectTitle:
Kits GET Kit Settings v10.0Kit settings returned by GET kits.
Show Source
-
bufferdays: integer
(int64)
Minimum Value:
0Buffer days for dispensing calculations.Example:5 -
calculatingDoses: boolean
Whether the kit uses calculated dosing.Example:
true -
controlSubstance: boolean
Whether the kit is a controlled substance.Example:
false -
deviceConn: string
Minimum Length:
1Maximum Length:32Allowed Values:[ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]Device connectivity type for device kits. `CloudtoCloud` means the device syncs through a third-party cloud service, `DevicetoCloud` means the device sends data directly to the platform cloud, and `NoConnection` means the device has no connectivity requirement.Example:DevicetoCloud -
deviceType: string
Minimum Length:
1Maximum Length:64Allowed Values:[ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]Device type for device kits. Allowed values: ActivityWatch, BloodPressureMonitor, WeightScale, ECGReader, Spirometer, MobileApp, SmartPillBottle, PulseOximeter, WearablePatch, Other, GlucoseMonitor.Example:ActivityWatch -
dispenseOnHighestDose: boolean
Whether to dispense on an up-titration request when the subject is already at the highest dose.Example:
true -
dispenseOnHighestDoseMsg: string
Minimum Length:
1Maximum Length:1024Message shown when a subject is already at the highest dose.Example:Subject is already at the highest dose. -
dispenseOnLowestDose: boolean
Whether to dispense on a down-titration request when the subject is already at the lowest dose.Example:
true -
dispenseOnLowestDoseMsg: string
Minimum Length:
1Maximum Length:1024Message shown when a subject is already at the lowest dose.Example:Subject is already at the lowest dose. -
dispenseOutsideWindow: boolean
Whether the kit can be dispensed outside the visit window.Example:
false -
distributionSetting: string
Minimum Length:
1Maximum Length:32Allowed Values:[ "BLINDED", "UNBLINDED", "UNBLINDEDPHARMAC" ]Distribution setting for the kit. `BLINDED` hides treatment assignment, `UNBLINDED` exposes treatment assignment, and `UNBLINDEDPHARMAC` is unblinded for pharmacy-managed dispensing workflows.Example:BLINDED -
doseChangeInUnschVisit: boolean
Whether dose changes are allowed at unscheduled visits.Example:
false -
dosingFrequency: boolean
Whether titration dosing frequency is configured.Example:
true -
downTitrateDose: integer
(int64)
Minimum Value:
0Maximum number of down-titration dose changes.Example:2 -
downTitrateDoseUnscheduled: integer
(int64)
Minimum Value:
0Maximum number of down-titration dose changes allowed for unscheduled visits.Example:2 -
hazardousMaterial: boolean
Whether the kit is hazardous material.Example:
false -
kitDescription: string
Minimum Length:
1Maximum Length:255Kit description displayed to users.Example:Standard treatment kit -
kitTypeId: string
Minimum Length:
1Maximum Length:64Kit type identifier.Example:KIT_STD_001 -
maxDoseChanges: integer
(int64)
Minimum Value:
0Maximum number of total dose changes.Example:3 -
minShipUnits: integer
(int64)
Minimum Value:
0Minimum number of ship units required for this kit.Example:10 -
serialized: boolean
Whether the kit is serialized.Example:
true -
storageSetting: string
Minimum Length:
1Maximum Length:32Allowed Values:[ "AMBIENT", "FROZEN", "REFRIGERATED" ]Storage setting for the kit. `AMBIENT` means room-temperature storage, `FROZEN` means frozen storage, and `REFRIGERATED` means refrigerated storage.Example:AMBIENT -
timeBetweenDownDoseChanges: integer
(int64)
Minimum Value:
0Minimum time required between down-dose changes.Example:20 -
timeBetweenDownDoseChangesException: boolean
Whether an exception is allowed for the time between down-dose changes.Example:
true -
timeBetweenDownDoseChangesUnit: string
Minimum Length:
1Maximum Length:16Allowed Values:[ "Days", "Hours" ]Unit used for the time between down-dose changes. `Days` measures the interval in calendar days and `Hours` measures the interval in hours.Example:Days -
timeBetweenUpDoseChanges: integer
(int64)
Minimum Value:
0Minimum time required between up-dose changes.Example:20 -
timeBetweenUpDoseChangesException: boolean
Whether an exception is allowed for the time between up-dose changes.Example:
true -
timeBetweenUpDoseChangesUnit: string
Minimum Length:
1Maximum Length:16Allowed Values:[ "Days", "Hours" ]Unit used for the time between up-dose changes. `Days` measures the interval in calendar days and `Hours` measures the interval in hours.Example:Days -
titratingDoses: boolean
Whether the kit supports titration dosing.Example:
false -
titrationKit: boolean
Whether the kit itself is a titration kit.Example:
false -
totalDoseUnscheduled: integer
(int64)
Minimum Value:
0Maximum number of total dose changes allowed for unscheduled visits.Example:3 -
trialSupplyType: string
Minimum Length:
1Maximum Length:32Allowed Values:[ "BLISTERPACK", "BOTTLE", "DEVICE", "SYRINGE", "OINTMENT", "VIAL", "INHALER", "INFUSION", "BOX", "OTHER" ]Trial supply type for the kit. Allowed values: BLISTERPACK, BOTTLE, DEVICE, SYRINGE, OINTMENT, VIAL, INHALER, INFUSION, BOX, OTHER.Example:BOTTLE -
upTitrateDose: integer
(int64)
Minimum Value:
0Maximum number of up-titration dose changes.Example:1 -
upTitrateDoseUnscheduled: integer
(int64)
Minimum Value:
0Maximum number of up-titration dose changes allowed for unscheduled visits.Example:1
Nested Schema : kitTitrations
Type:
arrayMinimum Number of Items:
0Titration rows configured for the kit.
Show Source
-
Array of:
object Kits GET Titration Group v10.0
Title:
Kits GET Titration Group v10.0Titration group row returned by GET kits.
Example:
[
{
"rowId":"81B8327AFAA6412287106192AB5984EF",
"titrationKitId":"B1B8327AFAA6412287106192AB5984EF",
"titrationKitLabel":"Low Dose",
"titrationKitSeq":1,
"titrationKitJson":{
"titrationKitItems":[
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSeq":1,
"kitDosage":"QD",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]
},
"upTitrationKitJson":{
"titrationKitItems":[
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSeq":1,
"kitDosage":"QD",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]
},
"maintainTitrationKitJson":{
"titrationKitItems":[
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSeq":1,
"kitDosage":"QD",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]
},
"downTitrationKitJson":{
"titrationKitItems":[
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSeq":1,
"kitDosage":"QD",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]
}
}
]Nested Schema : Kits GET Kit Unit Settings v10.0
Type:
objectTitle:
Kits GET Kit Unit Settings v10.0Unit settings returned by GET kits.
Show Source
-
singleUnitDose: object
Kits GET Value Units v10.0
Title:
Kits GET Value Units v10.0Value and unit pair used by dosing and kit unit settings. -
unitsPerKit: number
Minimum Value:
0Number of units per kit.Example:20
Nested Schema : Kits GET Advanced Dosing Group v10.0
Type:
objectTitle:
Kits GET Advanced Dosing Group v10.0Advanced dosing group definition.
Show Source
-
groupCriteria: array
groupCriteria
Minimum Number of Items:
0Criteria that determine whether the group applies. -
groupName: string
Minimum Length:
1Maximum Length:255Advanced dosing group name.Example:Adults -
id: string
(uuid)
Minimum Length:
32Maximum Length:32Advanced dosing group identifier. -
instructions: string
Minimum Length:
1Maximum Length:2000Instructions shown for the advanced dosing group.Example:Dispense one kit when the adult criteria are met. -
kitSettings: array
kitSettings
Minimum Number of Items:
0Kit settings applied when the group criteria are satisfied.
Nested Schema : groupCriteria
Type:
arrayMinimum Number of Items:
0Criteria that determine whether the group applies.
Show Source
-
Array of:
object Kits GET Advanced Dosing Criterion v10.0
Title:
Kits GET Advanced Dosing Criterion v10.0Advanced dosing group criterion.
Nested Schema : kitSettings
Type:
arrayMinimum Number of Items:
0Kit settings applied when the group criteria are satisfied.
Show Source
-
Array of:
object Kits GET Advanced Dosing Kit Settings v10.0
Title:
Kits GET Advanced Dosing Kit Settings v10.0Kit settings used inside an advanced dosing group.
Nested Schema : Kits GET Advanced Dosing Criterion v10.0
Type:
objectTitle:
Kits GET Advanced Dosing Criterion v10.0Advanced dosing group criterion.
Show Source
-
answer: array
answer
Minimum Number of Items:
0Selected answer values for choice-based criteria. -
criteriaType: string
Minimum Length:
1Maximum Length:32Allowed Values:[ "Question", "Dates", "Cohort", "Treatment Arm", "invalid" ]Criterion type. `Question` evaluates a form response, `Dates` evaluates a date variable, `Cohort` matches cohort membership, `Treatment Arm` matches arm assignment, and `invalid` represents an unrecognized persisted value.Example:Question -
dateValue: string
Minimum Length:
10Maximum Length:10Date value used by date-based criteria in `YYYY-MM-DD` format.Example:2026-01-15 -
formId: string
(uuid)
Minimum Length:
32Maximum Length:32Form identifier associated with the criterion. -
formName: string
Minimum Length:
1Maximum Length:255Form name associated with the criterion.Example:Demographics -
id: string
(uuid)
Minimum Length:
32Maximum Length:32Criterion identifier. -
questionId: string
(uuid)
Minimum Length:
32Maximum Length:32Question identifier associated with the criterion. -
questionName: string
Minimum Length:
1Maximum Length:255Question name associated with the criterion.Example:Age -
rule: object
Kits GET Rule v10.0
Title:
Kits GET Rule v10.0Advanced dosing evaluation rule. -
timePeriod: string
Minimum Length:
1Maximum Length:16Allowed Values:[ "After", "Before", "invalid" ]Time period qualifier used by date-based criteria. `After` means the event occurs after the supplied date, `Before` means it occurs before the supplied date, and `invalid` represents an unrecognized persisted value.Example:Before -
variable: string
Minimum Length:
1Maximum Length:255Variable label associated with the criterion.Example:System Screening Date -
variableId: string
(uuid)
Minimum Length:
32Maximum Length:32Variable identifier associated with the criterion. -
visitId: string
(uuid)
Minimum Length:
32Maximum Length:32Visit identifier associated with the criterion. -
visitName: string
Minimum Length:
1Maximum Length:255Visit name associated with the criterion.Example:Screening
Nested Schema : answer
Type:
arrayMinimum Number of Items:
0Selected answer values for choice-based criteria.
Show Source
-
Array of:
object Kits GET Label Value v10.0
Title:
Kits GET Label Value v10.0Label and value pair used across advanced dosing rules.
Nested Schema : Kits GET Rule v10.0
Type:
objectTitle:
Kits GET Rule v10.0Advanced dosing evaluation rule.
Show Source
-
id: string
(uuid)
Minimum Length:
32Maximum Length:32Rule identifier. -
lower: object
Kits GET Range Rule Boundary v10.0
Title:
Kits GET Range Rule Boundary v10.0Boundary value for a range-based rule. -
ruleName: string
Minimum Length:
1Maximum Length:255Rule display name.Example:Greater Than Or Equal To -
upper: object
Kits GET Range Rule Boundary v10.0
Title:
Kits GET Range Rule Boundary v10.0Boundary value for a range-based rule. -
value: string
Minimum Length:
1Maximum Length:255Single rule value when the rule accepts one value.Example:18 -
valueList: array
valueList
Minimum Number of Items:
0List of allowed rule values for list-based rules.
Nested Schema : Kits GET Label Value v10.0
Type:
objectTitle:
Kits GET Label Value v10.0Label and value pair used across advanced dosing rules.
Show Source
-
label: string
Minimum Length:
1Maximum Length:255Display label.Example:18 years or older -
value: string
Minimum Length:
1Maximum Length:255Stored value.Example:18_PLUS
Nested Schema : Kits GET Range Rule Boundary v10.0
Type:
objectTitle:
Kits GET Range Rule Boundary v10.0Boundary value for a range-based rule.
Show Source
-
inclusive: boolean
Whether the boundary is inclusive.Example:
true -
value: string
Minimum Length:
1Maximum Length:255Boundary value.Example:18
Nested Schema : valueList
Type:
arrayMinimum Number of Items:
0List of allowed rule values for list-based rules.
Show Source
-
Array of:
object Kits GET Label Value v10.0
Title:
Kits GET Label Value v10.0Label and value pair used across advanced dosing rules.
Nested Schema : Kits GET Advanced Dosing Kit Settings v10.0
Type:
objectTitle:
Kits GET Advanced Dosing Kit Settings v10.0Kit settings used inside an advanced dosing group.
Show Source
-
dosingId: string
(uuid)
Minimum Length:
32Maximum Length:32Dosing identifier referenced by this advanced dosing group. -
dosingLabel: string
Minimum Length:
1Maximum Length:255Dosing label displayed for the advanced dosing kit setting.Example:Dose 1 -
dosings: array
dosings
Minimum Number of Items:
0Calculated dosing definitions for the selected kit. -
id: string
(uuid)
Minimum Length:
32Maximum Length:32Advanced dosing kit settings identifier. -
kitId: string
(uuid)
Minimum Length:
32Maximum Length:32Kit identifier. -
kitName: string
Minimum Length:
1Maximum Length:255Kit name displayed in the advanced dosing group.Example:Standard treatment kit -
kitUnitSettings: object
Kits GET Kit Unit Settings v10.0
Title:
Kits GET Kit Unit Settings v10.0Unit settings returned by GET kits. -
quantity: integer
(int64)
Minimum Value:
0Quantity of kits to dispense for this setting.Example:1
Nested Schema : dosings
Type:
arrayMinimum Number of Items:
0Calculated dosing definitions for the selected kit.
Show Source
-
Array of:
object Kits GET Kit Dosing v10.0
Title:
Kits GET Kit Dosing v10.0Calculated dosing definition returned by GET kits.
Nested Schema : Kits GET Kit Dosing v10.0
Type:
objectTitle:
Kits GET Kit Dosing v10.0Calculated dosing definition returned by GET kits.
Show Source
-
dose: object
Kits GET Dose Settings v10.0
Title:
Kits GET Dose Settings v10.0Dose calculation settings. -
id: string
(uuid)
Minimum Length:
32Maximum Length:32Dosing identifier. -
measurement: object
Kits GET Dosing Measurement v10.0
Title:
Kits GET Dosing Measurement v10.0Kit and subject measurements used for dose calculation. -
name: string
Minimum Length:
1Maximum Length:255Display name for the dosing definition.Example:Weight-based dose -
question: object
Kits GET Dosing Question v10.0
Title:
Kits GET Dosing Question v10.0Form question reference used by a dosing definition. -
visit: object
Kits GET Dosing Visit v10.0
Title:
Kits GET Dosing Visit v10.0Visit reference used by a dosing definition.
Nested Schema : Kits GET Dose Settings v10.0
Type:
objectTitle:
Kits GET Dose Settings v10.0Dose calculation settings.
Show Source
-
frequency: string
Minimum Length:
1Maximum Length:128Dosing frequency label.Example:Daily -
leftOverUnits: boolean
Whether leftover units are carried into the next dose.Example:
false -
precision: integer
(int32)
Minimum Value:
0Number of decimal places retained for the calculated dose.Example:1 -
roundUp: integer
(int32)
Minimum Value:
0Rounding direction flag for the calculated dose.Example:1
Nested Schema : Kits GET Dosing Measurement v10.0
Type:
objectTitle:
Kits GET Dosing Measurement v10.0Kit and subject measurements used for dose calculation.
Show Source
-
kit: object
Kits GET Value Units v10.0
Title:
Kits GET Value Units v10.0Value and unit pair used by dosing and kit unit settings. -
subject: object
Kits GET Value Units v10.0
Title:
Kits GET Value Units v10.0Value and unit pair used by dosing and kit unit settings.
Nested Schema : Kits GET Dosing Question v10.0
Type:
objectTitle:
Kits GET Dosing Question v10.0Form question reference used by a dosing definition.
Show Source
-
formId: string
(uuid)
Minimum Length:
32Maximum Length:32Form identifier. -
itemId: string
(uuid)
Minimum Length:
32Maximum Length:32Question identifier.
Nested Schema : Kits GET Dosing Visit v10.0
Type:
objectTitle:
Kits GET Dosing Visit v10.0Visit reference used by a dosing definition.
Show Source
-
id: string
(uuid)
Minimum Length:
32Maximum Length:32Visit identifier. -
type: string
Minimum Length:
1Maximum Length:64Allowed Values:[ "ScreeningVisit", "ScheduleAbleVisit", "SubjectWithdrawalVisit", "SubjectCompletionVisit", "UnScheduleAbleVisit", "Event", "AdverseEvent", "ScreenFailureVisit", "ReScreeningEvent" ]Visit type for the dosing source visit. Allowed values: ScreeningVisit, ScheduleAbleVisit, SubjectWithdrawalVisit, SubjectCompletionVisit, UnScheduleAbleVisit, Event, AdverseEvent, ScreenFailureVisit, ReScreeningEvent.Example:ScreeningVisit
Nested Schema : Kits GET Value Units v10.0
Type:
objectTitle:
Kits GET Value Units v10.0Value and unit pair used by dosing and kit unit settings.
Show Source
-
units: string
Minimum Length:
1Maximum Length:32Measurement units.Example:mg -
value: number
(double)
Minimum Value:
0Numeric value for the measurement.Example:10
Nested Schema : Kits GET Titration Exception v10.0
Type:
objectTitle:
Kits GET Titration Exception v10.0Titration exception returned by GET kits.
Show Source
-
endingDoseJson: object
Kits GET Titration Exception Items v10.0
Title:
Kits GET Titration Exception Items v10.0Collection of titration kit items used by an exception. -
exceptionType: string
Minimum Length:
1Maximum Length:32Allowed Values:[ "UP_EXCEPTION", "DOWN_EXCEPTION" ]Exception type. `UP_EXCEPTION` applies when moving to a higher dose and `DOWN_EXCEPTION` applies when moving to a lower dose.Example:UP_EXCEPTION -
id: string
(uuid)
Minimum Length:
32Maximum Length:32Exception identifier. -
kitId: string
(uuid)
Minimum Length:
32Maximum Length:32Identifier of the kit that owns the exception. -
minTimeBetweenDoseChanges: integer
(int64)
Minimum Value:
0Minimum time between dose changes for the exception.Example:2 -
minTimeBetweenDoseChangesUnit: string
Minimum Length:
1Maximum Length:16Allowed Values:[ "Days", "Hours" ]Minimum time-between-dose-changes unit for the exception. `Days` measures the interval in calendar days and `Hours` measures the interval in hours.Example:Days -
sequence: integer
(int64)
Minimum Value:
0Display order for the exception.Example:1 -
startingDoseJson: object
Kits GET Titration Exception Items v10.0
Title:
Kits GET Titration Exception Items v10.0Collection of titration kit items used by an exception.
Nested Schema : Kits GET Titration Exception Items v10.0
Type:
objectTitle:
Kits GET Titration Exception Items v10.0Collection of titration kit items used by an exception.
Show Source
-
titrationKitExceptionItems: array
titrationKitExceptionItems
Minimum Number of Items:
0Titration kit items used by the exception.
Example:
{
"titrationKitExceptionItems":[
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSeq":1,
"kitDosage":"QD",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]
}Nested Schema : titrationKitExceptionItems
Type:
arrayMinimum Number of Items:
0Titration kit items used by the exception.
Show Source
-
Array of:
object Kits GET Titration Kit Item v10.0
Title:
Kits GET Titration Kit Item v10.0Titration kit item returned by GET kits.
Example:
[
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSeq":1,
"kitDosage":"QD",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]Nested Schema : Kits GET Titration Kit Item v10.0
Type:
objectTitle:
Kits GET Titration Kit Item v10.0Titration kit item returned by GET kits.
Show Source
-
dosageId: string
(uuid)
Minimum Length:
32Maximum Length:32Dosage identifier for the kit. -
kitDosage: string
Minimum Length:
1Maximum Length:64Dosage label for the kit.Example:QD -
kitId: string
(uuid)
Minimum Length:
32Maximum Length:32Kit identifier. -
kitSeq: integer
(int64)
Minimum Value:
0Sequence of the kit inside the titration list.Example:1
Nested Schema : Kits GET Titration Group v10.0
Type:
objectTitle:
Kits GET Titration Group v10.0Titration group row returned by GET kits.
Show Source
-
downTitrationKitJson: object
Kits GET Titration Items v10.0
Title:
Kits GET Titration Items v10.0Collection of titration kit items. -
maintainTitrationKitJson: object
Kits GET Titration Items v10.0
Title:
Kits GET Titration Items v10.0Collection of titration kit items. -
rowId: string
(uuid)
Minimum Length:
32Maximum Length:32Titration row identifier. -
titrationKitId: string
(uuid)
Minimum Length:
32Maximum Length:32Current titration kit identifier. -
titrationKitJson: object
Kits GET Titration Items v10.0
Title:
Kits GET Titration Items v10.0Collection of titration kit items. -
titrationKitLabel: string
Minimum Length:
1Maximum Length:255Dose level label for the titration row.Example:Low Dose -
titrationKitSeq: integer
(int64)
Minimum Value:
0Sequence of the titration row inside the kit.Example:1 -
upTitrationKitJson: object
Kits GET Titration Items v10.0
Title:
Kits GET Titration Items v10.0Collection of titration kit items.
Nested Schema : Kits GET Titration Items v10.0
Type:
objectTitle:
Kits GET Titration Items v10.0Collection of titration kit items.
Show Source
-
titrationKitItems: array
titrationKitItems
Minimum Number of Items:
0Titration kit items in the current group.
Example:
{
"titrationKitItems":[
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSeq":1,
"kitDosage":"QD",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]
}Nested Schema : titrationKitItems
Type:
arrayMinimum Number of Items:
0Titration kit items in the current group.
Show Source
-
Array of:
object Kits GET Titration Kit Item v10.0
Title:
Kits GET Titration Kit Item v10.0Titration kit item returned by GET kits.
Example:
[
{
"kitId":"B1B8327AFAA6412287106192AB5984EF",
"kitSeq":1,
"kitDosage":"QD",
"dosageId":"D1B8327AFAA6412287106192AB5984EF"
}
]Nested Schema : DispensingErrorParamListV7
Type:
objectCollection of error parameters associated with a dispensation row.
Show Source
-
ErrorParam: array
ErrorParam
Error parameters associated with the row.
Nested Schema : ErrorParam
Type:
arrayError parameters associated with the row.
Show Source
-
Array of:
object DispensingErrorParamV7
Error parameter identifying a missing or invalid object reference.
Example:
[
{
"key":"A1B8327AFAA6412287106192AB5984EF",
"type":"Visit",
"id":"A1B8327AFAA6412287106192AB5984EF",
"name":"Week 1"
}
]Nested Schema : DispensingErrorParamV7
Type:
objectError parameter identifying a missing or invalid object reference.
Show Source
-
id: string
(uuid)
Minimum Length:
32Maximum Length:32Unique identifier of the referenced object. -
key: string
(uuid)
Minimum Length:
32Maximum Length:32Unique key for the missing or invalid object reference. -
name: string
Minimum Length:
1Maximum Length:64Display name of the referenced object.Example:Week 1 -
type: string
Minimum Length:
4Maximum Length:6Allowed Values:[ "Dosing", "Visit", "Form" ]Object type associated with the error. Allowed values: Dosing = missing dosing reference, Visit = missing visit reference, Form = missing form reference.Example:Visit
Nested Schema : DispensingTitrationKitV7
Type:
objectTitration kit summary associated with a dispensation row.
Show Source
-
kitid: string
(uuid)
Minimum Length:
32Maximum Length:32Titration kit unique identifier. -
kitQuantity: integer
(int64)
Minimum Value:
1Maximum Value:9999Quantity of kits dispensed for the titration entry. Allowed numeric range is 1 through 9999. Zero and negative values are not allowed.Example:1 -
kitTypeId: string
Minimum Length:
1Maximum Length:64Kit type identifier for the titration kit.Example:KIT_STD_001
Examples
500 Response
Returned when the service cannot retrieve dispensing visit definitions for the supplied study version and kitType filter because of an unexpected server-side failure.
Root Schema : ErrorResponseData
Type:
objectTitle:
ErrorResponseDataError Response Details Information
Show Source
-
details: object
Object
Title:
ObjectObject with error details information. -
errorCode: string
Error code which is stored in ErrorCode enum. Example : C1-003Example:
C1-003 -
errorMessage: string
Error message which is stored in service property file. Example : Cannot modify object after a study version has been approvedExample:
Cannot modify object after a study version has been approved
Nested Schema : Object
Type:
objectTitle:
ObjectObject with error details information.
Example:
{
"field":"studyId",
"reason":"Invalid value"
}Examples