Changes for page Lab result file - SIKB0101 v14
Last modified by Robin Huisman on 2025/02/27 09:44
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -49,7 +49,7 @@ 49 49 === 50 50 Labassignment === 51 51 52 -The labassignment partis 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 54 With 3 differences: 55 55 ... ... @@ -58,163 +58,183 @@ 58 58 * The labassignment Report number can be send in: LabAssignmentCertificate 59 59 60 60 61 +=== LabAssignmentStatus === 61 61 62 -==== MeasureResult ==== 63 - 64 - 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 65 +**statusType **GenericName 71 71 )))|((( 72 - ValueProcessing Method -amathematical/statisticaloperationthat is appliedwhile the method of valuedetermination/analysisstandard remains unchanged.67 +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. 69 +Use the value '5' for final reported results. 70 +Use other values, or '4', for conceptual values. 75 75 76 -Domain table: ValueProcessing Method72 +Domain table: [[Labassignment Status>>https://codes.sikb.nl/tablet/domain-table-details/5c6ab373-693e-4039-af8d-93206ce4ebb4]] 77 77 ))) 78 78 |((( 79 -** qualityIndicatorType**GenericName75 +**dateExpected **DateTime 80 80 )))|((( 81 - QualityIndicator/Judgement->Detectionlimit,etc.77 +The date the results can be expected, in case of conceptual results. 82 82 83 - Domaintable:QualityJudgement79 +If final, fill with datetime.now. 84 84 ))) 85 85 86 -=== =Accuracy====82 +=== LabAssignmentCertificate === 87 87 88 - 89 -|**Attribute Name**|**Description**|**Unit** 84 +|**Attribute Name**|**Description** 90 90 |((( 91 -**recovery** Float 92 -)))|((( 93 -The part (percentage) of material that is recovered in an analysis. 94 -)))|Percentage [%] 86 +**labCertificateNumber **CharacterString 87 +)))|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. 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 [%] 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 [%] 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.| 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 [%] 89 +**certification **GenericName 90 +)))|((( 91 +Under which certificate the analyses has been done. If you do not find you code leave this field empty 107 107 108 -==== ==== 93 +Domain table: [[Certification Coding>>https://codes.sikb.nl/tablet/domain-table-details/df7ffd7c-192c-44f7-ae9f-0461d9266b30]] 94 +))) 109 109 110 -== ====96 +== LabAssignmentRequest == 111 111 112 - ========98 +The connection between the labassignment and the samples with analysisrequests, as send in the labassignment. 113 113 114 -==== AnalyticResult ==== 100 +If not retreived in a labassignment, make it yourself so we can import is as new samples. 101 +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/#]] 102 + 115 115 104 +== Project == 116 116 117 -The analyzed result of an observation, typically originating from a laboratory. 106 +Activity that leads to the collection of soil data, as send in the labassignment. 107 +It will be used to search the correct project/investiation to bind or create the samples. 118 118 109 +|**Attribute**|**Notes** 110 +|((( 111 +**identification** NEN3610ID 112 +)))|The unique identifier of the Project in TerraIndex and in the whole Exchange Chain, as send in the labassignment 113 +|((( 114 +**name** CharacterString 119 119 120 -|=**Attribute Name**|=**Description** 116 + [0..1] 117 +)))|The name of the project where the lab results are for, as send in the labassignment 121 121 |((( 122 -**limitSymbol** CharacterString 123 -)))|((( 124 -LimietSymbool, allowed values: '<' en '>'. 119 +**projectCode** CharacterString 120 +)))|The project code of the project where the lab results are for, as send in the labassignment 125 125 126 -'<' stands for 'less than the lowest threshold' 127 127 128 - '>'stands for 'greaterthanthe highest threshold'123 +== Sample (AnalysisSample) == 129 129 130 -The boundary for thelimitsymbolcan bepecifiedintheDeterminationLimits(LimitSymbolReferenceCode)asa referencewiththe actualvalueof the limit.The valuecan be included in the exchange intwo ways:125 +The analysissamples with analysisrequests, as send in the labassignment. The fieldsamples form the labassignment can be skipped in the results file. 131 131 132 -1) as a CData block: <![CDATA[<]]> or <![CDATA[>]]> 127 +If not retreived in a labassignment, make it yourself so we can import is as new analysissamples. 128 +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/#]] 133 133 134 -2) as HTML code: '& lt;' or '& gt;' 130 +(% class="box infomessage" %) 131 +((( 132 +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]] 135 135 ))) 134 + 135 +|**Attribute**|**Notes** 136 136 |((( 137 -**alphanumericValue** CharacterString 138 -)))|Textual value associated with an analysis result 137 +**identification** NEN3610ID 138 +)))|The unique identifier of TerraIndex for the analyses sample 139 +|((( 140 +**name** CharacterString 139 139 140 -==== ==== 142 + [0..1] 143 +)))|Name given to the sample 144 +|((( 145 +**specimenType** GenericName 141 141 142 -==== ==== 147 + [0..1] 148 +)))|((( 149 +Type of Sample- Fieldsample, Analysissample 143 143 144 - ========151 +For analysissamples fill with value '10'. 145 145 146 -==== 147 - ==== 153 +Domaintable: [[MonsterType / SampleType>>url:https://codes.sikb.nl/tablet/domain-table-details/9f956093-baad-4adb-b74d-20c00cef6ab4]] 154 +))) 155 +|((( 156 +**materialClass** GenericName 148 148 149 -=== Structure projectgegevens === 158 + 159 +)))|((( 160 +An SIKB code for the matrix type. Soil, Groundwater etc.. 150 150 151 - (% style="text-align:center" %)152 - [[image:1637656734277-997.png]]162 +Domaintable: [[Compartiment / Matrix>>url:https://codes.sikb.nl/tablet/domain-table-details/6134f3bb-6048-431d-a130-01290d84172c]] 163 +))) 153 153 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** 166 +== Analysis == 168 168 168 +|**Attribute Name**|**Description** 169 +|((( 170 +**identification** NEN3610ID 171 +)))|The unique identifier of the Project in TerraIndex and in the whole Exchange Chain, as send in the labassignment 172 +|((( 173 +**physicalProperty **PhysicalProperty 174 +)))|((( 175 +The combination of Quantity, Parameter and Condition to provide the parameter that has been measured. 176 +See this chapter for the combinations, and the CAS-NR's. 169 169 170 170 171 -)))|(% colspan="1" rowspan="1" %)A table containing all the analysis sample with their corresponding results|(% colspan="1" rowspan="1" %)- 179 +))) 180 +| | 172 172 173 -== Structure analysemonsters ==182 +=== AnalyticResult (inherited from MeasureResult) === 174 174 175 -(% style="text-align:center" %) 176 -[[image:1637656914799-534.png]] 177 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 185 +|**Attribute Name**|**Description** 186 +|((( 187 +**numericValue** Measure 188 +)))|((( 189 +Numeric Value - the numerical value of the observation. When no unit for the measurement is known, the unit 'Dimensionless' should be used. 187 187 188 - yyyy-mm-dd191 +Domaintable for Units: [[Eenheid>>https://codes.sikb.nl/tablet/domain-table-details/04f4f467-021b-4218-baa8-9742ed977c61]] 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" %)- 193 +|((( 194 +**valueProcessingMethod** GenericName 195 +)))|((( 196 +Value Processing Method - a mathematical/statistical operation that is applied while the method of value determination/analysis standard remains unchanged. 192 192 193 -== Structure analyseresultaten == 198 +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. 199 +\\Default the value '5' meaning 'Not available' can and should be used, besides leaving it empty. 194 194 195 -(% style="text-align:center" %) 196 -[[image:1637657248973-790.png]] 201 +Domain table: [[Value Processing Method>>https://codes.sikb.nl/tablet/domain-table-details/a2310c26-065f-4aec-9440-74892ec77753]] 202 +))) 203 +|((( 204 +**qualityIndicatorType** GenericName 205 +)))|((( 206 +Quality Indicator/Judgement -> Detection limit, etc. 207 +\\Default the value '0' meaning 'Not available' can and should be used, besides leaving it empty. 208 +If there is a detectionlimit/reportinglimit, use: '4', meaning 'determenated with full detection limit' 197 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 210 +Domain table: [[Quality Judgement>>https://codes.sikb.nl/tablet/domain-table-details/1e17d9e6-4e0e-4f88-8fe5-c71f6a7931db]] 211 +))) 208 208 209 -yyyy-mm-dd 213 +|((( 214 +**limitSymbol** CharacterString 215 +)))|((( 216 +LimietSymbool, allowed values: '<' en '>'. 217 + 218 +'<' stands for 'less than the lowest threshold' 219 + 220 +'>' stands for 'greater than the highest threshold' 221 + 222 +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: 223 + 224 +1) as a CData block: <![CDATA[<]]> or <![CDATA[>]]> 225 + 226 +2) as HTML code: '& lt;' or '& gt;' 227 +\\Default the value is leaving it empty. 228 +If there is a detectionlimit/reportinglimit, use: '<' 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 230 +|((( 231 +**alphanumericValue** CharacterString 232 +)))|Textual value associated with an analysis result 215 215 216 -= = 234 +==== ==== 217 217 236 +==== ==== 237 + 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,8 +253,8 @@ 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 277 + 258 258 = SIKB 14 Parameter result combinations = 259 259 260 260 In the SIKB0101 version 14 exchange of **__labresults is combination needed __**for exchanging the result parameters of the Lab analysis.