Jump to

• Request
• Response

v3.0

get

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

Get kits allowed for dose hold in the current visit for a given subject, taking into account ADs. 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

• instanceNumber: number
  Instance number for unscheduled visit.

  Example:

  1

• screeningDate: string
  Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

  Screening date and time in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.

  Example:

  2026-03-01T00:00:00.000Z

• studyVersion(required): string
  String representing the version of the study. Helps track changes in form or study design.

  Example:

  1

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

• visitStartDate: string
  Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

  Visit start date and time in yyyy-MM-dd'T'HH:mm:ss.SSS'Z' format.

  Example:

  2026-03-01T00:00:00.000Z

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Dose Hold Kits Response

Type: object

Title: Dose Hold Kits Response

Contains information about kits allowed or not allowed for dose hold.

Show Source

• kitsAllowedForDoseHold: array kitsAllowedForDoseHold
• kitsNotAllowedForDoseHold: array kitsNotAllowedForDoseHold
• status(required): string
  Title: Dose Hold Status

  Allowed Values: [ "ALLOW_DOSE_HOLD", "DOSE_HELD", "DISPENSED_AND_DOSE_HELD", "DISPENSED", "DOSE_HOLD_SETTINGS_OFF", "DOSE_HOLD_NOT_ALLOWED_ON_RAND_VISIT", "DOSE_HOLD_NOT_ALLOWED_ON_ANY_KITS" ]

  Indicates whether dose hold is allowed.

  Example: ALLOW_DOSE_HOLD

{
    "title":"Dose Hold Kits Response",
    "required":[
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "title":"Dose Hold Status",
            "type":"string",
            "description":"Indicates whether dose hold is allowed.",
            "example":"ALLOW_DOSE_HOLD",
            "enum":[
                "ALLOW_DOSE_HOLD",
                "DOSE_HELD",
                "DISPENSED_AND_DOSE_HELD",
                "DISPENSED",
                "DOSE_HOLD_SETTINGS_OFF",
                "DOSE_HOLD_NOT_ALLOWED_ON_RAND_VISIT",
                "DOSE_HOLD_NOT_ALLOWED_ON_ANY_KITS"
            ]
        },
        "kitsAllowedForDoseHold":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DoseHoldKit"
            }
        },
        "kitsNotAllowedForDoseHold":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DoseHoldKit"
            }
        }
    },
    "description":"Contains information about kits allowed or not allowed for dose hold."
}

Nested Schema : kitsAllowedForDoseHold

Type: array

Show Source

• Array of: object DoseHoldKit
  Title: DoseHoldKit

  Response containing dose hold kit details.

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

Nested Schema : kitsNotAllowedForDoseHold

Type: array

Show Source

• Array of: object DoseHoldKit
  Title: DoseHoldKit

  Response containing dose hold kit details.

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

Nested Schema : DoseHoldKit

Type: object

Title: DoseHoldKit

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
• isTitration: boolean
  Title: Titration

  Indicates whether the current medication is a titration.

  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
• trialSupplyType: string
  Title: Trial Supply Type

  Type of the trial supply.

  Example: BOTTLE

{
    "title":"DoseHoldKit",
    "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"
        }
    },
    "description":"Response containing dose hold kit details.",
    "example":{
        "kitId":"C1C8327AFAA6412287106192AB5984EF",
        "kitNumber":"KIT-000456"
    }
}

Example:

{
    "kitId":"C1C8327AFAA6412287106192AB5984EF",
    "kitNumber":"KIT-000456"
}

Examples

Select an example Allowed Dose Holds 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 Allowed Dose Holds 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 Allowed Dose Holds Server Error Response

Back to Top