Setting up API communication by REST services with TerraIndex for laboratories - Lab assignment file - SIKB0101 v14

Page / - last modified by Robin Huisman on 2024/07/31 23:13

Lab assignment file - SIKB0101 v14

last modified by Robin Huisman

on 2024/07/31 23:13

Table of Contents

A labassignment for a customer to the Laboratory

What is a lab assignment file?

Model structure

LabAssignment

Project

Sample (Specimen)

Package

SampleAnalysisRequest

AnalysisPackage

LabAssignmentRequest

LabAssignmentDelivery

What to store to send the correct results back?

What sample scenario's are exchanged?

A labassignment for a customer to the Laboratory

This chapter contains a detailed explanation of the structure of an Electronic lab assignment that a user can create with TerraIndex and send to your lab.

More information about SIKB0101 can be found here: https://www.sikb.nl/datastandaarden/sikb0101-bodembeheer

What is a lab assignment file?

A Lab assignment file that contains all the information for the lab assignment. This file will be transported in the API call CreateOrder. The lab can read this file, and create an order within the LIMS system, containing all samples, barcodes and requested Analysis.
Example files: labassignment.xml, TI_Example_LO_ANL038464_1066_546-v2.xml

XSD: Ask or SIKB Members can download from: https://www.sikb.nl/datastandaarden/richtlijnen/sikb0101

Controle XSLT: LabAssignment_Controle.xsl

Domaintable files: immetingen lookup v14.8.0.xml imsikb0101 lookup v14.8.0.xml
extracted from: https://codes.sikb.nl

A labassignment for a customer to the Laboratory

What is a lab assignment file?

Model structure

LabAssignment

Project

Sample (Specimen)

Package

SampleAnalysisRequest

AnalysisPackage

LabAssignmentRequest

LabAssignmentDelivery

What to store to send the correct results back?

Lab assignment file

What sample scenario's are exchanged?

Model structure

LabAssignment

Attribute	Notes
identification NEN3610ID	A unique code that is created when the object is created for the first time.
operatingLab GenericName	Code of the laboratory to which the assignment is assigned. Domaintable: Meetinstantie / Measuring Company
startTime DateTime	Dispatch date of the lab assignment
customerCode CharacterString	Client code or debtor number of the client as known by the laboratory
remarks CharacterString [0..1]	Comments on a lab assignment
endTime DateTime [0..1]	Dispatch date of the final lab results

Project

<digital exchange of soil-related data>

Activity that leads to the collection of soil data

Unique process, consisting of a set of coordinated and controlled activities with start and finish dates, undertaken to achieve an objective conforming to specific requirements, including the constraints of time, cost and resources [ISO 10006], in this case the collection or interpretation of soil data.

Note 1: An individual project may form part of a larger project structure.

Note 2: In some projects, the objective(s) is (are) refined and the product characteristics defined progressively as the project proceeds. (IEC 62198:2001).

Note 3: The data can be existing or new.

Attribute	Notes
identification NEN3610ID	The unique identifier of the Project in TerraIndex and in the whole Exchange Chain
name CharacterString [0..1]	The name of the project where the lab assignment is made for
projectCode CharacterString	The project code of the project where the lab assignment is made for

Sample (Specimen)

Attribute	Notes
identification NEN3610ID	The unique identifier of TerraIndex for the analyses sample
name CharacterString [0..1]	Name given to the sample
specimenType GenericName [0..1]	Type of Sample- Fieldsample, Analysissample Domaintable: MonsterType / SampleType
materialClass GenericName	An SIKB code for the matrix type. Soil, Groundwater etc.. Domaintable: Compartiment / Matrix
startTime DateTime [0..1]	DateTime the sample is created of taken on the site or location.
lowerDepth Depth [0..1]	The ending depth where the sample was taken from.
upperDepth Depth [0..1]	The starting depth where the sample was taken from.
remarks CharacterString [0..1]	Comments on a sample
size Measure [0..1]	The total weight or volume of the material taken into the sample/specimen.

Package

===> Q Luca: What about "consistsOfPackages"? it seems to be overlayed on top of "Barcode" in the Class Diagram

Attribute	Notes
name CharacterString [0..1]	Name given to the package container of the specimen/sample
barcode CharacterString [0..1]	Barcode on the package container of the specimen/sample
packageType GenericName	Type of container, like: bottle, jar, sachet, bucket Domaintable: MonsterVerpakking / Sample package container
remarks CharacterString [0..1]	Extra remark for the container
packageMaterialType GenericName [0..1]	Type of container material, like: glass, rvs, plastic, etc Domaintable: MateriaalMonsterVerpakking / Sample package material

SampleAnalysisRequest

Attribute	Notes
nameOnLabCertificate CharacterString [0..1]	Name of the sample for reporting in the certificate PDF.
certificateOrder int [0..1]	Order of reporting in the certificate PDF
labSampleType CharacterString [0..1]	The laboratory specific sample/specimen type, based on what kind of analysis will be request and the sample should be handled. The options a user can request are sent in the Labdelivery file, defined by the lab. Options are like: Soil, Soil Walloon, Wastewater, Groundwater, Groundwater Walloon, Asbestos, Building materials. The codes/values are defined by the lab, and should correspond with the LIMS information.

AnalysisPackage

Attribute	Notes
analysisPackageCode CharacterString	The code value of the requested Analysis (package) defined by the lab, and should correspond with the LIMS information. The options a user can request are sent in the Labdelivery file, defined by the lab.
description CharacterString [0..1]	Description/name of the requested analysis (package).

LabAssignmentRequest

Attribute	Notes
orderNumber CharacterString [0..1]	Order number used by the client (equal to ID order if not filled in by the client), this number must be stated on the laboratory invoice addressed to the client.
urgencyCode CharacterString [0..1]	Urgency of the assignment; Code, laboratory dependent The options a user can request are sent in the Labdelivery file, defined by the lab. The codes/values are defined by the lab, and should correspond with the LIMS information.
reservationNumber CharacterString [0..1]	Reservation Number - A reservation number provided by the laboratory to the client
isAgreement Boolean [0..1]	If a special price arrangement/agreement has been made with the lab for the assignment (0=No; 1=Yes)
agreementNumber CharacterString [0..1]	Price arrangement/agreement number - If 'isAgreement' = True, the appointment number to which the appointment relates can be entered here

LabAssignmentDelivery

Attribute	Notes
samplesDate Date	Date the fieldsamples have been delivered or send towards the lab.
transportationNumber CharacterString [0..1]	Transportation number given by the courier that transports the fieldsamples.

What to store to send the correct results back?

The 'Lab Assignment' data stream facilitates the exchange between, for example, a consultancy firm and a laboratory. It is used to exchange a request for analysis on specific samples.

Important fields:

Entity	Fixed Value	Remarks
Project	lokaalID (GUID)
projectCode
Lab Assignment	lokaalID (GUID)
Sample (Analysis sample)	lokaalID (GUID)
Name
Sample (Field monster)	lokaalID (GUID)

What sample scenario's are exchanged?

Field Sample -> Mixed Sample
- Field Sample – AA, materialClass = 1 (Soil), specimenType = 1 (Fieldsample)
o Packaging – Pot AA-1, barcode: ffdsgfdkds
o Reference to Mixed Sample : MM1
- Field Sample – BB, materialClass = 1 (Soil), specimenType = 1 (Fieldsample)
o Packaging – Pot BB-1, barcode: sadfnmsds
o Reference to Mixed Sample: MM1
- Mixed Sample – MM1, materialClass = 1 (Soil), specimenType = 10 (Analysissample)
o Reference to Subsample: AA
o Reference to Subsample: BB
o Lab Analysis Request
o Lab Results
Field Sample individual pot
- Field Sample– BO01-1, materialClass = 1 (Soil), specimenType = 1 (Fieldsample)
o Packaging – Pot BO01-1, barcode: fdmsakfds
o Reference to Analysis Sample: M1
- Analysis Sample– M1, materialClass = 1 (Soil), specimenType = 10 (Analysissample)
o Reference to Subsample: BO01-1
o Lab Analysis Request
o Lab Results
Water Sample (with multiple bottles)
- Field Sample – WA1, matrix = GW (SampleType = 1)
o Packaging – Bottle WA1-1, barcode: dfsfdslasd
o Packaging – Bottle WA1-2, barcode: fdsvfdsvfs
o Packaging – Bottle WA1-3, barcode: kjhgfvvxx
o Reference to Analysis Sample: WA1_Sample
- Analysis Sample – WA1_Sample, matrix = GW (ID=2) (SampleType = 10)
o Reference to Subsample: WA1
o Lab Analysis Request
o Lab Results
Analysis Sample met Leachate Samples
- Field Sample – BO01-1, matrix = GR (SampleType = 1)
o Packaging – Pot BO01-1, barcode: fdmsakfds
o Reference to Leachate Sample: M1
- Analysis Sample – M1, matrix = GR (SampleType = 10)
o Reference to Subsample: BO01-1
o (optional) Reference to Leachate Sample: M1_Leachate1
o (optional) Reference to Leachate Sample: M1_Leachate2
o Lab Analysis Request
o Lab Results
o (optional) Lab Results (Leaching, LS/10)
- Leachate Sample – M1_Leachate1, matrix = GR (SampleType = 9)
o Reference to Subsample: BO01-1
o Fraction Code = filled
o Lab Results Leaching
- Leachate Sample – M1_Leachate2, matrix = GR (SampleType = 9)
o Reference to Subsample: BO01-1
o Fraction Code = filled
o Lab Results Leaching