Randomize subject or dispense kit during visit
post
/ec-ors-svc/rest/v16.0/studies/{studyId}/{mode}/visits/subjectvisit
Randomize a subject and/or dispense kits during a randomization or dispensation visit. This version of the API enables to return locallySourced and quantity field in response to support local sourcing.
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 : VisitRequest v10.0
Type:
object
Title:
VisitRequest v10.0
Visit Request.
Show Source
-
instanceNumber: number
(BigDecimal)
Minimum Value:
1
Instance number of the unscheduled visitExample:2
-
kitTypesForDoseHold: array
kitTypesForDoseHold
-
kitTypesForResumeDispensation: array
kitTypesForResumeDispensation
-
parameters: array
parameters
-
resumePartialDispensation: boolean
Title:
resumePartialDispensation
Resume partial dispensationExample:false
-
reusableKits: array
reusableKits
Unique Items Required:
true
-
siteId(required): string
(uuid)
ID of the site
-
studyVersion(required): string
Version of the studyExample:
1.0.0.5
-
subjectId(required): string
ID of the subjectExample:
B1B8327AFAA6412287106192AB5984EF
-
titrationOption: string
Allowed Values:
[ "up", "down", "maintain" ]
Pattern:up|down|maintain
Titration OptionExample:up
-
userConfirmationTaken: boolean
User confirmation for titration.Example:
true
-
visitId(required): string
(uuid)
ID of the visit
-
visitTimestamp: string
Pattern:
(\d){4}-(\d){2}-(\d){2} (\d){2}:(\d){2}:(\d){2}
Visit date and timeExample:2018-11-23 08:43:01
Nested Schema : parameters
Type:
Show Source
array
-
Array of:
object Parameter
Contains details about parameters of the form
Nested Schema : reusableKits
Type:
array
Unique Items Required:
Show Source
true
-
Array of:
string(uuid)
ID of the kit
Nested Schema : kitTypesForDoseHold
Type:
Show Source
object
-
deviceType: string
deviceTypeExample:
Scale
-
isTitration: boolean
isTitration
-
isUnblindedPharmacist: boolean
-
kitTypeSrcId: string
(uuid)
kitTypeSrcId of the kit
-
trialSupplyType: string
trialSupplyTypeExample:
BOTTLE
Nested Schema : kitTypesForResumeDispensation
Type:
Show Source
object
-
deviceType: string
deviceTypeExample:
Scale
-
isTitration: boolean
isTitration
-
isUnblindedPharmacist: boolean
-
kitTypeSrcId: string
(uuid)
kitTypeSrcId of the kit
-
trialSupplyType: string
trialSupplyTypeExample:
BOTTLE
Nested Schema : Parameter
Type:
object
Contains details about parameters of the form
Show Source
-
formId: string
(uuid)
ID of the form
-
itemId: string
(uuid)
ID of the item
-
value: string
(uuid)
Value of the item
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : VisitResult
Type:
Show Source
object
-
countOfKitTypesOnDoseHold: integer
(int32)
countOfKitTypesOnDoseHold.Example:
1
-
kits: array
kits
-
needsToVisitPharmacist: boolean
Unblinded pharmacist kitExample:
true
-
pendingKitQuantity: integer
(int32)
pendingKitQuantity.Example:
1
-
randomNumber: string
Random NumberExample:
10
-
treatmentTitle: string
Treatment TitleExample:
A
-
visitTimestamp: string
(date-time)
Visit Timestamp
Nested Schema : kits
Type:
Show Source
array
-
Array of:
object DispensationKit
Title:
DispensationKit
Contains information for the kit dispensation
Nested Schema : DispensationKit
Type:
object
Title:
DispensationKit
Contains information for the kit dispensation
Show Source
-
barcode: string
Barcode for kitExample:
1000
-
conserved: boolean
Conserved for dispensationExample:
true
-
consumeAcrossDoses: boolean
Indicate if consume across dosed allowed.Example:
true
-
deviceConnection: string
Allowed Values:
[ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]
Device Connection TypeExample:DevicetoCloud
-
deviceType: string
Allowed Values:
[ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]
Device TypeExample:ActivityWatch
-
dispensationConfirmed: string
Barcode confirmation while dispensing kitExample:
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 IdExample:
D313327EF13845169A8ADADDA435431E
-
kitDescription: string
Kit descriptionExample:
Kit A
-
kitNumberUTF: string
Alpha-numeric KitNumberExample:
A-1
-
locallySourced: boolean
Kit is locally sourcedExample:
true
-
measurement: string
Dose Measurement.Example:
ml
-
quantity: number
(double)
kit quantity.Example:
5
-
titrationKitLabel: string
Titration Kit LabelExample:
High dose
-
titrationOption: string
Allowed Values:
[ "up", "down", "maintain" ]
Titration OptionExample:up
-
trialSupplyType: string
Trial Supply TypeExample:
BOTTLE
400 Response
Invalid visit timestamp OR You must associate the randomization design with a visit before you can create/upload a randomization list for it OR The next step in this visit isn???t allowed for subject because the study version at your site isn???t compatible with the subject OR Subject can't be Re-randomized before randomization OR This operation is not allowed in the current subject status
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
404 Response
Invalid study ID or version OR Rand List not found OR Design not found
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object
500 Response
Unsupported Visit OR Subject already completed the visit OR Subject is randomized in error OR Invalid treatment found for the subject OR Visit out of order OR This operation is not allowed in the current subject status OR Visit is outside visit window OR Visit is outside visit window and at least one kit is configured not to dispense outside visit window OR Not enough inventory.
Root Schema : ORSResponse
Type:
object
Common response object.
Show Source
-
errorData: object
ErrorResponseData
-
result: object
result
Result Object
-
status: string
Status of requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object