/openspecimen/rest/ng/visits
This rest api API is used to add/create a new visit of pre-registered participant. Use HTTP POST method to call invoke this api API by passing below payload details in json JSON format.
Below are the attributes which need to be sent in request body.
| Parameter | Description |
|---|---|
| cprId | System generated identifier for of the registered participant for particular collection protocol |
| eventId | Event identifier |
| eventLabel | Event label |
| ppid | Participant protocol identifer |
| cpTitle | Collection protocol title |
| cpShortTitle | Collection protocol short title |
| name | Visit name |
clinicalDiagnosis (Prior to v4.0) clinicalDiagnoses (From v4.0) [optional] | Clinical diagnosis Note: Starting v4.0, clinical diagnosis is a multi-value field in Visit. |
| 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. |
...
Use this URL to add visit for a pre-registered participant in OpenSpecimen application.
...