...
Below are the attributes which need to be sent in the request body:
Parameter | Details | ||
|---|---|---|---|
| title | Collection protocol title. Should be unique in the application | shortTitle | Collection protocol short title. Should be unique in the applicationFull title of the collection protocol, which is normally used in the regulatory approval documents. |
| shortTitle | User friendly short string to uniquely identify the collection protocol. | ||
| code [optional] | Collection protocol code | startDateA short code to uniquely identify the CP in the system. | |
| startDate [optional] | Collection protocol starting date | ||
| endDate [optional] | Collection protocol end date. If given then, the endDate should be later than start date. | ||
| principalInvestigator | Principal investigator of CP Mainly contains following parameters : loginName : User login name. For this specified user must be present in application. domainName: Name of domain to which user belongs to. By default it will be catissue. | ||
| coordinators [optional] | Collection of coordinators. It is collection of user info mainly contains following parameters : loginName : User login name. For this specified user must be present in application. domainName: Name of domain to which user belongs to. By default it will be catissue. | ||
| irbIdirbId [optional] | Ethics approval id | ||
| anticipatedParticipantsCountanticipatedParticipantsCount [optional] | Anticipated participants count. This is ignored for specimen centric CPs. | ||
| activityStatus | Activity status of a collection protocol | ||
| visitNameFmt [optional] | Visit name format. This is ignored for specimen centric CPs. | ||
| specimenLabelFmt [optional] | Specimen label format | ||
| derivedLabelFormat [optional] | Derived label format | ||
| aliquotLabelFormat [optional] | Aliquot label format | ||
| ppIdFormatppidFmt [optional] | PPId formatPPID format. This is ignored for specimen centric CPs. | ||
| cpSites | It is collection of SitesArray of sites at which the collection protocol is being run or active. Mainly contains following parameters : siteName: Site name. For this attribute Site must be present in application. code[optional]: Site code | ||
| manualPpidEnabledmanualPpidEnabled [optional] | User inputs allowed for ppid | manualVisitNameEnabledWhen enabled, users have to manually enter the participant PPID. | |
| manualVisitNameEnabled [optional] | User inputs allowed for visit name | manualSpecLabelEnabledWhen enabled, users have to manually enter the visit names. | |
| manualSpecLabelEnabled [optional] | User inputs allowed for specimen labelWhen enabled, users have to manually enter the specimen (primary, derived, aliquot) labels. | ||
| specimenCentric | Boolean indicating whether the CP is participant or specimen centric. When the value of this attribute is null or false, a participant centric CP is created. However, when the value is true, a specimen centric CP is created. Note: This flag is effective only when a CP is being created. The value of this attribute is ignored in the CP update APIs. In other words, a participant centric CP cannot be converted to specimen centric and vice-versa. |
...