/
Update specimen status
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Update specimen status

PUT openspecimen/rest/ng/specimens/{specimenId}/status

Use this API to update status of specific specimen.

Parameter Details:

This API accepts specimen ID in URL and status details in JSON format.

ParameterDetails
statusThe status of the specimen.
reasonReason for change in status.

Result:

This API provides updated specimen details as result. If specimen is not found for given specimen ID then error message is given.

API Example:

URLhttp://localhost:8080/openspecimen/rest/ng/specimens/1
MethodPUT
Requestapplication/json
JSON

{

  "status": "Collected",

  "Reason": "The specimen sample is collected"

}

Response

{

  "id": 1,

  "cpId": 1,

  "cprId": 1,

  "eventId": null,

  "visitId": 1,

  "visitName": "first visit",

  "cpShortTitle": "blood",

  "reqId": 1,

  "sortOrder": null,

  "label": "blood1",

  "barcode": null,

  "type": "Whole Blood",

  "specimenClass": "Fluid",

  "lineage": "New",

  "anatomicSite": "Autonomic nervous system, NOS",

  "laterality": "Not Applicable",

  "status": "Collected",

  "reqLabel": "whole blood",

  "pathology": "Malignant, Pre-Invasive",

  "initialQty": 250,

  "availableQty": 220,

  "available": true,

  "concentration": 10,

  "parentId": null,

  "parentLabel": null,

  "storageLocation": {

    "id": 1,

    "name": "Fluid Container",

    "positionX": "1",

    "positionY": "A"

  },

  "storageType": "Auto",

  "collectionContainer": null,

  "activityStatus": "Active",

  "createdOn": 1442993220000,

  "code": null,

  "distributed": true,

  "collectionEvent": null,

  "receivedEvent": null,

  "labelFmt": null,

  "biohazards": [],

  "comments": null,

  "closeAfterChildrenCreation": null,

  "children": [],

  "pooledSpecimenId": null,

  "pooledSpecimenLabel": null,

  "specimensPool": null,

  "closeParent": null,

  "poolSpecimen": false,

  "extensionDetail": null

}

Related content

REST APIs
REST APIs
Read with this
Specimen
Specimen
Read with this
Color coding by Specimen Status
Color coding by Specimen Status
Read with this
Get Specimen Event Forms
Get Specimen Event Forms
Read with this
Check specimen exists
Check specimen exists
Read with this
Specimen Search
Specimen Search
Read with this
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com