Page Comparison

/openspecimen/rest/ng/visits

This API is available for add visit for.

List of mandatory fields:

cprId
eventId
ppid
eventLabel
eventPoint
cpTitle
cpShortTitle
name
clinicalDiagnosis
clinicalStatus
activityStatus
site
status
comments
surgicalPathologyNumber
missedReason
missedBy - (User Details)
visitDate
code
cohort

...

used to add/create a new visit of pre-registered participant. Use HTTP POST method to invoke this API by passing below payload details in JSON format.

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

Parameter	Description
cprId	System generated identifier of the registered participant
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 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

Code Block

language	js

{
"cprId":5,
"eventId":2,

   "cpShortTitle":"CNS"
   "name":"skinCancerStudy_1_11",
   "clinicalDiagnosis":"Not Specified",
   "clinicalStatus":"Not Specified",
   "activityStatus":"Active",
   "site":"ATCC",
   "collectionStatus":"Complete",
   "surgicalPathologyNumber":"path123"
}

Response

{
   "id":1,
   "cprId":5,
   "cpeId":2,
   "name":"skinCancerStudy_1_11",
   "clinicalDiagnosis":"Not Specified",
   "clinicalStatus":"Not Specified",
   "activityStatus":"Active",
   "collectionSiteName":"ATCC",
   "collectionStatus":"Complete",
}

...

linenumbers	true

{
"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

Code Block

language	js
linenumbers	true

{
 "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

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

authority to create

specimen collection group

visit for the given collection protocol
500	All requests	Internal server error, Encountered server error while performing operations

Versions Compared

Old Version 6

New Version Current

Key