REST API for Clinical One Platform

Get visit by visit ID

get

/ec-ors-svc/rest/v17.0/studies/{studyId}/{mode}/visits/subjectvisit

This is a new version of the API which sends the dosing Instructions field in response for advanced dispensation kits.

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.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : VisitResult

Type: object

Show Source

countOfKitTypesOnDoseHold: integer (int32)

countOfKitTypesOnDoseHold.

Example: 1
kits: array kits
needsToVisitPharmacist: boolean

Unblinded pharmacist kit

Example: true
pendingKitQuantity: integer (int32)

pendingKitQuantity.

Example: 1
randomNumber: string

Random Number

Example: 10
treatmentTitle: string

Treatment Title

Example: A
visitTimestamp: string (date-time)

Visit Timestamp

{
    "type":"object",
    "properties":{
        "randomNumber":{
            "type":"string",
            "description":"Random Number",
            "example":"10"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/kits"
            }
        },
        "visitTimestamp":{
            "type":"string",
            "description":"Visit Timestamp",
            "format":"date-time"
        },
        "treatmentTitle":{
            "type":"string",
            "description":"Treatment Title",
            "example":"A"
        },
        "needsToVisitPharmacist":{
            "type":"boolean",
            "description":"Unblinded pharmacist kit",
            "example":true
        },
        "countOfKitTypesOnDoseHold":{
            "type":"integer",
            "description":"countOfKitTypesOnDoseHold.",
            "format":"int32",
            "example":1
        },
        "pendingKitQuantity":{
            "type":"integer",
            "description":"pendingKitQuantity.",
            "format":"int32",
            "example":1
        }
    }
}

Nested Schema : kits

Type: array

Show Source

Array of: object DispensationKit

Title: DispensationKit

Contains information for the kit dispensation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/kits"
    }
}

Nested Schema : DispensationKit

Type: object

Title: DispensationKit

Contains information for the kit dispensation

Show Source

barcode: string

Barcode for kit

Example: 1000
conserved: boolean

Conserved for dispensation

Example: true
consumeAcrossDoses: boolean

Indicate if consume across dosed allowed.

Example: true
deviceConnection: string

Allowed Values: [ "CloudtoCloud", "DevicetoCloud", "NoConnection" ]

Device Connection Type

Example: DevicetoCloud
deviceType: string

Allowed Values: [ "ActivityWatch", "BloodPressureMonitor", "WeightScale", "ECGReader", "Spirometer", "MobileApp", "SmartPillBottle", "PulseOximeter", "WearablePatch", "Other", "GlucoseMonitor" ]

Device Type

Example: ActivityWatch
dispensationConfirmed: string

Barcode confirmation while dispensing kit

Example: 1000
dose: number (double)

Dose.

Example: 5
dosingInstruction: string

Dosing Instruction

Example: Take one capsule daily
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 Id

Example: D313327EF13845169A8ADADDA435431E
kitDescription: string

Kit description

Example: Kit A
kitNumberUTF: string

Alpha-numeric KitNumber

Example: A-1
locallySourced: boolean

Kit is locally sourced

Example: true
lotId: string

Lot Id

Example: D313327EF13845169A8ADADDA435431E
lotNumber: string

Lot Number

Example: LOT20240605A
measurement: string

Dose Measurement.

Example: ml
quantity: number (double)

kit quantity.

Example: 5
titrationKitLabel: string

Titration Kit Label

Example: High dose
titrationOption: string

Allowed Values: [ "up", "down", "maintain" ]

Titration Option

Example: up
trialSupplyType: string

Trial Supply Type

Example: BOTTLE

{
    "title":"DispensationKit",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"Id of the dispensing kit.",
            "format":"Integer",
            "example":2
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description",
            "example":"Kit A"
        },
        "dose":{
            "type":"number",
            "description":"Dose.",
            "format":"double",
            "example":5
        },
        "measurement":{
            "type":"string",
            "description":"Dose Measurement.",
            "example":"ml"
        },
        "frequency":{
            "type":"string",
            "description":"Dosing frequency.",
            "example":"BID",
            "enum":[
                "Once",
                "QD",
                "BID",
                "TID",
                "QID",
                "Q3",
                "Q4",
                "Q8",
                "Q12",
                "Q24",
                "Bedtime",
                "With meals",
                "With meals and at bedtime"
            ]
        },
        "consumeAcrossDoses":{
            "type":"boolean",
            "description":"Indicate if consume across dosed allowed.",
            "example":true
        },
        "deviceType":{
            "type":"string",
            "description":"Device Type",
            "example":"ActivityWatch",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "type":"string",
            "description":"Device Connection Type",
            "example":"DevicetoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "inventoryId":{
            "type":"string",
            "description":"Inventory Id",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type",
            "example":"BOTTLE"
        },
        "conserved":{
            "type":"boolean",
            "description":"Conserved for dispensation",
            "example":true
        },
        "titrationKitLabel":{
            "type":"string",
            "description":"Titration Kit Label",
            "example":"High dose"
        },
        "barcode":{
            "type":"string",
            "description":"Barcode for kit",
            "example":"1000"
        },
        "dispensationConfirmed":{
            "type":"string",
            "description":"Barcode confirmation while dispensing kit",
            "example":"1000"
        },
        "groupingNumber":{
            "type":"integer",
            "description":"Grouping number for a kit.",
            "format":"int32",
            "example":1
        },
        "kitNumberUTF":{
            "type":"string",
            "description":"Alpha-numeric KitNumber",
            "example":"A-1"
        },
        "dosingUnblinded":{
            "type":"boolean",
            "description":"Indicate if unblinded or blinded.",
            "example":true
        },
        "titrationOption":{
            "type":"string",
            "description":"Titration Option",
            "example":"up",
            "enum":[
                "up",
                "down",
                "maintain"
            ]
        },
        "locallySourced":{
            "type":"boolean",
            "description":"Kit is locally sourced",
            "example":true
        },
        "quantity":{
            "type":"number",
            "description":"kit quantity.",
            "format":"double",
            "example":5
        },
        "lotId":{
            "type":"string",
            "description":"Lot Id",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "lotNumber":{
            "type":"string",
            "description":"Lot Number",
            "example":"LOT20240605A"
        },
        "dosingInstruction":{
            "type":"string",
            "description":"Dosing Instruction",
            "example":"Take one capsule daily"
        }
    },
    "description":"Contains information for the kit dispensation"
}

400 Response

Invalid subject

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result 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

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object

500 Response

Internal server error

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result

Result Object
status: string

Status of request

Example: Success
version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object

Result Object