EuroFIR Web Services - Danish Food Informatics

4 downloads 12 Views 2MB Size Report
Mar 1, 2012 - EuroFIR Web Services - EuroFIR Food Data Transport Package, Version 1.4 ... Complementary Use of Thesaurus Based Values and Free Text . ..... configuration and hosting, the EuroFIR standard vocabularies, the “small” ...

This work was completed in collaboration with EuroFIRNexus — The EuroFIR Food Platform: Further integration, refinement and Exploitation for its long-term self-sustainability. Funded under the EU 7th Framework Programme. Grant agreement no: 265967.

EuroFIR Web Services EuroFIR Food Data Transport Package Version 1.4

Anders Møller and Tue Christensen in collaboration with Heikki Pakkala, Ian D. Unwin, Mark A. Roe, and Erik Nørby

EuroFIR Nexus Technical Report D2.1

Danish Food Information

Disclaimer The authors of this report disclaim any warranty or representation as to the safety, reliability or accuracy of any and all information in this document and the use of its content.

EuroFIR Web Services FOOD DATA TRANSPORT PACKAGE VERSION 1.4 EUROFIR NEXUS TECHNICAL REPORT D2.1

ANDERS MØLLER TUE CHRISTENSEN IN COLLABORATION WITH

HEIKKI PAKKALA IAN D. UNWIN MARK A. ROE ERIK NØRBY

Danish Food Information

LEGAL NOTICE The authors nor any person acting on behalf of the authors is responsible for the use which might be made of the following information.

Information on the EuroFIR-NEXUS project is available on the Internet. It can be accessed through the EuroFIR server (http://www.eurofir.org/).

Cataloguing information: EuroFIR Web Services - EuroFIR Food Data Transport Package, Version 1.4 EuroFIR Nexus Technical Report D2.1 Anders Møller and Tue Christensen Denmark: Danish Food Information 2012 - 110 pp. - 21 x 29.7 cm. ISBN 978-87-92125-15-6

EAN 9788792125156

© Danish Food Information, 2012 Reproduction is authorised provided the source is acknowledged. Printed in Denmark.

EuroFIR Web Services EuroFIR Food Data Transport Package Version 1.4

Content Objective ................................................................................................................................ 5 Background ............................................................................................................................ 5 Changes from version 1.3 to version 1.4 ................................................................................ 7 Changes from version 1.0 to version 1.3 ................................................................................ 9 The EuroFIR Food Data Transport Package ........................................................................ 11 Formal conventions .............................................................................................................. 13 Properties .................................................................................................................... 13 Priorities ...................................................................................................................... 13 Complementary Use of Thesaurus Based Values and Free Text ................................. 13 Data Types .................................................................................................................. 14 Standards and thesauri ........................................................................................................ 15 Standards .................................................................................................................... 15 Thesauri ...................................................................................................................... 16 Short description of the XML template .................................................................................. 19 Introduction .................................................................................................................. 19 The XML Declaration ................................................................................................... 19 The Root Element, EuroFIRFoodDataTransportPackage ............................................ 19 The header element, StandardVocabularies ................................................................ 20 The header element, SenderInformation...................................................................... 21 The header element, Content ...................................................................................... 21 The food data element, Foods ..................................................................................... 22 The FoodDescription element ...................................................................................... 22 The Components element............................................................................................ 22 The Full Structure of the EuroFIR Food Data Transport Package ................................ 24 The minimum requirements – Updated 2011-09-06. ............................................................. 29 Future developments ............................................................................................................ 32 Further information ............................................................................................................... 32 Annex I ................................................................................................................................. 33 Detailed Specifications of the EuroFIR Food Data Transport Package ........................ 33 Annex II .............................................................................................................................. 105 Numerical Display of Elements .................................................................................. 105

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

5

Objective The objective of the EuroFIR Food Data Transport Package for food data interchange is to ensure the receiver, e.g. the food data compilers, a simple and comprehensive access to relevant and up-to-date food (product) information in national food composition databases. The EuroFIR Food Data Transport Package is developed from recommendations defined in the COST Action 99 1 – Eurofoods project as well as the international INFOODS network 23. The EuroFIR Food Data Transport Package’s intended use is data transport between the food data compilers in EuroFIR and transport of food data from compilers to the EuroFIR eSeach facility. It is the first XML transport package to be defined for information interchange via Web Services in the EuroFIR context. The EuroFIR Food Data Transport Package is not a comprehensive package. The XML template defined for the EuroFIR Food Data Transport Package contains only the most necessary information for the end-user/receiver to be able to assess the quality of the data for their work. It reflects the information presently existing in European food composition databases. It is expected to be expanded following the information becoming available in the European food composition databases.

Background Due to the increasing demand for harmonisation and standardisation of food product data the COST Action 99 – Eurofoods published the Eurofoods Basic recommendations for food composition database management and data interchange1. Based on the Eurofoods recommendations and succeeding work in connection with the EPIC project, a pragmatic and basic solution for food data interchange in the EuroFIR network was developed during the first year of the EuroFIR project (2005-2010). The solution uses an XML template to define and structure the contained data. In 2005, a project group (core database group) was established with representation from compilers with online database and IT-specialists. The XML standard was chosen for the data interchange, and a specific template for interchange of food composition data was developed and tested on existing online servers. The definitions in the Transport Package are based on the EuroFIR draft Standard for Food Composition Data and its Technical Annex 4. For detailed information on data entities and standard thesauri, the reader is referred to these documents.

1

Schlotke, F., Becker, W., Ireland, J., Møller, A., Ovaskainen, M.-J., Monspart, J. and Unwin, I. (2000). Basic Recommendations for Food Composition Database Management and Interchange. Report by the COST Action 99 – Eurofoods Working Group on Food Data Management and Interchange. Report No. EUR 19538, European Commission. () 2 Klensin, J.C. (1992). INFOODS Food Composition Data Interchange Handbook. The United Nations University, Tokyo, Japan. (http://www.unu.edu/unupress/unupbooks/80774e/80774E00.htm) 3 INFOODS (2004). Technical workshop on Standards for food composition data interchange, Rome, 19-22 January 2004. (ftp://ftp.fao.org/es/esn/infoods/interchange.pdf) 4 Becker et al.: Proposal for structure and detail of a EuroFIR standard on food composition data I: Description of the standard (2007-07-13) and II: Technical Annex (2007-11-05); EuroFIR working documents, 2007. Page 5 of 106

6

Page 6 of 110

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

7

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

Changes from version 1.3 to version 1.4 The EuroFIR Food Data Transport Package is undergoing constant updates. The definitions in the Transport Package are based on the EuroFIR draft Standard for Food Composition Data and its Technical Annex. The most recent version of the draft Standard’s Technical Annex (2008-12-31) contains considerable changes and additions. The XML template for the EuroFIR Food Data Transport Package has been changed accordingly. •

The The XML Declaration has been updated to allow multibyte character encoding using UTF-8 (8-bit UCS Transformation Format); example



The documentation of the root element has been updated to reflect the version 1.4 change removing redundant information, the attributes name and versiondate; an example of the version 1.4 root element is



The URI position of standard vocabularies has been altered. Due to changes in server configuration and hosting, the EuroFIR standard vocabularies, the “small” thesauri, are publicly accessible in XML format from the URI: http://techweb.eurofir.org/xml/...

In the list of mandatory EuroFIR thesauri, the missing thesaurus referencetype has been added (referencetype was name publicationtype in earlier versions); the EuroFIR component identifier system has wrongly been named component in earlier versions of the Food Data Transport Package, it is now named ecompid, the name of the system originally defined for the EuroFIR component identifier system. For specific information, see pages 14 and 17; •

The list of standard vocabularies has been expanded with examples of thesauri/standard vocabularies, which may be used mandatorily under certain circumstances, e.g. in data interchange for specific purposes;



With the introduction of the EuroFIR Meta Data Transport Package (see specific documentation), the previously defined root elements: EuroFIRFoodListTransportPackage, EuroFIRComponentListTransportPackage, are now obsolete and should not be used;



Specific issues concerning the mandatory template has been listed in the chapter concerning EuroFIR eSearch minimum requirements – Updated 2012-03-01, on page 24;



In the mandatory element (see details page 50), the mandatory attribute datasetcreated has been missing and is now added. Furthermore, the two attributes coverage and compilationtype has not been defined and are now removed; if in the future development of the FDTP the two attributes are defined, they may be reinstated;



In the recommended and elements the two missing attributes acquisitiontype and referencetype has been added (see pages 101 and 102).

Page 7 of 106

8

Page 8 of 110

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

9

Changes from version 1.0 to version 1.3 The EuroFIR Food Data Transport Package is undergoing constant updates. The definitions in the Transport Package are based on the EuroFIR draft Standard for Food Composition Data and its Technical Annex4. The most recent version of the draft Standard’s Technical Annex (2007-11-05) contains considerable changes and additions. The XML template for the EuroFIR Food Data Transport Package has been changed accordingly. • • • • • • • • • • • • • • • • • • • •

The root element has been renamed to ; The root element’s attribute list has been decreased by removing redundant information, the attributes name and versiondate has been removed; The position of standard vocabularies has been altered; Element has been added to the element; Element < OriginalFoodClassification /> has been added to the element; Element has been added to the element, the specific definitions of this element are still pending; Element has been added to the element; Element has been renamed to ; Element has been renamed to ; Element has been renamed ; Sub element to has been added; For element a new attribute kind has been added to indicate whether the food name is preferred (attribute: kind=”preferred”) or a synonym (attribute: kind=”synonym”); A new nested element with sub-elements has been added to the element; The value of the attribute system has been changed to “EuroFIR” when indicating that the component identifier is a EuroFIR component identifier; For the element the following attributes have been added: dategenerated, dateevaluated, methodparameter, and the attribute methodidentifier has been renamed medthodindicator; The element has been renamed and attribute acquisitiontype has been added; The elements and has been added as new nested elements to the element; The element element has been renamed to and two attributes portionsize and replicates has been added; For the element seven attibutes foodidentification, componentidentification, samplingplan, samplenumber, samplehandling, method, and performance has been added; New sub-element structures have been added: , , and .

Page 9 of 106

10

Page 10 of 110

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

11

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

The EuroFIR Food Data Transport Package The EuroFIR Food Data Transport Package XML template is based on a common XML de facto standard for food composition data interchange. It enables data to be transferred between food data compilers and between the food data compilers and the EuroFIR eSearch platform using web services’ applications.

The communication between the national or specialized database and the “outside world” is maintained by the use of web services implemented at the servers of the national and specialized databases. This allows the national and specialized databases to communicate directly with the eSearch platform, and it also provides the possibility for the national and specialized databases to communicate directly using the EuroFIR XML template to exchange data. In the greater aspect, the EuroFIR Food Data Transport Package XML template fulfils the data transfer between online datasets and their external users (either directly or indirectly). The full data transfer process is indicated below, and incorporates the following data transactions some of which using the Food Data Transport Package • • •

The compiler maintains food composition data on own web site with web service The end-user/receiver can build their own design for the food composition data The end-user/receiver updates information from the compiler automatically

Page 11 of 106

12

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

The full data flow is shown in the following figure: •

The compiler makes his data available online in XML on his web site



The online data service (e.g. the EuroFIR eSearch facilities) creates communication between own web server and the compiler’s XML files



The end-user asks for a products information



The online data service finds the relevant information and returns them to the end-user

Page 12 of 110

13

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

Formal conventions Properties For each entity set in the database schema, a list of all supported properties is provided. Each property is given a name, a unique property-id to be used in interchange packages (spelled out), a data type and a priority. Further detailed notes and explanations are provided for each property under scope note (see annex 1). As a default rule, a property Remark (type memo) is assigned to each main element within the XML template. This allows storage of all additional information not covered elsewhere in the schema.

Priorities The Eurofoods recommendations included priorities of properties based on the level of operation. The lower the level, according to the Eurofoods recommendations’ four-level structure, the more metadata is expected because the data reported is closer to its original source. The priorities given in the original Eurofoods recommendations were to be interpreted as seen from a food composition data compiler’s point of view. The same prioritization has been followed here. There are two priorities: 1. Mandatory (M) properties build the core set of data that is needed to be able to capture the basic idea of a given food composition study. 2. Optional (O) properties only apply to special circumstances and serve as a guideline to possibly important data. In some cases, the priority, recommended, is given in the specifications for an element. This means that the information is optional, but it is preferred that the information is given, if possible. Priorities are also given for whole entity sets (i.e. superior XML elements). If a recommended or optional entity set is used, the priorities for its properties apply as indicated in the entity set.

Complementary Use of Thesaurus Based Values and Free Text Properties that use set, THS (see Data types and Standards and thesauri) as their data type, only allow values that are part of the corresponding thesaurus. If for some reason the given thesaurus is not adequate, if a certain term is missing in the thesaurus, or if free text description is preferred over standardised vocabulary, the MEMO attribute should be used instead of the VALUE attribute. Further remarks should be placed in the REMARKS attribute. This mechanism allows use of both systems in parallel or introduction of new terms that might later become standard terms in the thesaurus. Page 13 of 106

14

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

Data Types Table 1 shows the basic original data types defined the Eurofoods Recommendations together with the suggested XML datatypes 5 for the XML template: 1

Abbreviation

Eurofoods Data Type

XML Data Type

STRnnn

Text String with a maximum of nnn characters where nnn stands for a number between 1 and 255. 255 applies if no length is specified. Currently, the XML encoding specifies the use of the ISO 8859-1).

string

MEM

Memo: text strings with a limit larger than 255 characters

string

DAT

Date: generally in the extended form, CCYY-MM-DD, with leading zeros according to ISO 8601:1988; nn case of reduced precision, days (DD), months (MM) or years (YY) may be omitted starting from the extreme right-hand side, e.g. 1999-07 or 1985. If time is also relevant use CCYY-MM-DD/hh:mm:ss

date

INT

Integer: in the range of +/- 2147483648 (= +/- 2 )

integer

NUM

Decimal Numbers: All given decimals must be significant. Trailing zeros are not cut, i.e. trailing zeros should be used to indicate significant decimals.

decimal

FRC

Fraction: a decimal number between 0 and 1 (0 and 1 inclusive)

BLN

Boolean: 1 = true, 0 = false

boolean

THS

Thesaurus Entry: valid interchange codes of thesaurus concepts. In the context of relational databases, thesauri are also known as look-up tables. Which thesaurus is used for a property is specified in the corresponding explanations.

string

FIL

Additional (multimedia) Files: Generally files are referred to as URIs. If a leading “http://” or “ftp://” is omitted, “file://MMFILES/*” is the default, i.e. a simple filename refers to a file, *, in the directory MMFILES, which is part of the interchange package.

anyURI

n/a

Not applicable – used for parent elements, which only encapsulates child elements and include no information themselves

31

1

From Eurofoods recommendations for food data management and data interchange with addition

5

W3C XML Schema Part 2: Datatypes Second Edition, W3C Recommendation 28 October 2004 (http://www.w3.org/TR/2004/REC-xmlschema-2-20041028/) Page 14 of 110

15

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

Standards and thesauri The EuroFIR Food Data Transport Package uses as widely as possible data representation as recommended in international and regional standard vocabularies and thesauri.

Standards A number of standards of the International Organization for Standardization (ISO), Geneva, Switzerland address issues of data interchange. The following standards have so far been identified as relevant for food composition data interchange. Some of these standards have been included as thesauri in the EuroFIR Food Data Transport Package, see next section. For more information on the standards, see http://www.iso.ch/. • ISO 639

Code for the representation of names of languages (current version available from ISO 639 Registration Authorities (ISO 639/RA) [http://www.infoterm.info/standardization/iso_639_1_2002.php].

• ISO 3166

Codes for the representation of names of countries and their subdivisions -- Part 1: Country codes and Part 2: Country subdivision code available at the ISO 3166 code lists page [http://www.iso.org/iso/country_codes/iso_3166_code_lists.htm].

The rules for the combinations of countries and languages best practices are defined in • Internet RFC4646

Defining Current Best Practice with regard to Tags for Identifying Languages, The Internet Society (2006) [http://tools.ietf.org/html/rfc4647].

• Internet RFC4647

Defining Current Best Practice with regard to Matching of Language Tags, The Internet Society (2005) [http://tools.ietf.org/html/rfc4646].

Indirectly, the following standards are also referred to in the Food Data Transport Package: • ISO 3297

Information and documentation -- International standard serial numbering (ISSN)

• ISO 6093

Information processing -- Representation of numerical values in character strings for information interchange

• ISO 8601

Data elements and interchange formats -- Information interchange -Representation of dates and times

• ISO 8859

Information processing -- 8-bit single-byte coded graphic character sets -- Part 1: Latin alphabet No. 1

• ISO 8879

Information processing -- Text and office systems -- Standard Generalized Markup Language (SGML)

Page 15 of 106

16

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

Thesauri The Eurofoods Basic Recommendations1 list a series of standard vocabularies, thesauri, that has been included in the EuroFIR Food Data Transport Package XML template together with some of the ISO standard representations. The thesauri are available as XML files. The locations are given below. The thesauri will be defined as XML namespaces in a future version of the EuroFIR Food Data Transport Package. The LanguaL food description thesaurus is publicly accessible from the langual.org website with the following URI http://www.langual.org/xml/langualXXXX.xml where XXXX is the version of the LanguaL Thesaurus. The LanguaL 2010 food description thesaurus is accessible from http://www.langual.org/xml/langual2010.xml The current version of LanguaL is always available as http://www.langual.org/xml/langual.xml and is the preferred LanguaL version used. The EuroFIR standard vocabularies, the “small” thesauri, are publicly accessible in XML format from the URI: http://techweb.eurofir.org/xml/... with the file names listed below. The following standard vocabularies are currently implemented (listed with filename): • acquisitiontype

EuroFIR standard representation of the aquisitiontype

• ecompid

EuroFIR standard representation of the component identifier

• unit

File: EuroFIR_Acquisition_Type_Thesaurus_version_1.1.xml File: EuroFIR_Component_Thesaurus_version_1.2.xml

EuroFIR standard representation of units of measurements

File: EuroFIR_Unit_Thesaurus_version_1.1.xml

• matrixunit

EuroFIR standard representation of matrix unit

• methodtype

EuroFIR standard representation of method type

• methodindicator

EuroFIR standard representation of method identifier

Page 16 of 110

File: EuroFIR_Matrix_Unit_Thesaurus_version_1.1.xml File: EuroFIR_Method_Type_Thesaurus_version_1.1.xml File: EuroFIR_Method_Indicator_Thesaurus_version_1.1.xml

17

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

• valuetype • referencetype

EuroFIR standard representation of value type

File: EuroFIR_Value_Type_Thesaurus_version_1.1.xml

EuroFIR standard representation of reference type

File: EuroFIR_Reference_Type_Thesaurus_version_1.1.xml

In addition, the ISO standard abbreviations for languages and countries are available in XML files • language • country

ISO 639:1988 - Code for the representation of names of languages

URI: http://www.loc.gov/standards/iso639-2/ISO-639-2_8859-1.txt l

ISO 3166-1:1997 - Codes for the representation of names of countries and their subdivisions -- Part 1: Country codes ISO 3166-2:1998 - Codes for the representation of names of countries and their subdivisions -- Part 2: Country subdivision code URI: http://www.iso.org/iso/iso_3166-1_list_en.zip

The following three standard vocabularies suggested previously has not been defined by EuroFIR at the time of publication of this report. • quality

EuroFIR standard representation of data quality data indicator

Thesaurus not defined for FDTP version 1.4

• domaintype

EuroFIR standard representation of domain type

• compilationtype

EuroFIR standard representation of compilation type

Thesaurus not defined for FDTP version 1.4 Thesaurus not defined for FDTP version 1.4

Subsequently, the corresponding elements has been removed from the XML representation. Similarly, corresponding attributes have been removed from the containing elements.

Other possible thesauri and standard vocabularies The list of thesauri and standard vocabularies used in connection with food data is in principle open ended, and the systems are practically used in parallel. The EuroFIR Food Data Transport Package allows the use of thesauri/standard vocabularies in parallel. For example, several component identifier systems or food classification systems can be used in parallel. The only prerequisite is that if food or compositional data make reference to a specific system (thesaurus/standard vocabulary), this system must be defined as a StandardVocabulary in the EuroFIR Food Data Transport Package. A non-exhaustive list of examples of other possible thesauri/standard vocabularies used in the EuroFIR and other food data interchange are

Page 17 of 106

18

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

for food classifications • CCFAF

Codex Classification of food and animal feed commodities

• CFCS

Codex Food Categorization System for the General Standard for Food Additives

http://www.codexalimentarius.net/download/standards/41/CXA_004_1993e. pdf

http://www.codexalimentarius.net/download/standards/4/cxs_192e.pdf

• GS1 GPC

• FoodEx 1

Global System 1 (GS1) Global Product Classification (GPC)

http://www.gs1.org/docs/gsmp/gpc/010611/Food_Beverage_Tobacco_0106 2011.zip

European Food Safety Authority food classification and description system FoodEx 1

http://www.efsa.europa.eu/en/datexdata/docs/StandardSampleDescription. xls

• FoodEx 2

European Food Safety Authority food classification and description system FoodEx 1 (draft revision 1) http://www.efsa.europa.eu/en/supporting/doc/215e.pdf

• etc. for components • ChEBI ID •

CAS No

Chemical Entities of Biological Interest (ChEBI ID)

http://www.ebi.ac.uk/chebi/init.do

CAS Registry Numbers

http://www.cas.org/expertise/cascontent/registry/regsys.html available from a series of free resources (source: Wikipedia) • Chemical Synthesis Database • PubChem • ChemSpider • NLM,NIH ChemIDplus • NIST Chemistry WebBook • R&D Chemicals • NCI Database Browser • NCI/CADD Chemical Identifier Resolver • Chemfinder • ChemSub Online (Multilingual chemical names) • European chemical Substances Information System (ESIS) - useful for finding EC# • NIOSH Pocket Guide to Chemical Hazards, index of CAS numbers

• EFSA code

• INFOODS

• etc. Page 18 of 110

European Food Safety Authority parameter codes for components

http://www.efsa.europa.eu/en/datexdata/docs/StandardSampleDescription. xls

INFOODS tagname thesaurus

Updated thesaurus reference pt. not available and therefore not defined for the FDTP.

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

19

Short description of the XML template Introduction This short description only incorporates the EuroFIR Food Data Transfer Package XML template’s elements (not the elements’ individual attributes). For the full structural layout, see Annex 3 and 4.

The XML Declaration The EuroFIR Food Data Transport Package’s XML declaration now uses UTF-8 encoding as the default:

In previous versions, the default encoding was iso-8859-1 encoding, while UTF-8 (UTF-16) encoding was allowed.

The Root Element, EuroFIRFoodDataTransportPackage The root element, EuroFIRFoodDataTransportPackage, indicating the full Food Data Transport Package for the eSearch, encapsulates the specific food data information. The EuroFIR Food Data Transport Package, version 1.4, XML template has a simple layout; it contains three header elements StandardVocabularies, SenderInformation and Content, and one food data entity represented by the Foods element. The full overview of the data model used in the EuroFIR Food Data Transport Package, version 1.4, XML template is shown schematically to the right. The single elements will be described in the following section.



The Root Element, EuroFIRFoodDataTransportPackage, needs specific attention. It defines the content of the XML packagenection with Web Services. The start tag of the root element looks like

which defines that the content and its structure in the XML transport package, e.g. in Web Services will be as defined in this document, which is currently the most comprehensive collecting of elements and attributes for food data interchange. In connection with the EuroFIR web services, other XML transport packages are under development,e.g. the EuroFIR Meta Data Transport Package, using elements with names and meanings as defined in this document, but possibly with a different structure of elements and attributes. Page 19 of 106

20

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

The root elements previosly defined EuroFIRFoodListTransportPackage, the list of food names in a dataset (under development) EuroFIRComponentListTransportPackage, the list of component names in a dataset (under development) have been removed from the current specifications. These elements are now obsolete and replaced by the use of the EuroFIR Meta Data Transport Package. The full specifications of the elements of the EuroFIR Food Data Transport Package, version 1.4, are given in Annex 1.

The header element, StandardVocabularies The StandardVocabularies element is further divided into one or more sub entities, StandardVocabulary. These contain information about (URLs, links to) standard vocabularies, thesauri, used in the food and component description of the data transported. The standard vocabularies may be redefined as XML namespaces in a future version of the EuroFIR Food Data Transport Package. For EuroFIR eSearch data interchange, the current positions and versions of the mandatory standard vocabularies 6 are

For other uses of the EuroFIR Food Data Transport Package, additional or different standard vocabularies may be used (for some examples, see also page 15). 6

All tags should occupy one line only, this is indicated with the ↵ symbol.

Page 20 of 110

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

21

The header element, SenderInformation The header element, SenderInformation, contains information about the sender of the Food Data Transport Package and information about how to contact the sender. The SenderInformation element is further divided into ten sub entities: • Sender, holding the name of the sender of the food data; • OrganisationName, the organisation to which the sender belongs; • SuperOrganisationName, entity to which the organisation belongs; • PostalAddress, the postal address (street, street number, city, zip); • Country, the country to which the sender and organisation belongs; • Telephone, telephone number of the sender (in international format • Fax, the fax number of the sender (in international format); • Email, the e-mail address of the sender; • WWWs, placeholder for URLs of the sender/sender’s organisation web site or web site to which the data belong; • WWW, single URL; • Remarks, additional remarks concerning the sender not covered by the elements above.

The header element, Content The Content element contains the information about the food data contained in the Foods element. The Content element is further subdivided into six elements: • ContentName, the (official) name of the data in the Foods element; • ShortContentName; a short name – eventually abbreviation – of the (official) name (used for identification of the dataset in EuroFIR eSearch, max. 20 characters); • ResponsibleBody, the body/organisation responsible for the data contained in the Foods element; • LegalRestrictions, any legal restrictions, e.g. copyrights, concerning the data contained in the Foods element; • SummaryOfContent, a short description of the data contained in the Foods element; • OriginalFoodClassification, information about the food classification used in connection with the element in the element; • QualityAssessmentScheme, information about the data quality assessment scheme used in the value documentation (this element is currently under development); Page 21 of 106

22

• • •

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

BibliographicReference, the overall bibliographic reference to the source of the data held in the Foods element, e.g. a published food composition database; Remarks, any futher remarks about the content of the transport package; ReasonForCreation, a short explanation about why (or how) this specific food data transport package was created.

The food data element, Foods The Foods element encapsulates the specific food data contained in the EuroFIR Food Data Transport Package. Each food is represented in a Food element. The Food element is further subdivided into two nested elements: • Description containing the description of the food • Components containing the information (identifiers, values, units, etc.) on the components in the food.

The FoodDescription element The FoodDescription element contains four sub-entities: • FoodIndentifiers element containing one or more local (national or regional) or international identifications of the food in sub-elements FoodIdentifier and Indentifier; • FoodClasses element containing one or more local (national or regional) or international classifications of the food in sub-elements FoodClass; • FoodNames element containing the name of the food in one or more languages (including scientific names) in sub-elements FoodName; • Recipe element containing the information about ingredients, if the food data are based on a recipe, either analysed or calculated; • Remarks element containing any information not included in the four previous elements.



The Components element The Components element encapsulates the Component elements which contain the food composition data. The Component element contains the two major component elements: the ComponentIdentifiers containing one or more local (national or regional) component identifers Page 22 of 110

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

23

in sub-elements ComponentIdentifier (for harmonised data, it must include an identifier from the appropriate thesaurus), and the Values element containing a Value element containing the following elements: •

• • • • • • • • • • • • •

SelectedValue containing the value of the food component, representing the best value (location) according to the choice of the food composition compiler; Mean containing the mean value of the statistic; Median containing the median of the statistic; Minimum containing the minimum value of the statistic; Maximum containing the maximum value of the statistic; StandardDeviation containing the standard deviation of the statistic; StandardError containing the standard error of the statistic; NoOfAnallyticalPortions containing the number of analyses; QualityIndex containing the quality index for the value according to the EuroFIR data quality assessment scheme (this element is currently under development); Remarks containing any further remarks concerning the value not included in the other Value sub-elements; ContributingValues containing any values contributing to the selected value above, it contains nested elements, ContributingValue, which has the same structure as Value, except for containing the ContributingValues element; Sample containing information about the sampling procedure and sample handling of the samples contributing to SelectedValue; MethodSpecification containing information about the method of analysis, analytical key steps, and laboratory performance; References containing two sub-elements: ValueReference containing the bibliographic reference to the source of the value, and MethodReference containing the specific reference to the analytical procedure the value is derived with.

Page 23 of 106

24

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

The Full Structure of the EuroFIR Food Data Transport Package EuroFIR XML Food Data Transport Package - Version 1.4

Page 24 of 110

25

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

EuroFIR XML Food Data Transport Package - Version 1.4



Page 25 of 106

26

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

EuroFIR XML Food Data Transport Package - Version 1.4





Page 26 of 110

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

27

EuroFIR XML Food Data Transport Package - Version 1.4

Page 27 of 106

28

Page 28 of 110

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

29

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

EuroFIR eSearch minimum requirements Updated 2012-03-01. The EuroFIR Food Data Transport Package, version 1.4, XML template has minimum requirements for the contained information. The following list indicates the minimum requirements for data interchange with EuroFIR eSearch listed in numerical display. All the elements listed are mandatory in the EuroFIR eSearch food data interchange and together with the corresponding attributes; they constitute the minimum requirements of the EuroFIR Food Data Transport Package (2012-03-01) 7.

ElementId

ElementName

0001 0002 0003 0004 0005 0006 0016 0017 0018 0019 0024 0027 0028 0029 0030 0031 0032 0034 0035 0045 0046 0047 0048 0049 0050 0051 0148 0149



7

There may be specific cases where more elements may be needed as necessary. Page 29 of 106

30

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

The following requirements must be fulfilled especially for the StandardVocabularies element: •

Always one StandardVocabularies element with at least one or more StandardVocabulary elements (the mandatory elements for the EuroFIR eSearch are listed on page.



In practice, all used standard vocabularies should be included. This means that for food composition data interchange within EuroFIR, the following standard vocabularies should be represented: o o o o o o o o o

language component unit matrixunit methodtype methodindicator valuetype acquisitiontype referencetype

In addition to the mandatory elements and their mandatory attributes, the following detailed requirements for EuroFIR eSearch listed below should be noted •

The element has a maximum length of 20 characters. The element is used a database identifier in EuroFIR eSearch;



For every component, there can be several component identifier elements, and at least one of them must be

in which, the attribute, system=”ecompid” denotes that the value of the element is the component identifier according to the EuroFIR Component Thesaurus. •

In the element / element,s one “preferred” name should be given for each domain, i.e. each language, used; this means that if the kind attribute is used, an example of how it should be used is

Abelmoschus esculentus (L.) Moench Hibiscus esculentus L.

and not like Amaretti (Mandelgebäck) Amaretti (almond-liquor flavoured cookies)

For more information on the FoodNames elements, see pages 66-67.

Page 30 of 110

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01



31

In order to be able to identify the food in the originating online database, it is mandatory to include a food identifier element as

in which, the attribute, system=”orgifdcd” denotes that the value of the element is the food identifier according to the originating database; although a “system” thesauri, it is not necessary to define the system in the StandardVocabularies section. •

In the element, the method parameter attribute, methodparameter=”[xxx]”, is mandatory for the EuroFIR Component Identifiers PROT and FAT ([xxx] being the nitrogen-to-protein conversion factor, NCF, or the lipid conversion factor, FACF, respectively) . This means that for the EuroFIR Component Identifiers PROT and FAT, the element should lookfor example look like

for a protein value; if no method parameter is known, it is suggested to leave the method parameter empty, e.g.

For the remaining mandatory and optional information in the element, see the element description on page 82.

Page 31 of 106

32

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

Future developments It is envisaged that the EuroFIR Food Data Transport Package XML template will undergo several revisions during the coming years as data interchange using the template is being tested. Nutrient retention factors are not expected to be delivered with the EuroFIR Food Data Transport Package. A special file format/name space may be defined for this purpose.

Further information For further information, see the EuroFIR draft Standard for food composition data and its Technical Annex4.

Page 32 of 110

33

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

Annex I Detailed Specifications of the EuroFIR Food Data Transport Package The EuroFIR Food Data Transport Package is described in details in the following annex.

Page 33 of 106

34

Page 34 of 110

EuroFIR Food Data Transport Package Description, Version 1.4 - 2012-03-01

Food Data Transport Package Description, Version 1.4

35

- 2012-03-01

EuroFIRFoodDataTransportPackage root element Description: The root element for the EuroFIR Food Data Transport Package.

Element Position:

Restrictions: Mandatory. Type: n/a. Max 1 (one) EuroFIRFoodDataTransportPackage per transport package.

Recommendations:

Attributes: Name

Description

Type

name

Name of the Food Data Transport Package XML template

string

Max length Mandatory Yes

version

Version of the Food Data Transport Package XML template

string

Yes

sentdate

Date the Food Data Transport Package was sent

date

Yes

Remarks

Further specifications:

Page 35 of 106

36

Food Data Transport Package Description, Version 1.4 - 2012-03-01

StandardVocabularies element Description: The main element for standard vocabularies (thesauri). Encapsulates the element StandardVocabulary.

Element Position:

Restrictions: Mandatory. Type: n/a. Max 1 (one) StandardVocabularies element per EuroFIRFoodDataTransportPackage. The StandardVocabularies element must contain all standard vocabularies referred to in the succeeding sections of the XML template.

Recommendations: It is mandatory that the EuroFIRFoodDataTransportPackage contains the StandardVocabularies element with reference to the thesauri used in the food and component descriptions

Attributes: Name

Description

Further specifications:

Page 36 of 110

Type

Max length Mandatory

Remarks

Food Data Transport Package Description, Version 1.4

37

- 2012-03-01

StandardVocabulary element Description: The StandardVocabulary element contains reference (link) to a thesaurus (controlled vocabulary).

Element Position:

Restrictions: Mandatory. Type: n/a. At least 1 (one) StandardVocabulary element per StandardVocabularies element. Only 1 (one) StandardVocabulary per system attribute.

Recommendations:

Attributes: Name

Description

system

Unique name of the thesaurus string referred to in the succeeding part of the template.

Type

Yes

position

URL of the thesaurus (typically at EuroFIR Technical Web Site)

Yes

anyURI

Max length Mandatory

Remarks

Further specifications:

Page 37 of 106

38

Food Data Transport Package Description, Version 1.4 - 2012-03-01

SenderInformation element Description: The SenderInformation element contains information about the Sender of the EuroFIR Food Data Transport Package.

Element Position:

Restrictions: Mandatory. Type: n/a.

Recommendations:

Attributes: Name

Description

Type

Max length Mandatory

Further specifications: The SenderInformation element corresponds to the INFOODS element

Page 38 of 110

Remarks

Food Data Transport Package Description, Version 1.4

39

- 2012-03-01

Sender element Description: The Sender element contains information about the Sender of the EuroFIR Food Data Transport Package. The Sender may be a person or a corporate entity.

Element Position:

Restrictions: Mandatory. Eurofoods data type: STR; XML Data Type: string. It must contain at least one or more of the subsidiary child elements.

Recommendations:

Attributes: Name

Description

Type

Max length Mandatory

Remarks

Further specifications: The Sender element corresponds to the INFOODS element. The Sender element corresponds to the Eurofoods SENDER field (Source table)

Page 39 of 106

40

Food Data Transport Package Description, Version 1.4 - 2012-03-01

OrganisationName element Description: The OrganisationName element contains information about the official name of the organisation. It specifies the organisation to which a person specified in belongs.

Element Position:

Restrictions: Mandatory. Eurofoods data type: STR; XML Data Type: string.

Recommendations:

Attributes: Name

Description

Type

Max length Mandatory

Remarks

Further specifications: The OrganisationName element corresponds to the INFOODS element. The OrganisationName element corresponds to the Eurofoods ORGNAM field (Organisation table).

Page 40 of 110

Food Data Transport Package Description, Version 1.4

41

- 2012-03-01

SuperOrganisationName element Description: The SuperOrganisationName element contains information about the official name of the umbrella organisation, if applicable.

Element Position:

Restrictions: Optional. Eurofoods data type: STR; XML Data Type: string.

Recommendations:

Attributes: Name

Description

Type

Max length Mandatory

Remarks

Further specifications: The SuperOrganisationName element corresponds to the Eurofoods SPORGNAM field (Organisation table).

Page 41 of 106

42

Food Data Transport Package Description, Version 1.4 - 2012-03-01

PostalAddress element Description: The PostalAddress element contains information the address of the organisation as would be put on a letter, i.e. PO box, address, zip code, city, country, etc.

Element Position:

Restrictions: Recommended. Eurofoods data type: MEM; XML Data Type: string.

Recommendations:

Attributes: Name

Description

Type

Max length Mandatory

Remarks

Further specifications: The PostalAddress element corresponds to the INFOODS element. The PostalAddress element corresponds to the Eurofoods POSTADDR field (Organisation table).

Page 42 of 110

Food Data Transport Package Description, Version 1.4

43

- 2012-03-01

Country element Description: The Country element contains the country information of the address of the organisation.

Element Position:

Restrictions: Recommended. Eurofoods data type: THS; XML Data Type: string.

Recommendations: Use ISO 3166-1. A country subdivision code as described in ISO 3166-2 can be added after the country code separated by a hyphen, e.g. CH-ZH.

Attributes: Name

Description

Type

Max length Mandatory

Remarks

Further specifications: The Country element corresponds to the INFOODS element. The Country element corresponds to the Eurofoods COUNTRY field (Organisation table).

Page 43 of 106

44

Food Data Transport Package Description, Version 1.4 - 2012-03-01

Telephone element Description: The Telephone element contains the telephone number of the Sender.

Element Position:

Restrictions: Recommended. Eurofoods data type: STR; XML Data Type: string.

Recommendations: Telephone and Fax numbers should be formatted from an international point of view. Use the form +country-code areacode sub area-code phone-number. The various blocks should be separated with a space character or hyphen.

Attributes: Name

Description

Type

Max length Mandatory

Remarks

Further specifications: The Telephone element corresponds to the INFOODS element. The Telephone element corresponds to the Eurofoods PHONE field (Organisation table).

Page 44 of 110

Food Data Transport Package Description, Version 1.4

45

- 2012-03-01

Fax element Description: The Fax element contains the fax number of the Sender.

Element Position:

Restrictions: Recommended. Eurofoods data type: STR; XML Data Type: string.

Recommendations: Telephone and Fax numbers should be formatted from an international point of view. Use the form +country-code areacode sub area-code phone-number. The various blocks should be separated with a space character or hyphen.

Attributes: Name

Description

Type

Max length Mandatory

Remarks

Further specifications: The Fax element corresponds to the INFOODS element. The Fax element corresponds to the Eurofoods FAX field (Organisation table).

Page 45 of 106

46

Food Data Transport Package Description, Version 1.4 - 2012-03-01

Email element Description: The Email element contains the Internet e-mail address of the Sender.

Element Position:

Restrictions: Recommended. Eurofoods data type: STR; XML Data Type: string.

Recommendations: It specifies the sender's electronic mail address. "Email" can be interpreted as an abbreviation for "electronic mail".

Attributes: Name

Description

Type

Max length Mandatory

Further specifications: The Email element corresponds to the INFOODS element. The Email element corresponds to the Eurofoods field EMAIL (Organisation table).

Page 46 of 110

Remarks

Food Data Transport Package Description, Version 1.4

47

- 2012-03-01

WWWs element Description: The WWWs element contains one or more URLs of serder/senderorganisations. It contains the nested WWW element.

Element Position:

Restrictions: Recommended. Type: n/a

Recommendations:

Attributes: Name

Description

Type

Max length Mandatory

Remarks

Further specifications:

Page 47 of 106

48

Food Data Transport Package Description, Version 1.4 - 2012-03-01

WWW element Description: The WWW element contains the URL of the Sender, if applicable.

Element Position:

Restrictions: Recommended. If the embedding has been used. is mandatory. Eurofoods data type: STR; XML Data Type: anyURI.

Recommendations: Always give complete URLs. Example: http://www.fao.org/infoods/.

Attributes: Name

Description

Type

Max length Mandatory

Further specifications: The WWW element corresponds to the Eurofoods WWW field (Organisation table).

Page 48 of 110

Remarks

Food Data Transport Package Description, Version 1.4

49

- 2012-03-01

Remarks element Description: The Remarks element subsidiary to the SenderInformation contains any further remarks to the SenderInformation not included in the other subsidiary SenderInformation elements, if applicable.

Element Position:

Restrictions: Optional. Eurofoods data type: MEM; XML Data Type: string.

Recommendations: Any further remarks.

Attributes: Name

Description

Type

Max length Mandatory

Remarks

Further specifications: The Remarks element corresponds to the INFOODS