...
Below are the attributes which need to be sent in request body.
Parameter | Description |
---|---|
cprId | System generated identifier for registered participant for particular collection protocol |
eventId | Event Identifier |
eventLabel | Event label |
eventPoint [optional] | Event point |
ppId | Participant protocol identifer |
cpTitle | Collection protocol title |
cpShortTitle | Collection protocol short title |
name | Visit name |
code [optional] | Unique code given to visit. Which can used for barcode based data entry |
clinicalDiagnosis [optional] | Clinical diagnosis |
clinicalStatus [optional] | Clinical status |
activityStatus [optional] | Activity Status |
site | Site name where visit perform |
status | Status of visit (COMPLETE, PENDING, MISSED) |
missedReason [optional] | Reason in case of missed visits |
missedBy [optional] | User details by which visit got missed |
comments [optional] | Comments on visit |
surgicalPathologyNumber [optional] | Surgical pathology number |
cohort [optional] | Cohort is a group of subjects who have shared a particular event together during a particular time span. Cohorts may be tracked over extended periods in a cohort study |
visitDate [optional] | Date of visit.By default it will take current date. |
Note :
To call below api following fields are mandatory
...
2. eventId or eventLabel
3. Name
4. Site
API URL :
http[s]:<host>:<port>/openspecimen/rest/ng/visits/{visitId}
Use this URL to add update visit for a registered participant in OpenSpecimen application.
...