Queries OpenClinica if Study Subject exists.

Usage

Queries OpenClinica if a study subjects is assigned to a target study/site. Study Subject is looked up by Label (aka Study Subject ID) only.
If only the Study ID is provided (and not the Site ID), the web service will check for the Study Subject across all sites in the study and, if found, return a result of ‘Success’. If a Site Identifier is also provided the scope of the query will be limited to subjects in that study and site.

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:isStudySubjectRequest>
<v1:studySubject>
<bean:label>?</bean:label>
<!--Lines selected in grey can be deleted from envelope. This information is NOT used by WS-->
<!--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:isStudySubjectRequest>
</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

 
ParameterUIDomainDBValidationsDatatypesExamplesRequired
labelStudy Subject IDStudySubjectBean:labelstudy_subject:label– cannot be longer than 30 charactersString<label>Sub A 101</label>

 Y

studyRef:identifierUnique Protocol IDStudyBean:identifierstudy:unique_identifier

– should be a valid study identifier

 String <identifier>StudyA</identifier> Y
siteRef:identifierUnique Protocol IDStudyBean:identifierstudy:unique_identifier– should be a valid site identifier String <identifier>SiteA</identifier> N

 

 Response Parameters

 
ParameterUIDomainDBResult on successResult on fail
studySubject:oc_oidStudy Subject OIDstudySubjectOIDstudy_subject:oc_oid<label>SSID001</label><label/>
resultn/an/an/a<result>Success</result><result>Fail</result>
warningn/an/an/an/an/a
errorn/an/an/an/a<error>An error message indicating reason of failure</error>