Skip to Content
Last modified by Robin Huisman on 2024/12/18 14:57
From version 33.1
edited by Robin Huisman
on 2024/04/03 19:19
Change comment: There is no comment for this version
To version 32.1
edited by Robin Huisman
on 2024/04/03 19:11
Change comment: Uploaded new attachment "1712164314258-543.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -17,9 +17,7 @@
17 17  **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]]
18 18  extracted from: **[[https:~~/~~/codes.sikb.nl>>url:https://codes.sikb.nl/]] **
19 19  
20 -{{toc/}}
21 21  
22 -
23 23  == File structure ==
24 24  
25 25  In the image below the main structure of the XML file is shown. Every table is described in more detail later on in this chapter.
... ... @@ -53,89 +53,55 @@
53 53  |(% colspan="1" rowspan="1" %)Reports|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
54 54  |(% colspan="1" rowspan="1" %)FractionLinks|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
55 55  
56 -== Structure explanation AnalysisSets ==
54 +== Structure explanation AnalysisSet ==
57 57  
58 -This table contains all the analyses sets or packages that your lab supports. The “AnalysisSetId” is your own identification code for the analysis packages.
56 +This table contains all the analyses packages that your lab supports. The “analysepakketcode” is your own identification code for the analysis packages.
59 59  
60 -It will be the chosen analysis and name, showed in the interface of TerraIndex:
61 -\\[[image:1712163759805-731.png]]
62 62  
63 -[[image:1712163688142-709.png||height="580" width="784"]]
64 -
65 65  (% class="table-hover" %)
66 66  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
67 -|(% colspan="1" rowspan="1" %)**AnalysisSetId**|(% colspan="1" rowspan="1" %)The identification code of the lab for the analyses Set or package|(% colspan="1" rowspan="1" %)string
68 -|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name/description of the analysis content of the set (This will also be shown in the user interface)|(% colspan="1" rowspan="1" %)string
69 -|(% colspan="1" rowspan="1" %)Sequence|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)string
70 -|(% colspan="1" rowspan="1" %)MinimalDeliveryTime|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)string
61 +|(% colspan="1" rowspan="1" %)**analysepakketcode**|(% colspan="1" rowspan="1" %)The identification code of the lab for their analysis package code|(% colspan="1" rowspan="1" %)string
62 +|(% colspan="1" rowspan="1" %)**omschrijving**|(% colspan="1" rowspan="1" %)The name/description of the analysis package (This will also be shown in the user interface)|(% colspan="1" rowspan="1" %)string
63 +|(% colspan="1" rowspan="1" %)**volgorde**|(% colspan="1" rowspan="1" %)Field is redundant and does not have to be filled in|(% colspan="1" rowspan="1" %)string
71 71  
72 -== Structure explanation Categories ==
65 +== Structure explanation categorieen ==
73 73  
74 -“Category” does not need a lot of explanation. A category is a group defined by the lab where certain values in the “koppeltabel” can be grouped under. A category is determined by the lab and can be used in the “Links”.
67 +“Categorie” does not need a lot of explanation. A category is a group defined by the lab where certain values in the “koppeltabel” can be grouped under. A category is determined by the lab and can be used in the “koppeltabel”
75 75  
76 -In TerraIndex it will be showed as Header/Group:
77 -[[image:1712162927138-349.png]]
69 +(% style="text-align:center" %)
70 +[[image:1637578815582-615.png]]
78 78  
79 -
80 -[[image:1712162765631-966.png]]
81 -
82 -
83 83  (% class="table-hover" %)
84 84  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
85 -|(% colspan="1" rowspan="1" %)**CategorieId**|(% colspan="1" rowspan="1" %)The code/Id of the category or group given by the lab|(% colspan="1" rowspan="1" %)string
86 -|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name/description of the category (This will also be shown in the user interface)|(% colspan="1" rowspan="1" %)string
87 -|(% colspan="1" rowspan="1" %)**Sequence**|(% colspan="1" rowspan="1" %)Field is redundant and does not have to be filled|(% colspan="1" rowspan="1" %)integer
74 +|(% colspan="1" rowspan="1" %)**Categoriecode**|(% colspan="1" rowspan="1" %)The category code of the category of the lab|(% colspan="1" rowspan="1" %)string
75 +|(% colspan="1" rowspan="1" %)**Omschrijving**|(% colspan="1" rowspan="1" %)The name/description of the category (This will also be shown in the user interface)|(% colspan="1" rowspan="1" %)string
76 +|(% colspan="1" rowspan="1" %)**volgorde**|(% colspan="1" rowspan="1" %)Field is redundant and does not have to be filled in|(% colspan="1" rowspan="1" %)integer
88 88  
89 -== Structure explanation AnalysisLink and Analysis ==
78 +== Analysetabel ==
90 90  
91 91  This table contains all the analyses that a analyses package can contain. Be sure the “analysepakketcode” corresponds to a code in the table: “analysepakketten”. The analysecode is your own identification code for the analyses.
92 -\\[[image:1712163145392-331.png]]
93 -\\[[image:1712163459761-326.png]]
94 94  
95 -(% class="table-hover" %)
96 -|(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
97 -|(% colspan="1" rowspan="1" %)**AnalysisSetId**|(% colspan="1" rowspan="1" %)The analyse set code that corresponds to a code in the “//AnalysisSets//”|(% colspan="1" rowspan="1" %)string
98 -|(% colspan="1" rowspan="1" %)**Analysis**|(% colspan="1" rowspan="1" %)A table containing ale the analyses that should be in this analysis set or package|(% colspan="1" rowspan="1" %)-
82 +(% style="text-align:center" %)
83 +[[image:1637578915565-695.png]]
99 99  
100 -=== __Analysis__ ===
101 -
102 102  (% class="table-hover" %)
103 103  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
104 -|(% colspan="1" rowspan="1" %)**AnalysisId**|(% colspan="1" rowspan="1" %)The identification code of the lab for the analyses|(% colspan="1" rowspan="1" %)string
105 -|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)The name/description of the analysis content of the set (This will also be shown in the user interface)|(% colspan="1" rowspan="1" %)string
106 -|(% colspan="1" rowspan="1" %)MinimalDeliveryTime|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)string
107 -|(% colspan="1" rowspan="1" %)Observation|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
87 +|(% colspan="1" rowspan="1" %)**Analysepakketcode**|(% colspan="1" rowspan="1" %)The analyse package code that corresponds to a code in the “//analysepakketten//”|(% colspan="1" rowspan="1" %)string
88 +|(% colspan="1" rowspan="1" %)**Analyse**|(% colspan="1" rowspan="1" %)A table containing ale the analyses that should be in this analysis package|(% colspan="1" rowspan="1" %)-
89 +|(% colspan="1" rowspan="1" %)**Analyse > analysecode**|(% colspan="1" rowspan="1" %)The identification code of the lab for the analyses|(% colspan="1" rowspan="1" %)string
90 +|(% colspan="1" rowspan="1" %)**Analyse > omschrijving**|(% colspan="1" rowspan="1" %)The name\description of the analysis (This will also be shown in the user interface)|(% colspan="1" rowspan="1" %)string
108 108  
109 -== Structure explanation Clients ==
92 +== Structure explanation debiteurtabel ==
110 110  
111 -A customer can have multiple “clients”. There always needs to be one “client” so that a lab assignment can be send. But for example when there is a price agreement for a certain project a new “Client” can be added. Or when a company has multiple offices every office can have its own “Client”.
112 -\\It will be shown in the interface of TerraIndex, and needs to be chosen before selecting analysis sets:
113 -[[image:1712163957735-690.png]]
114 -\\[[image:1712163986350-364.png]]
94 +A customer can have multiple “debiteuren”. There always needs to be one “debiteur” so that a lab assignment can be send. But for example when there is a price agreement for a certain project a new “debiteur” can be added. Or when a company has multiple offices every office can have its own “debiteur”
115 115  
96 +(% style="text-align:center" %)
97 +[[image:1637578988501-147.png]]
98 +
116 116  |(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**Unit**
117 -|(% colspan="1" rowspan="1" %)**ClientId**|(% colspan="1" rowspan="1" %)The customer identification code(s) for the company or office|(% colspan="1" rowspan="1" %)string
118 -|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)De name\description of the customer code, as shown in the interface and will be invoiced.|(% colspan="1" rowspan="1" %)string
100 +|(% colspan="1" rowspan="1" %)**klantcode**|(% colspan="1" rowspan="1" %)The customer code(s) for the company|(% colspan="1" rowspan="1" %)string
101 +|(% colspan="1" rowspan="1" %)**omschrijving**|(% colspan="1" rowspan="1" %)De name\description of the customer code|(% colspan="1" rowspan="1" %)string
119 119  
120 -== Structure explanation LabSampleMatrices ==
121 -
122 -The “LabSampleMatrices” is an important sections of the XML. The “matrix” defines the main type of sample for the lab, and can contain multiple or prefined additional pretreatments of preservations. Without a sample type in this table a customer will not be able to send in lab assignments to the laboratory.
123 -
124 -It needs to be chosen in the interface of TerraIndex, before any analysis set can be chosen:
125 -\\[[image:1712164314258-543.png]]
126 -
127 -
128 -[[image:1712164255757-638.png]]
129 -
130 -(% class="table-hover" %)
131 -|(% colspan="1" rowspan="1" %)**Attribute name**|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)**unit**
132 -|(% colspan="1" rowspan="1" %)**CompartimentId**|(% colspan="1" rowspan="1" %)An SIKB ID that determins to which matrix the analyses belongs.
133 -Domaintable: [[Compartment/Matrix>>https://codes.sikb.nl/tablet/domain-table-details/6134f3bb-6048-431d-a130-01290d84172c]]|(% colspan="1" rowspan="1" %)int
134 -|(% colspan="1" rowspan="1" %)CompartimentCode|(% colspan="1" rowspan="1" %)-not in use-|(% colspan="1" rowspan="1" %)
135 -|(% colspan="1" rowspan="1" %)**LabSampleMatrixCode**|(% colspan="1" rowspan="1" %)The laboratory matrix- or compartment-code of the lab, that will be also be send in the Labassignment to the lab|(% colspan="1" %)string
136 -|(% colspan="1" rowspan="1" %)**Description**|(% colspan="1" rowspan="1" %)De name\description of the matrix or compartment of the lab, as shown in the interface.|(% colspan="1" rowspan="1" %)string
137 -
138 -
139 139  == Structure explanation Links ==
140 140  
141 141  The “Links” is one of the most important sections of the XML. The “koppeltabel” defines the combination of Analysespackages, custeromcode, categories and sampletype. Without a combination in this table a customer will not be able to send in lab assignments to the laboratory.
... ... @@ -166,6 +166,5 @@
166 166  |(% colspan="1" rowspan="1" %)**urgentiecode**|(% colspan="1" rowspan="1" %)The code of the lab for when the analysis results need to be returned to the customer|(% colspan="1" rowspan="1" %)string
167 167  |(% colspan="1" rowspan="1" %)**omschrijving**|(% colspan="1" rowspan="1" %)The name/ description of the urgentie|(% colspan="1" rowspan="1" %)string
168 168  
169 -== ==
170 -
171 -== ==
133 +==
134 + ==