Summary

• Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

...	...	@@ -1,4 +1,4 @@
1		-= Exporting lab results to TerraIndex for a customer =
	1	+= Reporting lab results to TerraIndex for a customer =
2	2
3	3	Returning the labresults to the client, that requested the analysis on samples.
4	4
...	...	@@ -18,7 +18,7 @@
18	18
19	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	20
21		-**Controle XSLT**: [[attach:Labresult_Controle.xsl||rel=" noopener noreferrer" target="_blank"]]
	21	+**Controle XSLT**: [[attach:Labresult_Controle.xsl||rel="noopener noreferrer" target="_blank"]]
22	22
23	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	24	extracted from: **[[https:~~/~~/codes.sikb.nl>>url:https://codes.sikb.nl/]] **
...	...	@@ -49,76 +49,196 @@
49	49	===
50	50	Labassignment ===
51	51
52		-The labassignmentpart is the same as in the labassignment: [[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/#]]
	52	+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/#]]
53	53
54		-With 3 differences:
	54	+With 3 differences/additions:
55	55
56	56	* Status on the labassignment itself
57	57	* Status on the labassignment.sample link
58	58	* The labassignment Report number can be send in: LabAssignmentCertificate
59	59
	60	+|**Attribute**|**Notes**
	61	+|(((
	62	+**identification** NEN3610ID
	63	+)))|(((
	64	+A unique code that is created when the object is created for the first time.
	65	+)))
	66	+|(((
	67	+**operatingLab** GenericName
60	60
	69	+
	70	+)))|(((
	71	+Code of the laboratory to which the assignment is assigned.
61	61
62		-==== MeasureResult ====
	73	+Domaintable: [[Meetinstantie / Measuring Company>>url:https://codes.sikb.nl/tablet/domain-table-details/4e270f0a-cefe-446e-9d4d-6666c91180a8]]
	74	+)))
	75	+|(((
	76	+**startTime** DateTime
	77	+)))|Dispatch date of the lab assignment
	78	+|(((
	79	+**customerCode** CharacterString
	80	+)))|Client code or debtor number of the client as known by the laboratory
63	63
64	64
	83	+
	84	+=== LabAssignmentStatus ===
	85	+
65	65	|**Attribute Name**|**Description**
66	66	|(((
67		-**numericValue** Measure
68		-)))|Numeric Value - the numerical value of the observation. When no unit for the measurement is known, the unit 'Dimensionless' should be used.
69		-|(((
70		-**valueProcessingMethod** GenericName
	88	+**statusType **GenericName
71	71	)))|(((
72		-Value Processing Method - a mathematical/statistical operation that is applied while the method of value determination/analysis standard remains unchanged.
	90	+The status of the lab assignment.
73	73
74		-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.
	92	+Use the value '5' for final reported results.
	93	+Use other values, or '4', for conceptual values.
75	75
76		-Domain table: Value Processing Method
	95	+Domain table: [[Labassignment Status>>https://codes.sikb.nl/tablet/domain-table-details/5c6ab373-693e-4039-af8d-93206ce4ebb4]]
77	77	)))
78	78	|(((
79		-**qualityIndicatorType** GenericName
	98	+**dateExpected **DateTime
80	80	)))|(((
81		-Quality Indicator/Judgement -> Detection limit, etc.
	100	+The date the results can be expected, in case of conceptual results.
82	82
83		-Domain table: Quality Judgement
	102	+If final, fill with datetime.now.
84	84	)))
85	85
86		-==== Accuracy ====
	105	+=== LabAssignmentCertificate ===
87	87
88		-
89		-|**Attribute Name**|**Description**|**Unit**
	107	+|**Attribute Name**|**Description**
90	90	|(((
91		-**recovery** Float
	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
92	92	)))|(((
93		-The part (percentage) of material that is recovered in an analysis.
94		-)))|Percentage [%]
	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/#]]
	125	+
	126	+
	127	+== Project ==
	128	+
	129	+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**
95	95	|(((
96		-**spread** Float
97		-)))|Spread = the error measured (in %) in multiple repeated measurements of the same sample/situation (and by the same laboratory technician/measuring device).|Percentage [%]
	134	+**identification** NEN3610ID
	135	+)))|The unique identifier of the Project in TerraIndex and in the whole Exchange Chain, as send in the labassignment
98	98	|(((
99		-**measurementUncertainty** Float
100		-)))|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 [%]
	137	+**name** CharacterString
	138	+
	139	+ [0..1]
	140	+)))|The name of the project where the lab results are for, as send in the labassignment
101	101	|(((
102		-**zScore** Float
103		-)))|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.|
	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**
104	104	|(((
105		-**drift** Float
106		-)))|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 [%]
	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
107	107
108		-==== ====
	164	+ [0..1]
	165	+)))|Name given to the sample
	166	+|(((
	167	+**specimenType** GenericName
109	109
110		-==== ====
	169	+ [0..1]
	170	+)))|(((
	171	+Type of Sample- Fieldsample, Analysissample
111	111
112		-==== ====
	173	+For analysissamples fill with value '10'.
113	113
114		-==== AnalyticResult ====
	175	+Domaintable: [[MonsterType / SampleType>>url:https://codes.sikb.nl/tablet/domain-table-details/9f956093-baad-4adb-b74d-20c00cef6ab4]]
	176	+)))
	177	+|(((
	178	+**materialClass** GenericName
115	115
	180	+
	181	+)))|(((
	182	+An SIKB code for the matrix type. Soil, Groundwater etc..
116	116
117		-The analyzed result of an observation, typically originating from a laboratory.
	184	+Domaintable: [[Compartiment / Matrix>>url:https://codes.sikb.nl/tablet/domain-table-details/6134f3bb-6048-431d-a130-01290d84172c]]
	185	+)))
118	118
	187	+== Analysis ==
119	119
120		-|=**Attribute Name**|=**Description**
	189	+The measured parameter with it's value and process.
	190	+
	191	+|**Attribute Name**|**Description**
121	121	|(((
	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]]**
	201	+
	202	+
	203	+)))
	204	+|**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	+
	208	+
	209	+=== AnalyticResult (inherited from MeasureResult) ===
	210	+
	211	+The actual reported value, result of detection limit.
	212	+
	213	+|**Attribute Name**|**Description**
	214	+|(((
	215	+**numericValue** Measure
	216	+)))|(((
	217	+Numeric Value - the numerical value of the observation. When no unit for the measurement is known, the unit 'Dimensionless' should be used.
	218	+
	219	+Domaintable for Units: [[Eenheid>>https://codes.sikb.nl/tablet/domain-table-details/04f4f467-021b-4218-baa8-9742ed977c61]]
	220	+)))
	221	+|(((
	222	+**valueProcessingMethod** GenericName
	223	+)))|(((
	224	+Value Processing Method - a mathematical/statistical operation that is applied while the method of value determination/analysis standard remains unchanged.
	225	+
	226	+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.
	227	+\\Default the value '5' meaning 'Not available' can and should be used, besides leaving it empty.
	228	+
	229	+Domain table: [[Value Processing Method>>https://codes.sikb.nl/tablet/domain-table-details/a2310c26-065f-4aec-9440-74892ec77753]]
	230	+)))
	231	+|(((
	232	+**qualityIndicatorType** GenericName
	233	+)))|(((
	234	+Quality Indicator/Judgement -> Detection limit, etc.
	235	+\\Default the value '0' meaning 'Not available' can and should be used, besides leaving it empty.
	236	+If there is a detectionlimit/reportinglimit, use: '4', meaning 'determenated with full detection limit'
	237	+
	238	+Domain table: [[Quality Judgement>>https://codes.sikb.nl/tablet/domain-table-details/1e17d9e6-4e0e-4f88-8fe5-c71f6a7931db]]
	239	+)))
	240	+
	241	+|(((
122	122	**limitSymbol** CharacterString
123	123	)))|(((
124	124	LimietSymbool, allowed values: '<' en '>'.
...	...	@@ -132,89 +132,43 @@
132	132	1) as a CData block: <![CDATA[<]]> or <![CDATA[>]]>
133	133
134	134	2) as HTML code: '&amp; lt;' or '&amp; gt;'
	255	+\\Default the value is leaving it empty.
	256	+If there is a detectionlimit/reportinglimit, use: '<'
135	135	)))
136	136	|(((
137	137	**alphanumericValue** CharacterString
138	138	)))|Textual value associated with an analysis result
139	139
140		-==== ====
	262	+==== ====
141	141
142		-==== ====
	264	+==== ====
143	143
144		-==== ====
145	145
146		-====
147		- ====
148	148
149		-=== Structure projectgegevens ===
	268	+=== AnalysisProcess ===
150	150
151		-(% style="text-align:center" %)
152		-[[image:1637656734277-997.png]]
	270	+The process that has been used to detemine the measured value or result.
153	153
	272	+|**Attribute Name**|**Description**
	273	+|(((
	274	+**identification** NEN3610ID
	275	+)))|The unique identifier of the AnalysisProcess, it can be bound to multiple results at once.
	276	+|**analyticalTechnique **GenericName|(((
	277	+The used analytical technique to detemine the result.
154	154
155		-(% class="table-hover" %)
156		-|(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
157		-|(% colspan="1" rowspan="1" %)**idopdracht**|(% colspan="1" rowspan="1" %)The TerraIndex id of the lab assignment the result belongs to.|(% colspan="1" rowspan="1" %)-
158		-|(% colspan="1" rowspan="1" %)**projectcode**|(% colspan="1" rowspan="1" %)The project code of the project as it was delivered in the lab assignment|(% colspan="1" rowspan="1" %)string
159		-|(% colspan="1" rowspan="1" %)**projectnaam**|(% colspan="1" rowspan="1" %)The name of the project as it was delivered in the lab assignment.|(% colspan="1" rowspan="1" %)string
160		-|(% colspan="1" rowspan="1" %)**ordernummer**|(% colspan="1" rowspan="1" %)Not relevant. The order in which the lab result could be shown|(% colspan="1" rowspan="1" %)string
161		-|(% colspan="1" rowspan="1" %)**projectleider**|(% colspan="1" rowspan="1" %)The project leader of the customer. This needs the be the “contactpersoon” from the lab assignment with the code PL|(% colspan="1" rowspan="1" %)string
162		-|(% colspan="1" rowspan="1" %)**status**|(% colspan="1" rowspan="1" %)The status of the lab assignment. See Labstatus Codegroup 76 in the attachments for all the options.|(% colspan="1" rowspan="1" %)integer
163		-|(% colspan="1" rowspan="1" %)**datumverwacht**|(% colspan="1" rowspan="1" %)The date on which the lab expects the certificate to be available|(% colspan="1" rowspan="1" %)Date
164		-yyyy-mm-dd
165		-|(% colspan="1" rowspan="1" %)**certificaatnummer**|(% colspan="1" rowspan="1" %)The number of the certificate that will be send to the user.|(% colspan="1" rowspan="1" %)string
166		-|(% colspan="1" rowspan="1" %)(((
167		-**analysemonsters**
	279	+Domain table: [[AnalyticalTechnique>>https://codes.sikb.nl/tablet/domain-table-details/04be2365-3d05-4903-a53e-edafef7111e8]]
	280	+)))
	281	+|**certification **GenericName|(((
	282	+The used certification to detemine the result.
168	168
169		-
170		-
171		-)))|(% colspan="1" rowspan="1" %)A table containing all the analysis sample with their corresponding results|(% colspan="1" rowspan="1" %)-
172		-
173		-== Structure analysemonsters ==
174		-
175		-(% style="text-align:center" %)
176		-[[image:1637656914799-534.png]]
177		-
178		-(% class="table-hover" %)
179		-|(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
180		-|(% colspan="1" rowspan="1" %)**Idanlmons**|(% colspan="1" rowspan="1" %)The unique identification code of the analyses sample as given in the lab assignment file|(% colspan="1" rowspan="1" %)string
181		-|(% colspan="1" rowspan="1" %)**Anlmons**|(% colspan="1" rowspan="1" %)The name of the analyses sample as given in the lab assignment file|(% colspan="1" rowspan="1" %)string
182		-|(% colspan="1" rowspan="1" %)**Certificaat**|(% colspan="1" rowspan="1" %)The way the name of the sample should be on the certificate. This is also given in the lab assignment|(% colspan="1" rowspan="1" %)string
183		-|(% colspan="1" rowspan="1" %)**Monstersoort**|(% colspan="1" rowspan="1" %)The code referencing the type the sample is. Check the attachment: Sample type codegroup 51 for all the options|(% colspan="1" rowspan="1" %)integer
184		-|(% colspan="1" rowspan="1" %)**Status**|(% colspan="1" rowspan="1" %)The status of the sample. See Labstatus Codegroup 76 in the attachments.|(% colspan="1" rowspan="1" %)integer
185		-|(% colspan="1" rowspan="1" %)**Datumverwacht**|(% colspan="1" rowspan="1" %)The date on which the results for the sample are expected|(% colspan="1" rowspan="1" %)(((
186		-date
187		-
188		-yyyy-mm-dd
	284	+Domain table: [[CertificationCode>>https://codes.sikb.nl/tablet/domain-table-details/04be2365-3d05-4903-a53e-edafef7111e8]]
189	189	)))
190		-|(% colspan="1" rowspan="1" %)**Volgorde**|(% colspan="1" rowspan="1" %)Is a unused field in TerraIndex|(% colspan="1" rowspan="1" %)integer
191		-|(% colspan="1" rowspan="1" %)**analyseresultaten**|(% colspan="1" rowspan="1" %)A table containing all the measurement values of the analysis samples.|(% colspan="1" rowspan="1" %)-
	286	+|**valuationMethod **GenericName|(((
	287	+The used valuation method to detemine the result.
192	192
193		-== Structure analyseresultaten ==
194		-
195		-(% style="text-align:center" %)
196		-[[image:1637657248973-790.png]]
197		-
198		-(% class="table-hover" %)
199		-|(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
200		-|(% colspan="1" rowspan="1" %)**componentcode**|(% colspan="1" rowspan="1" %)The SIKB component code. See ComponentCode Codegroup 52 in the attachements for all possible options.|(% colspan="1" rowspan="1" %)integer
201		-|(% colspan="1" rowspan="1" %)**meetwaarde**|(% colspan="1" rowspan="1" %)What the measured value is for the analyses|(% colspan="1" rowspan="1" %)float
202		-|(% colspan="1" rowspan="1" %)**meetwaardeomschrijving**|(% colspan="1" rowspan="1" %)Alpha numerical description of the result|(% colspan="1" rowspan="1" %)string
203		-|(% colspan="1" rowspan="1" %)**eenheidcode**|(% colspan="1" rowspan="1" %)The unit of the measured value. See Unit CodeGroup 40 in the attachements for all possible options|(% colspan="1" rowspan="1" %)integer
204		-|(% colspan="1" rowspan="1" %)**referentiecode**|(% colspan="1" rowspan="1" %)This defines what the reference for the measurement value is. See ReferenceType CodeGroup 41 for all the possible options|(% colspan="1" rowspan="1" %)integer
205		-|(% colspan="1" rowspan="1" %)**analysenorm**|(% colspan="1" rowspan="1" %)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|(% colspan="1" rowspan="1" %)integer
206		-|(% colspan="1" rowspan="1" %)**datummonstervoorbehandeling**|(% colspan="1" rowspan="1" %)The date on which the sample was pre-treated. We don’t do anything with this value|(% colspan="1" rowspan="1" %)(((
207		-date
208		-
209		-yyyy-mm-dd
	289	+Domain table: [[ValuationMethod>>https://codes.sikb.nl/tablet/domain-table-details/04be2365-3d05-4903-a53e-edafef7111e8]]
210	210	)))
211		-|(% colspan="1" rowspan="1" %)**opmerking**|(% colspan="1" rowspan="1" %)A remark for this result|(% colspan="1" rowspan="1" %)string
212		-|(% colspan="1" rowspan="1" %)**certificering**|(% colspan="1" rowspan="1" %)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|(% colspan="1" rowspan="1" %)integer
213		-|(% colspan="1" rowspan="1" %)**status**|(% colspan="1" rowspan="1" %)The status of the labresult in the labassignemnt. See Labstatus Codegroep 76 in the attachments|(% colspan="1" rowspan="1" %)integer
214		-|(% colspan="1" rowspan="1" %)**datumverwacht**|(% colspan="1" rowspan="1" %)Date on which the analyses results are expected.|(% colspan="1" rowspan="1" %)date
215	215
216		-= =
217		-
218	218	= What to exchange to bind the right results to the right sample? =
219	219
220	220	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.
...	...	@@ -253,7 +253,6 @@
253	253	* If an Analysis Sample is found, the Analysis Results are always updated or added.
254	254	* If Project is found, but the analysis sample is not; then this analysis sample is imported as a new analysis sample with all results.
255	255	* (If it concerns water samples, a new fictional/temporary measuring point and filter could be created.)
256		-*
257	257
258	258	= SIKB 14 Parameter result combinations =
259	259