Lab delivery file
Creating a Delivery file and binding them to a customer
This chapter contains the information needed to understand the lab delivery file. A Lab delivery file only has to be updated when there are changes. Otherwise TerraIndex will always show the last imported file.
What is a lab delivery file
A lab delivery file contains the Customer code of the customer that will be sending the lab assignment. It also contains the analyses that can be requested from the a lab by the customer. A Lab delivery file needs to be custom for every user and needs to be a XML file
The file hereis the file that is used for the examples in the document:
File structure
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.
| Attribute name | Description | Unit |
| versie | SIKB version. This always must be: 9.0.0 | string |
| laboratorium | A number given by TerraIndex to the lab when requesting to connect to TerraIndex | integer |
| taal | The language of the Delivery file in a three-letter code: - dut = Dutch - eng = English This depends on the XSD used. | string |
| koppeltabel | A table to connect the “Analysepakketten” and the “Debiteurentabel” | - |
| analysepakketten | A table containing the name and lab code of analysis packages | - |
| categorieen | A table containing all the possible lab categories | - |
| analysetabel | A table containing all the analyses for an analysis packages | - |
| debiteurtabel | A table of all the customer codes that are available for the company | - |
| urgentietabel | A table containing a list of time frames in which the lab results need to be returned | - |
Structure explanation analysepakketten
This table contains all the analyses packages that your lab supports. The “analysepakketcode” is your own identification code for the analysis packages.
| Attribute name | Description | Unit |
| analysepakketcode | The identification code of the lab for their analysis package code | string |
| omschrijving | The name/description of the analysis package (This will also be shown in the user interface) | string |
| volgorde | Field is redundant and does not have to be filled in | string |
Structure explanation categorieen
“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”
| Attribute name | Description | Unit |
| Categoriecode | The category code of the category of the lab | string |
| Omschrijving | The name/description of the category (This will also be shown in the user interface) | string |
| volgorde | Field is redundant and does not have to be filled in | integer |
Analysetabel
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.
| Attribute name | Description | Unit |
| Analysepakketcode | The analyse package code that corresponds to a code in the “analysepakketten” | string |
| Analyse | A table containing ale the analyses that should be in this analysis package | - |
| Analyse > analysecode | The identification code of the lab for the analyses | string |
| Analyse > omschrijving | The name\description of the analysis (This will also be shown in the user interface) | string |
Structure explanation debiteurtabel
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”
| Attribute name | Description | Unit |
| klantcode | The customer code(s) for the company | string |
| omschrijving | De name\description of the customer code | string |
Structure explanation koppeltabel
The “koppeltabel” 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.
| Attribute name | Description | unit |
| Analysepakketcode | The analysepackagecode that corresponds to a code in the analysepakket | string |
| klantcode | A code that corresponds to a code in debiteuren | string |
| monstersoort | An SIKB code that determins to which matrix the analyses belongs. Sampletype Codegroup 51 in the Attachments for all possible codes | integer
|
| categoriecode | A code that corresponds to a category code in “categorie” | string |
Structure explanation urgentietabel
This table contains a list with different delivery times for analyses results. For example 5 work days, overnight, within 48 hours and so on. The “urgentie code” is a code given by the lab.
| Attribute name | Description | Unit |
| urgentiecode | The code of the lab for when the analysis results need to be returned to the customer | string |
| omschrijving | The name/ description of the urgentie | string |
Column mapping from Dutch to English
In the table below all the keys in the example XML with are shown their English counterparts from the XSD. The colours correspond to the parent. For example. DeliveryData has children that is why this one is coloured dark red in the English column and also coloured dark red in the left column.
| Parent English | Dutch | English |
| - | labaanlevering | DeliveryData |
| DeliveryData | versie | Version |
| DeliveryData | kenmerk | versionDeliveryData |
| DeliveryData | laboratorium | Laboratory |
| DeliveryData | taal | Language |
| DeliveryData | koppeltabel | Links |
| DeliveryData | analysepakketten | analysesSets |
| DeliveryData | Categorieen | Categories |
| DeliveryData | Analysetabel | AnalysisSets |
| DeliveryData | Debiteurtabel | Clients |
| DeliveryData | urgentietabel | urgencies |
| Links | Koppeling | Link |
| Link | Analysepakket | AnalysisSetId |
| Link | Klantcode | ClientId |
| Link | Monstersoort | SampleKind |
| Link | categoriecode | CategoryId |
| AnalysisSets | Analysepakket | AnalysisSet |
| AnalysisSet | Analysepakketcode | AnalysisSetId |
| AnalysisSet | Omschrijving | Description |
| AnalysisSet | volgorde | Sequence |
| Categories | Categorie | category |
| Category | Categoriecode | CategoryId |
| Category | omschrijving | Description |
| Category | volgorde | Sequence |
| AnalysesLinks | Pakket | AnalysisLink |
| AnalysisLink | Analysepakketcode | AnalysisSetId |
| AnalysisLink | Analyse | Analysis |
| Analysis | Analysecode | AnalysisId |
| Analysis | omschrijving | Description |
| Clients | debiteur | Client |
| Client | Klantcode | ClientId |
| Client | Omschrijving | Description |
| Urgencies | Urgentie | Urgency |
| Urgency | Urgentiecode | UrgencyId |
| Urgency | omschrijving | Description |