Add a subject
post
/ec-dc-svc/rest/v4.0/studies/{studyId}/{mode}/subjects
Adds a subject to a study. If medical record number (mrnNumber) is provided and if the user has 'Link Subject-Patient' rights, subject patient link would also be established. Rights: DataCaptureSubjectPost and SubjectDataClassificationPost.
Request
Path Parameters
-
mode(required): string
Mode of the study. Accepts test, active, or training.
-
studyId(required): string
ID of the study for which you want to get the list of subjects.
Supported Media Types
- application/json
Nested Schema : SubjectDto13
Type:
Show Source
object
-
canBeCompleted: boolean
-
codeBreak: string
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
description: string
Minimum Length:
0
Maximum Length:500
-
dob: string
(date-time)
-
enrollmentFailure: string
Minimum Length:
0
Maximum Length:255
-
enrollmentOverride: string
Minimum Length:
0
Maximum Length:255
-
eventType: string
-
freezedStatus: string
-
fromStudyId: string
(uuid)
-
gender: string
Minimum Length:
0
Maximum Length:10
-
hasLockData: boolean
-
id: string
(uuid)
-
informedConsentDate: string
(date-time)
-
lastSigned: string
-
lockedDateTime: string
(date-time)
-
lockedInStudyVersion: string
-
lockedStatus: string
-
mhealthSubjectId: string
(uuid)
-
mrnNumber: string
-
objectVersionNumber: number
-
operationType: string
-
previousSubjectNumber: string
-
randomizationNumber: string
-
reason: string
Minimum Length:
0
Maximum Length:255
-
screenFailureComment: string
-
screenFailureDate: string
(date-time)
-
screeningDate: string
(date-time)
-
screeningFailure: string
Minimum Length:
0
Maximum Length:255
-
screeningNumber: string
-
signedStatus: string
-
siteId: string
-
softwareVersionNumber: number
-
sourceTimeStamp: string
(date-time)
-
state(required): string
Minimum Length:
0
Maximum Length:100
-
stateDate: string
(date-time)
-
studyCompletionDate: string
(date-time)
-
studyId: string
-
studyVersion(required): string
-
subjectNumber(required): string
Minimum Length:
0
Maximum Length:500
-
subjectSiteSerialNumber: string
-
subjectStudySerialNumber: string
-
subjectTransferId: string
(uuid)
-
subjNumSiteOrgId: string
-
userId: string
(uuid)
-
verifiedStatus: string
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
-
withdrawalComment: string
-
withdrawalDate: string
(date-time)
-
withdrawalReason: string
Response
Supported Media Types
- application/json
200 Response
Subjects success.
Nested Schema : result
Type:
object
Nested Schema : details
Type:
object
400 Response
Bad request.
Root Schema : SubjectDto13
Type:
Show Source
object
-
canBeCompleted: boolean
-
codeBreak: string
-
comment: string
Minimum Length:
0
Maximum Length:2048
-
description: string
Minimum Length:
0
Maximum Length:500
-
dob: string
(date-time)
-
enrollmentFailure: string
Minimum Length:
0
Maximum Length:255
-
enrollmentOverride: string
Minimum Length:
0
Maximum Length:255
-
eventType: string
-
freezedStatus: string
-
fromStudyId: string
(uuid)
-
gender: string
Minimum Length:
0
Maximum Length:10
-
hasLockData: boolean
-
id: string
(uuid)
-
informedConsentDate: string
(date-time)
-
lastSigned: string
-
lockedDateTime: string
(date-time)
-
lockedInStudyVersion: string
-
lockedStatus: string
-
mhealthSubjectId: string
(uuid)
-
mrnNumber: string
-
objectVersionNumber: number
-
operationType: string
-
previousSubjectNumber: string
-
randomizationNumber: string
-
reason: string
Minimum Length:
0
Maximum Length:255
-
screenFailureComment: string
-
screenFailureDate: string
(date-time)
-
screeningDate: string
(date-time)
-
screeningFailure: string
Minimum Length:
0
Maximum Length:255
-
screeningNumber: string
-
signedStatus: string
-
siteId: string
-
softwareVersionNumber: number
-
sourceTimeStamp: string
(date-time)
-
state(required): string
Minimum Length:
0
Maximum Length:100
-
stateDate: string
(date-time)
-
studyCompletionDate: string
(date-time)
-
studyId: string
-
studyVersion(required): string
-
subjectNumber(required): string
Minimum Length:
0
Maximum Length:500
-
subjectSiteSerialNumber: string
-
subjectStudySerialNumber: string
-
subjectTransferId: string
(uuid)
-
subjNumSiteOrgId: string
-
userId: string
(uuid)
-
verifiedStatus: string
-
versionEnd: string
(date-time)
-
versionStart: string
(date-time)
-
withdrawalComment: string
-
withdrawalDate: string
(date-time)
-
withdrawalReason: string