|
DDI_XPath
|
Required
|
UI Label
|
Type
|
Repeatable
|
Usage note
|
| /ddi:DDIInstance/@xml:lang | Optional | Study description available in.. (in the search result list) | Attribute | | ISO 639-1 codes are strongly encouraged to be used. |
| /ddi:DDIInstance/@xsi:schemaLocation | Recommended | | Attribute | | System-required information - nearly always "ddi:instance:3_3
http://www.ddialliance.org/Specification/DDI-Lifecycle/3.3/XMLSchema/instance.xsd". |
| /ddi:FragmentInstance/@xsi:schemaLocation | Recommended | | Attribute | | ddi:FragmentInstance is another option for root element. System-required information - nearly always
"ddi:instance:3_3 http://www.ddialliance.org/Specification/DDI-Lifecycle/3.3/XMLSchema/instance.xsd". |
| /ddi:DDIInstance/r:Citation/r:Title/r:String | Optional | | Content element | No | Title of the CDC XML document - note that the Study Title goes in
/ddi:DDIInstance/s:StudyUnit/r:Citation/r:Title/r:String. |
| /ddi:DDIInstance/r:Citation/r:Title/r:String/@xml:lang | Mandatory if '..r:Title/r:String' element is present | | Attribute | | ISO 639-1 codes are strongly encouraged to be used. |
| //pi:PhysicalInstance/r:Citation/r:Language | Recommended | Language of data file(s) | Content element | Yes | ISO 639-1 codes are strongly encouraged to be used if available for the language. |
| //s:StudyUnit/r:UserID | Mandatory | Study number / PID | Access study | Content element | Yes | This element serves two use cases.
(1) Unique archival number.
If no such number available, a PID may be used alternatively (and in such a case,
the PID must be captured in this element *as well as* in
"/ddi:DDIInstance/s:StudyUnit/r:Citation/r:InternationalIdentifier/r:IdentifierContent").
The @typeOfUserID attribute must be "StudyNumber".
(2) A URL or URN (a reference to a web resource that specifies its location)
linking to the study description on the SP website. CDC provides a link from
the study information there to the study description on the SP website,
to allow users to access the data.
The @typeOfUserID attribute must be "URLServiceProvider". |
| //s:StudyUnit/r:UserID/@typeOfUserID | Mandatory | | Attribute | | Must be specifed when the "ddi:DDIInstance/s:StudyUnit/r:UserID"
element is used for the unique archival number. |
| //s:StudyUnit/r:UserID/@typeOfUserID | Mandatory | | Attribute | | Must be specifed when the "ddi:DDIInstance/s:StudyUnit/r:UserID"
element is used for the URL of the study description at the SP website. |
| //s:StudyUnit/r:Citation/r:Title/r:String | Mandatory | Study title | Content element | Yes | Title of the Study (as opposed to the title of the XML document). |
| //s:StudyUnit/r:Citation/r:Title/r:String/@xml:lang | Mandatory | | Attribute | | Language of the study title. ISO 639-1 codes are strongly encouraged
to be used. |
| //s:StudyUnit/r:Citation/r:Creator/r:CreatorReference | Recommended | Creator | Container element | Yes | Reference to Principal investigator Person OR Institution. |
| //s:StudyUnit/r:Citation/r:Creator/r:CreatorReference/r:TypeOfObject | Mandatory if 'r:CreatorReference' is present. | Creator | Content element | Yes | Type of object being referenced - in this case, it should always be either
"Individual" or "Organization". |
| //s:StudyUnit/r:Citation/r:Publisher/r:PublisherReference | Mandatory | Publisher | Container element | Yes | A reference to the name of the institution publishing the metadata,
i.e. the name of the actual CESSDA Service Provider providing the metadata information. Only on study level. |
| //s:StudyUnit/r:Citation/r:Publisher/r:PublisherReference/r:TypeOfObject | Mandatory if 'r:PublisherReference' is present | Publisher | Content element | Yes | Type of object being referenced - in this case, it should always be
"Organization". |
| //s:StudyUnit/r:Citation/r:PublicationDate/r:SimpleDate | Optional | Publication year | Content element | Yes | 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, CDC will try to read the publication date for CDC from
ddi:DDIInstance/r:Citation/r:PublicationDate/r:SimpleDate (metadata publication date).
It is not recommended to use this field for the embargo end date. |
| /ddi:DDIInstance/r:Citation/r:PublicationDate/r:SimpleDate | Optional | Publication year | Content element | No | This field is used in CDC only if the date in the field
//s:StudyUnit/r:Citation/r:PublicationDate/r:SimpleDate 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. |
| //s:StudyUnit/r:Citation/r:InternationalIdentifier/r:IdentifierContent | Mandatory | | Content element | Yes | Used for the study PID. PID must be one of these four types: ARK, DOI, Handle or URN. |
| //s:StudyUnit/r:Citation/r:InternationalIdentifier/r:ManagingAgency | Mandatory | | Content element | Yes | Agency responsible for the persistent identifier of the study. Value
should be one of
https://vocabularies.cessda.eu/vocabulary/CessdaPersistentIdentifierTypes i.e. ARK
or DOI or Handle or URN. |
| //s:StudyUnit/r:Abstract/r:Content | Mandatory | Abstract | Content element | Yes | The abstract for the study. |
| //s:StudyUnit/r:Abstract/r:Content/@xml:lang | Mandatory | | Attribute | | Language of the abstract. ISO 639-1 codes are strongly encouraged to
be used. |
| //s:StudyUnit/r:FundingInformation/r:AgencyOrganizationReference | Mandatory if ../r:FundingInformation is present | Funder | Container element | Yes | Reference to the Agency which provided the funding. |
| //s:StudyUnit/r:FundingInformation/r:AgencyOrganizationReference/r:TypeOfObject | Mandatory if ../r:FundingInformation/r:AgencyOrganizationReference is present | | Content element | | Type of Agency which provided the funding. Should be 'Organization'. |
| //s:StudyUnit/r:FundingInformation/r:FunderRole | Optional | | Content element | Yes | If different funding agencies sponsored different stages of the production process,
use 'r:FunderRole' to distinguish the grant numbers. |
| //s:StudyUnit/r:FundingInformation/r:GrantNumber | Optional | Grant number | Content element | Yes | 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 r:AgencyOrganizationReference element.
If different funding agencies sponsored different stages of the production process,
use the /r:FunderRole element to distinguish the grant numbers. |
| //s:StudyUnit/r:SeriesStatement/r:SeriesRepositoryLocation | Optional | Series | Content element | No | URI to the series description page in the SPs web page |
| //s:StudyUnit/r:SeriesStatement/r:SeriesName/r:String | Optional | Series | Content element | Yes | The name of the series. |
| //s:StudyUnit/r:SeriesStatement/r:SeriesName/r:String/@xml:lang | Recommended | | Attribute | | Language of the name of the series. ISO 639-1 codes are strongly encouraged
to be used. |
| //s:StudyUnit/r:SeriesStatement/r:SeriesDescription/r:Content | Optional | Series | Content element | Yes | The description of the series. |
| //s:StudyUnit/r:SeriesStatement/r:SeriesDescription/r:Content/@xml:lang | Recommended | | Attribute | | Language of the description of the series. ISO 639-1 codes are strongly encouraged
to be used. |
| //s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Subject | 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. |
| //s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Subject/@xml:lang | Mandatory if "/r:TopicalCoverage/r:Subject" element is
present | | Attribute | | Language of the subject classification term. ISO 639-1 codes are
strongly encouraged to be used. |
| //s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Subject/@controlledVocabularyName | Recommended | Keywords (if ELSST) | Attribute | | The name of the vocabulary. If possible, use "CESSDA Topic Classification"
(regardless of language) but other vocabularies are permitted. |
| //s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Subject/@controlledVocabularyURN | Recommended | | Attribute | | 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 . |
| //s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Keyword | Recommended | Keywords | Content element | Yes | Keyword for the study in the local language. |
| //s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Keyword/@xml:lang | Mandatory if 'r:keyword' element is present | | Attribute | | Language of the keyword. ISO 639-1 codes are strongly encouraged to be
used. |
| //s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Keyword/@controlledVocabularyName | Recommended if 'r:keyword' element is present | | Attribute | | Source of keywords - ELSST is recommended but other vocabularies can
be referenced. |
| //s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Keyword/@controlledVocabularyURN | Optional | | Attribute | | |
| //s:StudyUnit/r:Coverage/r:SpatialCoverage/r:Description/r:Content | Recommended | Country | Content element | Yes | Countries relevant to the study area. |
| //s:StudyUnit/r:Coverage/r:SpatialCoverage/r:Description/r:Content/@xml:lang | Mandatory if '..r:SpatialCoverage/r:Description/r:Content' element
is present | | Attribute | | Language of the country label. ISO 639-1 codes are strongly encouraged
to be used. |
| //s:StudyUnit/r:Coverage/r:SpatialCoverage/r:CountryCode | Recommended | | Content element | | Use this element only if the country has an
ISO 3166-1 2-letter code. |
| //s:StudyUnit/r:AnalysisUnit | Recommended | | Content element | Yes | Contains the Analysis Unit code value. |
| //s:StudyUnit/r:AnalysisUnit/@controlledVocabularyName | Recommended | | Attribute | | Use the string "DDI Analysis Unit" regardless of language. |
| //s:StudyUnit/r:AnalysisUnit/@controlledVocabularyURN | Optional | | Attribute | | 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 . |
| //s:StudyUnit/r:AnalysisUnitsCovered/r:String | Recommended | Analysis unit | Content element | Yes | Descriptive term of Analysis Unit CV item in the local language. |
| //s:StudyUnit/r:AnalysisUnitsCovered/r:String/@xml:lang | Mandatory if 'r:AnalysisUnitsCovered/r:String' element is
present | | Attribute | | Language of the Analysis Unit descriptive term. ISO 639-1
codes are strongly encouraged to be used. |
| //s:StudyUnit/r:OtherMaterialScheme/r:OtherMaterial/r:TypeOfMaterial | Recommended | | Content element | Yes | Should always be set as 'Related Publication'. |
| //s:StudyUnit/r:OtherMaterialScheme/r:OtherMaterial/r:Citation/r:Title/r:String | Recommended | Related publications | Content element | Yes | The title of the related publication. |
| //s:StudyUnit/r:OtherMaterialScheme/r:OtherMaterial/r:Citation/r:Title/r:String/@xml:lang | Optional | | Attribute | | Language of the title of the related publication which also serves as the language of the publication.
ISO 639-1 codes are strongly encouraged to be used. |
| //s:StudyUnit/r:OtherMaterialScheme/r:OtherMaterial/r:Citation/r:PublicationDate/r:SimpleDate | Recommended | | Content element | Yes | The publication year of the related publication. |
| //s:StudyUnit/r:OtherMaterialScheme/r:OtherMaterial/r:Citation/r:InternationalIdentifier/r:IdentifierContent | Optional | | Content element | Yes | PID of the publication. Required by OpenAIRE to to relate the
publication to a dataset. |
| //s:StudyUnit/r:OtherMaterialScheme/r:OtherMaterial/r:Citation/r:InternationalIdentifier/r:ManagingAgency | Optional | | Content element | Yes | 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. |
| //s:StudyUnit/r:OtherMaterialScheme/r:OtherMaterial/r:ExternalURLReference | Optional | | Content element | Yes | URL of website on which the publication can be found (or at least information concerning the literature). |
| //s:StudyUnit/r:RelatedOtherMaterialReference | Optional | | Container element | Yes | Another option for documenting Related publications with DDI3.3 is to reference OtherMaterial instead of giving it as a content of s:StudyUnit. |
| //s:StudyUnit/r:RelatedOtherMaterialReference/r:URN | Recommended | | Content element | No | Reference information of the Related publication (Other Material). Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //s:StudyUnit/r:RelatedOtherMaterialReference/r:Agency | Recommended | | Content element | No | Reference information of the Related publication (Other Material). Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //s:StudyUnit/r:RelatedOtherMaterialReference/r:ID | Recommended | | Content element | No | Reference information of the Related publication (Other Material). Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //s:StudyUnit/r:RelatedOtherMaterialReference/r:Version | Recommended | | Content element | No | Reference information of the Related publication (Other Material). Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //s:StudyUnit/r:RelatedOtherMaterialReference/r:TypeOfObject | Mandatory if ' //r:RelatedOtherMaterialReference' is present | | Content element | No | The type of the referenced object, which in this case is always OtherMaterial |
| //r:OtherMaterial/r:URN | Recommended | | Content element | No | Identifier of the related publication which is used when referencing it with //s:StudyUnit/r:RelatedOtherMaterialReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //r:OtherMaterial/r:URN | Recommended | | Content element | No | Identifier of the related publication which is used when referencing it with //s:StudyUnit/r:RelatedOtherMaterialReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //r:OtherMaterial/r:Agency | Recommended | | Content element | No | Identifier of the related publication which is used when referencing it with //s:StudyUnit/r:RelatedOtherMaterialReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //r:OtherMaterial/r:ID | Recommended | | Content element | No | Identifier of the related publication which is used when referencing it with //s:StudyUnit/r:RelatedOtherMaterialReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //r:OtherMaterial/r:Version | Recommended | | Content element | No | Identifier of the related publication which is used when referencing it with //s:StudyUnit/r:RelatedOtherMaterialReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //r:OtherMaterial/r:TypeOfMaterial | Recommended | | Content element | Yes | Should always be set as 'Related Publication'.
Use this only with //s:StudyUnit/r:RelatedOtherMaterialReference |
| //r:OtherMaterial/r:Citation/r:Title/r:String | Recommended | Related publications | Content element | Yes | The title of the related publication.
Use this only with //s:StudyUnit/r:RelatedOtherMaterialReference |
| //r:OtherMaterial/r:Citation/r:Title/r:String/@xml:lang | Optional | | Attribute | | Language of the title of the related publication which also serves as the language of the publication.
ISO 639-1 codes are strongly encouraged to be used.
Use this only with //s:StudyUnit/r:RelatedOtherMaterialReference |
| //r:OtherMaterial/r:Citation/r:PublicationDate/r:SimpleDate | Recommended | | Content element | Yes | The publication year of the related publication.
Use this only with //s:StudyUnit/r:RelatedOtherMaterialReference |
| //r:OtherMaterial/r:Citation/r:InternationalIdentifier/r:IdentifierContent | Optional | | Content element | Yes | PID of the publication. Required by OpenAIRE to to relate the
publication to a dataset.
Use this only with //s:StudyUnit/r:RelatedOtherMaterialReference |
| //r:OtherMaterial/r:Citation/r:InternationalIdentifier/r:ManagingAgency | Optional | | Content element | Yes | 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.
Use this only with //s:StudyUnit/r:RelatedOtherMaterialReference |
| //r:OtherMaterial/r:ExternalURLReference | Optional | | Content element | Yes | URL of website on which the publication can be found (or at least information concerning the literature).
Use this only with //s:StudyUnit/r:RelatedOtherMaterialReference |
| //s:StudyUnit/r:UniverseReference | Optional | | Container element | Yes | Reference information of the Universe. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //s:StudyUnit/r:UniverseReference/r:URN | Recommended | | Content element | No | Reference information of the Universe. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //s:StudyUnit/r:UniverseReference/r:Agency | Recommended | | Content element | No | Reference information of the Universe. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //s:StudyUnit/r:UniverseReference/r:ID | Recommended | | Content element | No | Reference information of the Universe. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //s:StudyUnit/r:UniverseReference/r:Version | Recommended | | Content element | No | Reference information of the Universe. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //s:StudyUnit/r:UniverseReference/r:TypeOfObject | Mandatory if ' //r:UniverseReference' is present | | Content element | No | The type of the referenced object, which in this case is always Universe |
| //c:Universe/r:URN | Recommended | | Content element | No | Identifier of the Universe which is used when referencing it with //s:StudyUnit/r:UniverseReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //c:Universe/r:Agency | Recommended | | Content element | No | Identifier of the Universe which is used when referencing it with //s:StudyUnit/r:UniverseReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //c:Universe/r:ID | Recommended | | Content element | No | Identifier of the Universe which is used when referencing it with //s:StudyUnit/r:UniverseReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //c:Universe/r:Version | Recommended | | Content element | No | Identifier of the Universe which is used when referencing it with //s:StudyUnit/r:UniverseReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //c:Universe/r:Description/r:Content | Recommended | Universe | Content element | Yes | First option for the description of population or other elements studied or measured (freetext).
Use this only with //s:StudyUnit/r:UniverseReference. |
| //c:Universe/r:Description/r:Content/@xml:lang | Mandatory if '../c:Universe/r:Description/r:Content' element is present. | None | Attribute | | Language of the Universe item. ISO 639-1 codes are strongly
encouraged to be used. Use this only with //s:StudyUnit/r:UniverseReference. |
| //c:Universe/r:Label/r:Content | Recommended | Universe | Content element | Yes | Second option for the description of population or other elements studied or measured (freetext).
Use this only with //s:StudyUnit/r:UniverseReference. |
| //c:Universe/r:Label/r:Content/@xml:lang | Mandatory if '../c:Universe/r:Label/r:Content' element is present. | None | Attribute | | Language of the Universe item. ISO 639-1 codes are strongly encouraged to be used.
Use this only with //s:StudyUnit/r:UniverseReference. |
| //c:Universe/@isInclusive | 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.
Use this only with //s:StudyUnit/r:UniverseReference. |
| //s:StudyUnit/r:KindOfData | Optional | Kind of data | Content element | Yes | A free text field describing shortly the type or kind of the dataset.
Using a vocabulary is recommended. |
| //d:Methodology/d:TimeMethod/d:TypeOfTimeMethod | Recommended | | Content element | Yes | Code value of the CV "DDI Time Method". Describes the time dimension
of the data collection. |
| //d:Methodology/d:TimeMethod/d:TypeOfTimeMethod/@controlledVocabularyName | Recommended | | Attribute | | Use the string "DDI Time Method" regardless of language. |
| //d:Methodology/d:TimeMethod/d:TypeOfTimeMethod/@controlledVocabularyURN | Optional | | Attribute | | 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 . |
| //d:Methodology/d:TimeMethod/r:Description/r:Content | Recommended | Time dimension | Content element | Yes | Descriptive term of Time Method CV item in the local language. |
| //d:Methodology/d:TimeMethod/r:Description/r:Content/@xml:lang | Mandatory if '.../d:TimeMethod/r:Description/r:Content' element is present | | Attribute | | Language of the Time Dimension descriptive term. ISO 639-1 codes are
strongly encouraged to be used. |
| //d:Methodology/d:SamplingProcedure/d:TypeOfSamplingProcedure | Recommended | | Content element | Yes | Type of sampling procedure used for data collection. Controlled
vocabulary includes a typology of sampling methods. Code value of the CV "DDI
Sampling Procedure". |
| //d:Methodology/d:SamplingProcedure/d:TypeOfSamplingProcedure/@controlledVocabularyName | Recommended | | Attribute | | Use the string "DDI Sampling Procedure" regardless of
language. |
| //d:Methodology/d:SamplingProcedure/d:TypeOfSamplingProcedure/@controlledVocabularyURN | Optional | | Attribute | | 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 . |
| //d:Methodology/d:SamplingProcedure/r:Description/r:Content | Recommended | Sampling procedure | Content element | Yes | Descriptive term of the Sampling Procedure CV
item in the local language. |
| //d:Methodology/d:SamplingProcedure/r:Description/r:Content/@xml:lang | Mandatory if '.../d:SamplingProcedure/r:Description/r:Content' element is
present | | Attribute | | Language of the Sampling Procedure Descriptive term. ISO 639-1 codes
are strongly encouraged to be used. |
| //d:DataCollection/d:CollectionEvent/d:DataCollectionDate/r:StartDate | Recommended | Data collection period | Element | No | Either a single point in time or start of a date range. Ideally
YYYY-MM-DDThh:mm:ssZ format, but can accept YYYY-MM-DD, YYYY-MM or YYYY. |
| //d:DataCollection/d:CollectionEvent/d:DataCollectionDate/r:EndDate | Recommended | Data collection period | Element | No | End of a date range. If data collection period is a single event, then
this element is not required. Ideally YYYY-MM-DDThh:mm:ssZ format, but can accept
YYYY-MM-DD, YYYY-MM or YYYY. |
| //d:DataCollection/d:CollectionEvent/d:DataCollectionDate/r:SimpleDate | Recommended | Data collection period | Element | No | Use if data collection period is a single event.
Ideally YYYY-MM-DDThh:mm:ssZ format, but can accept
YYYY-MM-DD, YYYY-MM or YYYY. |
| //d:DataCollection/d:CollectionEvent/d:CollectionSituation/r:Description/r:Content | Optional | Data collection period | Element | No | This is the free text expression of the collection period. This
element may be empty. |
| //d:DataCollection/d:CollectionEvent/d:CollectionSituation/r:Description/r:Content/@xml:lang | Mandatory if '...Content' element is populated with a freetext expression. | | Attribute | | Language of the free text expression of the collection period.
ISO 639-1 codes are strongly encouraged to be used. |
| //d:DataCollection/d:CollectionEvent/d:ModeOfCollection/d:TypeOfModeOfCollection | Recommended | | Content element | Yes | Description of the method of data collection - the procedure,
technique, or mode of inquiry used to attain the data. Code value of the CV "DDI
Mode of Data Collection". |
| //d:DataCollection/d:CollectionEvent/d:ModeOfCollection/d:TypeOfModeOfCollection/@controlledVocabularyName | Recommended | | Attribute | | Use the string "DDI Mode of Collection" regardless of
language. |
| //d:DataCollection/d:CollectionEvent/d:ModeOfCollection/d:TypeOfModeOfCollection/@controlledVocabularyURN | Optional | | Attribute | | 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 . |
| //d:DataCollection/d:CollectionEvent/d:ModeOfCollection/r:Description/r:Content | Recommended | Data collection mode | Content element | Yes | Descriptive term of the Mode of Data Collection CV item in the local language. |
| //d:DataCollection/d:CollectionEvent/d:ModeOfCollection/r:Description/r:Content/@xml:lang | Mandatory if '.../d:ModeOfCollection/r:Description/r:Content' element is
present | | Attribute | | Language of the Mode of Data Collection descriptive term. ISO 639-1
codes are strongly encouraged to be used. |
| //a:Archive/a:ArchiveSpecific/a:Item/a:Access/a:TypeOfAccess | Optional | Data access | Content element | Yes | 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. |
| //a:Archive/a:ArchiveSpecific/a:Item/a:Access/a:TypeOfAccess/@controlledVocabularyName | Optional | | Attribute | | When the TypeOfAccess element is used for vocabulary
'COAR Access Right Vocabulary', then use this vocabulary name
'COAR Access Right Vocabulary' in this field. |
| //a:Archive/a:ArchiveSpecific/a:Item/a:Access/r:Description/r:Content | Recommended | Terms of data access | Content element | Yes | Refers to any information relating to the access and use conditions of
data that the SP wants to appear in the CDC. |
| //a:Archive/a:ArchiveSpecific/a:Item/a:Access/r:Description/r:Content/@xml:lang | Mandatory if '..a:Access/r:Description/r:Content' element is
present | | Attribute | | Language of the Access statement. ISO 639-1 codes are strongly
encouraged to be used. |
| //a:Individual | Optional | | Container element | Yes | The repeatable parent element for the Individual information. |
| //a:Individual/r:URN | Recommended | | Content element | No | Identifier of the Individual which is used when referencing this individual e.g. CreatorReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Individual/r:Agency | Recommended | | Content element | No | Identifier of the Individual which is used when referencing this individual e.g. CreatorReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Individual/r:ID | Recommended | | Content element | No | Identifier of the Individual which is used when referencing this individual e.g. CreatorReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Individual/r:Version | Recommended | | Content element | No | Identifier of the Individual which is used when referencing this individual e.g. CreatorReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Individual/a:IndividualIdentification/a:IndividualName/a:FullName/r:String | Recommended | | Content element | Yes | The full name of the Individual |
| //a:Individual/a:IndividualIdentification/a:ResearcherID | Optional | | Container element | Yes | The repeatable parent element for the Individual PID. |
| //a:Individual/a:IndividualIdentification/a:ResearcherID/a:TypeOfID | Optional | | Content element | No | The type of the PID. If the PID is documented, the type of the PID
should be documented, too. |
| //a:Individual/a:IndividualIdentification/a:ResearcherID/a:ResearcherIdentification | Optional | | Content element | No | The persistent identifier (PID) of the Individual |
| //a:Individual/a:IndividualIdentification/a:ResearcherID/r:URI | Optional | | Content element | No | The URL of the PID. |
| //a:Organization | Optional | | Container element | Yes | The repeatable parent element for the Organization information. |
| //a:Organization/r:URN | Recommended | | Content element | No | Identifier of the Organization which is used when referencing this Organization e.g. CreatorReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Organization/r:Agency | Recommended | | Content element | No | Identifier of the Organization which is used when referencing this Organization e.g. CreatorReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Organization/r:ID | Recommended | | Content element | No | Identifier of the Organization which is used when referencing this Organization e.g. CreatorReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Organization/r:Version | Recommended | | Content element | No | Identifier of the Organization which is used when referencing this Organization e.g. CreatorReference.
Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Organization/a:OrganizationIdentification/a:OrganizationName/r:String | Recommended | | Content element | Yes | The name of the Organization |
| //a:Organization/r:UserID | Optional | | Content element | Yes | The URL of persistent identifier (PID) of the organization |
| //a:Organization/r:UserID/@typeOfUserID | Mandatory if '//a:Organization/r:UserID' element is present. | | Attribute | | The type of the PID. Please note, that the this attribute is mandatory for the
UserID element due to the DDI-L specification. |
| //a:Relation | Optional | | Container element | Yes | The repeatable parent element for the Relation information. |
| //a:Relation/r:URN | Recommended | | Content element | No | Identifier of the Relation. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/r:Agency | Recommended | | Content element | No | Identifier of the Relation. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/r:ID | Recommended | | Content element | No | Identifier of the Relation. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/r:Version | Recommended | | Content element | No | Identifier of the Relation. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/a:SourceObject | Mandatory if ' //a:Relation' is present | | Container element | No | The parent element for the SourceObject information. |
| //a:Relation/a:SourceObject/a:IndividualReference/r:URN | Recommended | | Content element | No | Reference information of the Individual. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/a:SourceObject/a:IndividualReference/r:Agency | Recommended | | Content element | No | Reference information of the Individual. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/a:SourceObject/a:IndividualReference/r:ID | Recommended | | Content element | No | Reference information of the Individual. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/a:SourceObject/a:IndividualReference/r:Version | Recommended | | Content element | No | Reference information of the Individual. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/a:SourceObject/a:IndividualReference/r:TypeOfObject | Mandatory if ' //a:SourceObject/a:IndividualReference' is present | | Content element | No | The type of the referenced object, which in this case is always Individual |
| //a:Relation/a:TargetObject | Mandatory if ' //a:Relation' is present | | Container element | No | The parent element for the TargetObject information. |
| //a:Relation/a:TargetObject/a:OrganizationReference/r:URN | Recommended | | Content element | No | Reference information of the Organization. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/a:TargetObject/a:OrganizationReference/r:Agency | Recommended | | Content element | No | Reference information of the Organization. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/a:TargetObject/a:OrganizationReference/r:ID | Recommended | | Content element | No | Reference information of the Organization. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/a:TargetObject/a:OrganizationReference/r:Version | Recommended | | Content element | No | Reference information of the Organization. Either DDI URN or triple Agency, ID, Version (or both) need to be provided. |
| //a:Relation/a:TargetObject/a:OrganizationReference/r:TypeOfObject | Mandatory if ' //a:SourceObject/a:IndividualReference' is present | | Content element | No | The type of the referenced object, which in this case is always Organization |
| //a:Relation/a:TargetObject/a:Role/r:Description/r:Content | Mandatory if ' //a:Relation/a:TargetObject/a:Role/r:Description' is present | | Content element | No | The role of the TargetObject (Organization), which in this case should always be set as 'Affiliation' |