/openspecimen/rest/ng/visits/{visitId}
This rest api is used to add update visit of registered participant. Use HTTP PUT method to call this api by passing below details in json format.
Below are the attributes which need to be sent in request body.
| Parameter | Description |
|---|
| cprId |
Participant registration identifier| System generated identifier for registered participant for particular collection protocol |
| eventId | Event Identifier |
ppid | Participant protocol identifer |
| eventLabel | Event label |
| eventPoint [optional] | Event point |
cpIdCollection identifier| 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 (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. |
Note :
To call below api following fields are mandatory
1. cprId or ppId and cpTitle or ppId and cpShortTitle
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.
...
Below is the example of the create participant:
| URL | openspecimen/rest/ng/visits/1 |
| Request type | application/json |
| Method |
POST| PUT |
| json |
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| { |
|
"cpTitle": "Lung Cancer Protocol", |
|
"eventLabel": "Initial Visit", |
|
clinicalDiagnosis "Not Specified", [
"3-part fracture of surgical neck of humerus",
"(Idiopathic) normal pressure hydrocephalus"
],
"clinicalStatus": "Operative", |
|
"activityStatus": "Active", |
|
"surgicalPathologyNumber": "1234567" |
|
"cpTitle": "Lung Cancer Protocol", |
|
"eventLabel": "Initial Visit", |
|
clinicalDiagnosis "Not Specified", [
"3-part fracture of surgical neck of humerus",
"(Idiopathic) normal pressure hydrocephalus"
],
"clinicalStatus": "Operative", |
|
"activityStatus": "Active", |
|
"surgicalPathologyNumber": "1234567" |
|
Error Cases :
| | |
|---|
| 200 | All resources | Specimen Collection group has been created successfully |
| 400 | All requests | Invalid parameters, e.g duplicate name, duplicate barcode, invalid Site Name , duplicate code etc |
| 401 | All requests | Authorization failed, User doesn’t have Authority to create specimen collection group for the given collection protocol |
| 500 | All requests | Internal server error, Encountered server error while performing operations |