Last updated: June 24, 1997
This document provides a formal description of metadata structure and content for the EMF Measurements Database.
The purpose of the metadata is to describe the data associated with a data set in the Database. The metadata performs two basic functions in the Database: 1) to inform a potential user what a data set contains; and 2) to document the structure and interpretation of the data products for the user.
The metadata specification is composed of a list of elements. The elements form a tree structure. There are two types of elements: 1) branch elements which provide structure; and 2) leaf elements provide the content of the metadata. At the root of the metadata tree is a branch element called `metadata'. The metadata element is composed of three other elements (dataset description, data model and data products), each of which is also a branch element composed of other elements.
Each element is assigned a reference number to help the reader in navigating the specification. The element definitions are listed in order by reference number in the body of the specification. A list of elements sorted alphabetically is presented at the end of the specification to help locate the element by name.
Each element definition includes the reference number, the element name, a discussion of the element and what it represents, a formal content model specification, and a list of parent elements (branch elements where the current element can occur). Elements in the content model and parent specifications include the associated reference number as a subscript.
The content model of a leaf element is given as `Free Text'. This indicates that the element contains textual information about the data set.
The content model of a branch element is more complex. Branch elements do not contain textual information directly, but rather contain other elements. Those elements may be themselves branch elements or leaf elements. Keywords are used to indicate how the constituent elements are composed. A keyword always comes immediately after an opening parenthesis and applies to all the elements until the matching right parenthesis. In the content model for the root element `metadata', the keyword `sequence' is used. Therefore, `metadata' is composed of the sequence of elements `dataset-description', `data-model', and `data-products'). Other keywords include `exclusive-or', `zero-or-one', `zero-or-more', and `one-or-more'.
The metadata describes the data set, including all the information a database user needs to understand and make use of it. Metadata is divided into three sections: dataset description, data model, and data products. Please refer to the descriptions of those sections for details.
Element Content:
(sequence dataset-description1 data-model2 data-products3 )
Parents:
The dataset description contains information about the data set as a whole. It indicates the name of the data set and answers the questions: who, what, where, when, how and why. It also identifies target populations and how samples were selected and measured.
Element Content:
(sequence dataset-title1.1 dataset-number1.2 dataset-version1.3 dataset-status1.4 (one-or-more revision-history4.1 ) dataset-abstract1.5 (zero-or-more producer1.6 ) time-period1.7 geographic-location1.8 general-location1.9 dataset-purpose1.10 (zero-or-one sic1.11 ) (one-or-more measurement-design1.12 ) (one-or-more instrumentation1.13 ) associated-project1.14 (zero-or-more report1.15 ) )
Parents:
Indicates the title by which the data set will be known. The data set contributor should provide a title, but it may be edited by the Database to conform to a standard format or to avoid confusion with a different data set.
Element Content:
Free Text
Parents:
Each data set will be assigned a number determined by the order in which it was accepted for inclusion by the Database. This number will be assigned by the Database. The data set contributor should leave this value blank.
Element Content:
Free Text
Parents:
The data set version reflects the data set as a whole. The version should be provided in the form of a date, and the date should be updated whenever a change occurs to any of the data products, the metadata or the report files. The date should be formatted in ISO 8601 (yyyymmdd) format.
Element Content:
Free Text
Parents:
The data set status should indicate the degree of completion associated with the data set. It may be used to indicate areas that seem to warrant additional data cleansing and if any development activities associated with the data set are planned or ongoing, including the general nature of those activities. The data set contributor should provide this information with reference to the data they supply to the Database. The Database will modify it to reflect whatever modifications they make to the data set.
Element Content:
Free Text
Parents:
The data set abstract is a textual description or executive summary of the data set and the research that led to its collection. It serves to introduce a reader to the data set by providing an overview. The data set contributor may wish to repeat much of the information from the data set description section of the metadata here in more of a prose form.
Element Content:
Free Text
Parents:
The producer information consists of the contact information for the person or organization responsible for the design and execution of the data collection (i.e., the principal investigator). Zero or more producers may be specified in the data set description, so contributors should include as many as seem appropriate. This information will provide acknowledgement of the individuals responsible for the data collection, as well as provide a point of contact in pursuing additional questions about how the data set was collected.
Element Content:
Parents:
The time period should indicate the period or periods during which data collection occurred. Dates should be provided in ISO 8601 (yyyymmdd) format.
Element Content:
Free Text
Parents:
The geographic location should indicate, as appropriate, the (one or more) city, township, county, region, state, province or country in which data collection occurred.
Element Content:
Free Text
Parents:
The general location of the data set indicates the type of environment in which the measurements were made. Examples include: occupational, residential, transportation, educational, commercial, recreational.
Element Content:
Free Text
Parents:
The data set purpose indicates the principal reason that data were collected. For example, were the data collected as part of a routine monitoring program, an exposure assessment study, a protocol development study or something else?
Element Content:
Free Text
Parents:
The Standard Industrial Classification should be provided in cases where data collection occurs in occupational environments, unless occupational data collection is incidental and no particular industries are the target of the data collection. This information is an optional part of the data set description section, but should be provided if applicable.
Element Content:
Free Text
Parents:
An measurement design includes information about a particular measurement type associated with the data set. It includes information about the target population, how a sample of that population was selected, the measured parameter of the sample that was measured and how it was measured. One or more measurement design may be included in the data set description, as appropriate for the data set.
Element Content:
(sequence sample-target1.12.1 sample-selection1.12.2 sample-size1.12.3 measured-parameter1.12.4 methodology1.12.5 (zero-or-more instrument-name1.12.6 ) sampling-interval1.12.7 sampling-duration1.12.8 )
Parents:
The sample target of the measurement design indicates the population for which a characterization is sought. This population could be human subjects, locations, activities or sources. For example, a study might be seeking to characterize the exposure of office workers. In this case, the sample target would be office workers. The sample target should reflect the goals of the data collection, not necessarily the results.
Element Content:
Free Text
Parents:
The sample selection should indicate how a sample of the target population was selected. The sample selection should indicate if the selection was random, targetted, convenience or made by some other method. A brief description of the protocol used to select the sample should be provided.
Element Content:
Free Text
Parents:
The sample size should indicate the size of the measured sample. The sample size should also indicate if each individual of the sample was measured more than once.
Element Content:
Free Text
Parents:
The measured parameter is the quantity being measured or characterized about each subject (person, environment, activity, source, etc.) of the sample. Examples of the measured parameter would include the resultant magnitude of contemporaneous three-axis magnetic field measurements, and maximum single-axis magnetic field.
Element Content:
Free Text
Parents:
The methodology describes how the measurements were collected. It should contain the relevant portions of the study's protocol not contained in other portions of the measurement design description. For example, the methodology should indicate where on the body the measurement device was used (in the case of personal exposure measurements).
Element Content:
Free Text
Parents:
The instrument name indicates the instrument used to perform a measurement. The instrument name is used to link an measurement design with a description of a type of instrumentation. The instrument name in the measurement design section is the link to information about the instrument contained in an adjacent section. If more than one instrument type is used interchangably for a measurement, then each one should be referenced with an instrument name. The instrument name should uniquely identify different instrumentation used in the study. If multiple versions of an instrument are sufficiently different to warrant separate consideration, they should be given different names. The names need only be unique within the data set.
Element Content:
Free Text
Parents:
For periodic measurements, such as those of a time-series, the sampling interval indicates the period between the measurements. If multiple measurements of a subject are not regular, then this irregularity should be indicated here.
Element Content:
Free Text
Parents:
The sampling duration indicates the span of time over which a time-series or other multiple measurements take place. For personal exposure measurements, examples include a work day or a 24-hour period.
Element Content:
Free Text
Parents:
The instrumentation describes a type of instrument used in the collection of data. Each is identified by an instrument name corresponding to one used in the measurement design section. Each instance of instrumentation should have a unique instrument name. Characteristics of the instrumentation are described here.
Element Content:
(sequence instrument-name1.12.6 manufacturer1.13.1 instrument-version1.13.2 associated-software1.13.3 frequency-response1.13.4 dynamic-range1.13.5 (zero-or-one discussion1.13.6 ) )
Parents:
The manufacturer information consists of the contact information for the person or organization responsible for the manufacture of the instrumentation. This provides a way for data set users to identify and contact manufacturers to obtain additional information about the characteristics of the instrumentation.
Element Content:
Parents:
Since instrumentation can sometimes have different operating characteristics from version to version, it is important that the version numbers be reported. If no explicit version information is provided with the instrument, data set contributors should indicate the date of instrument manufacture or purchase, if known.
Element Content:
Free Text
Parents:
The software used in association with an instrument may influence the way that collected data are processed and stored. Data set contributors should indicate the name and version numbers of software used in association with the instrument. If no explicit version information is available, a date associated with the software may be substituted. Examples of indicative dates include the date stamp on files from the software installation diskettes, or the purchase date of the software. The origin of the date should also be provided.
Element Content:
Free Text
Parents:
The frequency response provides an indication of the relative sensitivity of the instrument as a function of frequency. While frequency response is often communicated most effectively with a graph, some verbal description can be made here (for example, 30 to 300 Hz).
Element Content:
Free Text
Parents:
The dynamic range indicates the range of possible values, from minimum to maximum, that may be recorded by the instrument as it was used in the study.
Element Content:
Free Text
Parents:
Any information associated with the instrument or its use not found elsewhere may be optionally provided here.
Element Content:
Free Text
Parents:
A large study or project may generate more than one data set. Since the metadata primarily reflects the individual data sets, a special section is devoted to linking the data set to the larger study or project that generated it. The associated project contains information about the project's name, the investigators, and the sponsors.
Element Content:
(sequence project-name1.14.1 (zero-or-more investigator1.14.2 ) (zero-or-more sponsorship1.14.3 ) (zero-or-more citation1.14.4 ) )
Parents:
The project name is the official name by which the study or project is known, including any numeric designations assigned by the sponsors.
Element Content:
Free Text
Parents:
The investigator information consists of the contact information for the associated project. More than one investigator may be listed.
Element Content:
Parents:
The sponsorship information consists of the contact information for the sponsors of the associated project. More than one sponsor may be listed.
Element Content:
Parents:
The citation information provides references to published articles, reports and/or other documentation describing the associated project. Each citation should be listed separately.
Element Content:
Free Text
Parents:
A report refers to a document consisting of text, tabular and graphic information which describes the results of analysis of the data. Reports may be submitted by the contributor and/or by Database users. The report metadata element consists of authorship, title and version information as well as a URL to the online version of the report.
Element Content:
(sequence (zero-or-more report-author1.15.1 ) report-title1.15.2 report-version1.15.3 report-url1.15.4 )
Parents:
The report authorship information consists of the contact information for the author of the report. More than one author may be listed.
Element Content:
Parents:
The report title is a descriptive name for the report. A suggested title should be offered by the report authors, however, the Database may edit it for consistency with other report titles.
Element Content:
Free Text
Parents:
The report version should be provided in the form of a date. Revised reports may be retained in their earlier incarnations, in addition to newer versions. The report version provides a way to distinguish between the versions. The report version also indicates when the report was constructed, which may assist the reader in interpretting it.
Element Content:
Free Text
Parents:
The report URL (uniform resourse location) is the address, if one exists, of the report online. For reports contributed to the Database, the contributor may leave this blank.
Element Content:
Free Text
Parents:
The data model is, as its name suggests, a model of how the information in the data set are organized. The data model describes how the various components (entities) of the data set are related (relationships) and how they are described (attributes). As a model, it need not be precise. The goal is to capture the essence of the data set's organization, not necessarily all of its twists and turns. Data modeling in this context may be unfamiliar to many data set contributors. Consequently, the contributor need not provide this information. However, constructing a data model can be a helpful exercise in organizing data collection efforts. If the data model is not provided by the contributor, the Database staff will construct a data model from the available information.
Element Content:
(zero-or-more (exclusive-or entity2.1 relationship2.2 ) )
Parents:
An entity is a type of thing, abstract or concrete, about which information is (or will be) known. Each entity consists of a set of attributes. For example, in a personal exposure data set's data model, the entities might include the subject, the session and the measurement. The subject entity might be described with attributes such as name, age and job title. The session entity might be described by the start time, instrument serial number and sampling interval. The measurement entity might be described with attributes such as time, associated environment or activity, and magnetic field.
Element Content:
(sequence entity-name2.1.1 entity-description2.1.2 (zero-or-more attribute2.1.3 ) )
Parents:
The entity name is a way of referring to the entity (set of attributes) as a whole and in a way that represents the set of attributes. Each entity should have a unique name, since the name is used to refer to the entity.
Element Content:
Free Text
Parents:
The entity description should discuss in more detail what the entity represents.
Element Content:
Free Text
Parents:
An attribute describes a particular feature of an entity (or sometimes a relationship) in the data model. For example, in the data model for a personal exposure data set, the subject entity might be described by attributes such as identification number, age and job title. Each attribute has a name, description, an optional discussion of accuracy, and a domain.
Element Content:
(sequence attribute-name2.1.3.1 attribute-description2.1.3.2 (zero-or-one attribute-accuracy2.1.3.3 ) (exclusive-or simple-domain2.1.3.4 codeset-domain2.1.3.5 ) )
Parents:
The attribute name is a way of referring back to the attribute and its associated information. Each attribute in the data model should have a unique name.
Element Content:
Free Text
Parents:
The attribute description should discuss in detail what the attribute represents and how it was computed or arrived at.
Element Content:
Free Text
Parents:
Where applicable, the attribute accuracy should discuss the possible sources of error and their magnitude to provide an indication of how accurate the attribute data is likely to be. Also, quality assurance activities specific to the attribute may be described here. For magnetic flux density and electric field strength measurements, it is recommended to use the IEEE Std 1308-1994 as a guide to providing appropriate estimations of uncertainty.
Element Content:
Free Text
Parents:
A simple domain is a range of possible values that may be easily described verbally. The simple domain should indicate the range of possible values and any associated units. Attributes which use interval scales often are best represented by a simple domain. Some attributes which may be described with simple domains include magnetic field and date. Compare with the codeset domain.
Element Content:
Free Text
Parents:
A codeset domain is an enumeration of possible values, each requiring a separate description. A codeset domain is often appropriate for nominal or ordinal scale attributes, particularly where codes are used repeatedly to reference the same properties. Some examples of attributes suitable for codeset domains include job title, environment or activity.
Element Content:
(zero-or-more codeset-code2.1.3.5.1 )
Parents:
A codeset code represents each of the code values in the codeset domain. Each codeset code provides a mapping from one codeset value to a codeset description. For example, the job title attribute might use a code of `17' for `Substation Electrician'.
Element Content:
(sequence codeset-value2.1.3.5.1.1 codeset-description2.1.3.5.1.2 )
Parents:
The codeset value represents the code, usually numeric, that represents the meaning given in the codeset description. By convention, the Database will endeavor to use numeric rather than text codes to allow use with a wider array of software.
Element Content:
Free Text
Parents:
The codeset description contains text explaining the meaning of the codeset value. The codeset description should provide whatever detail is available about the corresponding codeset value for the attribute.
Element Content:
Free Text
Parents:
A relationship represents a link between entities in the data model. For a personal exposure data set, the subject and session entities might be linked with a relationship. Each session measures a subject. In the data products, the link might be represented through the use of identification numbers for the related entities. Relationships can sometimes have attributes of their own.
Element Content:
(sequence relationship-name2.2.1 relationship-description2.2.2 relationship-from2.2.3 relationship-to2.2.4 cardinality2.2.5 (zero-or-more attribute2.1.3 ) )
Parents:
The relationship name is a way of referring to the relationship as a whole. Each relationship should have a unique name, since the name may is used to refer to the relationship. Often, the name may be chosen so that it may be `read' in between the two names of the entities it is relating. For example, a `session' (entity) `measures' (relationship) a `subject' (entity).
Element Content:
Free Text
Parents:
The relationship description provides any details about the relationship. Often, little description is necessary for a relationship.
Element Content:
Free Text
Parents:
Indicates one of the entities the relationship is linking. The `from' entity should be the one read first in an entity-relationship-entity verbalization.
Element Content:
Free Text
Parents:
Indicates one of the entities the relationship is linking. The `to' entity should be the one read last in an entity-relationship-entity verbalization.
Element Content:
Free Text
Parents:
The cardinality is used to describe how many of one entity might be related to how many of the other entity by the relationship. Possible cardinalities include: one to one, one to many, many to many, etc. The order of the `one' and `many' should correspond to the way that `relationship from' and `relationship to' are defined. If each subject is measured multiple times but each session measures only one subject, then the cardinality of a `session measures a subject' relationship would be `many to one'.
Element Content:
Free Text
Parents:
The data products section of the metadata describes what data are available and from whom. The data products section contains the contact information for the distributors of the data products and detailed descriptions of the data products themselves. At present, a data product is either a binary data product or a delimited ASCII data product. Additional data product types will be added to the metadata specification as necessary.
Element Content:
(sequence (zero-or-more distributor3.1 ) (zero-or-more (exclusive-or binary-data-product3.2 delimited-ascii-data-product3.3 ) ) )
Parents:
The distributor information consists of the contact information for the person or organization responsible for distributing the data products. One or more distributors may be specified, as appropriate.
Element Content:
Parents:
The binary data product information describes a generic non-ASCII file structure. The structure of the file is described in terms of data segments. A data segment is a continuous sequence of bytes (or bits) that has a specified size, type and position. A data segment can represent one piece of information or a collection. In the latter case, it is called a composite data segment.
Element Content:
(sequence data-product-name3.2.1 data-product-description3.2.2 level-of-interpretation3.2.3 data-product-conditions3.2.4 data-product-url3.2.5 data-product-availability3.2.6 data-product-use-size3.2.7 data-product-download-size3.2.8 (zero-or-more revision-history4.1 ) byte-order3.2.9 (zero-or-one data-segment-content3.2.10 ) )
Parents:
The data product name provides a way of referring to the data product. It is a part of both the binary data product and the delimited ASCII data product.
Element Content:
Free Text
Parents:
The data product description provides a discussion of the features of the data product. It is a part of both the binary data product and the delimited ASCII data product.
Element Content:
Free Text
Parents:
The level of interpretation of a data product refers to the range of possibilities reflecting the raw versus processed nature of the information. The level of interpretation should be one of the following: raw or sensor data (raw values obtained from the measurement device), calibrated data (raw physical values, corrected with calibration operators), validated data (calibrated data that has been filtered through quality assurance procedures), derived data (frequently aggregated data, such as gridded or averaged data for which the detail of the underlying measurements has been lost), or interpreted data (derived data that is related to other data sets or to relevant literature). The level of interpretation is a part of both the binary data product and the delimited ASCII data product.
Element Content:
Free Text
Parents:
The data product conditions represent any conditions placed on the use of the data. For data sets distributed by the Database, contributors will be asked to sign papers authorizing the Database to distribute and allow redistribution of their data set. The data product conditions are a part of both the binary data product and the delimited ASCII data product.
Element Content:
Free Text
Parents:
The data product URL (uniform resource location) is the address, if one exists, of the data product online. For data sets distributed by the Database, the contributor may leave this blank. The data product URL is a part of both the binary data product and the delimited ASCII data product.
Element Content:
Free Text
Parents:
The data product availability describes off-line procedures for obtaining the data product. Typically, data products will be available on diskette or CD-ROM for a nominal fee to cover materials, shipping and handling. The data product availability is a part of both the binary data product and the delimited ASCII data product.
Element Content:
Free Text
Parents:
The use size of the data product is the size of the uncompressed data product file or files in bytes.
Element Content:
Free Text
Parents:
The download size of the data product is the size of the data product file or files in bytes, as it is presented online. This value will provide a basis for judging approximately how long it will take to electronically transfer from the distributor.
Element Content:
Free Text
Parents:
The byte order indicates how multi-byte values are arranged in binary data products. For example, Intel-based personal computers (and clones) use `least-significant-byte-first' ordering and Motorola-based personal computers (such as the Macintosh) use `most-significant-byte-first' ordering. To avoid uncertainty, byte ordering should be explicitly indicated. If the contributor does not know the byte-ordering, they may substitute a description of their computer and software used to create the binary data product.
Element Content:
Free Text
Parents:
The data segment content lists the parts of the composite data segment. It consists of one or more data segment or composite data segment. The data segment content is a part of both the binary data product and the composite data segment.
Element Content:
(one-or-more (exclusive-or data-segment3.2.10.1 composite-data-segment3.2.10.2 ) )
Parents:
The data segment describes a sequence of one or more bytes (or bits) that represents a single attribute or other piece of information in the data product. An example of three data segments is provided by the following hypothetical binary data product file header. The first ten bytes of the header contain three data segments: 1) the first four bytes contain an integer value representing the total size of the file; 2) the next four bytes contain an integer value representing the number of measurements found following the header in the file; and 3) the last two bytes of the header contain an integer value representing the identification number of the session for the file.
Element Content:
(sequence data-segment-name3.2.10.1.1 (exclusive-or data-segment-description3.2.10.1.2 (sequence entity-membership4.3 (zero-or-one data-segment-description3.2.10.1.2 ) ) ) data-segment-position3.2.10.1.3 data-segment-size3.2.10.1.4 data-segment-format3.2.10.1.5 )
Parents:
The data segment name is a descriptive name for the data segment. If the data segment is related to an attribute from the data model section, then this name should match the attribute name. The data segment name occurs in both the data segment and composite data segments. The data segment name is a part of both the data segment and the composite data segment.
Element Content:
Free Text
Parents:
The data segment description provides information about the data segment contents. If the data segment also contains entity membership information, then the corresponding attribute of the named entity may carry the primary burden of describing the data segment. However, in such cases the data segment description should indicate anything special about the binary format presentation of the information. The data segment description is a part of both the data segment and the composite data segment.
Element Content:
Free Text
Parents:
The data segment position indicates the location of the data segment within the binary file or within other indicated structures within the binary file. The data segment position is a part of both the data segment and the composite data segment.
Element Content:
Free Text
Parents:
The data segment size indicates the size of the element, typically in units of bytes or bits. If the data segment is of variable size, the data segment size should indicate how to compute or deduce the size of the data segment. The data segment size is a part of both the data segment and the composite data segment.
Element Content:
Free Text
Parents:
The data segment format indicates how the bytes or bits are arranged. For example, the data segment might be formatted as an IEEE floating point number, which by definition assigns certain bits to the mantissa and exponent portions of the number. Other format examples include signed and unsigned integers.
Element Content:
Free Text
Parents:
The composite data segment, as the name suggests, is a composite of other data segments or composite data segments. A composite data segment might be used to describe a file structure that contains a header and a body. The header will often itself be a composite. The composite data segment allows arbitrary file structures to be described in a systematic manner by building more complex structures from less complex ones.
Element Content:
(sequence data-segment-name3.2.10.1.1 data-segment-description3.2.10.1.2 data-segment-position3.2.10.1.3 data-segment-size3.2.10.1.4 data-segment-content3.2.10 )
Parents:
A delimited ASCII data product is a data product that is organized in a way to be used by a wide variety of data analysis software. Instead of relying on absolute position to identify an attribute value within the file, attributes are identified within the file by specially designated delimiter characters. The data product file is organized into records, each of which is composed of a set of fields. The set of fields does not vary within the data product. Both records and fields are separated with specified characters or delimiters. Typically, records are delimited by a `new line' and fields are delimited by one or more space characters (commas are another common field delimiter).
Element Content:
(sequence data-product-name3.2.1 data-product-description3.2.2 level-of-interpretation3.2.3 data-product-conditions3.2.4 data-product-url3.2.5 data-product-availability3.2.6 (zero-or-more revision-history4.1 ) record-delimiter3.3.1 field-delimiter3.3.2 missing-value3.3.3 data-product-use-size3.2.7 data-product-download-size3.2.8 number-of-records3.3.4 number-of-fields3.3.5 maximum-record-length3.3.6 field-content3.3.7 )
Parents:
The record delimiter is a description of the byte or bit pattern that indicates the end of a record. Typically, this will be a carriage-return line-feed combination, used in MS-DOS. The delimiter must be selected so that it does not occur within the body of a field or record, or it will be difficult or impossible to determine if it is a delimiter or data.
Element Content:
Free Text
Parents:
The field delimiter is a description of the byte or bit pattern that indicates the separation between two fields. Typically, this will be a space or comma. The delimiter must be selected so that it does not occur within the body of a field or it will be impossible to determine if it is a delimiter or data.
Element Content:
Free Text
Parents:
The missing value is a description of the byte or bit pattern that indicates a missing value in a field. Such a pattern, immediately preceded and followed by a field or record delimiter, indicates a missing value for the field.
Element Content:
Free Text
Parents:
The number of records reports the number of records found in the data product.
Element Content:
Free Text
Parents:
The number of fields reports the number of fields within each record of the data product. All records within the data products have the same number of fields.
Element Content:
Free Text
Parents:
The maximum record length indicates the size of the largest record in the data product. Some data analysis programs have an upper bound on the size of records they can read correctly. Therefore, this information is important in determining if the data products are compatible with a particular program.
Element Content:
Free Text
Parents:
The field content provides the list of fields present in the data product.
Element Content:
(zero-or-more delimited-ascii-field3.3.7.1 )
Parents:
A delimited ASCII field describes each field in the delimited ASCII data product. Often fields are manifestations in a data product of an attribute in the data model. Each field consists of a name and either a description or a reference to an entity in the data model that contains a corresponding attribute (where the field is described). Examples of a field include session number, job title or time-weighted average magnetic field magnitude.
Element Content:
(sequence field-name3.3.7.1.1 (exclusive-or (sequence field-description3.3.7.1.2 field-number3.3.7.1.3 ) (sequence field-number3.3.7.1.3 entity-membership4.3 ) ) )
Parents:
The field name refers to the field as a whole. Often fields are manifestations in a data product of an attribute in the data model. In such cases, a thorough description of the attribute is already present in the data model and it need not be repeated for the field. For example, if an attribute named `job title' exists as part of the `subject' entity in the data model, a field representing the job title can be described implicitly by assigning the field the same name, `job title', and including an entity membership element in the definition of the field.
Element Content:
Free Text
Parents:
The field description information provides details on the content of the field. The field description is not necessary if an entity membership is available for the field, in which case the field is described by the attribute with the corresponding attribute name of the named entity.
Element Content:
Free Text
Parents:
The field number indicates the position within the record of the field under discussion. The field numbers begin with one and are numbered sequentially.
Element Content:
Free Text
Parents:
The revision history is a mechanism to describe changes in the data set or data products. The revision history contains a date of the changes, who made the changes and a detailed description of the changes. At least one revision history should be supplied describing the data set. Each new change should add a revision history element to the associated data set description and/or data product.
Element Content:
(sequence revision-date4.1.1 contact4.2 revision-description4.1.2 )
Parents:
dataset-description1 binary-data-product3.2 delimited-ascii-data-product3.3
The revision date is the date on which the changes were made. The date should be supplied in ISO 8601 (yyyymmdd) format.
Element Content:
Free Text
Parents:
The revision description provides a detailed description of the changes made to the data set or data product. In particular, reference should be made to data cleansing activities that occur after or between publication of results.
Element Content:
Free Text
Parents:
A contact is a person or organization that may be available to provide information about their role in the data set, either as contributor, sponsor, distributor or revisor. The contact element contains information about how to contact and/or communicate with the person or organization. The contact can be principally a personal contact (the name comes first) or an organizational contact (the organization comes first).
Element Content:
(sequence (exclusive-or (sequence contact-organization4.2.2 (zero-or-one contact-name4.2.1 ) ) (sequence contact-name4.2.1 (zero-or-one contact-organization4.2.2 ) ) ) (zero-or-more address4.2.3 ) (zero-or-more phone-voice4.2.4 ) (zero-or-more phone-fax4.2.5 ) (zero-or-more email-address4.2.6 ) )
Parents:
revision-history4.1 producer1.6 manufacturer1.13.1 investigator1.14.2 sponsorship1.14.3 report-author1.15.1 distributor3.1
The contact name is a name of the contact at the organization. If the contact name precedes the contact organization, then the person's organization may be incidental and others at the organization may not be able to provide assistance. If the contact name follows the contact organization, then the named person is merely the principal contact for the organization and others at the organization may be able to provide assistance.
Element Content:
Free Text
Parents:
The contact organization is the name of the organization. If the contact organization precedes the contact name, then the contact is primarily organizational, and more than one person there may be able to provide assistance. If the contact organization follows the contact name, then the contact is primarily personal and the organization may be incidental for the purposes of the contact.
Element Content:
Free Text
Parents:
The address of the contact. Multiple addresses may be provided if, for example, the mailing address is different from the shipping address.
Element Content:
Free Text
Parents:
The voice phone number is the number to dial in order to speak with the contact. The area code and (if outside North America) the country code should be included. Extensions should be included if applicable.
Element Content:
Free Text
Parents:
The fax phone number is the number to dial to connect to the contact facsimile (fax) machine. The area code and (if outside North America) the country code should be included.
Element Content:
Free Text
Parents:
The email address is a valid Internet electronic mail address associated with the contact.
Element Content:
Free Text
Parents:
The entity membership uses the name of an entity to create a link between a field in the delimited ASCII data product or data segment in the binary data product and an attribute in the data model. Since a thorough description of the attribute is already present in the data model, it need not be repeated for the field. The field name must match an attribute of the named entity. For example, if an attribute named `job title' exists as part of the `subject' entity in the data model, a field representing the job title can be described implicitly by assigning the field name, `job title', and including an entity membership of `subject'.
Element Content:
Free Text
Parents: