/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 Identifier| ppid | Participant protocol identifer |
Collection protocol identifier| identifier |
| eventLabel | Event label |
| eventPoint | Event point |
cpId | | ppid | Participant protocol identifer |
| cpTitle | Collection protocol title |
| cpShortTitle | Collection protocol short title |
| name | Visit name |
| code | Unique code given to visit. Which can used for barcode based data entry |
| clinicalDiagnosis | Clinical diagnosis |
clinicalStatusclinicalDiagnosis (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 pre-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 | |
{| language | js |
|---|
| linenumbers | true |
|---|
| {
"name": "LP-5600-W0-PD", |
|
"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", |
|
232015
"surgicalPathologyNumber": "1234567", |
|
{
| Code Block |
|---|
| language | js |
|---|
| linenumbers | true |
|---|
| {
"id": 1 |
|
"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", |
|
232015
"surgicalPathologyNumber": "1234567", |
|
Error Cases :
Specimen Collection group | 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 specimen collection group | visit for the given collection protocol |
| 500 | All requests | Internal server error, Encountered server error while performing operations |