/openspecimen/rest/ng/visits
This rest api is used to add visit of registered participant. Use HTTP POST 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 | System generated identifier for 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. |
Note :
To invoke the create visit API, following fields are mandatory
- cprId or (ppid and cpTitle) or (ppid and cpShortTitle)
- name
- site
API URL:
http[s]:<host>:<port>/openspecimen/rest/ng/visits
Use this URL to add visit for a registered participant in OpenSpecimen application.
Result:
The response of this request will contains the details of the created visit.
Below is the example of the create participant:
| URL | openspecimen/rest/ng/visits |
| Request type | application/json |
| Method | POST |
| json | {
"name": "LP-5600-W0-PD",
"code": "1",
"cpTitle": "Lung Cancer Protocol",
"cprId": 101,
"eventId": 1,
"eventLabel": "Initial Visit",
"eventPoint": 0,
"clinicalDiagnoses": [
"3-part fracture of surgical neck of humerus",
"(Idiopathic) normal pressure hydrocephalus"
],
"clinicalStatus": "Operative",
"activityStatus": "Active",
"site": "Site 1",
"visitDate": "2015-11-23",
"status": "Complete",
"surgicalPathologyNumber": "1234567",
"cohort": "Treated"
}
|
Response | {
"id": 1
"name": "LP-5600-W0-PD",
"code": "1",
"cpTitle": "Lung Cancer Protocol",
"cprId": 101,
"eventId": 1,
"eventLabel": "Initial Visit",
"eventPoint": 0,
"clinicalDiagnoses": [
"3-part fracture of surgical neck of humerus",
"(Idiopathic) normal pressure hydrocephalus"
],
"clinicalStatus": "Operative",
"activityStatus": "Active",
"site": "Site 1",
"visitDate": "2015-11-23",
"status": "Complete",
"surgicalPathologyNumber": "1234567",
"cohort": "Treated"
}
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Visit 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 visit for the given collection protocol |
| 500 | All requests | Internal server error, Encountered server error while performing operations |