|
DDI_XPath
|
Required
|
UI Label
|
Type
|
Repeatable
|
Usage note
|
| /codeBook/@xml:lang | Recommended | | Attribute | | ISO 639-1 codes are strongly encouraged to be used |
| /codeBook/docDscr/citation/titlStmt/titl | Optional | none. | Content element | No | Title of the EQB XML document - note that the Study Title goes in
/codeBook/stdyDscr/citation/titlStmt/titl |
| /codeBook/docDscr/citation/titlStmt/titl/@xml:lang | Mandatory if 'titl' element is present | none. | Attribute | | ISO 639-1 codes are strongly encouraged to be used |
| /codeBook/docDscr/citation/prodStmt/copyright | Optional | to be displayed in EQB v2.0. | Content element | Yes | Information on the copyright of the study documentation. |
| /codeBook/docDscr/citation/prodStmt/copyright/@xml:lang | Mandatory if '..prodStmt/copyright' element is present. | to be displayed in EQB v2.0. | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/docDscr/citation/distStmt/distrbtr | Mandatory | Publisher. | Content element | Yes | A name of the organization or institution |
| /codeBook/docDscr/citation/distStmt/distrbtr/@xml:lang | Mandatory if '../distStmt/distrbtr' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/docDscr/citation/distStmt/distrbtr/@abbr | Optional | to be displayed in EQB v2.0 | Attribute | | If applicable: abbreviation of the institution's name |
| /codeBook/docDscr/citation/holdings/@URI | Mandatory | Link to study in CESSDA Data Catalogue. | Attribute | | A URL or URN (a reference to a web resource that specifies its
location) linking to the study to a CDC page. |
| /codeBook/stdyDscr/citation/titlStmt/titl | Mandatory | studyTitle | Content element | Yes | A title or name for the study. If additional titles are required in
other languages, use the parTitl element |
| /codeBook/stdyDscr/citation/titlStmt/titl/@xml:lang | Mandatory if '..stdyDscr/citation/titlStmt/titl' element is
present. | not displayed (internal info) | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/citation/titlStmt/partitl | Optional | studyTitle | Content element | Yes | Title of the Study in additional languages other than the 'titl'
element. It is preferable to include this element to hold an English version of the
title if the 'titl' element is not in English. |
| /codeBook/stdyDscr/citation/titlStmt/partitl/@xml:lang | Mandatory if '..stdyDscr/citation/titlStmt/partitl' element is
present. | not displayed (internal info) | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/citation/titlStmt/IDNo | Mandatory | Study number. | Content element | Yes | The content of this element serves two purposes. It is used both for
the PID and for the study/archival number given by the SP. These two cases have
different specifications. IDNo in the sense of study number is optional. PID is
mandatory |
| /codeBook/stdyDscr/citation/titlStmt/IDNo/@xml:lang | Recommended | not displayed (internal info) | Attribute | | Language is recommended when the @agency attribute contains an
organisation name, for example, in the context of 'IDNo' being used to display the
internal study number |
| /codeBook/stdyDscr/citation/titlStmt/IDNo/@agency | Mandatory | not displayed (internal info) | Attribute | | Agency responsible for the identifier of the study. If you are using
IDNo for a Persistent Identifer, value should be one of
https://vocabularies.cessda.eu/vocabulary/CessdaPersistentIdentifierTypes i.e. ARK
or DOI or Handle or URN |
| /codeBook/stdyDscr/citation/rspStmt/AuthEnty | Mandatory | Not used in EQB | Content element | Yes | Person OR Institution. Principal Investigator not used in EQB but
mandatory in CDC. |
| /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@xml:lang | Recommended | Not used in EQB | Attribute | | Language of the Organisation name, which may be the contents of the
AuthEnty element or the @affiliation attribute if AuthEnty specifies a person. ISO
639-1 codes codes are strongly encouraged to be used. |
| /codeBook/stdyDscr/citation/rspStmt/AuthEnty/@affiliation | Optional | Not used in EQB | Attribute | | If AuthEnty is a person, the organisational affiliation of that
person |
| /codeBook/stdyDscr/citation/prodStmt/copyright | Recommended | to be displayed in EQB v2.0. | Content element | Yes | Freetext description on the metadata access conditions for the
provided metadata for the study-related information only. Examples of such
conditions are the copyright status, usage regulations based on legislation, a
license, or other agreement concerning the metadata usage. |
| /codeBook/stdyDscr/citation/prodStmt/copyright/@xml:lang | Mandatory if '..stdyDscr/citation/prodStmt/copyright' element is
present. | to be displayed in EQB v2.0. | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/citation/distStmt/distrbtr | Mandatory | Publisher | Content element | Yes | A name of the institution publishing the metadata, i.e. CESSDA Service
Provider providing the metadata information or the name of the actual publisher of
the metadata, who is not the SPs. Only on study level. |
| /codeBook/stdyDscr/citation/distStmt/distrbtr/xml:lang | Mandatory | not displayed (internal info). | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/citation/distStmt/distDate | Mandatory | Publication date. | Content element | Yes | The year or freetext date of when the study description was published.
This element may be empty. |
| /codeBook/stdyDscr/citation/distStmt/distDate/@date | Recommended if 'distDate' element is present | Publication date. | Attribute | | IDate (date-time combination (YYYY-MM-DDTHH:MM:SS), date (YYYY-MM-DD),
year-month (YYYY-MM), year (YYYY)) of publication (by publisher) of the study.
Extract the year if only this is needed (e.g. citation). This element refers to the
date (ISO 8601) when the data of the study was or will be made publicly available.
If there is an embargo on the data in effect, use the date when the embargo period
ends. |
| /codeBook/stdyDscr/citation/serStmt/serName | Optional | Filter/Part of study group/series. | Content element | Yes | A title or name for the study group. |
| /codeBook/stdyDscr/citation/serStmt/serName/@xml:lang | Mandatory if '..serStmt/serName' element is present. | not displayed (internal info). | Attribute | | |
| /codeBook/stdyDscr/citation/serStmt/serInfo/ExtLink | Optional | not displayed (internal info). | Content element | Yes | A value of a persistent identifier for the study group. |
| /codeBook/stdyDscr/citation/serStmt/serInfo/ExtLink/@URI | Mandatory if ',,serInfo/ExtLink' element is present. | included as hyperlink | Attribute | | An URL or URN (a reference to a web resource that specifies its
location) linking to the study group. |
| /codeBook/stdyDscr/citation/serStmt/serInfo/ExtLink/@title | Mandatory if ',,serInfo/ExtLink' element is present. | included as hyperlink | Attribute | | A required attribute containing the local user identification system.
Always 'GroupID'. |
| /codeBook/stdyDscr/citation/verStmt/version | Optional | Versionnumber. | Content element | Yes | A number of the version (free text) that the Service Provider uses to
identify this version of the study. |
| /codeBook/stdyDscr/citation/verStmt/version/@date | Optional | Versiondate. | Attribute | | |
| /codeBook/stdyDscr/citation/holdings/@xml:lang | Recommended | not displayed (internal info) | Attribute | | Language of the study description page at the SP website (there can be
multiple 'holding' elements for study description pages in different languages. ISO
639-1 codes are strongly encouraged to be used. |
| /codeBook/stdyDscr/citation/holdings/@URI | Mandatory | Further information on study and data | Attribute | | This is the document the metadata refers to, i.e. the URL of the study
description page at the SP website. |
| /codeBook/stdyDscr/stdyInfo/subject/topcClas | Recommended | Topics | Content element | Yes | Subject classifcation term for the study in the local language. Use
descriptive terms from https://vocabularies.cessda.eu/vocabulary/TopicClassification
if possible but other vocabularies are permitted. |
| /codeBook/stdyDscr/stdyInfo/subject/topcClas/@xml:lang | Mandatory if 'topcClas' element is present | not displayed (internal info). | Attribute | | Language of the subject classification term. ISO 639-1 codes are
strongly encouraged to be used. |
| /codeBook/stdyDscr/stdyInfo/subject/topcClas/@vocab | Recommended | not displayed (internal info). | Attribute | | name of the vocabulary. If possible, use "CESSDA Topic Classification"
(regardless of language) but other vocabularies are permitted. |
| /codeBook/stdyDscr/stdyInfo/subject/topcClas/@vocabURI | Recommended | not displayed (internal info). | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/TopicClassification/4.0?languageVersion=en-4.0 |
| /codeBook/stdyDscr/stdyInfo/abstract | Mandatory | Abstract | Content element | Yes | The abstract for the study |
| /codeBook/stdyDscr/stdyInfo/abstract/@xml:lang | Mandatory | not displayed (internal info) | Attribute | | Language of the abstract. ISO 639-1 codes are strongly encouraged to
be used. |
| /codeBook/stdyDscr/stdyInfo/sumDscr/collDate | Optional | Data collection period | Content element | Yes | This is the free text expression of the collection period. This
element may be empty. |
| /codeBook/stdyDscr/stdyInfo/sumDscr/collDate/@event | Mandatory if parent is present | Data collection period | Attribute | | Either 'start', 'end' or 'single' to indicate the type of @date
Attribute |
| /codeBook/stdyDscr/stdyInfo/sumDscr/collDate/@date | Recommended strongly if 'collDate' element is present. | Data collection period | Attribute | | Ideally YYYY-MM-DDThh:mm:ssZ format, but can accept YYYY-MM-DD,
YYYY-MM or YYYY as date attribute. If there are multiple end dates, use the
last. |
| /codeBook/stdyDscr/stdyInfo/sumDscr/nation | Recommended | Country | Content element | Yes | Countries relevant to the study area |
| /codeBook/stdyDscr/stdyInfo/sumDscr/nation/@xml:lang | Mandatory if 'nation' element is present | Country | Attribute | | Language of the country label. ISO 639-1 codes are strongly encouraged
to be used. |
| /codeBook/stdyDscr/stdyInfo/sumDscr/nation/@abbr | Recommended | Country | Attribute | | Use this attribute only if the country in the 'nation' element has an
ISO 3166-1 2-letter code. |
| /codeBook/stdyDscr/method/dataColl/timeMeth | Recommended | Time dimension | Content element | Yes | Contains the Time Method CV item in the local language |
| /codeBook/stdyDscr/method/dataColl/timeMeth/@xml:lang | Mandatory if 'timeMeth' element is present | not displayed (internal info) | Attribute | | Language of the Time Method CV item. ISO 639-1 codes are strongly
encouraged to be used. |
| /codeBook/stdyDscr/method/dataColl/timeMeth/concept | Recommended | not displayed (internal info) | Content element | No | Time Method Controlled Vocabulary "Code value" that is the same across
languages. e.g if the 'timeMeth' element is 'Pitkittäisaineisto' for Finnish, the
'concept' element is 'Longitudinal'. See example at
https://vocabularies.cessda.eu/urn/urn:ddi:int.ddi.cv:TimeMethod |
| /codeBook/stdyDscr/method/dataColl/timeMeth/concept/@vocab | Recommended | not displayed (internal info) | Attribute | | Use the string "DDI Time Method" regardless of language. |
| /codeBook/stdyDscr/method/dataColl/timeMeth/concept/@vocabURI | Optional | not displayed (internal info) | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/TimeMethod/1.2?languageVersion=en-1.2 |
| /codeBook/stdyDscr/method/dataColl/sampProc | Recommended | Sampling procedure | Content element | Yes | Contains the Sampling Procedure CV item in the local language and/or a
freetext description in the local language |
| /codeBook/stdyDscr/method/dataColl/sampProc/@xml:lang | Mandatory if 'sampProc' element is present | not displayed (internal info) | Attribute | | Language of the Sampling Procedure CV item or freetext description.
ISO 639-1 codes are strongly encouraged to be used. |
| /codeBook/stdyDscr/method/dataColl/sampProc/concept | Recommended | not displayed (internal info) | Content element | No | Sampling Procedure Controlled Vocabulary "Code value" that is the same
across languages. e.g if the 'sampProc' element is 'Todennäköisyysotanta' for
Finnish, the 'concept' element is 'Probability'. See example at
https://vocabularies.cessda.eu/urn/urn:ddi:int.ddi.cv:SamplingProcedure |
| /codeBook/stdyDscr/method/dataColl/sampProc/concept/@vocab | Recommended | not displayed (internal info) | Attribute | | Use the string "DDI Sampling Procedure" regardless of
language. |
| /codeBook/stdyDscr/method/dataColl/sampProc/concept/@vocabURI | Optional | not displayed (internal info) | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/SamplingProcedure/1.1?languageVersion=en-1.1 |
| /codeBook/stdyDscr/method/dataColl/collMode | Recommended | Data collection mode | Content element | Yes | Contains the Mode of Collection CV item in the local
language. |
| /codeBook/stdyDscr/method/dataColl/collMode/@xml:lang | Mandatory if 'collMode' element is present | not displayed (internal info) | Attribute | | Language of the Mode of Collection CV item. ISO 639-1 codes are
strongly encouraged to be used. |
| /codeBook/stdyDscr/method/dataColl/collMode/concept | Recommended | not displayed (internal info) | Content element | No | Mode of Collection Controlled Vocabulary "Code value" that is the same
across languages. e.g if the 'collMode' element is 'Haastattelu' for Finnish, the
'concept' element is 'Interview'. See example at
https://vocabularies.cessda.eu/urn/urn:ddi:int.ddi.cv:ModeOfCollection |
| /codeBook/stdyDscr/method/dataColl/collMode/concept/@vocab | Recommended | not displayed (internal info) | Attribute | | Use the string "DDI Mode of Collection" regardless of
language. |
| /codeBook/stdyDscr/method/dataColl/collMode/concept/@vocabURI | Optional | not displayed (internal info) | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/ModeOfCollection/3.0?languageVersion=en-3.0 |
| /codeBook/stdyDscr/method/dataColl/resInstru | Mandatory | to be displayed in EQB v2.0 | Attribute | | The language of the instrument name that is being used in the study.
ISO 639-1 codes are strongly encouraged to be used |
| /codeBook/stdyDscr/method/dataColl/resInstru/@xml:lang | Mandatory | Interview Language. | Attribute | | The language of the instrument name that is being used in the study.
ISO 639-1 codes are strongly encouraged to be used |
| /codeBook/stdyDscr/dataAccs/useStmt/specPerm | Recommended | to be displayed in EQB v2.0 | Content element | Yes | Freetext description on the metadata access conditions for the
provided metadata if there is one access condition for both study- and
question-related metadata. Examples of such conditions are the copyright status,
usage regulations based on legislation, a license, or other agreement concerning the
metadata usage. |
| /codeBook/stdyDscr/dataAccs/useStmt/specPerm/@xml:lang | Mandatory if '..stdyDscr/dataAccs/useStmt/specPerm/' element is
present. | not displayed (internal info) | Attribute | Yes | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/dataAccs/useStmt/restrctn | Mandatory | to be displayed in EQB v2.0. | Content element | Yes | Freetext description of possibilities to access data. |
| /codeBook/stdyDscr/dataAccs/useStmt/restrctn/@xml:lang | Mandatory | to be displayed in EQB v2.0. | Attribute | Yes | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/dataAccs/useStmt/conditions | Optional | to be displayed in EQB v2.0. | Content element | Yes | If the preserved content is subject to any access restrictions, those
must be expressed in as much detail as possible in the information package in
accordance with cataloguing rules and metadata formats used. Examples of such
restrictions are the copyright status, usage restrictions based on legislation, a
license, or other agreement concerning the content usage. Should the information
package contain several digital objects with different restrictions, these
restrictions should be attached correctly and individually to those objects that the
restrictions concern. |
| /codeBook/stdyDscr/dataAccs/useStmt/conditions/@xml:lang | Mandatory if '..stdyDscr/dataAccs/useStmt/conditions/' element is
present. | not displayed (internal info) | Attribute | Yes | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/othrStdyMat/relMat/@label | Mandatory if '..codeBook/stdyDscr/othrStdyMat/relMat' element is
present | not displayed (internal info). | Attribute | | Within the context of survey research, a showcard or showsheet is a
visual aid used predominantly during in-person surveys. It is a card, a piece of
paper, or an electronic screen containing answer categories to a question, from
which the respondent chooses the answer to the survey question. showcardFileName is
linked to the variable by using the /var/@name value for the relMat/@label value
here |
| /codeBook/stdyDscr/othrStdyMat/relMat/@type | Mandatory if '..codeBook/stdyDscr/othrStdyMat/relMat' element is
present | not displayed (internal info). | Attribute | | Required to indicate that @label represents /var/@name
value. |
| /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/titl | Optional | to be displayed in EQB v2.0 | Content element | Yes | A file name of the showcard in the original language. Use 'parTitl'
element if other languages are required. |
| /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/titl/@xml:lang | Mandatory if '..othrStdyMat/relMat/citation/titlStmt/titl' element
is present. | not displayed (internal info) | Attribue | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/partitl | Optional | to be displayed in EQB v2.0 | Content element | Yes | A file name of the showcard in anguages other than the original. Use
'titl' element for the original language. |
| /codeBook/stdyDscr/othrStdyMat/relMat/citation/titlStmt/parTitl/@xml:lang | Mandatory if '..othrStdyMat/relMat/citation/titlStmt/parTitl'
element is present. | not displayed (internal info) | Attribue | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/copyright | Recommended | to be displayed in EQB v2.0. | Content element | Yes | Freetext description on the metadata access conditions for the
provided metadata for question-related information only. Examples of such conditions
are the copyright status, usage regulations based on legislation, a license, or
other agreement concerning the metadata usage. |
| /codeBook/stdyDscr/othrStdyMat/relMat/citation/prodStmt/copyright/@xml:lang | Mandatory if '..othrStdyMat/relMat/citation/prodStmt/copyright'
element is present. | not displayed (internal info) | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/stdyDscr/othrStdyMat/relMat/citation/holdings/@URI | Optional | to be displayed in EQB v2.0 | Attribute | | A link to the showcard |
| /codeBook/fileDscr/fileTxt/fileName | Mandatory | to be displayed in EQB v2.0. | Content element | Yes | A file name of the data set. |
| /codeBook/fileDscr/fileTxt/fileName/@xml:lang | Mandatory | not displayed (internal info). | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/fileDscr/fileTxt/fileCitation/titlStmt/IDNo | Optional | to be displayed in EQB v2.0 | Content element | Yes | An identifier that captures information on the type and value of a
PID. |
| /codeBook/fileDscr/fileTxt/fileCitation/titlStmt/IDNo/@agency | Mandatory if '..fileDscr/fileTxt/fileCitation/titlStmt/IDNo'
element is present. | not displayed (internal info) | Attribute | | The identification of the agency which assigns and manages the
identifier, i.e., ISBN, ISSN, DOI, etc. |
| /codeBook/dataDscr/var/@name | Mandatory | Variables | Attribute | | A name of a variable within a dataset. |
| /codeBook/dataDscr/var/@xml:lang | Mandatory | not displayed (internal info). | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/dataDscr/var/@qstn | Mandatory | not displayed (internal info) | Attribute | | A reference of a variable to a question e.g. 'QID1' |
| /codeBook/dataDscr/var/@nature | Mandatory | Variables. | Attribute | | A variable can have different types according to the ways they can be
studied, measured, and presented. E.g. 'Ordinal' |
| /codeBook/dataDscr/var/@representationType | Mandatory | not displayed (internal info). | Attribute | | States the type of object being referenced e.g. 'code', 'mumeric' or 'text' for example. |
| /codeBook/dataDscr/var/location/@width | Optional | to be displayed in EQB v2.0. | Attribute | | Length of the text: Min length |
| /codeBook/dataDscr/var/labl | Optional | Variables | Content element | Yes | A label of a variable for display. |
| /codeBook/dataDscr/var/labl/@xml:lang | Mandatory if '..dataDscr/var/labl' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /codeBook/dataDscr/var/qstn/@seqNo | Mandatory if '../dataDscr/var/qstn' element is present. | not displayed (internal info). | Attribute | Yes | Question number. |
| /codeBook/dataDscr/var/qstn/@elementVersion | Mandatory if '../dataDscr/var/qstn' element is present. | Version. | Attribute | Yes | A version number of the question item. |
| /codeBook/dataDscr/var/qstn/@IDNo | Mandatory if '../dataDscr/var/qstn' element is present. | not displayed (internal info). | Attribute | Yes | ID of the question e.g. 'QID1' |
| /codeBook/dataDscr/var/qstn/ExtLink | Optional | Question ID | Content element | Yes | An identifier provided by the user for the question. |
| /codeBook/dataDscr/var/qstn/ExtLink/@title | Mandatory if '..var/qstn/ExtLink' element is present. | not displayed (internal info) | Attribute | | Type of User ID for question. Always 'QuestionID'. |
| /codeBook/dataDscr/var/qstn/list/label | Optional | Name. | Content element | Yes | A label of a question item the metadata refers to for display. |
| /codeBook/dataDscr/var/qstn/list/label/@xml:lang | Mandatory if '..dataDscr/var/qstn/list/label' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/qstn/list/itm | Optional | Question number. | Content element | Yes | A number of the question item the metadata refers to within the associated instrument. |
| /codeBook/dataDscr/var/qstn/list/itm/@xml:lang | Mandatory if '..var/qstn/list/itm/' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/qstn/preQTxt | Optional | Pre-/Post-question text. | Content element | Yes | A prequestion and/or postquestion and other statements as part
of the question item text. |
| /codeBook/dataDscr/var/qstn/preQTxt/@xml:lang | Mandatory if '..var/qstn/preQTxt' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/qstn/qstnLit | Optional | Question text | Content element | Yes | A literal question item text. |
| /codeBook/dataDscr/var/qstn/qstnLit/@xml:lang | Mandatory if '..var/qstn/qstnLit' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/qstn/ivuInstr | Recommended | Interviewer instruction . | Content element | Yes | An instruction for the interviewer. |
| /codeBook/dataDscr/var/qstn/ivuInstr/@xml:lang | Mandatory if '..var/qstn/ivuInstr' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/valrng/range/@min | Mandatory if '..dataDscr/var/valrng/range' element is present. | to be displayed in EQB v2.0. | Attribute | | Structures a numeric range. Low value is designated |
| /codeBook/dataDscr/var/valrng/range/@max | Mandatory if '..dataDscr/var/valrng/range' element is present. | to be displayed in EQB v2.0. | Attribute | | Structures a numeric range. High value is designated |
| /codeBook/dataDscr/var/catgryGrp/@catgry | Mandatory if '..dataDscr/var/catgryGrp' element is present. | not displayed (internal info). | Attribute | | Category IDs in this Category group e.g. 'Ctgry1 Ctgry2'. |
| /codeBook/dataDscr/var/catgryGrp/@levelnm | Mandatory if '..dataDscr/var/catgryGrp' element is present. | not displayed (internal info) | Attribute | | An identifier of the codelist the metadata refers to. |
| /codeBook/dataDscr/var/catgryGrp/@levelno | Mandatory if '..dataDscr/var/catgryGrp' element is present. | to be displayed in EQB v2.0. | Attribute | | It indicates the minimum and the maximum number of possible answers within the codelist. |
| /codeBook/dataDscr/var/catgryGrp/labl/@level | Mandatory if 'dataDscr/var/catgryGrp/labl' element is present. | to be displayed in EQB v2.0. | Attribute | | @level attribute indicates whether the labl element is:
(1) A name of the codelist (@level='name') OR
(2) A label of the codelist (@level='label') OR
(2) A description of the codelist (@level='description') |
| /codeBook/dataDscr/var/catgryGrp/labl/@xml:lang | Mandatory if 'dataDscr/var/catgryGrp/labl' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/catgry/@missing | Mandatory if '..dataDscr/var/catgry' element is present. | Answer code/Response category | Attribute | | A value for missing data. If the category is describing a classification of
"missing data" set the value of isMissing to "true". |
| /codeBook/dataDscr/var/catgry/catValu | Mandatory if '..dataDscr/var/catgry' element is present. | Answer code. | Content element | Yes | A structure that links a unique value of a code to a specified category. |
| /codeBook/dataDscr/var/catgry/labl | Mandatory if '..dataDscr/var/catgry' element is present. | Response category | Content element | Yes | A description of a particular category or response |
| /codeBook/dataDscr/var/catgry/labl/@xml:lang | Mandatory if '..dataDscr/var/catgry/labl' element is present. | not displayed (internal info) | Attribute | Yes | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/concept | Optional | Concepts. | Content element | Yes | A name of the concept. |
| /codeBook/dataDscr/var/concept/@xml:lang | Mandatory if '../dataDscr/var/concept' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/concept/list/itm/label | Optional | Concepts | Content element | Yes | A label of the concept. |
| /codeBook/dataDscr/var/concept/list/itm/label/@xml:lang | Mandatory if '..dataDscr/var/concept/list/itm/label' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/concept/list/itm/p | Optional | Concept Descriptions | Content element | Yes | A description of the concept. |
| /codeBook/dataDscr/var/concept/list/itm/p/@xml:lang | Mandatory if '..dataDscr/var/concept/list/itm/p' element is present | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/dataDscr/var/notes | Optional | Variables. | Content element | Yes | An additional description of the variable or the file content. |
| /codeBook/dataDscr/var/notes/@xml:lang | Mandatory if '..dataDscr/var/notes' element is present. | not displayed (internal info) | Content element | Yes | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/otherMat/@type | Mandatory if 'codeBook/otherMat' element is present. | Type. | Attribute | | A controlled vocabulary of the type of document that is provided. |
| /codeBook/otherMat/@level | Mandatory if 'codeBook/otherMat' element is present. | not displayed (internal info). | Attribute | | Required for DDI schema. Object to which the document is related e.g. 'Study'. |
| /codeBook/otherMat/citation/titlStmt/titl | Optional | Title | Content element | No | A title for the document in the original language. Use the 'parTitl'
element if Title is required for another language. |
| /codeBook/otherMat/citation/titlStmt/titl/@xml:lang | Mandatory if '../otherMat/citation/titlStmt/titl' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/otherMat/citation/titlStmt/parTitl | Optional | Title. | Content element | Yes | A title for the document in a language other than the original. |
| /codeBook/otherMat/citation/titlStmt/parTitl/@xml:lang | Mandatory if '../otherMat/citation/titlStmt/parTitl' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /codeBook/otherMat/citation/titlStmt/IDNo | Optional | ID. | Content element | Yes | An identifier for the document. |
| /codeBook/otherMat/citation/titlStmt/IDNo/@agency | Mandatory if '..otherMat/citation/titlStmt/IDNo' element is present. | not displayed (internal info) | Attribute | | Type of ID for the document ID. Always 'DocumentID'. |
| /codeBook/otherMat/citation/holdings/@URI | Optional | displayed as hyperlink | Content element | Yes | URL / Web address of the document the metadata refer to. |