...
Parameter | Details |
|---|---|
| collectionProtocolId[mandatory] | The collection protocol identifier for which the participant registrations to be searched. |
| searchString | The value with which you want to search the participant registration. The given value will be matched with PPID, firstName, lastName |
| registraitonDate | Participant registration date |
| paritcipantName | This parameter will be used to match on the basis of firstName and lastName of the participant |
| participantProtocolId | Matched with the protocol participant Id |
| participantUniqueIdentifier | Matched with the unique identifier of the patient |
| masterPatientIndex | Matched with Medical record number, participant unique identifier and master patient index |
| masterPatientIndex | Matched with master patient index |
| dateOfBirth | Matched with participants date of birth |
| specimenDetails | Matched with specimen label and barcode |
| startAt | start index of the results |
| maxResults | Maximum number of records to fetch. By default it will be 1000 |
| includeStats | To specify whether to include statistics like visits count, collected specimen or pending counts etc |
| exactMatch | Flag to specify whether to perform exact match or not. |
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols
or
http[s]:<host>:<port>/openspecimen/rest/ng/collection-protocols?start={start}&max={maxResults}&searchString={searchString}&countReq={true/false}
Use this URL to get collection protocols in openSpecimen application.Result:
The response of this request will contains the details of the collection protocols.
...