Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Below are the attributes which need to be sent in request body.

 

ParameterDescription
cprIdSystem generated identifier for registered participant for particular collection protocol
eventIdEvent Identifier
eventLabelEvent label
eventPoint [optional]Event point
ppIdParticipant protocol identifer
cpTitleCollection protocol title
cpShortTitleCollection protocol short title
nameVisit 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
siteSite name where visit perform
statusStatus 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. 

...