Jump to

• Request
• Response

v4.0

post

/ec-ors-svc/rest/v4.0/studies/{studyId}/{mode}/subjects/{subjectId}/reuse-kits

Retrieves previously dispensed kits, from a list of kit types passed in the request body, that can be reused in the current visit for a given subject. Support for unblinded pharmacist kits which are put on dose hold. UTF-8 format support for kitNumber. 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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Visit Dose Hold Request

Type: object

Title: Visit Dose Hold Request

Request containing dose hold parameters for a visit.

Show Source

• instanceNumber: number (BigDecimal)
  Minimum Value: 1

  Instance number of the unscheduled visit

  Example: 2
• kitTypesForDoseHold: array kitTypesForDoseHold
  Kit Types For DoseHold
• screeningDate: string (date-time)
  Screening date.
• studyVersion(required): string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: 1.0.0.5
• titrationOption: string
  Allowed Values: [ "up", "down", "maintain" ]

  Pattern: up|down|maintain

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

  Example: up
• visitId(required): string (uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit
• visitStartDate: string (date-time)
  Visit start date.

{
    "title":"Visit Dose Hold Request",
    "required":[
        "studyVersion",
        "visitId"
    ],
    "type":"object",
    "properties":{
        "studyVersion":{
            "type":"string",
            "description":"Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"1.0.0.5"
        },
        "visitId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the visit",
            "format":"uuid"
        },
        "instanceNumber":{
            "minimum":1,
            "type":"number",
            "description":"Instance number of the unscheduled visit",
            "format":"BigDecimal",
            "example":2
        },
        "titrationOption":{
            "pattern":"up|down|maintain",
            "type":"string",
            "description":"Titration options to dispense kits. For example: up/down/maintain.",
            "example":"up",
            "enum":[
                "up",
                "down",
                "maintain"
            ]
        },
        "kitTypesForDoseHold":{
            "type":"array",
            "description":"Kit Types For DoseHold",
            "example":[
                {
                    "kitTypeSrcId":"C36A3197FDEE433FB5547EE83DE99E4B",
                    "trialSupplyType":"BOTTLE",
                    "deviceType":"Spirometer",
                    "isTitration":true
                }
            ],
            "items":{
                "$ref":"#/components/schemas/DoseHoldRequestV1"
            }
        },
        "screeningDate":{
            "type":"string",
            "description":"Screening date.",
            "format":"date-time"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date.",
            "format":"date-time"
        }
    },
    "description":"Request containing dose hold parameters for a visit."
}

Nested Schema : kitTypesForDoseHold

Type: array

Kit Types For DoseHold

Show Source

• Array of: object Dose Hold Request
  Title: Dose Hold Request

  Request containing dose hold settings.

{
    "type":"array",
    "description":"Kit Types For DoseHold",
    "example":[
        {
            "kitTypeSrcId":"C36A3197FDEE433FB5547EE83DE99E4B",
            "trialSupplyType":"BOTTLE",
            "deviceType":"Spirometer",
            "isTitration":true
        }
    ],
    "items":{
        "$ref":"#/components/schemas/DoseHoldRequestV1"
    }
}

Example:

[
    {
        "kitTypeSrcId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "trialSupplyType":"BOTTLE",
        "deviceType":"Spirometer",
        "isTitration":true
    }
]

Nested Schema : Dose Hold Request

Type: object

Title: Dose Hold Request

Request containing dose hold settings.

Show Source

• deviceType: string
  Title: Device Type

  Device type.

  Example: Spirometer
• isTitration: boolean
  Title: Titration

  Indicates whether the current medication is a titration.

  Example: true
• kitTypeSrcId: string (uuid)
  Title: Kit Type Source ID

  Kit type ID.
• trialSupplyType: string
  Title: Trial Supply Type

  Type of the trial supply.

  Example: BOTTLE

{
    "title":"Dose Hold Request",
    "type":"object",
    "properties":{
        "kitTypeSrcId":{
            "title":"Kit Type Source ID",
            "type":"string",
            "description":"Kit type ID.",
            "format":"uuid"
        },
        "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":"Spirometer"
        },
        "isTitration":{
            "title":"Titration",
            "type":"boolean",
            "description":"Indicates whether the current medication is a titration.",
            "example":true
        }
    },
    "description":"Request containing dose hold settings.",
    "example":{
        "kitTypeSrcId":"C36A3197FDEE433FB5547EE83DE99E4B",
        "trialSupplyType":"BOTTLE",
        "deviceType":"Spirometer",
        "isTitration":true
    }
}

Example:

{
    "kitTypeSrcId":"C36A3197FDEE433FB5547EE83DE99E4B",
    "trialSupplyType":"BOTTLE",
    "deviceType":"Spirometer",
    "isTitration":true
}

Examples

Select an example Reusable Kits Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Reusable Kits Response

Type: object

Title: Reusable Kits Response

Contains details of reusable kits.

Show Source

• kits: array ReusableKit
  Title: ReusableKit

  Contains information for the reusable kits.
• status(required): string
  Allowed Values: [ "ALLOW", "REUSE_NOT_ALLOWED" ]

  Indicates whether reuse is allowed.

  Example: ALLOW

{
    "title":"Reusable Kits Response",
    "required":[
        "status"
    ],
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Indicates whether reuse is allowed.",
            "example":"ALLOW",
            "enum":[
                "ALLOW",
                "REUSE_NOT_ALLOWED"
            ]
        },
        "kits":{
            "title":"ReusableKit",
            "type":"array",
            "description":"Contains information for the reusable kits.",
            "example":[
                {
                    "id":2,
                    "inventoryId":"D313327EF13845169A8ADADDA435431E",
                    "trialSupplyType":"BOTTLE",
                    "isDosingUnblinded":true,
                    "dose":5,
                    "measurement":"ml",
                    "frequency":"BID",
                    "kitDescription":"Kit A"
                }
            ],
            "items":{
                "$ref":"#/components/schemas/ReusableKit"
            }
        }
    },
    "description":"Contains details of reusable kits."
}

Nested Schema : ReusableKit

Type: array

Title: ReusableKit

Contains information for the reusable kits.

Show Source

• Array of: object ReusableKit
  Title: ReusableKit

  Response containing reusable kit details.

{
    "title":"ReusableKit",
    "type":"array",
    "description":"Contains information for the reusable kits.",
    "example":[
        {
            "id":2,
            "inventoryId":"D313327EF13845169A8ADADDA435431E",
            "trialSupplyType":"BOTTLE",
            "isDosingUnblinded":true,
            "dose":5,
            "measurement":"ml",
            "frequency":"BID",
            "kitDescription":"Kit A"
        }
    ],
    "items":{
        "$ref":"#/components/schemas/ReusableKit"
    }
}

Example:

[
    {
        "id":2,
        "inventoryId":"D313327EF13845169A8ADADDA435431E",
        "trialSupplyType":"BOTTLE",
        "isDosingUnblinded":true,
        "dose":5,
        "measurement":"ml",
        "frequency":"BID",
        "kitDescription":"Kit A"
    }
]

Nested Schema : ReusableKit

Type: object

Title: ReusableKit

Response containing reusable kit details.

Show Source

• consumeAcrossDoses: boolean
  Indicate if consume across dosed allowed.

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

  Example: 5
• 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
• id: number (Integer)
  Id of the reusable kit.

  Example: 2
• inventoryId: string (uuid)
  ID of the inventory.
• kitDescription: string
  Kit description.

  Example: Kit A
• measurement: string
  Dose Measurement.

  Example: ml
• trialSupplyType: string
  Trial Supply Type

  Example: BOTTLE

{
    "title":"ReusableKit",
    "type":"object",
    "properties":{
        "id":{
            "type":"number",
            "description":"Id of the reusable kit.",
            "format":"Integer",
            "example":2
        },
        "inventoryId":{
            "type":"string",
            "description":"ID of the inventory.",
            "format":"uuid"
        },
        "trialSupplyType":{
            "type":"string",
            "description":"Trial Supply Type",
            "example":"BOTTLE"
        },
        "consumeAcrossDoses":{
            "type":"boolean",
            "description":"Indicate if consume across dosed allowed.",
            "example":true
        },
        "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"
            ]
        },
        "kitDescription":{
            "type":"string",
            "description":"Kit description.",
            "example":"Kit A"
        }
    },
    "description":"Response containing reusable kit details.",
    "example":{
        "id":2,
        "inventoryId":"D313327EF13845169A8ADADDA435431E",
        "trialSupplyType":"BOTTLE",
        "isDosingUnblinded":true,
        "dose":5,
        "measurement":"ml",
        "frequency":"BID",
        "kitDescription":"Kit A"
    }
}

Example:

{
    "id":2,
    "inventoryId":"D313327EF13845169A8ADADDA435431E",
    "trialSupplyType":"BOTTLE",
    "isDosingUnblinded":true,
    "dose":5,
    "measurement":"ml",
    "frequency":"BID",
    "kitDescription":"Kit A"
}

Examples

Select an example Reusable 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 Reusable 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 Reusable Kits Server Error Response

Back to Top