Create Aliquots

label

Label given to aliquot.

initialQty

Specimen quantity to create aliquot.

visitId

Visit id under which the parent specimen is present.

parentId

Parent specimen id of which aliquot will be created.

storageLocation [optional]

Storage location to store the created aliquot.

The location detail is also a JSON object, which contains :

• As Position is optional, If not given then aliquots will be stored virtually.

• If only container name is given then first available position will be allocated in specified container.If position is not available then throws error message.

lineage

This property value should be "Aliquot". This property is used to show that we want to create aliquot of specimen.

status

This value shows the aliquot status. This value should be "Collected".

createdOn

The date:time on which the aliquot is created.

closeAfterChildrenCreation [optional]

This is boolean property. Possible values are true, false.

If value is present on parent specimen detail object then the parent specimen will be closed after aliquots are created.

children

This is the JSON array of specimen details object.

If we are specifying the the closeAfterChildrenCreation option to close the parent specimen then the children array will contain the object of aliquots details which needs to be created.

specimenPool

This is the JSON array of specimen detail object.

This object contains the details of specimens.

URL

openspecimen/rest/ng/specimens/collect

Request

application/json

Method

POST

json

[

{

"initialQty":"10",

"label":"label1",

"visitId":1,

"storageLocation":{"name":"Fluid Container"},

"parentId":1,

"lineage":"Aliquot",

"status":"Collected",

"createdOn":"2015-12-03T04:37:03.779Z",

"children":[],

"specimensPool":[]

},

{

"initialQty":"10",

"label":"label2",

"visitId":1,

"storageLocation":{"name":"Fluid Container"},

"parentId":1,

"lineage":"Aliquot",

"status":"Collected",

"createdOn":"2015-12-03T04:37:03.779Z",

"children":[],

"specimensPool":[]

}

]

Response

1. [

2.    {

3.        "id": 12,

4.        "cpId": 1,

5.        "cprId": 1,

6.        "eventId": null,

7.        "visitId": 1,

8.        "visitName": "first visit",

9.        "cpShortTitle": "blood",

10.        "reqId": null,

11.        "sortOrder": null,

12.        "label": "label1",

13.        "barcode": null,

14.        "type": "Whole Blood",

15.        "specimenClass": "Fluid",

16.        "lineage": "Aliquot",

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

18.        "laterality": "Not Applicable",

19.        "status": "Collected",

20.        "reqLabel": null,

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

22.        "initialQty": 10,

23.        "availableQty": 10,

24.        "available": true,

25.        "concentration": 10,

26.        "parentId": 1,

27.        "parentLabel": "blood1",

28.        "storageLocation":

29.        {

30.            "id": 1,

31.            "name": "Fluid Container",

32.            "positionX": "7",

33.            "positionY": "A" 

34.        },

35.        "storageType": null,

36.        "collectionContainer": null,

37.        "activityStatus": "Active",

38.        "createdOn": 1449117420000,

39.        "code": null,

40.        "distributed": null,

41.        "collectionEvent": null,

42.        "receivedEvent": null,

43.        "labelFmt": null,

44.        "biohazards":

45.        [

46.        ],

47.        "comments": null,

48.        "closeAfterChildrenCreation": null,

49.        "children":

50.        [

51.        ],

52.        "pooledSpecimenId": null,

53.        "pooledSpecimenLabel": null,

54.        "specimensPool": null,

55.        "closeParent": null,

56.        "poolSpecimen": null,

57.        "extensionDetail": null 

58.    },

59.    {

60.        "id": 13,

61.        "cpId": 1,

62.        "cprId": 1,

63.        "eventId": null,

64.        "visitId": 1,

65.        "visitName": "first visit",

66.        "cpShortTitle": "blood",

67.        "reqId": null,

68.        "sortOrder": null,

69.        "label": "label2",

70.        "barcode": null,

71.        "type": "Whole Blood",

72.        "specimenClass": "Fluid",

73.        "lineage": "Aliquot",

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

75.        "laterality": "Not Applicable",

76.        "status": "Collected",

77.        "reqLabel": null,

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

79.        "initialQty": 10,

80.        "availableQty": 10,

81.        "available": true,

82.        "concentration": 10,

83.        "parentId": 1,

84.        "parentLabel": "blood1",

85.        "storageLocation":

86.        {

87.            "id": 1,

88.            "name": "Fluid Container",

89.            "positionX": "8",

90.            "positionY": "A" 

91.        },

92.        "storageType": null,

93.        "collectionContainer": null,

94.        "activityStatus": "Active",

95.        "createdOn": 1449117420000,

96.        "code": null,

97.        "distributed": null,

98.        "collectionEvent": null,

99.        "receivedEvent": null,

100.        "labelFmt": null,

101.        "biohazards":

102.        [

103.        ],

104.        "comments": null,

105.        "closeAfterChildrenCreation": null,

106.        "children":

107.        [

108.        ],

109.        "pooledSpecimenId": null,

110.        "pooledSpecimenLabel": null,

111.        "specimensPool": null,

112.        "closeParent": null,

113.        "poolSpecimen": null,

114.        "extensionDetail": null 

115.    }

116. ]

200