Lab result file - SIKB0101 v14

1

= Reporting lab results to TerraIndex for a customer =

2

3

Returning the labresults to the client, that requested the analysis on samples.

4

5

(% class="box infomessage" %)

6

(((

7

More information about SIKB0101 can be found here: [[https:~~/~~/www.sikb.nl/datastandaarden/sikb0101-bodembeheer>>url:https://www.sikb.nl/datastandaarden/sikb0101-bodembeheer]]

)))

== What is a Lab result file? ==

13

14

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”

15

16

17

**Example files**: [[attach:labresult_IndividualGw.xml||rel="noopener noreferrer" target="_blank"]], [[attach:labresult_IndividualGr.xml||rel="noopener noreferrer" target="_blank"]], [[attach:labresult_MixedSampleGr.xml||rel="noopener noreferrer" target="_blank"]]

18

19

**XSD**: Ask or SIKB Members can download from: [[https:~~/~~/www.sikb.nl/datastandaarden/richtlijnen/sikb0101>>url:https://www.sikb.nl/datastandaarden/richtlijnen/sikb0101]]

20

21

**Controle XSLT**: [[attach:Labresult_Controle.xsl||rel="noopener noreferrer" target="_blank"]]

22

23

**Domaintable files**: [[immetingen lookup v14.8.0.xml>>url:https://wiki.terraindex.com/bin/download/Implementation%20documentation/Setting%20up%20Lab%20communication%20by%20REST%20services%20with%20TerraIndex/Lab%20assignment%20file/WebHome/immetingen%20lookup%20v14.8.0.xml?rev=1.2]] [[imsikb0101 lookup v14.8.0.xml>>url:https://wiki.terraindex.com/bin/download/Implementation%20documentation/Setting%20up%20Lab%20communication%20by%20REST%20services%20with%20TerraIndex/Lab%20assignment%20file/WebHome/imsikb0101%20lookup%20v14.8.0.xml?rev=1.1]]

24

extracted from: **[[https:~~/~~/codes.sikb.nl>>url:https://codes.sikb.nl/]] **

== Model Structure ==

31

32

[[image:IMSIKB0101 - Labresults.png]]

=== Metadata ===

(% class="table-hover" %)

38

|(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**

39

|(% colspan="1" rowspan="1" %)**version**|(% colspan="1" rowspan="1" %)The SIKB version of the lab results file. This must be: **14.8.0 or 14.9.0**|(% colspan="1" rowspan="1" %)string

40

|(% colspan="1" rowspan="1" %)**application**|(% colspan="1" rowspan="1" %)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>>https://codes.sikb.nl/tablet/domain-table-details/50be26c9-5e66-46c9-9373-9d402762876f]] |(% colspan="1" rowspan="1" %)Integer

41

|(% colspan="1" rowspan="1" %)**reportDate**|(% colspan="1" rowspan="1" %)The date on which the lab result file was made|(% colspan="1" rowspan="1" %)(((

date

yyyy-mm-dd

)))

|(% colspan="1" rowspan="1" %)**supplier**|(% colspan="1" rowspan="1" %)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>>https://codes.sikb.nl/tablet/domain-table-details/dc2ad4df-f958-4146-aee8-31f8c2f1c74b]]|(% colspan="1" rowspan="1" %)string

47

|(% colspan="1" rowspan="1" %)**dataflow**|(% colspan="1" rowspan="1" %)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>>https://codes.sikb.nl/tablet/domain-table-details/79365ded-f56a-4f10-ba45-16bac69752d9]]|(% colspan="1" rowspan="1" %)integer

=== Labassignment ===

52

53

The labassignment is the same as in the labassignment file: [[Lab assignment file - SIKB0101 v14>>https://wiki.terraindex.com/bin/view/Implementation%20documentation/Setting%20up%20Lab%20communication%20by%20REST%20services%20with%20TerraIndex/Lab%20assignment%20file/#]]

54

55

With 3 differences/additions:

56

57

* Status on the labassignment itself

58

* Status on the labassignment.sample link

59

* The labassignment Report number can be send in: LabAssignmentCertificate

60

61

|**Attribute**|**Notes**

62

|(((

63

**identification** NEN3610ID

64

)))|(((

65

A unique code that is created when the object is created for the first time.

66

)))

67

|(((

68

**operatingLab** GenericName

)))|(((

Code of the laboratory to which the assignment is assigned.

73

74

Domaintable: [[Meetinstantie / Measuring Company>>url:https://codes.sikb.nl/tablet/domain-table-details/4e270f0a-cefe-446e-9d4d-6666c91180a8]]

75

)))

76

|(((

77

**startTime** DateTime

78

)))|Dispatch date of the lab assignment

79

|(((

80

**customerCode** CharacterString

81

)))|Client code or debtor number of the client as known by the laboratory

82

83

=== LabAssignmentStatus ===

84

85

|**Attribute Name**|**Description**

86

|(((

87

**statusType **GenericName

88

)))|(((

89

The status of the lab assignment.

90

91

Use the value '5' for final reported results.

92

Use other values, or '4', for conceptual values.

93

94

Domain table: [[Labassignment Status>>https://codes.sikb.nl/tablet/domain-table-details/5c6ab373-693e-4039-af8d-93206ce4ebb4]]

95

)))

96

|(((

97

**dateExpected **DateTime

98

)))|(((

99

The date the results can be expected, in case of conceptual results.

100

101

If final, fill with datetime.now.

102

)))

103

104

=== LabAssignmentCertificate ===

105

106

|**Attribute Name**|**Description**

107

|(((

108

**labCertificateNumber **CharacterString

109

)))|The number of the certificate that will be send to the user/client, and what is used in the PDF file as order or report number of the laboratory.

110

|(((

111

**certification **GenericName

112

)))|(((

113

Under which certificate the analyses has been done. If you do not find you code leave this field empty

114

115

Domain table: [[Certification Coding>>https://codes.sikb.nl/tablet/domain-table-details/df7ffd7c-192c-44f7-ae9f-0461d9266b30]]

116

)))

117

118

== LabAssignmentRequest ==

119

120

The connection between the labassignment and the samples with analysisrequests, as send in the labassignment.

121

122

If not retreived in a labassignment, make it yourself so we can import is as new samples.

123

Just fill what you can fill, otherwise leave field empty, based on documentation here: [[Labassignment file - SIKB0101 v14>>https://wiki.terraindex.com/bin/view/Implementation%20documentation/Setting%20up%20Lab%20communication%20by%20REST%20services%20with%20TerraIndex/Lab%20assignment%20file/#]]

== Project ==

Activity that leads to the collection of soil data, as send in the labassignment.

129

It will be used to search the correct project/investiation to bind or create the samples.

130

131

|**Attribute**|**Notes**

132

|(((

133

**identification** NEN3610ID

134

)))|The unique identifier of the Project in TerraIndex and in the whole Exchange Chain, as send in the labassignment

135

|(((

136

**name** CharacterString

137

138

[0..1]

139

)))|The name of the project where the lab results are for, as send in the labassignment

140

|(((

141

**projectCode** CharacterString

142

)))|The project code of the project where the lab results are for, as send in the labassignment

143

144

== Sample (AnalysisSample) ==

145

146

The analysissamples with analysisrequests, as send in the labassignment. The fieldsamples form the labassignment can be skipped in the results file.

147

148

If not retreived in a labassignment, make it yourself so we can import is as new analysissamples.

149

Just fill what you can fill, based on documentation here: [[Labassignment file - SIKB0101 v14>>https://wiki.terraindex.com/bin/view/Implementation%20documentation/Setting%20up%20Lab%20communication%20by%20REST%20services%20with%20TerraIndex/Lab%20assignment%20file/#]]

150

151

(% class="box infomessage" %)

152

(((

153

Please keep these scenario's in mind: [[Analysissample scenario's>>https://wiki.terraindex.com/bin/view/Implementation%20documentation/Setting%20up%20Lab%20communication%20by%20REST%20services%20with%20TerraIndex/Lab%20assignment%20file/#HWhatsamplescenario27sareexchanged3F]]

154

)))

155

156

|**Attribute**|**Notes**

157

|(((

158

**identification** NEN3610ID

159

)))|The unique identifier of TerraIndex for the analyses sample, to keep this value unique forever in the whole exchange chain.

160

|(((

161

**name** CharacterString

162

163

[0..1]

164

)))|Name given to the sample

165

|(((

166

**specimenType** GenericName

[0..1]

)))|(((

Type of Sample- Fieldsample, Analysissample

171

172

For analysissamples fill with value '10'.

173

174

Domaintable: [[MonsterType / SampleType>>url:https://codes.sikb.nl/tablet/domain-table-details/9f956093-baad-4adb-b74d-20c00cef6ab4]]

175

)))

176

|(((

177

**materialClass** GenericName

)))|(((

An SIKB code for the matrix type. Soil, Groundwater etc..

182

183

Domaintable: [[Compartiment / Matrix>>url:https://codes.sikb.nl/tablet/domain-table-details/6134f3bb-6048-431d-a130-01290d84172c]]

)))

== Analysis ==

The measured parameter with it's value and process.

189

190

|**Attribute Name**|**Description**

191

|(((

192

**identification** NEN3610ID

193

)))|The unique identifier of the AnalysisResult, to keep this value unique forever in the whole exchange chain.

194

If not possible to store this in the Lims, generate on the fly.

195

(% class="info" %)|(((

196

**physicalProperty **PhysicalProperty

197

)))|(((

198

The combination of Quantity, Parameter and Condition to provide the parameter that has been measured.

199

**[[See this chapter for the combinations, and the CAS-NR's. >>https://wiki.terraindex.com/bin/view/Implementation%20documentation/Setting%20up%20Lab%20communication%20by%20REST%20services%20with%20TerraIndex/Lab%20result%20file/#HSIKB14Parameterresultcombinations]]**

)))

|**result **AnalyticResult|The result of the analysis, see next chapter.

204

|**procedure **AnalysisProcess|The process that has been used to measure/determine the result, see next chapter.

205

206

=== AnalyticResult (inherited from MeasureResult) ===

207

208

The actual reported value, result of detection limit.

209

210

|**Attribute Name**|**Description**

211

|(((

212

**numericValue** Measure

213

)))|(((

214

Numeric Value - the numerical value of the observation. When no unit for the measurement is known, the unit 'Dimensionless' should be used.

215

216

Domaintable for Units: [[Eenheid>>https://codes.sikb.nl/tablet/domain-table-details/04f4f467-021b-4218-baa8-9742ed977c61]]

217

)))

218

|(((

219

**valueProcessingMethod** GenericName

220

)))|(((

221

Value Processing Method - a mathematical/statistical operation that is applied while the method of value determination/analysis standard remains unchanged.

222

223

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.

224

\\Default the value '5' meaning 'Not available' can and should be used, besides leaving it empty.

225

226

Domain table: [[Value Processing Method>>https://codes.sikb.nl/tablet/domain-table-details/a2310c26-065f-4aec-9440-74892ec77753]]

227

)))

228

|(((

229

**qualityIndicatorType** GenericName

230

)))|(((

231

Quality Indicator/Judgement -> Detection limit, etc.

232

\\Default the value '0' meaning 'Not available' can and should be used, besides leaving it empty.

233

If there is a detectionlimit/reportinglimit, use: '4', meaning 'determenated with full detection limit'

234

235

Domain table: [[Quality Judgement>>https://codes.sikb.nl/tablet/domain-table-details/1e17d9e6-4e0e-4f88-8fe5-c71f6a7931db]]

)))

|(((

**limitSymbol** CharacterString

240

)))|(((

241

LimietSymbool, allowed values: '<' en '>'.

242

243

'<' stands for 'less than the lowest threshold'

244

245

'>' stands for 'greater than the highest threshold'

246

247

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:

248

249

1) as a CData block: <![CDATA[<]]> or <![CDATA[>]]>

250

251

2) as HTML code: '& lt;' or '& gt;'

252

\\Default the value is leaving it empty.

253

If there is a detectionlimit/reportinglimit, use: '<'

254

)))

255

|(((

256

**alphanumericValue** CharacterString

257

)))|Textual value associated with an analysis result

258

259

260

=== AnalysisProcess ===

261

262

The process that has been used to detemine the measured value or result.

263

264

|**Attribute Name**|**Description**

265

|(((

266

**identification** NEN3610ID

267

)))|The unique identifier of the AnalysisProcess, it can be bound to multiple results at once.

268

|**analyticalTechnique **GenericName|(((

269

The used analytical technique to detemine the result.

270

271

Domain table: [[AnalyticalTechnique>>https://codes.sikb.nl/tablet/domain-table-details/04be2365-3d05-4903-a53e-edafef7111e8]]

272

)))

273

|**certification **GenericName|(((

274

The used certification to detemine the result.

275

276

Domain table: [[CertificationCode>>https://codes.sikb.nl/tablet/domain-table-details/04be2365-3d05-4903-a53e-edafef7111e8]]

277

)))

278

|**valuationMethod **GenericName|(((

279

The used valuation method to detemine the result.

280

281

Domain table: [[ValuationMethod>>https://codes.sikb.nl/tablet/domain-table-details/04be2365-3d05-4903-a53e-edafef7111e8]]

282

)))

283

284

= What to exchange to bind the right results to the right sample? =

285

286

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.

287

288

This requires importand field to match the samples in the xml to the samples in our database.

289

290

**Important fields:**

291

292

|=Entity|=Fixed value|=Remark

293

|**Project**|lokaalID (GUID)|As submitted in the Lab assignment XML

294

| |projectCode|As submitted in the Lab assignment XML

295

|**Labassignment**|lokaalID (GUID)|As submitted in the Lab assignment XML

296

|**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.

297

| |Name|As submitted in the Lab assignment XML

298

|**Sample (field sample)**|(((

299

lokaalID (GUID)

300

)))|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.

305

* 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.

306

* 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.

307

308

**Importing the data will be done based on the following steps:**

309

310

* Search Project with Project.lokaalID (as placed in the Lab assignment XML).

311

* Search Project with Project.ProjectCode (as placed in the Lab assignment XML) if searching on Project.LokaalID yields no results.

312

* Search Project and Lab assignment with Labassignment.LokaalID (as placed in the Lab assignment XML) if the Project has not yet been found.

313

* 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).

314

* 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).

315

* Search Analysis Sample with Sample.Name within the project, if the Analysis Sample has not been found but the project has.

316

317

**What can be imported?**

318

319

* If an Analysis Sample is found, the Analysis Results are always updated or added.

320

* If Project is found, but the analysis sample is not; then this analysis sample is imported as a new analysis sample with all results.

321

* (If it concerns water samples, a new fictional/temporary measuring point and filter could be created.)

322

323

= SIKB 14 Parameter result combinations =

324

325

In the SIKB0101 version 14 exchange of **__labresults is combination needed __**for exchanging the result parameters of the Lab analysis.

326

It's based on PhysicalProperty, the combination of Quantity, Parameter and Condition.

327

\\[[image:1713183008796-215.png]]

328

*small remark, condition will be used as: [0..1]

329

330

Domaintables bound to these fields:

331

332

* Quantity -[[ Parameter, but only group/groep: Grootheid (Quantity)>>https://codes.sikb.nl/tablet/domain-table-details/0eafa483-2875-4c94-890d-66258a6b4d88]]

333

* Parameter -[[ Parameter, but mainly group/groep: Chemische Stof (Chemical substance)>>https://codes.sikb.nl/tablet/domain-table-details/0eafa483-2875-4c94-890d-66258a6b4d88]]

334

* Condition - Condition, but not group/groeps that refer to Chemical substance.

335

336

The combinations are defined for different compartiments like soil/ground, groundwater, wastewater.

337

Below are some examples, and some attachments included to support all combinations.

338

339

**2 Examples for Soil:**

340

341