CESSDA CDC_DDI26_PROFILE 2.1.0 Katja Moilanen - FSD CESSDA DATA CATALOGUE (CDC) DDI2.6 PROFILE 1.0 2.6 ddi ddi:codebook:2_6 xsi http://www.w3.org/2001/XMLSchema-instance Required: Optional ElementType: Attribute Usage: ISO 639-1 codes are strongly encouraged to be used CDC_UI_Label: Study description available in.. (in the search result list) CMM_Mapping: None ]]> Required: Recommended ElementType: Attribute Usage: System-required information - nearly always "ddi:codebook:2_6 http://www.ddialliance.org/Specification/DDI-Codebook/2.6/XMLSchema/codebook.xsd" CMM_Mapping: 11.2.1 ]]> 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 CMM_Mapping: 11.1.1 ]]> Required: Mandatory if 'titl' element is present ElementType: Attribute Usage: ISO 639-1 codes are strongly encouraged to be used CMM_Mapping: 11.1.1.1 ]]> 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 CMM_Mapping: 1.1.3 Required: Mandatory ElementType: Attribute Usage: Language of the study title. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: 1.1.3.1 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 CMM_Mapping: 1.1.3 ]]> 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. CMM_Mapping: 1.1.3.1 ]]> 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 CDC_UI_Label: Study number / PID CMM_Mapping: 1.1.10.4/1.1.2 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 CMM_Mapping: 3.2.1/3.3.1 ]]> 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 CDC_UI_Label: Study number / PID CMM_Mapping: 1.1.10.4.1/1.1.2.1 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. CMM_Mapping: 1.1.10.5.1 ]]> 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. CDC_UI_Label: Access study CMM_Mapping: 1.1.10.5 Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Principal investigator Person OR Institution CDC_UI_Label: Creator CMM_Mapping: 1.1.7.1/1.1.7.2 ]]> Required: Recommended ElementType: Attribute Usage: 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. CMM_Mapping: 3.2.1/3.3.1 ]]> Required: Optional ElementType: Attribute Usage: If AuthEnty is a person, the organisational affiliation of that person CDC_UI_Label: Creator CMM_Mapping: 1.1.7.1/1.1.7.2 ]]> Required: Optional ElementType: Attribute Usage: The persistent identifier (PID) of the principal investigator/creator CDC_UI_Label: Creator CMM_Mapping: 2.4 ]]> Required: Optional ElementType: Attribute Usage: The type of the PID. If the PID is documented, the type of the PID should be documented, too CDC_UI_Label: Creator CMM_Mapping: 2.4.1 ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: The identification code of the grant or other monetary award which provided funding for the Study. If you know that the funder is included in the OpenAire list of Funders, see the instructions for grantNo syntax here: https://guidelines.openaire.eu/en/latest/data/field_contributor.html#nameidentifier-ma-o . Indicate the appropriate agency using the "agency" attribute. If different funding agencies sponsored different stages of the production process, use the "role" attribute to distinguish the grant numbers. CDC_UI_Label: Grant number CMM_Mapping: 1.1.6.2 ]]> Required: Recommended ElementType: Attribute Usage: Language of the name of the agency which provided the funding. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: 3.2.1 ]]> Required: Mandatory if 'grantNo' element is present ElementType: Attribute Usage: Agency which provided the funding. CDC_UI_Label: Funder CMM_Mapping: 1.1.6.1 ]]> Required: Optional ElementType: Attribute Usage: If different funding agencies sponsored different stages of the production process, use the "role" attribute to distinguish the grant numbers. CMM_Mapping: 1.1.6.4 ]]> 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 CMM_Mapping: 1.1.8 Required: Mandatory ElementType: Attribute Usage: Language of the organisation name. ISO codes are strongly encouraged to be used. CMM_Mapping: 3.2.1/3.3.1 Required: Optional ElementType: Attribute Usage: Abbreviated form of the Publisher name e.g. 'UKDA' for 'UK Data Archive' CMM_Mapping: 3.3 ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: The freetext date when the study description was published. This element may be left empty. CDC_UI_Label: Publication year CMM_Mapping: None ]]> Required: Optional ElementType: Attribute Usage: Language of the free text expression of the study description publication time. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: None ]]> 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. It is strongly recommended to provide the full date to allow sorting by publication date in CDC. If this date is in the future (data embargo end date), CDC will try to read the publication date for CDC from ddi:codeBook/ddi:docDscr/ddi:citation/ddi:distStmt/ddi:distDate/@date (metadata publication date). CDC_UI_Label: Publication year CMM_Mapping: 1.1.9 ]]> Required: Optional ElementType: Attribute Usage: This field is used in CDC only if the date in the field ddi:codeBook/ddi:stdyDscr/ddi:citation/ddi:distStmt/ddi:distDate/@date is in the future. Ideally 'YYYY-MM-DDThh:mm:ssZ' format, but can accept 'YYYY-MM-DD', 'YYYY-MM' or 'YYYY' as date format. It is strongly recommended to provide the full date to allow sorting by publication date in CDC. CDC_UI_Label: Publication year CMM_Mapping: 11.1.3.1 ]]> Required: Optional ElementType: Attribute Usage: URI to the series description page in the SPs web page CDC_UI_Label: Series CMM_Mapping: None ]]> Required: Optional ElementType: Attribute Usage: Language of the whole serStmt OR the URI to the series description page in the SPs web page. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: None ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: The name of the series. CDC_UI_Label: Series CMM_Mapping: None ]]> Required: Recommended ElementType: Attribute Usage: Language of the name of the series. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: None ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: The description of the series. CDC_UI_Label: Series CMM_Mapping: None ]]> Required: Recommended ElementType: Attribute Usage: Language of the description of the series. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: None ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Keyword for the study in the local language. CDC_UI_Label: Keywords CMM_Mapping: 1.2.3 ]]> Required: Mandatory if 'keyword' element is present ElementType: Attribute Usage: Language of the keyword. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: 1.2.3.1 ]]> Required: Recommended if 'keyword' element is present ElementType: Attribute Usage: Source of keywords - ELSST is recommended but other vocabularies can be referenced. CDC_UI_Label: Keywords (if ELSST) CMM_Mapping: 1.2.3.2 ]]> Required: Optional ElementType: Attribute Optional but note that if vocab=”ELSST”, then use “https://elsst.cessda.eu/id/” here. CMM_Mapping: 1.2.3.4 ]]> 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: Topics CMM_Mapping: 1.2.2.1 ]]> 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. CMM_Mapping: 1.2.2.1.1 ]]> Required: Recommended ElementType: Attribute Usage: name of the vocabulary. If possible, use "CESSDA Topic Classification" (regardless of language) but other vocabularies are permitted. CMM_Mapping: 1.2.2.2 ]]> 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.2.3?languageVersion=en-4.2.3 . CMM_Mapping: 1.2.2.4 ]]> Required: Mandatory ElementType: Content element ElementRepeatable: Yes Usage: The abstract for the study CDC_UI_Label: Abstract CMM_Mapping: 1.2.1 Required: Mandatory ElementType: Attribute Usage: Language of the abstract. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: 1.2.1.1 Required: Recommended 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 CMM_Mapping: 1.3.7.4 ]]> Required: Optional ElementType: Attribute Usage: Language of the free text expression of the collection period. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: 1.3.7.4.1 ]]> 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 CMM_Mapping: 1.3.7.1/1.3.7.2/1.3.7.3 ]]> 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. CDC_UI_Label: Data collection period CMM_Mapping: 1.3.7.1/1.3.7.2/1.3.7.3 ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Countries relevant to the study area CDC_UI_Label: Country CMM_Mapping: 1.3.3 ]]> 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. CMM_Mapping: 1.3.3.1 ]]> Required: Recommended ElementType: Attribute Usage: Use this attribute only if the country in the 'nation' element has an ISO 3166-1 2-letter code. CMM_Mapping: 1.3.2 ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Contains the Analysis Unit CV item in the local language. CDC_UI_Label: Analysis unit CMM_Mapping: 1.3.5.2 ]]> 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. CMM_Mapping: 1.3.5.2.1 ]]> 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. CMM_Mapping: 1.3.5.1 ]]> Required: Recommended ElementType: Attribute Usage: Use the string "DDI Analysis Unit" regardless of language. CMM_Mapping: 1.3.5.3 ]]> 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/2.1.3?languageVersion=en-2.1.3 . CMM_Mapping: 1.3.5.5 ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Description of population or other elements studied or measured (freetext). CDC_UI_Label: Universe CMM_Mapping: 1.3.4 ]]> Required: Recommended ElementType: Attribute Usage: Language of the Universe item. ISO 639-1 codes are strongly encouraged to be used. CDC_UI_Label: None CMM_Mapping: 1.3.4.1 ]]> Required: Optional ElementType: Attribute Usage: 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. CDC_UI_Label: Universe CMM_Mapping: 1.3.4.2 ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: A free text field describing shortly the type or kind of the dataset. Using a vocabulary is recommended. CDC_UI_Label: Kind of data CMM_Mapping: 1.2.4 ]]> Required: Recommended ElementType: Attribute Usage: Language of the data kind. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: None ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Contains the Time Method CV item in the local language CDC_UI_Label: Time dimension CMM_Mapping: 1.3.1.2 ]]> 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. CMM_Mapping: 1.3.1.2.1 ]]> Required: 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 CMM_Mapping: 1.3.1.1 ]]> Required: Recommended ElementType: Attribute Usage: Use the string "DDI Time Method" regardless of language. CMM_Mapping: 1.3.1.3 ]]> Required: Optional ElementType: Attribute Usage: The Canonical URL of the CV version that is being used e.g. https://vocabularies.cessda.eu/v2/vocabularies/TimeMethod/1.2.3?languageVersion=en-1.2.3 . CMM_Mapping: 1.3.1.5 ]]> 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 CMM_Mapping: 1.3.6.2.2 ]]> 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. CMM_Mapping: 1.3.6.2.2.1 ]]> Required: 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 CMM_Mapping: 1.3.6.2.1 ]]> Required: Recommended ElementType: Attribute Usage: Use the string "DDI Sampling Procedure" regardless of language. CMM_Mapping: 1.3.6.2.3 ]]> 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/2.0.1?languageVersion=en-2.0.1 . CMM_Mapping: 1.3.6.2.5 ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Contains the Mode of Collection CV item in the local language. CDC_UI_Label: Data collection mode CMM_Mapping: 1.3.6.4.2 ]]> 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. CMM_Mapping: 1.3.6.4.2.1 ]]> Required: 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 CMM_Mapping: 1.3.6.4.1 ]]> Required: Recommended ElementType: Attribute Usage: Use the string "DDI Mode of Collection" regardless of language. CMM_Mapping: 1.3.6.4.3 ]]> 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/5.0.0?languageVersion=en-5.0.0 . CMM_Mapping: 1.3.6.4.5 ]]> 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 CMM_Mapping: 1.4.2 ]]> Required: Mandatory if 'restrctn' is present ElementType: Attribute Usage: Language of the Access statement. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: 1.4.2.1 ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: Controlled description of the data access (open access vs. restricted access). CDC will use the COAR Access Rights vocabulary https://vocabularies.coar-repositories.org/access_rights/. Only the codes "restricted access" and "open access" will be used. CDC_UI_Label: Data access CMM_Mapping: 1.4.1 ]]> Required: Optional ElementType: Attribute Usage: When the typeOfAccess element is used for vocabulary 'COAR Access Right Vocabulary', then use this vocabulary name 'COAR Access Right Vocabulary' in this field. CMM_Mapping: 1.4.1 ]]> Required: Recommended ElementType: Content element ElementRepeatable: Yes Usage: Language-specific name of file CMM_Mapping: 4.2.2 ]]> 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). CMM_Mapping: 4.2.2.1 ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: First option for bibliographic citation of the related publication. CDC_UI_Label: Related publications CMM_Mapping: 9.11 ]]> Required: Optional ElementType: Attribute Usage: Language of the related publication. This not always the same as the metadata language and therefore this is useful for monolingual profile, too. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: 9.5.1/9.8.1.1 ]]> Required: Optional ElementType: Content element ElementRepeatable: No Usage: Second option for bibliographic citation of the related publication. CDC_UI_Label: Related publications CMM_Mapping: 9.11 ]]> Required: Optional ElementType: Attribute Usage: Language of the related publication title. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: 9.5.1 ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: PID of the publication. Required by OpenAire to to relate the publication to a dataset. CMM_Mapping: 9.9 ]]> Required: Mandatory if '..../IDNo' element is present. ElementType: Attribute Usage: Agency responsible for the identifier of the publication. Required by OpenAire and the value has to come from their controlled list of relatedIdentifierTypes: https://guidelines.openaire.eu/en/latest/data/field_relatedidentifier.html#d-relatedidentifier.. CMM_Mapping: 9.9.1 ]]> Required: Optional ElementType: Content element ElementRepeatable: Yes Usage: Third option for bibliographic citation of the related publication. CDC_UI_Label: Related publications CMM_Mapping: 9.11 ]]> Required: Optional ElementType: Attribute Usage: Language of the related publication title. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: 9.5.1 ]]> Required: Recommended ElementType: Attribute Usage: The publication year of the related publication. CMM_Mapping: 9.6 ]]> Required: Optional ElementType: Attribute Usage: URL of website on which the publication can be found (or at least information concerning the literature). CDC_UI_Label: Related publications CMM_Mapping: 9.10 ]]> Required: Optional ElementType: Attribute Usage: Language of the publication website. ISO 639-1 codes are strongly encouraged to be used. CMM_Mapping: None ]]>