This API is used to create derived specimen requirements.
| URL | /openspecimen/rest/ng/specimen-requirements/{parent-req-id}/derived |
| Method | POST |
| Body | { "code": "PL", "specimenClass": "Fluid", "type": "Plasma", "anatomicSite": "Not Specified", "laterality": "Not Specified", "pathology": "Not Specified", "quantity": 10, "concentration": 1.1, "labelFmt": null} |
Response
HTTP Status Code | Description |
|---|---|
| 200 | The derived specimen requirement is created and is assigned a unique ID. The response body contains the requirement details along with the unique ID. This unique ID can be used later to update, retrieve or create aliquots. |
| 400 | Something incorrect with the request. The response body contains the error code and the human readable error message. |
| 500 | Something wrong with the server. Please contact support along with the request payload and exception stack trace. |
Request Parameters
Parameter | Description |
|---|---|
| code | Unique code assigned to the specimen within the event/visit. Useful in generation of specimen labels, generating collection reports, and bulk importing planned specimen records. For this, CP coding setting needs to be enabled. |
| specimenClass | Specimen class. Fluid, Cell, Molecular, Tissue. |
| type | Specifies the type of specimen. Example: Whole Blood, Fresh Tissue etc. The value should be one of the allowed values configured in the PV list for specimen type. |
| anatomicSite | The part of the body from which the specimen was retrieved. Example Cerebrum, Liver etc |
laterality | The side of the part from which the specimen was retrieved. Example - Left, Right etc |
| pathology | Indicates whether the specimen is cancerous. Example - Malignant, Non-Malignant etc |
| quantity | Quantity of specimen to be collected. Example: 10 ml of Whole Blood |
| concentration | Mostly relevant for molecular specimens like DNA, RNA to determine the purity of samples. |