[Deprecated]: Get dispensation history
get
/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{externalSubjectId}/dispensation-history
Deprecated: Use latest version instead. Retrieves dispensation history by study ID. Rights: OrsSubjectVisitGet.
Request
Path Parameters
-
externalSubjectId(required): string(uuid)
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
Query Parameters
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 DispensationHistoryResponse v4.0
Title:
DispensationHistoryResponse v4.0
Response object containing Dispensation History.
Nested Schema : DispensationHistoryResponse v4.0
Type:
object
Title:
DispensationHistoryResponse v4.0
Response object containing Dispensation History.
Show Source
-
balanceUnits: number
(double)
Balance Units of KitExample:
1
-
deviceConnection: string
Allowed Values:
[ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]
Indicates device connection in case of device kitExample:DevicetoCloud
-
deviceType: string
Allowed Values:
[ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]
Indicates type of device in case of device kitExample:WearablePatch
-
dispensationDate: string
(date-time)
Dispensation date
-
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
-
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
-
kitDescription: string
Kit Type DescriptionExample:
Kit A
-
kitNumber: number
(double)
Kit nuumber.Example:
5
-
lastModifiedDate: string
(date-time)
Last modified date
-
measurement: string
Dose Measurement.Example:
ml
-
mHealthDeviceId: string
mHealth Device IdExample:
B1B8327AFAA6412287106192AB5984EF
-
missingUnits: number
(double)
Missing Units of KitExample:
1
-
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 KitExample:
1
-
siteId: string
(uuid)
ID of the site
-
trialSupplyType: string
Trial Supply Type for the kitExample:
BOTTLE
-
unitsPerKit: number
(double)
Units per KitExample:
1
-
visitId: string
(uuid)
ID of the visit
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 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 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 requestExample:
Success
-
version: integer
(int32)
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 requestExample:
Success
-
version: integer
(int32)
Nested Schema : result
Type:
object
Result Object
Nested Schema : details
Type:
object