Jump to

• Request
• Response

v3.0

get

/ec-ors-svc/rest/v3.0/studies/{studyId}/{mode}/subjects/{subjectId}/doseheld

Get kits which are marked as dose hold for a given search criteria. Rights: OrsSubjectVisitGet.

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:

  1BC29B36F5D64B1B95F4BDBBCEA481BE

• subjectId(required): string(uuid)
  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:

  C36A3197FDEE433FB5547EE83DE99E4B

Query Parameters

• asofdate: string
  Get data as of the given date

  Example:

  2026-03-01

• instanceNumber: number
  Instance number for unscheduled visit.

  Example:

  1

• visitId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit

  Example:

  B1B8327AFAA6412287106192AB5984EF

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : DoseHoldKit v3.0

Type: object

Title: DoseHoldKit v3.0

Response containing dose hold kit details.

Show Source

• blindedTItrationLabel: string
  Title: Blinded Titration Label

  Blinded titration label.

  Example: Low dose
• deviceType: string
  Title: Device Type

  Device type.

  Example: ActivityWatch
• instanceNumber: number
  Title: Instance Number

  Visit instance number.

  Example: 1
• isTitration: boolean
  Title: Titration

  Indicates whether the current medication is a titration.

  Example: true
• isUnblindedPharmacist: boolean
  Title: Treatment Assignment Visibility

  Indicates whether treatment assignment information may be visible to study personnel. It should not be visible to study personnel and must be accessible only to an unblinded pharmacist.

  Example: true
• kitDescription: string
  Title: Kit Description

  Kit description.

  Example: Kit A
• kitTypeSrcId: string
  Title: Kit Type Source ID

  Kit type ID.

  Example: D313327EF13845169A8ADADDA435431E
• reason: string
  Title: Reason

  Reason for kits not allowed for dose hold.

  Example: DOSE_HOLD_VISIT_NOT_STARTED
• transactionDate: string (date-time)
  Title: Visit Timestamp

  Visit timestamp.

  Example: 2017-09-26T15:40:14.357Z
• trialSupplyType: string
  Title: Trial Supply Type

  Type of the trial supply.

  Example: BOTTLE
• userId: string (uuid)
  Title: User ID

  User ID.
• visitId: string (uuid)
  Title: Visit ID

  Visit ID.

{
    "title":"DoseHoldKit v3.0",
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "example":"D313327EF13845169A8ADADDA435431E"
        },
        "kitDescription":{
            "title":"Kit Description",
            "type":"string",
            "description":"Kit description.",
            "example":"Kit A"
        },
        "trialSupplyType":{
            "title":"Trial Supply Type",
            "type":"string",
            "description":"Type of the trial supply.",
            "example":"BOTTLE"
        },
        "deviceType":{
            "title":"Device Type",
            "type":"string",
            "description":"Device type.",
            "example":"ActivityWatch"
        },
        "blindedTItrationLabel":{
            "title":"Blinded Titration Label",
            "type":"string",
            "description":"Blinded titration label.",
            "example":"Low dose"
        },
        "isTitration":{
            "title":"Titration",
            "type":"boolean",
            "description":"Indicates whether the current medication is a titration.",
            "example":true
        },
        "reason":{
            "title":"Reason",
            "type":"string",
            "description":"Reason for kits not allowed for dose hold.",
            "example":"DOSE_HOLD_VISIT_NOT_STARTED"
        },
        "isUnblindedPharmacist":{
            "title":"Treatment Assignment Visibility",
            "type":"boolean",
            "description":"Indicates whether treatment assignment information may be visible to study personnel. It should not be visible to study personnel and must be accessible only to an unblinded pharmacist.",
            "example":true
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"User ID.",
            "format":"uuid"
        },
        "instanceNumber":{
            "title":"Instance Number",
            "type":"number",
            "description":"Visit instance number.",
            "example":1
        },
        "transactionDate":{
            "title":"Visit Timestamp",
            "type":"string",
            "description":"Visit timestamp.",
            "format":"date-time",
            "example":"2017-09-26T15:40:14.357Z"
        },
        "visitId":{
            "title":"Visit ID",
            "type":"string",
            "description":"Visit ID.",
            "format":"uuid"
        }
    },
    "description":"Response containing dose hold kit details."
}

Examples

Select an example Dose Held Kits Response

400 Response

Invalid subject OR Scheduled visit with instance number OR Unscheduled visit with no instance number

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 Dose Held Kits Bad Request Response

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

Examples

Select an example Dose Held Kits Server Error Response

Back to Top