CESSDA CDC_DDI25_PROFILE 0.31 Darren Bell - UKDA CESSDA DATA CATALOGUE (CDC) DDI2.5 PROFILE 1.0 2.5 ddi:codebook:2_5 xsi http://www.w3.org/2001/XMLSchema-instance Required: Mandatory ElementType: Attribute Usage: ISO 639-1 codes must be used Required: Mandatory ElementType: Attribute Usage: System-required information - always "ddi:codebook:2_5 codebook.xsd" Required: Mandatory ElementType: Content element ElementRepeatable: No Usage: Title of the CDC XML document Required: Mandatory ElementType: Attribute Usage: Language of the study title. ISO 639-1 codes must be used. Required: Mandatory ElementType: Attribute Usage: 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 must be used. Required: Mandatory ElementType: Attribute Usage: This is the document the metadata refers to, i.e. the URL of the study description page at the SP website. Required: Mandatory ElementType: Content element ElementRepeatable: No Usage: Title of the Study. If additional titles are required in other languages, use the parTitl element CDC UI Label: Study title Required: Mandatory ElementType: Attribute Usage: Language of the study title. ISO 639-1 codes must be used. Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: 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. CDC UI Label: Study title ]]> Required: Mandatory if 'parTitl' element is present ElementType: Attribute Usage: Language of the translated study title. ISO 639-1 codes must used. Required: Mandatory ElementType: Content element ElementRepeatable: Yes Usage: The content of this element serves two purposes. First it is used for the study/archival number given by the SP and secondly it is used for the PID. These two cases have different specifications. IDNo in the sense of study number is mandatory. An additional IDNo element may be provided for the purposes of a PID but it is not mandatory. Required: Recommended ElementType: Attribute Usage: Language of the persistent identifier of the study. ISO 639-1 codes must be used. @xml:lang is mandatory if the 'IDNo' element is being used to display a PID but it is not mandatory when IDNo is used to display the Study Number. ]]> Required: Mandatory if 'IDNo' is present ElementType: Attribute Usage: Agency responsible for the identifier of the study. Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Principal investigator Person OR Institution CDC UI Label: Creator ]]> Required: Mandatory if 'AuthEnty' element is present ElementType: Attribute Usage: Language of Person or Organisation name. ISO 639-1 codes must be used. Required: Optional ElementType: Attribute Usage: If AuthEnty is a person, the organisational affiliation of that person ]]> Required: Mandatory ElementType: Content element ElementRepeatable: Yes Usage: The element should contain the name of the organisation who has published the metadata for the harvested study description. This is usually the SP. CDC UI Label: Publisher Required: Mandatory ElementType: Attribute Usage: Language of the organisation name. ISO 639-1 codes must be used. Required: Optional ElementType: Attribute Usage: Abbreviated form of the Publisher name e.g. 'UKDA' for 'UK Data Archive' ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: The year or freetext date of when the study description was published CDC UI Label: Year of publication ]]> Required: Mandatory if 'distDate' element is present ElementType: Attribute Usage: Ideally 'YYYY-MM-DDThh:mm:ssZ' format, but can accept 'YYYY-MM-DD', 'YYYY-MM' or 'YYYY' as date format. CDC UI Label: Year of publication Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Keyword for the study in the local language. There should always be an English version of the keyword. CDC UI Label: Keyword ]]> Required: Mandatory if 'keyword' element is present ElementType: Attribute Usage: Language of the keyword. ISO 639-1 codes must be used. Required: Mandatory if 'keyword' element is present ElementType: Attribute Usage: Source of keywords - always ELSST Required: Optional ElementType: Attribute Usage: For future use when ELSST has migrated to new linked data platform (late 2020) ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Subject classifcation term for the study in the local language. Use values from https://vocabularies.cessda.eu/urn/urn:ddi:int.cessda.cv:TopicClassification. There should always be a value for the English Topic Classification. CDC UI Label: Topic ]]> Required: Mandatory if 'topcClas' element is present ElementType: Attribute Usage: Language of the subject classification term. ISO 639-1 codes must be used. Required: Recommended ElementType: Attribute Usage: name of the vocabulary. Use "CESSDA Topic Classification" regardless of language. ]]> Required: Recommended ElementType: Attribute Usage: The Canonical URN of the CV version that is being used e.g. "urn:ddi:int.cessda.cv:TopicClassification:4.0" ]]> Required: Mandatory ElementType: Content element ElementRepeatable: Yes Usage: The abstract for the study CDC UI Label: Abstract Required: Mandatory ElementType: Attribute Usage: Language of the abstract. ISO 639-1 codes must be used. Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: This is the free text expression of the collection period. CDC UI Label: Data collection period ]]> Required: Mandatory if collDate element is present and populated ElementType: Attribute Usage: Language of the free text expression of the collection period. ISO 639-1 codes must be used. Required: Mandatory if @date Attribute is present ElementType: Attribute Usage: Either 'start', 'end' or 'single' to indicate the type of @date Attribute CDC UI Label: Data collection period: start date OR Data collection period: End date Required: Mandatory if 'collDate' element is present and empty ElementType: Attribute Usage: 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. Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Countries relevant to the study area CDC UI Label: Country ]]> Required: Mandatory if 'nation' element is present ElementType: Attribute Usage: Language of the country label. ISO 639-1 codes must be used. Required: Recommended ElementType: Attribute Usage: ISO 3166-1 2-letter code must be used if this attribute is present ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Contains the Analysis Unit CV item in the local language. CDC UI Label: Analysis unit ]]> Required: Mandatory if 'anlyUnit' element is present ElementType: Attribute Usage: Language of the Analysis Unit CV item. ISO 639-1 codes must be used. Required: Recommended ElementType: Content element ElementRepeatable: No Analysis Unit Controlled Vocabulary "Code value" that is the same across languages. e.g if the "anlyUnit" element is 'Kotitalous' for Finnish, the "concept" element is 'Household' See https://vocabularies.cessda.eu/urn/urn:ddi:int.ddi.cv:AnalysisUnit. ]]> Required: Recommended ElementType: Attribute Usage: Use the string "DDI Analysis Unit" regardless of language. ]]> Required: Optional ElementType: Attribute Usage: The Canonical URN of the CV version that is being used e.g. "urn:ddi:int.ddi.cv:AnalysisUnit:2.0" ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Contains the Time Method CV item in the local language CDC UI Label: Time dimension ]]> Required: Mandatory if 'timeMeth' element is present ElementType: Attribute Usage: Language of the Time Method CV item. ISO 639-1 codes must be used. Recommended ElementType: Content element ElementRepeatable: No Usage: 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 https://vocabularies.cessda.eu/urn/urn:ddi:int.ddi.cv:TimeMethod ]]> Required: Recommended ElementType: Attribute Usage: Use the string "DDI Time Method" regardless of language. ]]> Required: Optional ElementType: Attribute Usage: The Canonical URN of the CV version that is being used e.g. "urn:ddi:int.ddi.cv:TimeMethod:1.2" ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: Contains the Sampling Procedure CV item in the local language OR a freetext description in the local language CDC UI Label: Sampling procedure ]]> Required: Mandatory if 'sampProc' element is present ElementType: Attribute Usage: Language of the Sampling Procedure CV item or freetext description. ISO 639-1 codes must be used. Recommended ElementType: Content element ElementRepeatable: No Usage: 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 https://vocabularies.cessda.eu/urn/urn:ddi:int.ddi.cv:SamplingProcedure ]]> Required: Recommended ElementType: Attribute Usage: Use the string "DDI Sampling Procedure" regardless of language. ]]> Required: Optional ElementType: Attribute Usage: The Canonical URN of the CV version that is being used e.g. "urn:ddi:int.ddi.cv:SamplingProcedure:1.1" ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Contains the Mode of Collection CV item in the local language. CDC UI Label: Data collection method ]]> Required: Mandatory if 'collMode' element is present ElementType: Attribute Usage: Language of the Mode of Collection CV item. ISO 639-1 codes must be used. Recommended ElementType: Content element ElementRepeatable: No Usage: 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 https://vocabularies.cessda.eu/urn/urn:ddi:int.ddi.cv:ModeOfCollection ]]> Required: Recommended ElementType: Attribute Usage: Use the string "DDI Mode of Collection" regardless of language. ]]> Required: Optional ElementType: Attribute Usage: The Canonical URN of the CV version that is being used e.g. "urn:ddi:int.ddi.cv:ModeOfCollection:3.0" ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Refers to any information relating to the access and use conditions of data that the SP wants to send. SPs need to concatenate the information for 'restrctn' the way they want it to appear in the CDC, if they use data from different elements e.g.specPerm, restrctn, avlStatus etc. CDC UI Label: Terms of data access ]]> Required: Mandatory if 'restrctn' is present ElementType: Attribute Usage: Language of the Access statement. ISO 639-1 codes must be used. Required: Mandatory ElementType: Content element ElementRepeatable: Yes Usage: Language-specific name of file Required: Mandatory ElementType: Attribute Usage: Language(s) of data files. The only information necessary for CDC is the language of the files, as this is needed for the filter. The values or content of 'fileName' are not extracted. ISO 639-1 codes must be used. CDC UI Label: Language of data file(s).