CESSDA CDC_DDI25_PROFILE 1.0.4 Darren Bell - UKDA CESSDA DATA CATALOGUE (CDC) DDI2.5 PROFILE 1.0 2.5 ddi ddi:codebook:2_5 xsi http://www.w3.org/2001/XMLSchema-instance Required: Recommended ElementType: Attribute Usage: ISO 639-1 codes are strongly encouraged to be used ]]> Required: Mandatory ElementType: Attribute Usage: System-required information - always "ddi:codebook:2_5 codebook.xsd" Required: Optional ElementType: Content element ElementRepeatable: No Usage: Title of the CDC XML document - note that the Study Title goes in /ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:titlStmt/ddi:titl ]]> Required: Mandatory if 'titl' element is present ElementType: Attribute Usage: ISO 639-1 codes are strongly encouraged to be used ]]> 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 are strongly encouraged to 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 are strongly encouraged to be used. ]]> Required: Mandatory ElementType: Content element ElementRepeatable: Yes Usage: 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 Required: Recommended ElementType: Attribute Usage: 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 ]]> Required: Mandatory ElementType: Attribute Usage: 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 Required: Recommended 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 are strongly encouraged to 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: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Principal investigator Person OR Institution CDC UI Label: Creator ]]> Required: Recommended ElementType: Attribute Usage: Language of the Organisation name, which may be the contents of the AuthEnty element or the @affiliation attribute of AuthEnty specifies a person. ISO 639-1 codes codes are strongly encouraged to 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 codes are strongly encouraged to 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. This element may be empty. 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. CDC UI Label: Keyword ]]> Required: Mandatory if 'keyword' element is present ElementType: Attribute Usage: Language of the keyword. ISO 639-1 codes are strongly encouraged to be used. ]]> Required: Recommended if 'keyword' element is present ElementType: Attribute Usage: Source of keywords - ELSST is recommended but other vocabularies can be referenced. ]]> Required: Optional ElementType: Attribute Optional but note that if @vocab=”ELSST”, then use “https://elsst.cessda.eu/id” here. ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: 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. CDC UI Label: Topic ]]> Required: Mandatory if 'topcClas' element is present ElementType: Attribute Usage: Language of the subject classification term. ISO 639-1 codes are strongly encouraged to be used. ]]> Required: Recommended ElementType: Attribute Usage: name of the vocabulary. If possible, use "CESSDA Topic Classification" (regardless of language) but other vocabularies are permitted. ]]> Required: Recommended ElementType: Attribute Usage: 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 ]]> 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 are strongly encouraged to be used. Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: This is the free text expression of the collection period. This element may be empty. CDC UI Label: Data collection period ]]> Required: Mandatory if parent 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: Recommended strongly if 'collDate' 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 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 are strongly encouraged to be used. ]]> Required: Recommended ElementType: Attribute Usage: Use this attribute only if the country in the 'nation' element has an ISO 3166-1 2-letter code. ]]> 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 are strongly encouraged to 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 example at 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 URL of the CV version that is being used e.g. https://vocabularies.cessda.eu/v2/vocabularies/AnalysisUnit/1.0?languageVersion=en-1.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 are strongly encouraged to 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 example at 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 URL of the CV version that is being used e.g. https://vocabularies.cessda.eu/v2/vocabularies/ddi:timeMethod/1.2?languageVersion=en-1.2 ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: Contains the Sampling Procedure CV item in the local language and/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 are strongly encouraged to 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 example at 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 URL of the CV version that is being used e.g. https://vocabularies.cessda.eu/v2/vocabularies/SamplingProcedure/1.1?languageVersion=en-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 are strongly encouraged to 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 example at 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 URL of the CV version that is being used e.g. https://vocabularies.cessda.eu/v2/vocabularies/ModeOfCollection/3.0?languageVersion=en-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 are strongly encouraged to be used. ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Language-specific name of file ]]> Required: Recommended 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 are strongly encouraged to be used. CDC UI Label: Language of data file(s). ]]>