Jump to

• Request
• Response

[Deprecated]: v11.0

post

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

Deprecated: Schedules a new visit in the study. This is a new version of the API for adding additional attribute groupingNumber for kits. Rights: OrsVisitManagementPost.

Request

Path Parameters

• mode(required): string
  Indicates the operational mode of the study. Accepted values: active, test, or training.

  Example:

  test

• studyId(required): string(uuid)
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example:

  B1B8327AFAA6412287106192AB5984EF

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : VisitRequest v7.0

Type: object

Title: VisitRequest v7.0

Request containing subject visit details.

Show Source

• AuthUserListDtoV1: array AuthUserListDtoV1
• instanceNumber: number (BigDecimal)
  Title: Instance Number

  Minimum Value: 1

  Visit instance number.

  Example: 2
• reusableKits: array Reusable Kits
  Title: Reusable Kits

  Unique Items Required: true

  IDs of kits that can be reused in the visit.
• siteId(required): string (uuid)
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.
• studyVersion(required): string
  String representing the version of the study. Helps track changes in form or study design.

  Example: 1.0.0.5
• subjectId(required): string
  Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: B1B8327AFAA6412287106192AB5984EF
• titrationOption: string
  Title: Titration Option

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

  Pattern: up|down|maintain

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

  Example: up
• userConfirmationTaken: boolean
  Title: User Confirmation Taken

  User confirmation for titration.

  Example: true
• visitId(required): string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit
• visitTimestamp: string
  Pattern: (\d){4}-(\d){2}-(\d){2} (\d){2}:(\d){2}:(\d){2}

  Visit date and time

  Example: 2018-11-23 08:43:01

{
    "title":"VisitRequest v7.0",
    "required":[
        "siteId",
        "studyVersion",
        "subjectId",
        "visitId"
    ],
    "type":"object",
    "properties":{
        "subjectId":{
            "type":"string",
            "description":"Unique identifier of the subject. Used to represent a participant enrolled in a study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "format":"uuid"
        },
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"1.0.0.5"
        },
        "visitTimestamp":{
            "pattern":"(\\d){4}-(\\d){2}-(\\d){2} (\\d){2}:(\\d){2}:(\\d){2}",
            "type":"string",
            "description":"Visit date and time",
            "example":"2018-11-23 08:43:01"
        },
        "AuthUserListDtoV1":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Parameter"
            }
        },
        "reusableKits":{
            "title":"Reusable Kits",
            "uniqueItems":true,
            "type":"array",
            "description":"IDs of kits that can be reused in the visit.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "titrationOption":{
            "title":"Titration Option",
            "pattern":"up|down|maintain",
            "type":"string",
            "description":"Titration options to dispense kits. For example: up/down/maintain.",
            "example":"up",
            "enum":[
                "up",
                "down",
                "maintain"
            ]
        },
        "userConfirmationTaken":{
            "title":"User Confirmation Taken",
            "type":"boolean",
            "description":"User confirmation for titration.",
            "example":true
        },
        "instanceNumber":{
            "title":"Instance Number",
            "minimum":1,
            "type":"number",
            "description":"Visit instance number.",
            "format":"BigDecimal",
            "example":2
        }
    },
    "description":"Request containing subject visit details."
}

Nested Schema : AuthUserListDtoV1

Type: array

Show Source

• Array of: object Parameter
  Contains details about parameters of the form

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

Nested Schema : Reusable Kits

Type: array

Title: Reusable Kits

Unique Items Required: true

IDs of kits that can be reused in the visit.

Show Source

• Array of: string(uuid)

{
    "title":"Reusable Kits",
    "uniqueItems":true,
    "type":"array",
    "description":"IDs of kits that can be reused in the visit.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : Parameter

Type: object

Contains details about parameters of the form

Show Source

• formId: string (uuid)
  Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
• itemId: string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.
• value: string (uuid)
  Value of the item

{
    "type":"object",
    "properties":{
        "formId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.",
            "format":"uuid"
        },
        "itemId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the question within a form. This ID corresponds to the reference code set by the study designer when creating or updating a form question in draft mode.",
            "format":"uuid"
        },
        "value":{
            "type":"string",
            "description":"Value of the item",
            "format":"uuid"
        }
    },
    "description":"Contains details about parameters of the form"
}

Examples

Select an example Visit Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : VisitResult v10.0

Type: object

Title: VisitResult v10.0

Visit result.

Show Source

• kits: array kits
• needsToVisitPharmacist: boolean
  Title: Needs To Visit Pharmacist

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

  Example: true
• 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 v10.0",
    "type":"object",
    "properties":{
        "randomNumber":{
            "title":"Random Number",
            "type":"string",
            "description":"Random number.",
            "example":"10"
        },
        "kits":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DispensationKitV9"
            }
        },
        "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
        }
    },
    "description":"Visit result."
}

Nested Schema : kits

Type: array

Show Source

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

  Contains information for the kit dispensation.

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

Nested Schema : DispensationKit v9.0

Type: object

Title: DispensationKit v9.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
• 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
• measurement: string
  Title: Measurement

  Dose Measurement.

  Example: ml
• 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 v9.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
        },
        "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"
            ]
        }
    },
    "description":"Contains information for the kit dispensation."
}

Examples

Select an example Visit Response

400 Response

Invalid visit timestamp OR You must associate the randomization design with a visit before you can create/upload a randomization list for it OR The next step in this visit isn???t allowed for subject because the study version at your site isn???t compatible with the subject OR Subject can't be Re-randomized before randomization OR This operation is not allowed in the current subject status

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

Examples

Select an example Bad Request

404 Response

Invalid study ID or version OR Rand List not found OR Design not found

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

Examples

Select an example Not Found

500 Response

Unsupported Visit OR Subject already completed the visit OR Subject is randomized in error OR Invalid treatment found for the subject OR Visit out of order OR This operation is not allowed in the current subject status OR Visit is outside visit window OR Visit is outside visit window and at least one kit is configured not to dispense outside visit window OR Not enough inventory.

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

Examples

Select an example Server Error

Back to Top