Page Comparison

openspecimen/rest/ng/visits/collect

Use this resource to add create visit and collect specimens of that visit.its specimens in one call.

Use HTTP POST method to call this API by passing the below details in JSON format.

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

Parameter	Details

visitName [optional]Name of the visitsprNumber [optional]Surgical pathology number

Here both parameters are optional

...

visit	Visit Details. Please refer Add Visit for attributes of visit.
specimens	Array of specimen details which wanted to collect. Please refer Create Specimen for attributes of specimen.

Result:

The response of this request will contains the details of the visits with anticipated and unplanned collection status.

Below is the example of the get visits by name:

all collected and anticipated specimen details of visit.

URL	`http://<host>:<port>/openspecimen`/rest/ng/visits/

bynamespr?visitName=01

collect

Method

GET

POST

Request

application/json

Json

Code Block

linenumbers	true

{"visit":
  {
    "eventLabel":"Baseline",
    "eventPoint":10,
    "

clinicalDiagnosis

clinicalDiagnoses":

"Not Specified"

 [
        "3-part fracture of surgical neck of humerus", 
		"(Idiopathic) normal pressure hydrocephalus"
	],
    "clinicalStatus":"Not Specified",
    "activityStatus":"Active",
    "code":null,
    "eventId":4,
    "site":"Arkansas Hospital",
    "cpTitle":"Planned Clinical Study",
    "visitDate":

1450377000000

"08-12-2015",
    "cprId":596,
    "status":"Complete"
  },
  "specimens":[
    {
      "initialQty":10,
      "label":null,
      "reqId":4,
      "storageLocation":{id":null,"name":null,"positionX":null,"positionY":null},
      "lineage":"New",
      "concentration":null,
      "status":"Collected",
      "closeAfterChildrenCreation":null,
      "collectionEvent":{"time":"2015-12-

08T15:30:36.766Z

08"},
      "receivedEvent":{"time":"2015-12-

08T15:30:36.766Z

08"},
      "children":[],
      "specimensPool":[]
    }
  ]
}

Response

Code Block

linenumbers	true

{
"visit":

 {
"cprId":

596

 52
"eventId":

4

 86
"ppid":

DWP00014

DWP00004"
"eventLabel":

Baseline

Test"
"eventPoint":

10

 10
"cpId":

2

 2
"cpTitle":

 "Planned Clinical Study"
"cpShortTitle":

 "A Planned Clinical Study FD"
"id":

726

 728
"name":

DWP00014

DWP00004_

Baseline

Test_

331""clinicalDiagnosis": "Not Specified""clinicalStatus": "Not Specified""activityStatus": "Active""site": "Arkansas Hospital""status": "Complete""comments": null"surgicalPathologyNumber": null"sprName": null"missedReason": null"missedBy": null"sprLocked": false"visitDate": 1449595018823"code": null"cohort": null"extensionDetail": null}-"specimens": [1]0: {"id": 2922"cpId": 2"cprId": 596"eventId": null"visitId": 726"visitName": "DWP00014_Baseline_331""cpShortTitle": "A Planned Clinical Study FD""reqId": 4"sortOrder": null"label": "DWP00014.WB.280""autoPrintLabelEnabled": false"barcode": null"type": "Whole Blood""specimenClass": "Fluid""lineage": "New""anatomicSite": "Not Specified""laterality": "Not Specified""status": "Collected""reqLabel": "EDTA Blood""pathology": "Not Specified""initialQty": 10"availableQty": 10"available": true"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": -1"name": null"positionX": null"positionY": null}-"storageType": "Virtual""collectionContainer": null"activityStatus": "Active""createdOn": 1449594960000"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%""biohazards": [0]"comments": null"closeAfterChildrenCreation": null"children": [1]0: {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 5"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Derived""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 5"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Virtual""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [5]0: {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 6"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Aliquot""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 1"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Auto""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PSPEC_LABEL%.%PSPEC_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}-1: {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 7"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Aliquot""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 1"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Auto""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PSPEC_LABEL%.%PSPEC_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}-2: {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 8"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Aliquot""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 1"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Auto""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PSPEC_LABEL%.%PSPEC_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}-3: {"id": null"cpId": null"cprId": null"eventId": null"visitId": null"visitName": null"cpShortTitle": null"reqId": 9"sortOrder": null"label": null"autoPrintLabelEnabled": false"barcode": null"type": "Plasma""specimenClass": "Fluid""lineage": "Aliquot""anatomicSite": "Not Specified""laterality": "Not Specified""status": null"reqLabel": "Plasma""pathology": "Not Specified""initialQty": 1"availableQty": null"available": null"concentration": null"parentId": null"parentLabel": null"storageLocation": {"id": null"name": null"positionX": null"positionY": null}-"storageType": "Auto""collectionContainer": "EDTA Vacutainer""activityStatus": null"createdOn": null"code": null"distributed": null"collectionEvent": null"receivedEvent": null"labelFmt": "%PSPEC_LABEL%.%PSPEC_UID%""biohazards": null"comments": null"closeAfterChildrenCreation": null"children": [0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}[0]"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}--"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}--"pooledSpecimenId": null"pooledSpecimenLabel": null"specimensPool": null"closeParent": null"poolSpecimen": false"extensionDetail": null}--}

code	Applies to	Status Message
200	All resources	Specimen collection groups got successfully
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations

...

333"
"clinicalDiagnoses": [
    "3-part fracture of surgical neck of humerus", 
	"(Idiopathic) normal pressure hydrocephalus"
],
"clinicalStatus": "Not Specified"
"activityStatus": "Active"
"site": "3165 Porder Drive"
"status": "Complete"
"comments": null
"surgicalPathologyNumber": null
"sprName": null
"missedReason": null
"missedBy": null
"sprLocked": false
"visitDate": 1449597053346
"code": null
"cohort": null
"extensionDetail": null
}-
"specimens": [1]
0:  {
"id": 2925
"cpId": 2
"cprId": 52
"eventId": null
"visitId": 728
"visitName": "DWP00004_Test_333"
"cpShortTitle": "A Planned Clinical Study FD"
"reqId": 471
"sortOrder": null
"label": "DWP00004.WB.283"
"autoPrintLabelEnabled": false
"barcode": null
"type": "Whole Blood"
"specimenClass": "Fluid"
"lineage": "New"
"anatomicSite": "Not Specified"
"laterality": "Not Specified"
"status": "Collected"
"reqLabel": null
"pathology": "Not Specified"
"initialQty": 10
"availableQty": 10
"available": true
"concentration": null
"parentId": null
"parentLabel": null
"storageLocation": {
"id": -1
"name": null
"positionX": null
"positionY": null
}-
"storageType": "Auto"
"collectionContainer": null
"activityStatus": "Active"
"createdOn": 1449596760000
"code": null
"distributed": null
"collectionEvent": null
"receivedEvent": null
"labelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%"

...


"biohazards": [0]

...


"comments": null

...


"closeAfterChildrenCreation": null

...


"children": [1]
0:  {
"id": null

...


"cpId": null

...


"cprId": null

...


"eventId": null

...


"visitId": null

...


"visitName": null

...


"cpShortTitle": null

...


"reqId":

...

 472
"sortOrder": null

...


"label": null

...


"autoPrintLabelEnabled": false

...


"barcode": null

...


"type": "Plasma"

...


"specimenClass": "Fluid"

...


"lineage": "Derived"

...


"anatomicSite": "Not Specified"

...


"laterality": "Not Specified"

...


"status": null

...


"reqLabel":

...

 null
"pathology": "

...

Malignant"

...


"initialQty":

...

 10
"availableQty": null

...


"available": null

...


"concentration": null

...


"parentId": null

...


"parentLabel": null

...


"storageLocation": {
"id": null

...


"name": null

...


"positionX": null

...


"positionY": null
}

...

-
"storageType": "

...

Auto"

...


"collectionContainer": "

...

Not Specified"
"activityStatus": null

...


"createdOn": null

...


"code": null

...


"distributed": null

...


"collectionEvent": null

...


"receivedEvent": null

...


"labelFmt": "%PPI%.%SP_TYPE%.%SYS_UID%"

...


"biohazards": null

...


"comments": null

...


"closeAfterChildrenCreation":

...

 null
"pooledSpecimenId": null
"pooledSpecimenLabel": null
"specimensPool": null
"closeParent": null
"poolSpecimen": false
"extensionDetail": null
}-
-
"pooledSpecimenId": null
"pooledSpecimenLabel": null
"specimensPool": null
"closeParent": null
"poolSpecimen": false
"extensionDetail": null
}-
-
}

code	Applies to	Status Message
200	All resources	Specimen collection groups got successfully
401	All requests	Authorization failed, user doesn’t have authority
500	All requests	Internal server error, encountered server error while performing operations

Versions Compared

Old Version 4

New Version Current

Key