Check if subject is eligible for titration
get
/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/titration-eligible
Checks if subject is eligible for titration. This is a new version of the API for returning additional attributes for titration kit label. Right: OrsSubjectVisitGet.
Request
Path Parameters
-
mode(required): string
Mode of the study, accepts: test, active, or training
-
studyId(required): string(uuid)
ID of the study
-
subjectId(required): string(uuid)
ID of the subject
Query Parameters
-
instanceNumber: string
Instance number for unscheduled visit.
-
studyVersion(required): string
Version of the study
-
visitId(required): string(uuid)
ID of the visit
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SubjectVisitKitTypeTO
Type:
Show Source
object
-
isDownAllowed(required): boolean
Is down titration allowedExample:
true
-
isUpAllowed(required): boolean
Is up titration allowedExample:
true
-
kitsDispensed(required): array
kitsDispensed
Id's of kits dispensed
-
status(required): string
Status of titration allowedExample:
ALLOW, COOL_DOWN_PERIOD, MAX_CHANGES_DONE, NOT_ALLOWED_ON_THE_VISIT
-
titrationId(required): string
(uuid)
ID of the titration
-
titrationKitLabel: string
Label of the matching titration rowExample:
Low Dose
Nested Schema : kitsDispensed
Type:
array
Id's of kits dispensed
Show Source
-
Array of:
string(uuid)
Id's of kits dispensed
400 Response
For a subject who cannot be titrated as there are no titration kits dispensed to the subject earlier OR Subject cannot be titrated as no matching kits are defined with subject dispensations. ORInvalid subject OR Missing subject OR Scheduled visit with instance number OR Unscheduled visit with no instance number
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
Visit 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
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