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

48

49

(% class="wikigeneratedid" %)

50

51

52

=== Labassignment ===

53

54

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/#]]

55

56

With 3 differences/additions:

57

58

* Status on the labassignment itself

59

* Status on the labassignment.sample link

60

* The labassignment Report number can be send in: LabAssignmentCertificate

61

62

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

63

|(((

64

**identification** NEN3610ID

65

)))|(((

66

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

67

)))

68

|(((

69

**operatingLab** GenericName

)))|(((

Code of the laboratory to which the assignment is assigned.

74

75

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

76

)))

77

|(((

78

**startTime** DateTime

79

)))|Dispatch date of the lab assignment

80

|(((

81

**customerCode** CharacterString

82

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

83

84

=== LabAssignmentStatus ===

85

86

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

87

|(((

88

**statusType **GenericName

89

)))|(((

90

The status of the lab assignment.

91

92

Use the value '5' for final reported results.

93

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

94

95

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

96

)))

97

|(((

98

**dateExpected **DateTime

99

)))|(((

100

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

101

102

If final, fill with datetime.now.

103

)))

104

105

=== LabAssignmentCertificate ===

106

107

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

108

|(((

109

**labCertificateNumber **CharacterString

110

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

111

|(((

112

**certification **GenericName

113

)))|(((

114

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

115

116

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

117

)))

118

119

== LabAssignmentRequest ==

120

121

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

122

123

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

124

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.

130

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

131

132

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

133

|(((

134

**identification** NEN3610ID

135

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

136

|(((

137

**name** CharacterString

138

139

[0..1]

140

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

141

|(((

142

**projectCode** CharacterString

143

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

144

145

== Sample (AnalysisSample) ==

146

147

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

148

149

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

150

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/#]]

151

152

(% class="box infomessage" %)

153

(((

154

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]]

155

)))

156

157

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

158

|(((

159

**identification** NEN3610ID

160

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

161

|(((

162

**name** CharacterString

163

164

[0..1]

165

)))|Name given to the sample

166

|(((

167

**specimenType** GenericName

[0..1]

)))|(((

Type of Sample- Fieldsample, Analysissample

172

173

For analysissamples fill with value '10'.

174

175

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

176

)))

177

|(((

178

**materialClass** GenericName

)))|(((

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

183

184

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.

190

191

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

192

|(((

193

**identification** NEN3610ID

194

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

195

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

196

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

197

**physicalProperty **PhysicalProperty

198

)))|(((

199

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

200

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

205

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

206

207

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

208

209

The actual reported value, result of detection limit.

210

211

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

212

|(((

213

**numericValue** Measure

214

)))|(((

215

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

216

217

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

218

)))

219

|(((

220

**valueProcessingMethod** GenericName

221

)))|(((

222

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

223

224

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.

225

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

226

227

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

228

)))

229

|(((

230

**qualityIndicatorType** GenericName

231

)))|(((

232

Quality Indicator/Judgement -> Detection limit, etc.

233

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

234

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

235

236

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

)))

|(((

**limitSymbol** CharacterString

241

)))|(((

242

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

243

244

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

245

246

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

247

248

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:

249

250

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

251

252

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

253

\\Default the value is leaving it empty.

254

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

255

)))

256

|(((

257

**alphanumericValue** CharacterString

258

)))|Textual value associated with an analysis result

==== ====

==== ====

=== AnalysisProcess ===

267

268

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

269

270

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

271

|(((

272

**identification** NEN3610ID

273

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

274

|**analyticalTechnique **GenericName|(((

275

The used analytical technique to detemine the result.

276

277

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

278

)))

279

|**certification **GenericName|(((

280

The used certification to detemine the result.

281

282

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

283

)))

284

|**valuationMethod **GenericName|(((

285

The used valuation method to detemine the result.

286

287

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

288

)))

289

290

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

291

292

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.

293

294

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

295

296

**Important fields:**

297

298

|=Entity|=Fixed value|=Remark

299

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

300

| |projectCode|As submitted in the Lab assignment XML

301

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

302

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

303

| |Name|As submitted in the Lab assignment XML

304

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

305

lokaalID (GUID)

306

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

311

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

312

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

313

314

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

315

316

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

317

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

318

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

319

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

320

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

321

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

322

323

**What can be imported?**

324

325

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

326

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

327

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

328

329

= SIKB 14 Parameter result combinations =

330

331

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

332

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

333

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

334

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

335

336

Domaintables bound to these fields:

337

338

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

339

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

340

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

341

342

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

343

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

344

345

**2 Examples for Soil:**

346

347