[Deprecated]: Get visit by visit ID
get
/ec-ors-svc/rest/v7.0/studies/{studyId}/{mode}/visits/subjectvisit
Deprecated: Use latest version instead. Retrieves visit by visit ID. This is a new version of the API for adding additional attribute conserved, for partial dispensation. Rights: OrsSubjectVisitGet.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
Query Parameters
-
externalSubjectId(required): string
ID of the subject
-
instanceNumber: string
Instance number for unscheduled visit.
-
visitId(required): string
ID of the visit
There's no request body for this operation.
Back to TopResponse
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 subject
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 Visit for subject does not exist.
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
Internal server 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