Create Method generates a new Study Subject.
Usage
SOAP XML Request and Response Template
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:v1="http://openclinica.org/ws/studySubject/v1"
xmlns:bean="http://openclinica.org/ws/beans">
${insert header}
<soapenv:Body>
<v1:createRequest>
<!--1 or more repetitions:-->
<v1:studySubject>
<bean:label>?</bean:label>
<!--Optional:-->
<bean:secondaryLabel>?</bean:secondaryLabel>
<bean:enrollmentDate>?</bean:enrollmentDate>
<bean:subject>
<!--Optional:-->
<bean:uniqueIdentifier>?</bean:uniqueIdentifier>
<!--Optional:-->
<bean:gender>?</bean:gender>
<!--You have a CHOICE of the next 2 items at this level-->
<bean:dateOfBirth>?</bean:dateOfBirth>
<bean:yearOfBirth>?</bean:yearOfBirth>
</bean:subject>
<bean:studyRef>
<bean:identifier>?</bean:identifier>
<!--Optional:-->
<bean:siteRef>
<bean:identifier>?</bean:identifier>
</bean:siteRef>
</bean:studyRef>
</v1:studySubject>
</v1:createRequest>
</soapenv:Body>
</soapenv:Envelope>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<createResponse>
<result>success</result>
<label>?</label>
</createResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Parameters
Request Parameters
Parameter | UI | Domain | DB | Validations | Datatypes | Examples | Required |
---|---|---|---|---|---|---|---|
label | Study Subject ID | StudySubjectBean:label | study_subject:label | – cannot be longer than 30 characters | String | <label>SSID001</label>
Note: The OID of the study subject is truncated if the label contains 9 or more characters. For example, if you create a subject with a Study Subject ID # ALC5000001 –> the Study Subject OID saved in the database is: SS_ALC50000 instead of SS_ALC5000001 If there is another study subject containing the same first 8 characters as the first study subject,the second study subject will have the same OID as the first study subject with an appended 4 randomly assigned digits to ensure uniqueness. For example, if after you submitted a request to create a Study subject of ALC5000001, you submit a request to create a Study Subject ID # ALC5000002, the Study Subject OID saved in the database is: SS_ALC50000_5363 instead of SS_ALC5000002
| Y – if “Study Parameter Configuration – Generate the Study Subject ID” is set to Manual Entry. N – if “Study Parameter Configuration – Generate the Study Subject ID” is set to Auto-generated and Editable or Auto-generated and Non-editable. |
secondaryLabel | Secondary ID | StudySubjectBean:secondaryLabel | study_subject:secondary_label | – cannot be longer than 30 characters | String | <secondaryLabel>?</secondaryLabel> | N |
enrollmentDate | Date of Enrollment | StudySubjectBean:enrollmentDate | study_subject:enrollment_date | – should be a valid date in the ISO 8601 format – date should be in the past | Date | <enrollmentDate>2008-12-12</enrollmentDate> | Y |
subject:uniqueIdentifier | Person ID | SubjectBean:uniqueIdentifier | subject:unique_identifier | – cannot be longer than 255 characters | String | <uniqueIdentifier>PID001</uniqueIdentifier> | Y – if “Study Parameter Configuration – Person ID Required” is set to Required. N – if “Study Parameter Configuration – Person ID Required” is set to Optional or Not Used. |
subject:gender | Sex | SubjectBean:gender | subject:gender | – should be ‘m’ or ‘f’ | char | <gender>m<gender> | Y – if “Study Parameter Configuration – Sex Required” is set to Yes. N – if “Study Parameter Configuration – Sex Required” is set to No. |
subject:dateOfBirth | Date of Birth | SubjectBean:dateOfBirth | subject:date_of_birth | – should be a valid date in the ISO 8601 format | Date | <dateOfBirth>2008-12-12</dateOfBirth> | Y – if “Study Parameter Configuration – Collect Subject Date of Birth” is set to Yes. N – if “Study Parameter Configuration – Collect Subject Date of Birth” is set to Not Used or Only Year of Birth. |
subject:yearOfBirth | Date of Birth | SubjectBean:dateOfBirth | subject:date_of_birth | – should be a valid year | Date | <yearOfBirth>2008</yearOfBirth> | Y – if “Study Parameter Configuration – Collect Subject Date of Birth” is set to Only Year of Birth. N – if “Study Parameter Configuration – Collect Subject Date of Birth” is set to Not Used or Yes. |
studyRef:identifier | Unique Protocol ID | StudyBean:identifier | study:unique_identifier | – should be a valid study identifier | String | <identifier>StudyA</identifier> | Y |
siteRef:identifier | Unique Protocol ID | StudyBean:identifier | study:unique_identifier | – should be a valid site identifier | String | <identifier>SiteA</identifier> | N |
Response Parameters
Parameter | UI | Domain | DB | Result on success | Result on fail |
---|---|---|---|---|---|
label | Study Subject ID | StudySubjectBean:label | study_subject:label | <label>SSID001</label> | <label/> |
result | n/a | n/a | n/a | <result>Success</result> | <result>Fail</result> |
warning | n/a | n/a | n/a | n/a | n/a |
error | n/a | n/a | n/a | n/a | <error>An error message indicating reason of failure</error> |