Jump to

• Request
• Response

[Deprecated]: v1.0

post

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

Deprecated: Randomize a subject and/or dispense kits during a randomization or dispensation visit. 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:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Visit Request

Type: object

Title: Visit Request

Request containing subject visit details.

Show Source

• AuthUserListDtoV1: array AuthUserListDtoV1
• blind_rand_number_enabled: string
  Title: Blind Rand Number Enabled

  Check if rand number needs to be blinded

  Example: true
• dcssubjects: object DCS Subject
  Title: DCS Subject

  Subject properties indicating completion capability and the locked study version
• forcedRandLimitReached: boolean
  Title: forcedRandLimitReached

  Check if forced limit is reached

  Example: true
• instanceNumber: number (BigDecimal)
  Title: Instance Number

  Minimum Value: 1

  Visit instance number.

  Example: 2
• isVisitWithinWindow: boolean
  Title: Visit Within Window

  Indicates whether the visit occurs within the configured window.

  Example: true
• kitTypesForDoseHold: array Kit Types for Dose Hold
  Title: Kit Types for Dose Hold

  List of kit types configured for dose hold.
• kitTypesForResumeDispensation: array Kit Types for Resume Dispensation
  Title: Kit Types for Resume Dispensation

  List of kit types for which to resume dispensation.
• notify_dispensation_failure_only: string
  Title: Notify Dispensation Failure Only

  Send notification only for dispensation failures.

  Example: true
• notify_randomization_failure_only: string
  Title: Notify Randomization Failure Only

  Send notification only for randomization failures.

  Example: true
• notifyDispensationFailureOnly: string
• notifyRandomizationFailureOnly: string
• resumePartialDispensation: boolean
  Title: Resume Partial Dispensation

  Indicates whether to resume partial dispensation in the visit.

  Example: false
• 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
• visits: array Visits
  Title: Visits

  Visit status details.
• 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":"Visit Request",
    "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"
            }
        },
        "notifyDispensationFailureOnly":{
            "type":"string"
        },
        "notifyRandomizationFailureOnly":{
            "type":"string"
        },
        "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
        },
        "kitTypesForDoseHold":{
            "title":"Kit Types for Dose Hold",
            "type":"array",
            "description":"List of kit types configured for dose hold.",
            "items":{
                "$ref":"#/components/schemas/DoseHoldRequestV2"
            }
        },
        "kitTypesForResumeDispensation":{
            "title":"Kit Types for Resume Dispensation",
            "type":"array",
            "description":"List of kit types for which to resume dispensation.",
            "items":{
                "$ref":"#/components/schemas/DoseHoldRequestV2"
            }
        },
        "resumePartialDispensation":{
            "title":"Resume Partial Dispensation",
            "type":"boolean",
            "description":"Indicates whether to resume partial dispensation in the visit.",
            "example":false
        },
        "notify_dispensation_failure_only":{
            "title":"Notify Dispensation Failure Only",
            "type":"string",
            "description":"Send notification only for dispensation failures.",
            "example":"true"
        },
        "notify_randomization_failure_only":{
            "title":"Notify Randomization Failure Only",
            "type":"string",
            "description":"Send notification only for randomization failures.",
            "example":"true"
        },
        "isVisitWithinWindow":{
            "title":"Visit Within Window",
            "type":"boolean",
            "description":"Indicates whether the visit occurs within the configured window.",
            "example":true
        },
        "visits":{
            "title":"Visits",
            "type":"array",
            "description":"Visit status details.",
            "items":{
                "$ref":"#/components/schemas/VisitsStatusDto9"
            }
        },
        "dcssubjects":{
            "$ref":"#/components/schemas/SubjectDto12"
        },
        "blind_rand_number_enabled":{
            "title":"Blind Rand Number Enabled",
            "type":"string",
            "description":"Check if rand number needs to be blinded",
            "example":"true"
        },
        "forcedRandLimitReached":{
            "title":"forcedRandLimitReached",
            "type":"boolean",
            "description":"Check if forced limit is reached",
            "example":true
        }
    },
    "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 : DCS Subject

Type: object

Title: DCS Subject

Subject properties indicating completion capability and the locked study version

Show Source

• canBeCompleted: boolean
  Indicates if the subject has met conditions to be completed

  Example: true
• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Comment for latest subject update

  Example: Initial enrollment
• description: string
  Minimum Length: 0

  Maximum Length: 500

  Free text description for the subject

  Example: Screened subject
• dob: string (date-time)
  Date of birth
• enrollmentFailure: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for enrollment failure, if any

  Example: Consent withdrawn
• enrollmentOverride: string
  Minimum Length: 0

  Maximum Length: 255

  If subject enrollment is overridden.

  Example: Subject Enrollment Overridden
• eventType: string
  Event Type for Subject, can have value New, Screened, Randomized, Withdrawn, Undo_Withdrawn, Randomization_Replaced, Transferred, Screen_Failed, Undo_Randomization.

  Example: Screened
• freezedStatus: string
  Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.

  Example: FROZEN
• fromStudyId: string
  Origin study identifier (UUID, 32-character uppercase hexadecimal string) from which the subject was transferred

  Example: 5D5F9311C591424F852B99FD902E98A4
• gender: string
  Minimum Length: 0

  Maximum Length: 10

  Gender value

  Example: [{"value":"1","label":"male"}]
• hasLockData: boolean
  Indicates whether lock related data exists for the subject

  Example: false
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the subject

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• informedConsentDate: string (date-time)
  Informed consent date

  Example: 2025-09-25T09:00:00Z
• lastSigned: string (date-time)
  Timestamp when the subject was last signed

  Example: 2025-10-16T14:30:31.892Z
• lockedDateTime: string (date-time)
  Timestamp when the subject was locked

  Example: 2025-10-16T14:30:31.892Z
• lockedInStudyVersion: string
  Study version in which the subject is locked

  Example: 3.0.0.4
• lockedStatus: string
  Lock status of the subject,applicable values are LOCKED, UNLOCKED

  Example: UNLOCKED
• mhealthSubjectId: string
  Unique Identifier (UUID, 32-character uppercase hexadecimal string) of the subject in mHealth system.

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• objectVersionNumber: number
  Audit trail field that represents the version number of the data.

  Example: 14
• operationType: string
  Operation type on the record, can have values CREATED, MODIFIED or REMOVED

  Example: MODIFIED
• previousSubjectNumber: string
  Previous subject number if renumbered or transferred

  Example: SUBJECT-0001-OLD
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for latest subject update

  Example: Protocol break happened
• screenFailureDate: string (date-time)
  Date when the subject was marked as screen failure

  Example: 2025-10-16T14:30:31.892Z
• screeningDate: string (date-time)
  Screening date if applicable

  Example: 2025-10-01T10:00:00Z
• screeningFailure: string
  Minimum Length: 0

  Maximum Length: 255

  Reason for screening failure, if any

  Example: Inclusion criteria not met
• signedStatus: string
  Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.

  Example: SIGNED
• siteId: string
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• softwareVersionNumber: number
  Software version number associated with the event

  Example: 14
• sourceTimeStamp: string (date-time)
  Source system timestamp for the subject payload

  Example: 2025-10-16T14:30:31.892Z
• state(required): string
  Minimum Length: 0

  Maximum Length: 100

  Lifecycle state of the subject in the study. Reflects the subject???s current status. Common values include:

  • New
  • Active
  • Screening_Initiated
  • Screen_Failed
  • Withdrawn
  • Auto_Screen_Failed
  • Complete
  • Enrolled

  Example: Active
• stateDate: string (date-time)
  Timestamp when the subject transitioned to current state

  Example: 2025-10-16T14:30:31.892Z
• studyId: string
  Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.

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

  Example: 3.0.0.1
• subjectNumber(required): string
  Minimum Length: 0

  Maximum Length: 500

  Unique subject Number representing the patient/participant enrolled in the study.

  Example: SUBJ-0001
• subjectSiteSerialNumber: string
  Site-level serial number assigned to the subject

  Example: SITE-0001-001
• subjectStudySerialNumber: string
  Study-level serial number assigned to the subject

  Example: STUDY-0001-001
• subjectTransferId: string
  Unique Identifier(UUID, 32-character uppercase hexadecimal string) of a subject transfer if applicable

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• subjNumSiteOrgId: string
  Subject number site organization identifier (UUID, 32-character uppercase hexadecimal string)

  Example: 5D5F9311C591424F852B99FD902E98A4
• verifiedStatus: string
  Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.

  Example: VERIFIED
• versionEnd: string (date-time)
  End timestamp of the subject version record

  Example: 2025-10-16T14:30:31.892Z
• versionStart: string (date-time)
  The timestamp marking the beginning of the validity period for this record version within the system.

  Example: 2025-10-16T14:30:31.892Z

{
    "title":"DCS Subject",
    "required":[
        "state",
        "studyVersion",
        "subjectNumber"
    ],
    "type":"object",
    "properties":{
        "screeningDate":{
            "type":"string",
            "description":"Screening date if applicable",
            "format":"date-time",
            "example":"2025-10-01T10:00:00Z"
        },
        "eventType":{
            "type":"string",
            "description":"Event Type for Subject, can have value New, Screened, Randomized, Withdrawn, Undo_Withdrawn, Randomization_Replaced, Transferred, Screen_Failed, Undo_Randomization.",
            "example":"Screened"
        },
        "subjectTransferId":{
            "type":"string",
            "description":"Unique Identifier(UUID, 32-character uppercase hexadecimal string) of a subject transfer if applicable",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "objectVersionNumber":{
            "type":"number",
            "description":"Audit trail field that represents the version number of the data.",
            "example":14
        },
        "mhealthSubjectId":{
            "type":"string",
            "description":"Unique Identifier (UUID, 32-character uppercase hexadecimal string)  of the subject in mHealth system.",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "fromStudyId":{
            "type":"string",
            "description":"Origin study identifier (UUID, 32-character uppercase hexadecimal string) from which the subject was transferred",
            "example":"5D5F9311C591424F852B99FD902E98A4"
        },
        "subjNumSiteOrgId":{
            "type":"string",
            "description":"Subject number site organization identifier (UUID, 32-character uppercase hexadecimal string) ",
            "example":"5D5F9311C591424F852B99FD902E98A4"
        },
        "signedStatus":{
            "type":"string",
            "description":"Signed status for workflow, the acceptable values are:  NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.",
            "example":"SIGNED"
        },
        "verifiedStatus":{
            "type":"string",
            "description":"Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.",
            "example":"VERIFIED"
        },
        "freezedStatus":{
            "type":"string",
            "description":"Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.",
            "example":"FROZEN"
        },
        "lastSigned":{
            "type":"string",
            "description":"Timestamp when the subject was last signed",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "softwareVersionNumber":{
            "type":"number",
            "description":"Software version number associated with the event",
            "example":14
        },
        "operationType":{
            "type":"string",
            "description":"Operation type on the record, can have values CREATED, MODIFIED or REMOVED",
            "example":"MODIFIED"
        },
        "subjectStudySerialNumber":{
            "type":"string",
            "description":"Study-level serial number assigned to the subject",
            "example":"STUDY-0001-001"
        },
        "subjectSiteSerialNumber":{
            "type":"string",
            "description":"Site-level serial number assigned to the subject",
            "example":"SITE-0001-001"
        },
        "versionEnd":{
            "type":"string",
            "description":"End timestamp of the subject version record",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "previousSubjectNumber":{
            "type":"string",
            "description":"Previous subject number if renumbered or transferred",
            "example":"SUBJECT-0001-OLD"
        },
        "screenFailureDate":{
            "type":"string",
            "description":"Date when the subject was marked as screen failure",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "lockedStatus":{
            "type":"string",
            "description":"Lock status of the subject,applicable values are LOCKED, UNLOCKED",
            "example":"UNLOCKED"
        },
        "hasLockData":{
            "type":"boolean",
            "description":"Indicates whether lock related data exists for the subject",
            "example":false
        },
        "lockedDateTime":{
            "type":"string",
            "description":"Timestamp when the subject was locked",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "canBeCompleted":{
            "type":"boolean",
            "description":"Indicates if the subject has met conditions to be completed",
            "example":true
        },
        "lockedInStudyVersion":{
            "type":"string",
            "description":"Study version in which the subject is locked",
            "example":"3.0.0.4"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the subject",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"The timestamp marking the beginning of the validity period for this record version within the system.",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "description":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Free text description for the subject",
            "example":"Screened subject"
        },
        "subjectNumber":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":"Unique subject Number representing the patient/participant enrolled in the study.",
            "example":"SUBJ-0001"
        },
        "studyId":{
            "type":"string",
            "description":"Unique identifier of the study. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "dob":{
            "type":"string",
            "description":"Date of birth",
            "format":"date-time"
        },
        "state":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Lifecycle state of the subject in the study.  Reflects the subject???s current status. Common values include: <ul><li>New</li><li>Active</li><li>Screening_Initiated</li><li>Screen_Failed</li><li>Withdrawn</li><li>Auto_Screen_Failed</li><li>Complete</li><li>Enrolled</li></ul>",
            "example":"Active"
        },
        "stateDate":{
            "type":"string",
            "description":"Timestamp when the subject transitioned to current state",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "screeningFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for screening failure, if any",
            "example":"Inclusion criteria not met"
        },
        "enrollmentFailure":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for enrollment failure, if any",
            "example":"Consent withdrawn"
        },
        "enrollmentOverride":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"If subject enrollment is overridden.",
            "example":"Subject Enrollment Overridden"
        },
        "informedConsentDate":{
            "type":"string",
            "description":"Informed consent date",
            "format":"date-time",
            "example":"2025-09-25T09:00:00Z"
        },
        "gender":{
            "maxLength":10,
            "minLength":0,
            "type":"string",
            "description":"Gender value",
            "example":"[{\"value\":\"1\",\"label\":\"male\"}]"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for latest subject update",
            "example":"Protocol break happened"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Comment for latest subject update",
            "example":"Initial enrollment"
        },
        "studyVersion":{
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "sourceTimeStamp":{
            "type":"string",
            "description":"Source system timestamp for the subject payload",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        }
    },
    "description":"Subject properties indicating completion capability and the locked study version"
}

Nested Schema : Kit Types for Dose Hold

Type: array

Title: Kit Types for Dose Hold

List of kit types configured for dose hold.

Show Source

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

  Request containing dose hold settings.

{
    "title":"Kit Types for Dose Hold",
    "type":"array",
    "description":"List of kit types configured for dose hold.",
    "items":{
        "$ref":"#/components/schemas/DoseHoldRequestV2"
    }
}

Nested Schema : Kit Types for Resume Dispensation

Type: array

Title: Kit Types for Resume Dispensation

List of kit types for which to resume dispensation.

Show Source

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

  Request containing dose hold settings.

{
    "title":"Kit Types for Resume Dispensation",
    "type":"array",
    "description":"List of kit types for which to resume dispensation.",
    "items":{
        "$ref":"#/components/schemas/DoseHoldRequestV2"
    }
}

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 : Visits

Type: array

Title: Visits

Visit status details.

Show Source

• Array of: object VisitsStatusDto9
  Visit status details including associated study version

{
    "title":"Visits",
    "type":"array",
    "description":"Visit status details.",
    "items":{
        "$ref":"#/components/schemas/VisitsStatusDto9"
    }
}

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"
}

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
• 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
• 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":{
        "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
        },
        "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."
}

Nested Schema : VisitsStatusDto9

Type: object

Visit status details including associated study version

Show Source

• associatedStudyVersion: string
  Study version with which the visit status is associated

  Example: 3.0.0.1
• comment: string
  Minimum Length: 0

  Maximum Length: 2048

  Additional comment for the visit status

  Example: All data verified
• eventId: string
  Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• eventInstanceNum: integer (int32)
  Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.

  Example: 1
• eventType: string
  Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.

  Example: Visit_Not_Started
• freezedStatus: string
  Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.

  Example: FROZEN
• id: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record

  Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
• reason: string
  Minimum Length: 0

  Maximum Length: 255

  Reason associated with the visit status

  Example: Subject completed the visit successfully
• repeatingFormCount: number
  Number of repeating form instances for the visit.

  Example: 2
• scheduledWindowEndDate: string (date-time)
  Scheduled window end date for the visit

  Example: 2025-10-16T14:30:31.892Z
• scheduledWindowStartDate: string (date-time)
  Scheduled window start date for the visit

  Example: 2025-10-16T14:30:31.892Z
• signedStatus: string
  Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.

  Example: SIGNED
• siteId: string
  Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.

  Example: ABCDEF1234567890ABCDEF1234567890
• studyVersion(required): string
  Minimum Length: 0

  Maximum Length: 100

  String representing the version of the study. Helps track changes in form or study design.

  Example: 3.0.0.1
• subjectId: 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: ABCDEF1234567890ABCDEF1234567890
• verifiedStatus: string
  Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.

  Example: VERIFIED
• versionStart: string
  Start timestamp of the version record

  Example: 2025-10-16T14:30:31.892Z
• visitStartDate: string (date-time)
  Visit start date timestamp

  Example: 2025-10-16T14:30:31.892Z
• visitStatus: string
  Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.

  Example: COMPLETE
• visitType: string
  Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.

  Example: SCREENING

{
    "required":[
        "studyVersion"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the record",
            "example":"1BC29B36F5D64B1B95F4BDBBCEA481BE"
        },
        "versionStart":{
            "type":"string",
            "description":"Start timestamp of the version record",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "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":"ABCDEF1234567890ABCDEF1234567890"
        },
        "eventId":{
            "type":"string",
            "description":"Unique identifier(UUID, 32-character uppercase hexadecimal string) of the clinical event. A clinical event can be, for example: Screening, Randomization, Visit 1, etc. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "siteId":{
            "type":"string",
            "description":"Unique identifier of the site. Uses UUID in a 32-character uppercase hexadecimal string format.",
            "example":"ABCDEF1234567890ABCDEF1234567890"
        },
        "studyVersion":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"String representing the version of the study. Helps track changes in form or study design.",
            "example":"3.0.0.1"
        },
        "visitStatus":{
            "type":"string",
            "description":"Status of the visit. The Value of the status can be NEW, COMPLETE, COMPLETE_ERR, INPROGRESS, INCOMPLETE, INCOMPLETE_ERR, SKIPPED, UNDO_SKIP and NOT_STARTED.",
            "example":"COMPLETE"
        },
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason associated with the visit status",
            "example":"Subject completed the visit successfully"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment for the visit status",
            "example":"All data verified"
        },
        "visitStartDate":{
            "type":"string",
            "description":"Visit start date timestamp",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "visitType":{
            "type":"string",
            "description":"Type of visit as per the visit type enumeration. The acceptable values are: SCREENING, RANDOMIZATION, DISPENSATION, NON_DISPENSATION, OPTIONAL, OPTIONAL_DISPENSATION, WITHDRAW, SCREENDISP, SCREENRAND, SUBJECT_COMPLETE, UNSCHEDULED, UNSCHEDULED_DISPENSATION, ADVERSE_EVENT, SCREENFAILURE, RESCREENING and RESCREENDISP.",
            "example":"SCREENING"
        },
        "eventType":{
            "type":"string",
            "description":"Event type corresponding to the visit. The acceptable values are: Visit_Not_Started, Visit_Started, Visit_Complete, Visit_Skipped, Visit_Skip_Undone, Visit_Date_Changed, Visit_Inserted, Visit_Show, Visit_Hide, VisitDateEntered and VisitDateCleared.",
            "example":"Visit_Not_Started"
        },
        "eventInstanceNum":{
            "type":"integer",
            "description":"Numeric value representing the instance number of the event. Used for repeated or unscheduled visits (e.g., 1, 2, 3). It is null for scheduled events.",
            "format":"int32",
            "example":1
        },
        "signedStatus":{
            "type":"string",
            "description":"Signed status for workflow, the acceptable values are:  NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.",
            "example":"SIGNED"
        },
        "verifiedStatus":{
            "type":"string",
            "description":"Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.",
            "example":"VERIFIED"
        },
        "freezedStatus":{
            "type":"string",
            "description":"Frozen status of the record can have values NOT_APPLICABLE, FROZEN, UNFREEZE.",
            "example":"FROZEN"
        },
        "repeatingFormCount":{
            "type":"number",
            "description":"Number of repeating form instances for the visit.",
            "example":2
        },
        "scheduledWindowStartDate":{
            "type":"string",
            "description":"Scheduled window start date for the visit",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "scheduledWindowEndDate":{
            "type":"string",
            "description":"Scheduled window end date for the visit",
            "format":"date-time",
            "example":"2025-10-16T14:30:31.892Z"
        },
        "associatedStudyVersion":{
            "type":"string",
            "description":"Study version with which the visit status is associated",
            "example":"3.0.0.1"
        }
    },
    "description":"Visit status details including associated study version"
}

Examples

Select an example Subject Visit Request

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Response

Type: object

Show Source

• allowedMethods: array allowedMethods
  Unique Items Required: true
• closed: boolean
• cookies: object cookies
  Additional Properties Allowed: NewCookie
• date: string (date-time)
• entity: object entity
• entityTag: object EntityTag
• headers: object headers
  Additional Properties Allowed: additionalProperties
• language: object language
• lastModified: string (date-time)
• length: integer (int32)
• links: array links
  Unique Items Required: true
• location: string (uri)
• mediaType: object MediaType
• metadata: object metadata
  Additional Properties Allowed: additionalProperties
• status: integer (int32)
• statusInfo: object StatusType
• stringHeaders: object stringHeaders
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "location":{
            "type":"string",
            "format":"uri"
        },
        "language":{
            "type":"object",
            "properties":{
                "language":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                },
                "country":{
                    "type":"string"
                },
                "variant":{
                    "type":"string"
                },
                "script":{
                    "type":"string"
                },
                "unicodeLocaleAttributes":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "unicodeLocaleKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "displayLanguage":{
                    "type":"string"
                },
                "displayScript":{
                    "type":"string"
                },
                "displayCountry":{
                    "type":"string"
                },
                "displayVariant":{
                    "type":"string"
                },
                "extensionKeys":{
                    "uniqueItems":true,
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                },
                "iso3Language":{
                    "type":"string"
                },
                "iso3Country":{
                    "type":"string"
                }
            }
        },
        "date":{
            "type":"string",
            "format":"date-time"
        },
        "lastModified":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "metadata":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "entity":{
            "type":"object"
        },
        "cookies":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/components/schemas/NewCookie"
            }
        },
        "links":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "stringHeaders":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "statusInfo":{
            "$ref":"#/components/schemas/StatusType"
        },
        "mediaType":{
            "$ref":"#/components/schemas/MediaType"
        },
        "allowedMethods":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "entityTag":{
            "$ref":"#/components/schemas/EntityTag"
        },
        "headers":{
            "type":"object",
            "properties":{
                "empty":{
                    "type":"boolean"
                }
            },
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"object"
                }
            }
        },
        "closed":{
            "type":"boolean"
        }
    }
}

Nested Schema : allowedMethods

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : cookies

Type: object

Additional Properties Allowed

Show Source

• object NewCookie

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/components/schemas/NewCookie"
    }
}

Nested Schema : entity

Type: object

Nested Schema : EntityTag

Type: object

Show Source

• value: string
• weak: boolean

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "weak":{
            "type":"boolean"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Show Source

• empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : language

Type: object

Show Source

• country: string
• displayCountry: string
• displayLanguage: string
• displayName: string
• displayScript: string
• displayVariant: string
• extensionKeys: array extensionKeys
  Unique Items Required: true
• iso3Country: string
• iso3Language: string
• language: string
• script: string
• unicodeLocaleAttributes: array unicodeLocaleAttributes
  Unique Items Required: true
• unicodeLocaleKeys: array unicodeLocaleKeys
  Unique Items Required: true
• variant: string

{
    "type":"object",
    "properties":{
        "language":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "country":{
            "type":"string"
        },
        "variant":{
            "type":"string"
        },
        "script":{
            "type":"string"
        },
        "unicodeLocaleAttributes":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "unicodeLocaleKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "displayLanguage":{
            "type":"string"
        },
        "displayScript":{
            "type":"string"
        },
        "displayCountry":{
            "type":"string"
        },
        "displayVariant":{
            "type":"string"
        },
        "extensionKeys":{
            "uniqueItems":true,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "iso3Language":{
            "type":"string"
        },
        "iso3Country":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Unique Items Required: true

Show Source

• Array of: object Link

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : MediaType

Type: object

Show Source

• parameters: object parameters
  Additional Properties Allowed: additionalProperties
• subtype: string
• type: string
• wildcardSubtype: boolean
• wildcardType: boolean

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean"
        },
        "wildcardSubtype":{
            "type":"boolean"
        }
    }
}

Nested Schema : metadata

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Show Source

• empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"object"
        }
    }
}

Nested Schema : StatusType

Type: object

Show Source

• family: string
  Allowed Values: [ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ]
• reasonPhrase: string
• statusCode: integer (int32)

{
    "type":"object",
    "properties":{
        "family":{
            "type":"string",
            "enum":[
                "INFORMATIONAL",
                "SUCCESSFUL",
                "REDIRECTION",
                "CLIENT_ERROR",
                "SERVER_ERROR",
                "OTHER"
            ]
        },
        "statusCode":{
            "type":"integer",
            "format":"int32"
        },
        "reasonPhrase":{
            "type":"string"
        }
    }
}

Nested Schema : stringHeaders

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Show Source

• empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    },
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : NewCookie

Type: object

Show Source

• comment: string
• domain: string
• expiry: string (date-time)
• httpOnly: boolean
• maxAge: integer (int32)
• name: string
• path: string
• sameSite: string
  Allowed Values: [ "NONE", "LAX", "STRICT" ]
• secure: boolean
• value: string
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        },
        "path":{
            "type":"string"
        },
        "domain":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "maxAge":{
            "type":"integer",
            "format":"int32"
        },
        "expiry":{
            "type":"string",
            "format":"date-time"
        },
        "secure":{
            "type":"boolean"
        },
        "httpOnly":{
            "type":"boolean"
        },
        "sameSite":{
            "type":"string",
            "enum":[
                "NONE",
                "LAX",
                "STRICT"
            ]
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : extensionKeys

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleAttributes

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : unicodeLocaleKeys

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "uniqueItems":true,
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Link

Type: object

Show Source

• params: object params
  Additional Properties Allowed: additionalProperties
• rel: string
• rels: array rels
• title: string
• type: string
• uri: string (uri)
• uriBuilder: object UriBuilder

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "params":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "uri":{
            "type":"string",
            "format":"uri"
        },
        "title":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "uriBuilder":{
            "$ref":"#/components/schemas/UriBuilder"
        },
        "rels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : params

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : rels

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : UriBuilder

Type: object

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

Select an example Subject Visit 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 Subject Visit Server Error Response

Back to Top