...
Parameter | Details |
|---|---|
| title | Full 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] | A 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. |
| irbId [optional] | Ethics approval id |
| anticipatedParticipantsCount [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 |
| ppidFormat ppidFmt [optional] | PPID format. This is ignored for specimen centric CPs. |
| cpSites | Array of sites at which the collection protocol is being run or active. Mainly contains following parameters : siteName: Site name. code[optional]: Site code |
| manualPpidEnabled [optional] | When enabled, users have to manually enter the participant PPID. |
| manualVisitNameEnabled [optional] | When enabled, users have to manually enter the visit names. |
| manualSpecLabelEnabled [optional] | When 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. |
...