Jump to

• Request
• Response

v14.0

get

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

This is a new version of the API which sends the partial dispensation details in the new field pendingKitQuantity in response.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training.
• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

Query Parameters

• externalSubjectId(required): string
  Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
• instanceNumber: string
  Instance number for unscheduled visit.
• visitId(required): string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : VisitResult

Type: object

Title: VisitResult

Visit result.

Show Source

• countOfKitTypesOnDoseHold: integer (int32)
  Title: Count Of Kit Types On Dose Hold

  Number of kit types on dose hold.

  Example: 1
• forcedRandomized: boolean
  Title: Forced Randomized

  Indicates whether the subject was forced randomized.

  Example: true
• kits: array Kits
  Title: Kits

  Contains information for the kit dispensation.
• needsToVisitPharmacist: boolean
  Title: Needs To Visit Pharmacist

  Indicates whether the subject needs to visit an unblinded pharmacist for kit dispensation.

  Example: true
• pendingKitQuantity: integer (int32)
  Title: Pending Kit Quantity

  Number of kits pending dispensation.

  Example: 1
• randomNumber: string
  Title: Random Number

  Random number.

  Example: 10
• treatmentTitle: string
  Title: Treatment Title

  Treatment title.

  Example: A
• visitTimestamp: string (date-time)
  Title: Visit Timestamp

  Visit timestamp.

{
    "title":"VisitResult",
    "type":"object",
    "properties":{
        "randomNumber":{
            "title":"Random Number",
            "type":"string",
            "description":"Random number.",
            "example":"10"
        },
        "kits":{
            "title":"Kits",
            "type":"array",
            "description":"Contains information for the kit dispensation.",
            "items":{
                "$ref":"#/components/schemas/DispensationKit"
            }
        },
        "visitTimestamp":{
            "title":"Visit Timestamp",
            "type":"string",
            "description":"Visit timestamp.",
            "format":"date-time"
        },
        "treatmentTitle":{
            "title":"Treatment Title",
            "type":"string",
            "description":"Treatment title.",
            "example":"A"
        },
        "needsToVisitPharmacist":{
            "title":"Needs To Visit Pharmacist",
            "type":"boolean",
            "description":"Indicates whether the subject needs to visit an unblinded pharmacist for kit dispensation.",
            "example":true
        },
        "countOfKitTypesOnDoseHold":{
            "title":"Count Of Kit Types On Dose Hold",
            "type":"integer",
            "description":"Number of kit types on dose hold.",
            "format":"int32",
            "example":1
        },
        "pendingKitQuantity":{
            "title":"Pending Kit Quantity",
            "type":"integer",
            "description":"Number of kits pending dispensation.",
            "format":"int32",
            "example":1
        },
        "forcedRandomized":{
            "title":"Forced Randomized",
            "type":"boolean",
            "description":"Indicates whether the subject was forced randomized.",
            "example":true
        }
    },
    "description":"Visit result."
}

Nested Schema : Kits

Type: array

Title: Kits

Contains information for the kit dispensation.

Show Source

• Array of: object DispensationKit v13.0
  Title: DispensationKit v13.0

  Contains information for the kit dispensation.

{
    "title":"Kits",
    "type":"array",
    "description":"Contains information for the kit dispensation.",
    "items":{
        "$ref":"#/components/schemas/DispensationKit"
    }
}

Nested Schema : DispensationKit v13.0

Type: object

Title: DispensationKit v13.0

Contains information for the kit dispensation.

Show Source

• barcode: string
  Barcode.

  Example: 1000
• conserved: boolean
  Title: Conserved

  Conserved for dispensation.

  Example: true
• consumeAcrossDoses: boolean
  Title: Consume Across Doses

  Indicates whether consumption across doses is allowed.

  Example: true
• deviceConnection: string
  Title: Device Connection Type

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

  Device connection type.

  Example: DevicetoCloud
• deviceType: string
  Title: Device Type

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

  Device type.

  Example: ActivityWatch
• dispensationConfirmed: boolean
  Indicates whether dispensation is confirmed.

  Example: true
• dose: number (double)
  Title: Dose

  Dose.

  Example: 5
• dosingInstruction: string
  Title: Dosing Instruction

  Dosing instruction.

  Example: Take one capsule daily
• dosingUnblinded: boolean
  Title: Dosing Unblinded

  Indicates whether dosing is unblinded.

  Example: true
• frequency: string
  Title: Frequency

  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)
  Title: Grouping Number

  Grouping number for a kit.

  Example: 1
• id: number (Integer)
  Title: Dispensation Kit ID

  Unique identifier of the dispensation kit.

  Example: 2
• inventoryId: string
  Title: Inventory ID

  Inventory ID.

  Example: D313327EF13845169A8ADADDA435431E
• kitDescription: string
  Title: Kit Description

  Kit description.

  Example: Kit A
• kitNumberUTF: string
  Title: Kit Number UTF

  Kit number with UTF-8 support.

  Example: A-1
• locallySourced: boolean
  Title: Locally Sourced

  Indicates whether the kit is locally sourced.

  Example: true
• lotId: string
  Title: Lot ID

  Lot ID.

  Example: D313327EF13845169A8ADADDA435431E
• lotNumber: string
  Title: Lot Number

  Lot number.

  Example: LOT20240605A
• measurement: string
  Title: Measurement

  Dose Measurement.

  Example: ml
• quantity: number (BigDecimal)
  Title: Quantity

  Kit quantity.

  Example: 5
• titrationKitLabel: string
  Title: Blinded Titration Label

  Blinded titration label.

  Example: High dose
• titrationOption: string
  Title: Titration Option

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

  Titration options to dispense kits. For example: up/down/maintain.

  Example: up
• trialSupplyType: string
  Title: Trial Supply Type

  Type of the trial supply.

  Example: BOTTLE

{
    "title":"DispensationKit v13.0",
    "type":"object",
    "properties":{
        "id":{
            "title":"Dispensation Kit ID",
            "type":"number",
            "description":"Unique identifier of the dispensation kit.",
            "format":"Integer",
            "example":2
        },
        "kitDescription":{
            "title":"Kit Description",
            "type":"string",
            "description":"Kit description.",
            "example":"Kit A"
        },
        "dose":{
            "title":"Dose",
            "type":"number",
            "description":"Dose.",
            "format":"double",
            "example":5
        },
        "measurement":{
            "title":"Measurement",
            "type":"string",
            "description":"Dose Measurement.",
            "example":"ml"
        },
        "frequency":{
            "title":"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":{
            "title":"Consume Across Doses",
            "type":"boolean",
            "description":"Indicates whether consumption across doses is allowed.",
            "example":true
        },
        "deviceType":{
            "title":"Device Type",
            "type":"string",
            "description":"Device type.",
            "example":"ActivityWatch",
            "enum":[
                "ActivityWatch",
                "BloodPressureMonitor",
                "WeightScale",
                "ECGReader",
                "Spirometer",
                "MobileApp",
                "SmartPillBottle",
                "PulseOximeter",
                "WearablePatch",
                "Other",
                "GlucoseMonitor"
            ]
        },
        "deviceConnection":{
            "title":"Device Connection Type",
            "type":"string",
            "description":"Device connection type.",
            "example":"DevicetoCloud",
            "enum":[
                "CloudtoCloud",
                "DevicetoCloud",
                "NoConnection"
            ]
        },
        "inventoryId":{
            "title":"Inventory ID",
            "type":"string",
            "description":"Inventory ID.",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "trialSupplyType":{
            "title":"Trial Supply Type",
            "type":"string",
            "description":"Type of the trial supply.",
            "example":"BOTTLE"
        },
        "conserved":{
            "title":"Conserved",
            "type":"boolean",
            "description":"Conserved for dispensation.",
            "example":true
        },
        "titrationKitLabel":{
            "title":"Blinded Titration Label",
            "type":"string",
            "description":"Blinded titration label.",
            "example":"High dose"
        },
        "barcode":{
            "type":"string",
            "description":"Barcode.",
            "example":"1000"
        },
        "dispensationConfirmed":{
            "type":"boolean",
            "description":"Indicates whether dispensation is confirmed.",
            "example":true
        },
        "groupingNumber":{
            "title":"Grouping Number",
            "type":"integer",
            "description":"Grouping number for a kit.",
            "format":"int32",
            "example":1
        },
        "kitNumberUTF":{
            "title":"Kit Number UTF",
            "type":"string",
            "description":"Kit number with UTF-8 support.",
            "example":"A-1"
        },
        "dosingUnblinded":{
            "title":"Dosing Unblinded",
            "type":"boolean",
            "description":"Indicates whether dosing is unblinded.",
            "example":true
        },
        "titrationOption":{
            "title":"Titration Option",
            "type":"string",
            "description":"Titration options to dispense kits. For example: up/down/maintain.",
            "example":"up",
            "enum":[
                "up",
                "down",
                "maintain"
            ]
        },
        "locallySourced":{
            "title":"Locally Sourced",
            "type":"boolean",
            "description":"Indicates whether the kit is locally sourced.",
            "example":true
        },
        "quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Kit quantity.",
            "format":"BigDecimal",
            "example":5
        },
        "lotId":{
            "title":"Lot ID",
            "type":"string",
            "description":"Lot ID.",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "lotNumber":{
            "title":"Lot Number",
            "type":"string",
            "description":"Lot number.",
            "example":"LOT20240605A"
        },
        "dosingInstruction":{
            "title":"Dosing Instruction",
            "type":"string",
            "description":"Dosing instruction.",
            "example":"Take one capsule daily"
        }
    },
    "description":"Contains information for the kit dispensation."
}

400 Response

Invalid subject

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

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.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• 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

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

Result Object

Nested Schema : details

Type: object

Back to Top