Got feedback or spotted a mistake?
Leave a comment at the end of this page or email contact@krishagni.com
JSON: Specimen Default Fields
Introduction
You can use the configuration settings below to display specimen fields for data entry or read-only access, based on your requirements.
Field Configuration
Field Name | Description | Configuration |
|---|---|---|
Label |
| {
"name": "specimen.label",
"caption": "Label",
"type": "text",
"optional": true,
"showIf": {
"op": "OR",
"rules": [
{
"field": "specimen.labelFmt",
"op": "not_exist"
},
{
"field": "cp.manualSpecLabelEnabled",
"op": "exists"
}
]
}
} |
Barcode |
| {
"name": "specimen.barcode",
"caption": "Barcode",
"type": "text",
"optional": true,
"showIf": {
"op": "OR",
"rules": [
{
"field": "cp.barcodingEnabled",
"op": "==",
"value": "true"
}
]
},
"showInOverviewIf": "useShowIf"
} |
Lineage |
| {
"name": "specimen.lineage",
"caption": "Lineage",
"type": "radio",
"optional": false,
"options": [
{
"value": "New",
"caption": "New"
},
{
"value": "Derived",
"caption": "Derived"
},
{
"value": "Aliquot",
"caption": "Aliquot"
}
]
} |
Collection Status |
| {
"name": "specimen.status",
"caption": "Collection Status",
"type": "dropdown",
"optional": true,
"listSource": {
"selectProp": "value",
"displayProp": "value",
"options": [
{
"value": "Collected"
},
{
"value": "Missed Collection"
},
{
"value": "Pending"
}
]
}
} |
Type |
| {
"name": "specimen.type",
"caption": "Type",
"type": "specimen-type",
"specimen": "specimen",
"optional": false,
"defaultValue": "Not Specified",
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "!=",
"value": "'Aliquot'"
}
]
}
} |
Anatomical Site |
| {
"name": "specimen.anatomicSite",
"caption": "Anatomical Site",
"type": "pvs",
"attr": "anatomic_site",
"optional": true,
"defaultValue": "Not Specified",
"showOnlyLeafValues": true,
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "!=",
"value": "'Aliquot'"
}
]
}
} |
Laterality |
| {
"name": "specimen.laterality",
"caption": "Laterality",
"type": "pvs",
"attr": "laterality",
"optional": true,
"defaultValue": "Not Specified",
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "!=",
"value": "'Aliquot'"
}
]
}
} |
Pathology Status |
| {
"name": "specimen.pathology",
"caption": "Pathology Status",
"type": "pvs",
"attr": "pathology_status",
"optional": true,
"defaultValue": "Not Specified",
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "!=",
"value": "'Aliquot'"
}
]
}
} |
Initial Quantity |
| {
"name": "specimen.initialQty",
"caption": "Initial Quantity",
"type": "specimen-quantity",
"specimen": "specimen",
"optional": true
} |
Available Quantity |
| {
"name": "specimen.availableQty",
"caption": "Available Quantity",
"type": "specimen-quantity",
"specimen": "specimen",
"optional": true
} |
Concentration |
| {
"name": "specimen.concentration",
"caption": "Concentration",
"type": "specimen-quantity",
"specimen": "specimen",
"measure": "concentration",
"pattern": "/^([0-9]+|[0-9]*\\.?[0-9]+[e]?[+-]?[0-9]*)$/",
"optional": true
} |
Parent Specimen |
| {
"name": "specimen.parentLabel",
"caption": "Parent Specimen",
"type": "text",
"optional": false,
"url": "specimen({specimenId: specimen.parentId})",
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "!=",
"value": "'New'"
}
]
},
"modelOpts": {
"updateOn": "blur"
},
"showInOverviewIf": "useShowIf"
} |
Biohazards |
| {
"name": "specimen.biohazards",
"caption": "Biohazards",
"type": "pvs",
"multiple": true,
"attr": "specimen-biohazard",
"optional": true,
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "==",
"value": "'New'"
}
]
},
"showInOverviewIf": "useShowIf"
} |
Location |
| {
"name": "specimen.storageLocation",
"caption": "Location",
"type": "storage-position",
"optional": true,
"cpId": "specimen.cpId",
"entity": "specimen",
"url": "container-detail.locations({containerId: specimen.storageLocation.id})",
"subFields": [
{
"name": "name",
"caption": "Container Name"
},
{
"name": "positionY",
"caption": "Container Row"
},
{
"name": "positionX",
"caption": "Container Column"
}
]
} |
Created On |
| {
"name": "specimen.createdOn",
"caption": "Created On",
"type": "datetime",
"optional": false,
"defaultValue": "current_date",
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "!=",
"value": "'New'"
}
]
},
"showInOverviewIf": "useShowIf"
} |
Freeze Thaw Cycles |
| {
"name": "specimen.freezeThawCycles",
"caption": "Freeze Thaw Cycles",
"type": "text",
"optional": true,
"pattern": "/^[0-9][0-9]*$/"
} |
Increment parent specimen's Freeze/Thaw cycles? |
| {
"name": "specimen.incrParentFreezeThaw",
"caption": "Increment parent specimen's Freeze/Thaw cycles?",
"type": "radio",
"optional": true,
"options": [
{ "caption": "Yes", "value": 1 },
{ "caption": "No", "value": 0 }
],
"showInOverviewIf": "!!specimen.incrParentFreezeThaw"
} |
Comments |
| {
"name": "specimen.comments",
"caption": "Comments",
"type": "textarea",
"optional": true
} |
Collection Date and Time |
| {
"name": "specimen.collectionEvent.time",
"caption": "Collection Date and Time",
"type": "datetime",
"defaultValue": "current_date",
"optional": true,
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "==",
"value": "'New'"
},
{
"field" : "specimen.status",
"op" : "==",
"value" : "'Collected'"
},
{
"field": "specimen.reqId",
"op": "not_exist"
}
]
},
"showInOverviewIf": "useShowIf"
} |
Collector |
| {
"name": "specimen.collectionEvent.user",
"caption": "Collector",
"type": "user",
"defaultValue": "current_user",
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "==",
"value": "'New'"
},
{
"field" : "specimen.status",
"op" : "==",
"value" : "'Collected'"
},
{
"field": "specimen.reqId",
"op": "not_exist"
}
]
},
"subFields": [
{
"name": "emailAddress",
"caption": "Collector Email Address"
}
],
"showInOverviewIf": "useShowIf"
} |
Collection Container |
| {
"name": "specimen.collectionEvent.container",
"caption": "Collection Container",
"type": "pvs",
"attr": "collection-container",
"optional": true,
"defaultValue": "Not Specified",
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "==",
"value": "'New'"
},
{
"field" : "specimen.status",
"op" : "==",
"value" : "'Collected'"
},
{
"field": "specimen.reqId",
"op": "not_exist"
}
]
},
"showInOverviewIf": "useShowIf"
} |
Collection Procedure |
| {
"name": "specimen.collectionEvent.procedure",
"caption": "Collection Procedure",
"type": "pvs",
"attr": "collection-procedure",
"defaultValue": "Not Specified",
"optional": true,
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "==",
"value": "'New'"
},
{
"field" : "specimen.status",
"op" : "==",
"value" : "'Collected'"
},
{
"field": "specimen.reqId",
"op": "not_exist"
}
]
},
"showInOverviewIf": "useShowIf"
} |
Receiver |
| {
"name": "specimen.receivedEvent.user",
"caption": "Receiver",
"type": "user",
"defaultValue": "current_user",
"showIf": {
"op": "AND",
"rules": [{
"field": "specimen.lineage",
"op": "==",
"value": "'New'"
},
{
"field" : "specimen.status",
"op" : "==",
"value" : "'Collected'"
},
{
"field": "specimen.reqId",
"op": "not_exist"
}
]
},
"showInOverviewIf": "useShowIf",
"subFields": [{
"name": "emailAddress",
"caption": "Collector Email Address"
}]
} |
Received Date and Time |
| {
"name": "specimen.receivedEvent.time",
"caption": "Received Date and Time",
"type": "datetime",
"defaultValue": "current_date",
"optional": true,
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "==",
"value": "'New'"
},
{
"field" : "specimen.status",
"op" : "==",
"value" : "'Collected'"
},
{
"field": "specimen.reqId",
"op": "not_exist"
}
]
},
"showInOverviewIf": "useShowIf"
} |
Received Quality |
| {
"name": "specimen.receivedEvent.receivedQuality",
"caption": "Received Quality",
"type": "pvs",
"attr": "received-quality",
"defaultValue": "Acceptable",
"optional": true,
"showIf": {
"op": "AND",
"rules": [
{
"field": "specimen.lineage",
"op": "==",
"value": "'New'"
},
{
"field" : "specimen.status",
"op" : "==",
"value" : "'Collected'"
},
{
"field": "specimen.reqId",
"op": "not_exist"
}
]
},
"showInOverviewIf": "useShowIf"
} |
External IDs | Code to capture the details of specimen external IDs in openspecimen using this field. | {
"name": "specimen.externalIds",
"type": "collection",
"caption": "External IDs",
"fields": [
{
"name": "name",
"caption": "External Name",
"type": "text",
"optional": true
},
{
"name": "value",
"caption": "External Value",
"type": "text",
"optional": true
}
]
} |
Req ID |
| {
"name": "specimen.reqId",
"caption": "Req ID",
"type": "span"
} |
Req Label |
| {
"name": "specimen.reqLabel",
"caption": "Req Label",
"type": "span"
} |
Req Code |
| {
"name": "specimen.reqCode",
"caption": "Req Code",
"type": "span"
} |
Got feedback or spotted a mistake?
Leave a comment at the end of this page or email contact@krishagni.com