Versions Compared

Old Version 13

changes.mady.by.user Vinod Gaikwad (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Vinayak Pawar

Saved on

Key

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

/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.

ParameterDescription
cprIdSystem generated identifier
for
of the registered participant
for particular collection protocol
eventIdEvent
Identifier
identifier
eventLabelEvent label
eventPoint [optional]Event pointppId
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 entryclinicalDiagnoses

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
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 invoke the create visit API, following fields are mandatory1.  

  1. cprId

...

  1. or

...

  1. (ppid and

...

  1. cpTitle) or

...

  1. (ppid and cpShortTitle)

2.  eventId or eventLabel

3. Name

4. Site

 

  1. name
  2. 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. 
 

...

Below is the example of the create participant:

 


URLopenspecimen/rest/ng/visits
Request typeapplication/json
MethodPOST
json


Code Block
languagejs
linenumberstrue
{
"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":
23
"2015-11-
2015
23",
"status": "Complete",
"surgicalPathologyNumber": "1234567",
"cohort": "Treated"
}


Response


Code Block
languagejs
linenumberstrue
{
 "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":
23
"2015-11-
2015
23",
"status": "Complete",
"surgicalPathologyNumber": "1234567",
 "cohort": "Treated"
}

...



Error Cases :
code
Applies to
Status Message
200All resourcesVisit has been created successfully
400All requestsInvalid parameters, e.g  duplicate name, duplicate barcode, invalid Site Name , duplicate code etc
401All requestsAuthorization failed, User doesn’t have authority to create visit for the given collection protocol
500All requestsInternal server error, Encountered server error while performing operations