1. REST API for Clinical One Platform
  2. Tasks
  3. Data Capture
  4. Subjects
  5. Assign subject number after screening

V1.0

post

/ec-dc-svc/rest/v1.0/studies/{studyId}/{mode}/subjects/screen

Screens a candidate subject for enrollment. Returns the assigned screening number and validation result.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Subject screening request, containing enrollment context and submitted forms with data elements.
Show Source
Nested Schema : SubjectScreenContext
Type: object
Context for subject screening data, including site, event, subject, and visit date.
Show Source
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: 78DB4EF4847849CCB24EFCCB71CDA436
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: 40DB4EF4847849CCB24EFCCB71CDA436
  • Unique subject Number representing the patient/participant enrolled in the study.
    Example: SUBJ-0123
  • Visit start date for screening
    Example: 2025-12-01T09:00:00Z
Nested Schema : forms
Type: object
Screening subject form and its input data elements.
Show Source
Nested Schema : dataElements
Type: array
List of data elements input by user in the form
Show Source
Nested Schema : CoreDataElementV7
Type: object
Core data element payload (v7).
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Any general comments for the data element instance.
    Example: Measured after fasting
  • Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).
    Example: B1B8327AFAA6412287106192AB5984EF
  • Unique identifier of the associated source document (hex UUID, 32-character uppercase), enabling traceability between the data element and its original supporting document or file.
  • Version of the source or supporting document linked to this data element.
    Example: 1
  • ID (UUID, 32-character uppercase hexadecimal string) of the form section.
    Example: D9876543D9876543D9876543D9876543
  • Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.
    Example: A86F2D0BB610404DB62D37AFA9C20B50
  • Primary uuid identifier for the data element instance (HEX, upper case).
    Example: C1234567C1234567C1234567C1234567
  • Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.
    Example: 1
  • Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: 1BC29B36F5D64B1B95F4BDBBCEA481BE
  • Unit of measurement for this value (if applicable).
    Example: mg/dL
  • An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).
    Example: F4443333F4443333F4443333F4443333
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 1
  • Unique Identfier (UUID, 32-character uppercase hexadecimal string) of data capture properties
    Example: 299BC76CF0F943E6BAC1D209BC3D1CDC
  • The timestamp marking the beginning of the validity period for this record version within the system.
    Example: 2024-01-01T00:00:00Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason for this data entry/edit.
    Example: Other
  • Represents the ordinal number assigned to a repeated instance of a data collection form. It uniquely identifies each occurrence of a repeating form for a subject when multiple instances of the form.
    Example: 1
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 2
  • Timestamp from the data source when this element was generated.
    Example: 2024-01-01T00:00:00Z
  • Transaction end date/time for this observation.
    Example: 2024-01-01T13:00:00Z
  • Transaction start date/time for this observation.
    Example: 2024-01-01T12:00:00Z
  • Minimum Length: 0
    Maximum Length: 4000
    Measured value captured for this data element.
    Example: 42.0
  • Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.
    Example: E5554444E5554444E5554444E5554444
  • Minimum Length: 0
    Maximum Length: 100
    Code supplied by vendor.
    Example: VENDOR42
Examples

Back to Top

Response

Supported Media Types

200 Response

Candidate subject successfully screened.
Body ()
Root Schema : SubjectScreenResponseDto
Type: object
Screen subject response object: details of the subject, visit status, and data elements captured.
Show Source
Nested Schema : dataElements
Type: array
All data elements extracted from the screen form for the subject.
Show Source
Nested Schema : Subject1
Type: object
Comprehensive subject details including identity, site, study, demographic and state details, with example showing all fields.
Show Source
Nested Schema : VisitsStatus
Type: object
Details of the visit for screening.
Show Source
  • Minimum Length: 0
    Maximum Length: 100
    Associated study version, if visit is linked to another protocol version.
    Example: 3.1.0.2
  • Minimum Length: 0
    Maximum Length: 2048
    Comment regarding the last change made to the entity.
    Example: Imported via migration tool.
  • Design version for the study when visit was enerated.
    Example: 3.1.0.2
  • Display indicator flag (Y/N), whether this visit should display in UIs.
    Example: Y
  • Holds any dose hold action taken on this visit.
    Example: ENABLE
  • Indicates if visit is part of dynamic all cycles (Y/N).
    Example: N
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: D1AABBCCDDEEFF112233445566778899
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 1
  • Frozen status of the record can have values NOT_APPLICABLE, FROZEN.
    Example: Freezed
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) for visit status.
    Example: AABBCCDDEEFF00112233445566778899
  • Unique Identfier ( (UUID, 32-character uppercase hexadecimal string) of the leading data element for this visit, if any.
    Example: EEDD00112233445566778899AABBCCDD
  • Date/time when the visit was locked (if applicable).
    Example: 2025-10-02T12:00:00Z
  • Lock status specifically for the visit start date.Values can be LOCKED, UNLOCKED, NEVER_LOCKED, NOT_APPLICABLE
    Example: UNLOCKED
  • Minimum Length: 1
    Maximum Length: 16
    Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: REMOVED
  • Minimum Length: 0
    Maximum Length: 255
    Reason for the entity creation or latest modification.
    Example: Initial import.
  • Count of repeating forms related to visit.
    Example: 0
  • holds visit schedule date which is calculated from an anchor visit start date.
    Example: 2025-10-02T09:00:00Z
  • holds visit schedule end date which is calculated from the visit scheduledDate.
    Example: 2025-10-03T23:59:59Z
  • Event ID (UUID, 32-character uppercase hexadecimal string) from which the schedule for this visit was derived.
    Example: EEDD00112233445566778899AABBCCDD
  • holds visit schedule start date which is calculated from the visit scheduledDate.
    Example: 2025-10-02T00:00:00Z
  • Scheduled window end date for the visit (dynamic calculation).
    Example: 2025-10-05T23:59:59Z
  • Scheduled window start date (dynamic calculation for visit scheduling).
    Example: 2025-09-30T00:00:00Z
  • Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.
    Example: SIGNED
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: BEEFAABBCCDDEEDDFF00112233445566
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 3.1.0.2
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: AABBCCDDEEFF00112233445566778899
  • Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.
    Example: VERIFIED
  • Action taken on the visit start date value. Acceptable values are SCREEN_ENABLE ,SCREEN_DISABLE ,RANDOMIZE_ENABLE ,RANDOMIZE_DISABLE, DISPENSE_ENABLE, DISPENSE_DISABLE, COMPLETE_STUDY_ENABLE, COMPLETE_STUDY_DISABLE.
    Example: ENABLE
  • Date/time the visit was started.
    Example: 2025-10-02T08:45:00Z
  • Datetime when visit start date was locked.
    Example: 2025-10-02T12:00:00Z
  • Action taken on the visit start date value. Acceptable values are LOCKED, UNLOCKED, NEVER_LOCKED.
    Example: LOCKED
  • 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: COMPLETED
  • 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
  • Window warning details or messages for visit timing.
    Example: Visit outside of permitted window.
Nested Schema : DataElement
Type: object
Represents a data element as captured/stored for a subject during a study, including repeat and validation info.
Show Source
  • Minimum Length: 0
    Maximum Length: 2048
    Comment regarding the last change made to the entity.
    Example: Imported via migration tool.
  • Event occurs when a form is restored.
    Example: FORM_RESTORED
  • Unique Data flag identifier(UUID, 32-character uppercase hexadecimal string).
    Example: C9E86AF896F04FBB82FB755666DA6B58
  • data flag applied, values which are applicable Not Done, Not Applicable, Unknown
    Example: Not Done
  • Unique identifier of the associated source document (hex UUID, 32-character uppercase), enabling traceability between the data element and its original supporting document or file.
    Example: 26C7C2DF6B2546E6BBA8331738FACD1E
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical event like Screening, Visit 1 etc.
    Example: BEEFAABBCCDDEEDDFF00112233445566
  • Numeric value representing the instance number of the event. Used for repeated or unscheduled visits. It is null for scheduled events.
    Example: 3
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) representing the clinical form.
    Example: 360E6122F84A43CAAF70E3BECC471A7C
  • ID (UUID, 32-character uppercase hexadecimal string) of the form section.
    Example: 4FB2D38F8F9644D2B3BE08B815A8FF1A
  • Frozen status of the record can have values NOT_APPLICABLE, FROZEN.
    Example: FROZEN
  • Unique Identfier (UUID, 32-character uppercase hexadecimal string) HDI value for integrations.
    Example: D3C9A4B5E6F78123456789ABCDEF1234
  • Unique identifier(UUID, 32-character uppercase hexadecimal string) for the data element.
    Example: B58C5C21BFC94E1384D0F4C6BA7566F3
  • Indicates the repeat sequence number of a nested or inner repeating form within an outer repeating structure. This value is used to distinguish multiple occurrences of the same inner form for a given outer repeat instance.
    Example: 1
  • Indicates if this safety field is default-selected.
    Example: true
  • Indicates if this triggers a safety-related workflow.
    Example: false
  • Minimum Length: 0
    Maximum Length: 4000
    The formatted value that matches the data type of the question, such as a date in a specific format or a number with correct decimal places. If the user didn't provide a valid response, ItemF will be null.
    Example: example free-field
  • Minimum Length: 0
    Maximum Length: 4000
    Unique Item identifier (UUID, 32-character uppercase hexadecimal string) from the study Designer, associated to a form.
    Example: 7978B7DD0A0A4CA899C485990994300C
  • Minimum Length: 0
    Maximum Length: 4000
    The raw value entered by the user, which can be a text, number, or date, and is stored as alphanumeric data. It may also contain special flags such as NA (Not Applicable), ND (Not Done), UNK (Unknown), or Not Answered if the user didn't provide a response.
    Example: example result_R
  • Minimum Length: 0
    Maximum Length: 255
    Type/category of the item.
    Example: NUMERIC
  • Date/time when lock was applied.
    Example: 2025-05-20T10:30:00Z
  • Indicates if the field is locked.values applicable LOCKED, NEVER_LOCKED, UNLOCKED, NOT_APPLICABLE
    Example: LOCKED
  • Minimum Length: 0
    Maximum Length: 64
    Unit of measurement for value field (e.g. mg, cm).
    Example: mg
  • Minimum Length: 1
    Maximum Length: 16
    Operation type on the record, can have values CREATED, MODIFIED or REMOVED
    Example: REMOVED
  • An identifier representing the system, or user that initiated the transaction (UUID, 32-character uppercase hexadecimal string).
    Example: D340A21830F6465C8466A2B42EF370D5
  • Indicates the repeat sequence number of the primary or outer repeating form. This value identifies each top-level occurrence of a repeating form and serves as the parent context for any nested inner repeats.
    Example: 1
  • Unique Identfier (UUID, 32-character uppercase hexadecimal string) of data capture properties
    Example: FFBC9E118C4C48FDB77A50A1CDD28AA9
  • Start time (timestamp) for the property version.
    Example: 2025-01-01T13:10:00Z
  • Minimum Length: 0
    Maximum Length: 255
    Reason for the entity creation or latest modification.
    Example: Initial import.
  • Form repeat number if applicable.
    Example: 0
  • Indicates the order of occurrence for a repeating form instance, used to distinguish between multiple repetitions of the same form.
    Example: 1
  • Signed status for workflow, the acceptable values are: NEVER_SIGNED, SIGNED, UNSIGNED, NEVER_SIGNED.
    Example: SIGNED
  • Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the clinical site.
    Example: BEEFAABBCCDDEEDDFF00112233445566
  • Minimum Length: 0
    Maximum Length: 100
    Name of the study.
    Example: Study Alpha
  • Minimum Length: 0
    Maximum Length: 100
    String representing the version of the study configuration or protocol. Helps track changes in form or study design.
    Example: 1.0.0.0
  • Unique subject identifier (UUID, 32-character uppercase hexadecimal string) representing the patient/participant enrolled in the study.
    Example: ABD123EFC6784123BBAA1122CCDDEE44
  • Date when the transaction for this element ended.
    Example: 2023-01-21
  • Date when the transaction for this element started.
    Example: 2023-01-20
  • validationRules
    Validation rules applied to this data element.
  • Minimum Length: 0
    Maximum Length: 4000
    Raw string value for the data element (as entered/captured).
    Example: 102.1
  • Variable identifier (UUID, 32-character uppercase hexadecimal string) in uppercase hex format.
    Example: E8EB947A8B684C8B8A30C6070A65BD76
  • Minimum Length: 0
    Maximum Length: 100
    Third-party system or vendor code, if imported.
    Example: VENDOR1
  • Verified status for review workflow,the acceptable values are: NEVER_VEIFIED, VERIFIED, UNVERIFIED, NOT_APPLICABLE.
    Example: VERIFIED
  • Date when the visit started.
    Example: 2025-05-19
  • Allowed Values: [ "NEW", "COMPLETE", "COMPLETE_ERR", "INPROGRESS", "INCOMPLETE", "INCOMPLETE_ERR", "SKIPPED", "UNDO_SKIP", "NOT_STARTED" ]
    Visit status for this data element.
    Example: INPROGRESS
Nested Schema : validationRules
Type: array
Validation rules applied to this data element.
Show Source
Nested Schema : ValidationRuleDto
Type: object
Validation rule details associated with a specific data element.
Show Source
  • Query identifier (UUID, 32-character uppercase hexadecimal string) generated by the validation rule.
    Example: 45B982CDC4604AF5A354AAAF7BEEB93B
  • Status of the query associated with this rule and values can be Candidate, Answered, Closed, Opened, Deleted
    Example: Opened
  • Unique Identifier (UUID, 32-character uppercase hexadecimal string) for the validation rule.
    Example: 45B982CDC4604AF5A354AAAF7BEEB93B
Examples

400 Response

Bad request - invalid payload or subject info.
Body ()
Root Schema : DcsResponse
Type: object
Show Source
Nested Schema : ErrorResponseData
Type: object
Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
Show Source
  • details
    Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
  • Application or business-specific error code representing the error type.
    Example: REPT_401
  • Human-readable error message describing the failure or issue.
    Example: Unauthorized: User does not have access to the requested resource
Nested Schema : result
Type: object
Nested Schema : details
Type: object
Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.
Example:
User role is missing required permission REPORTING_VIEW. Field: userId
Back to Top