|
DDI_XPath
|
Required
|
UI Label
|
Type
|
Repeatable
|
Usage note
|
| /ddi:codeBook/@xml:lang | Optional | Study description available in.. (in the search result
list) | Attribute | | ISO 639-1 codes are strongly encouraged to be used |
| /ddi:codeBook/@xsi:schemaLocation | Recommended | | Attribute | | System-required information - nearly always
"ddi:codebook:2_5 http://www.ddialliance.org/Specification/DDI-Codebook/2.5/XMLSchema/codebook.xsd"
|
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:titlStmt/ddi:titl | Mandatory | Study title | Content element | No | Title of the Study. If additional titles are required in other
languages, use the parTitl element |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:titlStmt/ddi:titl/@xml:lang | Mandatory | | Attribute | | Language of the study title. ISO 639-1 codes are strongly encouraged
to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:titlStmt/ddi:parTitl | Optional | Study title | 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. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:titlStmt/ddi:parTitl/@xml:lang | Mandatory if 'parTitl' element is present | | Attribute | | Language of the translated study title. ISO 639-1 codes are strongly
encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:titlStmt/ddi:IDNo | Mandatory | Study number / PID | 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 |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:titlStmt/ddi:IDNo/@xml:lang | Recommended | | 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 |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:titlStmt/ddi:IDNo/@agency | Mandatory | Study number / PID | 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 |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:holdings/@xml:lang | Recommended | | 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. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:holdings/@URI | Mandatory | in the search result list with label "Access study" | Attribute | | This is the document the metadata refers to, i.e. the URL of the study
description page at the SP website. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:distStmt/ddi:distrbtr | Mandatory | Publisher | Content element | Yes | The element should contain the name of the organisation who has
published the metadata for the harvested study description. This is usually the
SP. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:distStmt/ddi:distrbtr/@xml:lang | Mandatory | | Attribute | | Language of the organisation name. ISO codes are strongly encouraged
to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:distStmt/ddi:distrbtr/@abbr | Optional | | Attribute | | Abbreviated form of the Publisher name e.g. 'UKDA' for 'UK Data
Archive' |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:serStmt/@URI | Optional | Series | Attribute | | URI to the study group (series) description page in the SPs web page |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:serStmt/@xml:lang | Optional | | Attribute | | Language of the whole serStmt OR the URI to the study group (series) description page
in the SPs web page. ISO 639-1 codes are strongly encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:serStmt/ddi:serName | Optional | Series | Content element | Yes | The name of the study group / series. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:serStmt/ddi:serName/@xml:lang | Mandatory if 'serName' element is present. | | Attribute | | Language of the name of the series. ISO 639-1 codes are strongly encouraged
to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:serStmt/ddi:serInfo | Optional | Series | Content element | Yes | The description of the study group / series. |
| /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:serStmt/ddi:serInfo/@xml:lang | Mandatory if 'serInfo' element is present. | | Attribute | | Language of the description of the series. ISO 639-1 codes are strongly encouraged
to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:subject/ddi: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. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:subject/ddi:topcClas/@xml:lang | Mandatory if 'topcClas' element is present | | Attribute | | Language of the subject classification term. ISO 639-1 codes are
strongly encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:subject/ddi:topcClas/@vocab | Recommended | | Attribute | | name of the vocabulary. If possible, use "CESSDA Topic Classification"
(regardless of language) but other vocabularies are permitted. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:subject/ddi:topcClas/@vocabURI | Recommended | | Attribute | | Use the URI of the CV version that is being used based on the pattern
"https://vocabularies.cessda.eu/urn/urn:ddi:int.cessda.cv:TopicClassification:[version number]"
For example, for version 4.2.2 of CESSDA Topic Classification, use
"https://vocabularies.cessda.eu/urn/urn:ddi:int.cessda.cv:TopicClassification:4.2.2" |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:collDate | Recommended | Data collection period | Content element | Yes | This is the free text expression of the collection period. This
element may be empty. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:collDate/@xml:lang | Optional | | Attribute | | Language of the free text expression of the collection period.
ISO 639-1 codes are strongly encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:collDate/@event | Mandatory if parent is present | Data collection period | Attribute | | Either 'start', 'end' or 'single' to indicate the type of date
attribute |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi: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. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:collDate/@cycle | Optional | Data collection period | Attribute | | The cycle/wave of the data collection |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:nation | Recommended | Country | Content element | Yes | Countries relevant to the study area |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:nation/@xml:lang | Mandatory if 'nation' element is present | | Attribute | | Language of the country label. ISO 639-1 codes are strongly encouraged
to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:nation/@abbr | Recommended | | Attribute | | Use this attribute only if the country in the 'nation' element has an
ISO 3166-1 2-letter code. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:anlyUnit | Recommended | Analysis unit | Content element | Yes | Contains the Analysis Unit CV item in the local language. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:anlyUnit/@xml:lang | Mandatory if 'anlyUnit' element is present | | Attribute | | Language of the Analysis Unit CV item. ISO 639-1 codes are strongly
encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:anlyUnit/ddi:concept | Recommended | | Content element | No | |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:anlyUnit/ddi:concept/@vocab | Recommended | | Attribute | | Use the string "DDI Analysis Unit" regardless of language. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:anlyUnit/ddi:concept/@vocabURI | Optional | | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/AnalysisUnit/1.0.0?languageVersion=en-1.0.0 |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:universe | Recommended | Universe | Content element | Yes | Description of population or other elements studied or measured (freetext). |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:universe/@xml:lang | Mandatory if 'universe' element is present. | None | Attribute | | Language of the Universe item. ISO 639-1 codes are strongly
encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:stdyInfo/ddi:sumDscr/ddi:universe/@clusion | Optional | Universe | Attribute | | The default value is "true" in DDI-L. The description statement of a
universe is generally stated in inclusive terms such as "All persons residing in Europe".
Occasionally a universe is defined by what it excludes, i.e., "All persons residing
in Europe except for those residing on U.S. Military bases".
In this case the value would be changed to "false".
In DDI-C, attribute clusion states the inclusion/exclusion with values "I" and "E" respectively. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:timeMeth | Recommended | Time dimension | Content element | Yes | Contains the Time Method CV item in the local language |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:timeMeth/@xml:lang | Mandatory if 'timeMeth' element is present | | Attribute | | Language of the Time Method CV item. ISO 639-1 codes are strongly
encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:timeMeth/ddi:concept | Recommended | | 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 |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:timeMeth/ddi:concept/@vocab | Recommended | | Attribute | | Use the string "DDI Time Method" regardless of language. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:timeMeth/ddi:concept/@vocabURI | Optional | | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/TimeMethod/1.2.0?languageVersion=en-1.2.0 |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:sampProc | Optional | Sampling procedure | Content element | Yes | Contains the Sampling Procedure CV item in the local language and/or a
freetext description in the local language |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:sampProc/@xml:lang | Mandatory if 'sampProc' element is present | | Attribute | | Language of the Sampling Procedure CV item or freetext description.
ISO 639-1 codes are strongly encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:sampProc/ddi:concept | Recommended | | 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 |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:sampProc/ddi:concept/@vocab | Recommended | | Attribute | | Use the string "DDI Sampling Procedure" regardless of
language. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:sampProc/ddi:concept/@vocabURI | Optional | | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/SamplingProcedure/1.1.0?languageVersion=en-1.1.0 |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:collMode | Recommended | Data collection mode | Content element | Yes | Contains the Mode of Collection CV item in the local
language. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:collMode/@xml:lang | Mandatory if 'collMode' element is present | | Attribute | | Language of the Mode of Collection CV item. ISO 639-1 codes are
strongly encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:collMode/ddi:concept | Recommended | | 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 |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:collMode/ddi:concept/@vocab | Recommended | | Attribute | | Use the string "DDI Mode of Collection" regardless of
language. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:collMode/ddi:concept/@vocabURI | Optional | | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/ModeOfCollection/3.0.0?languageVersion=en-3.0.0 |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:resInstru | Recommended | Type of instrument | Content element | Yes | Contains the Type of Instrument CV item in the local
language. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:resInstru/@xml:lang | Mandatory if 'collMode' element is present | | Attribute | | Language of the Type of Instrument CV item. ISO 639-1 codes are
strongly encouraged to be used. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:resInstru/ddi:concept | Recommended | | Content element | No | the Type of Instrument Controlled Vocabulary "Code value" that is the same
across languages. e.g if the 'resInstru' element is 'Lomake' for Finnish, the
'concept' element is 'Questionnaire'. See example at
https://vocabularies.cessda.eu/urn/urn:ddi:int.ddi.cv:TypeOfInstrument:1.1.2 |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:resInstru/ddi:concept/@vocab | Recommended | | Attribute | | Use the string "DDI Type of Instrument" regardless of
language. |
| /ddi:codeBook/ddi:stdyDscr/ddi:method/ddi:dataColl/ddi:resInstru/ddi:concept/@vocabURI | Optional | | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/TypeOfInstrument/1.1.0?languageVersion=en-1.1.0 |
| /ddi:codeBook/ddi:dataDscr/ddi:var/@name | Optional | TBD | Attribute | | A name of a variable within a dataset. |
| /ddi:codeBook/ddi:dataDscr/ddi:var/@xml:lang | Optional | TBD | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:labl | Optional | TBD | Content element | Yes | A label of a variable. |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:labl/@xml:lang | Mandatory if '//ddi:var/ddi:labl' element is present | TBD | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:qstn/ddi:preQTxt | Optional | TBD | Content element | Yes | A prequestion text appearing before the actual question text |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:qstn/ddi:preQTxt/@xml:lang | Mandatory if '//ddi:qstn/ddi:preQTxt' element is present. | TBD | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:qstn/ddi:qstnLit | Required | TBD | Content element | Yes | A literal question item text. |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:qstn/ddi:qstnLit/@xml:lang | Mandatory if '//ddi:qstn/ddi:qstnLit' element is present. | TBD | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:qstn/ddi:postQTxt | Optional | TBD | Content element | Yes | A postquestion text appearing after the actual question text |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:qstn/ddi:postQTxt/@xml:lang | Mandatory if '//ddi:qstn/ddi:postQTxt' element is present. | TBD | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:qstn/ddi:ivuInstr | Optional | TBD | Content element | Yes | An instruction for the interviewer. |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:qstn/ddi:ivuInstr/@xml:lang | Mandatory if '//ddi:qstn/ddi:ivuInstr' element is present. | TBD | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:catgry/ddi:catValu | Optional | TBD | Content element | No | A value related to a particular category. |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:catgry/ddi:labl | Optional | TBD | Content element | Yes | A label of a particular category |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:catgry/ddi:labl/@xml:lang | Mandatory if '//ddi:catgry/ddi:labl' element is present. | TBD | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:concept | Optional | TBD | Content element | Yes | A concept related to a variable. |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:concept/@xml:lang | Mandatory if '//ddi:var/ddi:concept' element is present. | TBD | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:concept/@vocab | Optional | TBD | Attribute | | The name of the vocabulary |
| /ddi:codeBook/ddi:dataDscr/ddi:var/ddi:concept/@vocabURI | Optional | TBD | Attribute | | The URI of the vocabulary |
| /ddi:codeBook/ddi:otherMat/@level | Mandatory if 'ddi:codeBook/ddi:otherMat' element is present. | TBD | Attribute | | Required for DDI schema. Use always 'instrument' in this context. |
| /ddi:codeBook/ddi:otherMat/ddi:labl | Optional | TBD | Content element | Yes | The name / label of the instrument. |
| /ddi:codeBook/ddi:otherMat/ddi:labl/@xml:lang | Mandatory if 'ddi:codeBook/ddi:otherMat/ddi:labl' element is present. | TBD | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used |