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

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

Lab result file - SIKB0101 v14 
last modified by Robin Huisman
on 2024/07/31 23:33

Table of Contents
Exporting lab results to TerraIndex for a customer
What is a Lab result file?
Model Structure
Metadata
Labassignment
Structure projectgegevens
Structure analysemonsters
Structure analyseresultaten
What to exchange to bind the right results to the right sample?
SIKB 14 Parameter result combinations

Exporting lab results to TerraIndex for a customer
Returning the labresults to the client, that requested the analysis on samples.
More information about SIKB0101 can be found here: https://www.sikb.nl/datastandaarden/sikb0101-bodembeheer 
What is a Lab result file?
A lab result file is an XML file contains all the lab results. The results are mapped tot their analyses samples. A lab result will be matched to the corresponding analyses sample based on the: “Labassignment Guid/SIKB-ID, projectCode, AnalysisSample Guid/SIKB-ID”
Example files: labresultaat_MengmonsterGr.xml, labresultaat_IndividueelGr.xml, labresultaat_IndividueelGw.xml
XSD: Ask or SIKB Members can download from: https://www.sikb.nl/datastandaarden/richtlijnen/sikb0101
Controle XSLT: Labresult_Controle.xsl
Domaintable files: immetingen lookup v14.8.0.xml   imsikb0101 lookup v14.8.0.xml
extracted from: https://codes.sikb.nl 
•	Exporting lab results to TerraIndex for a customer
•	What is a Lab result file?
•	Model Structure
•	Metadata
•	
Labassignment
•	MeasureResult
•	Accuracy
•	 
•	 
•	 
•	AnalyticResult
•	 
•	 
•	 
•	 
•	 
•	Structure projectgegevens
•	Structure analysemonsters
•	Structure analyseresultaten
•	 
•	What to exchange to bind the right results to the right sample?
•	SIKB 14 Parameter result combinations
Model Structure

Metadata
Attribute name	Description	Unit	
version	The SIKB version of the lab results file. This must be: 14.8.0 or 14.9.0	string	
application	This is the application code of your LIMS system that you will get from TerraIndex. Be careful this is not the same code as your laboratory number. Your applicationcode can be requested of found here: https://codes.sikb.nl/tablet/domain-table-details/50be26c9-5e66-46c9-9373-9d402762876f 	Integer	
reportDate	The date on which the lab result file was made	date
yyyy-mm-dd	
supplier	The number you get from TerraIndex. This needs to be the same as the laboratorium number in the lab delivery file. Your supplier code can be requested of found here: https://codes.sikb.nl/tablet/domain-table-details/dc2ad4df-f958-4146-aee8-31f8c2f1c74b	string	
dataflow	Should be '1' in this case, what stands voor 'AnalysisResults'. Other option can be found here: https://codes.sikb.nl/tablet/domain-table-details/79365ded-f56a-4f10-ba45-16bac69752d9	integer	

Labassignment
The labassignmentpart is the same as in the labassignment: Lab assignment file - SIKB0101 v14 
With 3 differences:
•	Status on the labassignment itself
•	Status on the labassignment.sample link
•	The labassignment Report number can be send in: LabAssignmentCertificate
MeasureResult
Attribute Name	Description	
numericValue Measure	Numeric Value - the numerical value of the observation. When no unit for the measurement is known, the unit 'Dimensionless' should be used.	
valueProcessingMethod GenericName	Value Processing Method - a mathematical/statistical operation that is applied while the method of value determination/analysis standard remains unchanged.
The operation can be applied to a series of measurement values with the same parameter (quantity/component or typing or taxon or object) or to a series of measurement values with the same analysis method that are summed up to a sum parameter.
Domain table: Value Processing Method	
qualityIndicatorType GenericName	Quality Indicator/Judgement -> Detection limit, etc.
Domain table: Quality Judgement	
Accuracy
Attribute Name	Description	Unit	
recovery Float	The part (percentage) of material that is recovered in an analysis.	Percentage [%]	
spread Float	Spread = the error measured (in %) in multiple repeated measurements of the same sample/situation (and by the same laboratory technician/measuring device).	Percentage [%]	
measurementUncertainty Float	Measurement uncertainty = the total error in the analysis (in %), considering sample collection, variation in measuring equipment/lab technician, and repeated measurements. It practically represents the value indicating the uncertainty of the measurement result.	Percentage [%]	
zScore Float	This is an optional value that indicates how the measurement value scores in relation to other techniques or laboratories. This could be from interlaboratory comparisons or comparisons between different measuring equipment.	 	
drift Float	This is the degree of sensor drift over time (in %/year). Sensors will age over time and experience more or less drift depending on the conditions. This drift can be quantified and depends partly on age. This is especially true for online sensors.	Percentage [%]	
AnalyticResult
The analyzed result of an observation, typically originating from a laboratory.
Attribute Name	Description	
limitSymbol CharacterString	LimietSymbool, allowed values: '&lt;' en '&gt;'.
'&lt;' stands for 'less than the lowest threshold'
'&gt;' stands for 'greater than the highest threshold'
The boundary for the limit symbol can be specified in the DeterminationLimits (LimitSymbolReferenceCode) as a reference with the actual value of the limit. The value can be included in the exchange in two ways:
1) as a CData block: <![CDATA[<]]> or <![CDATA[>]]>
2) as HTML code: '&amp; lt;' or '&amp; gt;'	
alphanumericValue CharacterString	Textual value associated with an analysis result	
Structure projectgegevens

Attribute name	Description	Unit	
idopdracht	The TerraIndex id of the lab assignment the result belongs to.	-	
projectcode	The project code of the project as it was delivered in the lab assignment	string	
projectnaam	The name of the project as it was delivered in the lab assignment.	string	
ordernummer	Not relevant. The order in which the lab result could be shown	string	
projectleider	The project leader of the customer. This needs the be the “contactpersoon” from the lab assignment with the code PL	string	
status	The status of the lab assignment. See Labstatus Codegroup 76 in the attachments for all the options.	integer	
datumverwacht	The date on which the lab expects the certificate to be available	Date
yyyy-mm-dd	
certificaatnummer	The number of the certificate that will be send to the user.	string	
analysemonsters
 	A table containing all the analysis sample with their corresponding results	-	
Structure analysemonsters

Attribute name	Description	Unit	
Idanlmons	The unique identification code of the analyses sample as given in the lab assignment file	string	
Anlmons	The name of the analyses sample as given in the lab assignment file	string	
Certificaat	The way the name of the sample should be on the certificate. This is also given in the lab assignment	string	
Monstersoort	The code referencing the type the sample is. Check the attachment: Sample type codegroup 51 for all the options	integer	
Status	The status of the sample. See Labstatus Codegroup 76 in the attachments.	integer	
Datumverwacht	The date on which the results for the sample are expected	date
yyyy-mm-dd	
Volgorde	Is a unused field in TerraIndex	integer	
analyseresultaten	A table containing all the measurement values of the analysis samples.	-	
Structure analyseresultaten

Attribute name	Description	Unit	
componentcode	The SIKB component code. See ComponentCode Codegroup 52 in the attachements for all possible options.	integer	
meetwaarde	What the measured value is for the analyses	float	
meetwaardeomschrijving	Alpha numerical description of the result	string	
eenheidcode	The unit of the measured value. See Unit CodeGroup 40 in the attachements for all possible options	integer	
referentiecode	This defines what the reference for the measurement value is. See ReferenceType CodeGroup 41 for all the possible options	integer	
analysenorm	Against which standard the analysis has been tested. See Laboratory method Codegroup 57 in the attachments for all the option. I your standard is not in the list leave this empty	integer	
datummonstervoorbehandeling	The date on which the sample was pre-treated. We don’t do anything with this value	date
yyyy-mm-dd	
opmerking	A remark for this result	string	
certificering	Under which certificate the analyses has been done. See CertificateCode Codegroup 48 for all the possible options. If you do not find you code leave this field empty	integer	
status	The status of the labresult in the labassignemnt. See Labstatus Codegroep 76 in the attachments	integer	
datumverwacht	Date on which the analyses results are expected.	date	
What to exchange to bind the right results to the right sample?
The data stream ‘Lab Result’ is the feedback of analysis results on the requested lab assignment at a laboratory. At import we need to bind it onto the correct sample.
This requires importand field to match the samples in the xml to the samples in our database.
Important fields:
Entity	Fixed value	Remark	
Project	lokaalID (GUID)	As submitted in the Lab assignment XML	
 	projectCode	As submitted in the Lab assignment XML	
Labassignment	lokaalID (GUID)	As submitted in the Lab assignment XML	
Sample (analysis sample)	lokaalID (GUID)	As submitted in the Lab assignment XML, if assignment in SIKB<11, but results in >=11; fill with old BISNR/IDANLMONS.	
 	Name	As submitted in the Lab assignment XML	
Sample (field sample)	lokaalID (GUID)	Only if this entity is included, which is optional.	
Remarks:
•	The entity ‘Analysis Result’ does not yet have a fixed lokaalID (GUID), connected laboratories cannot yet guarantee that a unique ID will be generated.
•	For Asbestos and Asphalt, new samples are also created at the Lab, which are therefore fed back with a reference to the sample from which they are derived.
•	There is still a desire to feedback from a lab whether an analysis sample has been modified at the lab in terms of sub-samples. For example, if a jar has broken and been replaced with another jar. This has not yet been included in current practices.
Importing the data will be done based on the following steps:
•	Search Project with Project.lokaalID (as placed in the Lab assignment XML).
•	Search Project with Project.ProjectCode (as placed in the Lab assignment XML) if searching on Project.LokaalID yields no results.
•	Search Project and Lab assignment with Labassignment.LokaalID (as placed in the Lab assignment XML) if the Project has not yet been found.
•	Search Project (if Project not yet found) and Analysis Sample with Sample.LokaalID as GUID (as placed in the Lab assignment XML, version 11 and higher).
•	Search Project (if Project not yet found) and Analysis Sample with Sample.LokaalID as BISNR (as placed in the Lab assignment XML, versions lower than 11, 'old' idanlmons/BISNR).
•	Search Analysis Sample with Sample.Name within the project, if the Analysis Sample has not been found but the project has.
What can be imported?
•	If an Analysis Sample is found, the Analysis Results are always updated or added.
•	If Project is found, but the analysis sample is not; then this analysis sample is imported as a new analysis sample with all results.
•	(If it concerns water samples, a new fictional/temporary measuring point and filter could be created.)
•	 
SIKB 14 Parameter result combinations
In the SIKB0101 version 14 exchange of labresults is combination needed for exchanging the result parameters of the Lab analysis.
It's based on PhysicalProperty, the combination of Quantity, Parameter and Condition.

*small remark, condition will be used as: [0..1] 
Domaintables bound to these fields:
•	Quantity - Parameter, but only group/groep: Grootheid (Quantity)
•	Parameter - Parameter, but mainly group/groep: Chemische Stof (Chemical substance)
•	Condition - Condition, but not group/groeps that refer to Chemical substance.
The combinations are defined for different compartiments like soil/ground, groundwater, wastewater.
Below are some examples, and some attachments included to support all combinations.
2 Examples for Soil:
Parameter Name	Parameter ID	Quantity ID	Quantity name	Condition ID	Condition Name	
lood
(lead)	1116	2725	Massafractie
(Massfraction)	1	t.o.v. drooggewicht
(relative to dry weight)	
minerale olie
(minerale oil)	1200	2725	Massafractie
(Massfraction)	93	koolwaterstoffractie C10-C40 / drooggewicht
(hydrocarbon fraction C10-C40 / dry weight)	
2 Examples for Groundwater:
Parameter Name	Parameter ID	Quantity ID	Quantity name	Condition ID	Condition Name	 	
cyanide-complex	2595	2720	(massa)Concentratie	9	opgeloste fractie (bijv. na filtratie)		
som 29 dioxines (TEQ)	2160	2720	(massa)Concentratie	10	uitgedrukt in Toxiciteit equivalenten		
2 Examples for Wastewater:
Parameter Name	Parameter ID	Quantity ID	Quantity name	Condition ID	Condition Name	 	
cyanide-complex	2595	2720	(massa)Concentratie	8	Niet van toepassing		
som 29 dioxines (TEQ)	2160	2720	(massa)Concentratie	10	uitgedrukt in Toxiciteit equivalenten		
Full combinations sheet:  Full List of AnalysisResult combinations 04-2024.xlsx
We can help you with the right combinations and mappings to your own codes.