|
DDI_XPath
|
Required
|
UI Label
|
Type
|
Repeatable
|
Usage note
|
| /ddi:DDIInstance/r:Citation/r:Publisher/r:PublisherReference/r:TypeOfObject | Mandatory | not displayed (internal reference) - associated with 'Metadata
Provider'. | Content element | No | States the type of object being referenced based on a persistent list
of valid DDI object types. Must be 'Individual' or 'Organization' |
| /ddi:DDIInstance/r:Citation/r:Copyright/r:String | Optional | to be displayed in EQB v2.0. | Content element | Yes | Information on the copyright of the study documentation. |
| /ddi:DDIInstance/r:Citation/r:Copyright/r:String/@xml:lang | Mandatory if 'Copyright/String' element is present | to be displayed in EQB v2.0. | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used. |
| /ddi:DDIInstance/g:Group/r:UserID | Mandatory | not displayed (internal info). | Content element | Yes | Two use cases:
(1) A value of a persistent identifier for the study group
(mandatory).
(2) An URL or URN (a reference to a web resource that specifies
its location) linking to the study group (optional).
|
| /ddi:DDIInstance/g:Group/r:UserID/@typeOfUserID | Required: Mandatory if 'g:Group/r:UserID' element is present | not displayed (internal info). | Attribute | | Two use cases as per r:UserID:
(1) A required attribute containing the local user identification system
that maintains and defines the UserID. Always 'GroupID'.
(2) A required attribute containing the local user identification system
that maintains and defines the UserID. Always 'URLServiceProvider'.
|
| /ddi:DDIInstance/g:Group/r:StudyUnitReference/r:TypeOfObject | Mandatory | not displayed (internal info). | Content element | Yes | Two use cases:
(1) States the type of object being referenced based on a persistent
list of valid DDI object types. Always 'StudyUnit' if referring to a Study..
(2) States the type of object being referenced based on a persistent
list of valid DDI object types. Always 'OtherMaterial' if referrring to a document.
|
| /ddi:DDIInstance/g:Group/r:Citation/r:Title/r:String | Mandatory | Filter/Part of study group/series. | Content element | Yes | A title or name for the study group. |
| /ddi:DDIInstance/g:Group/r:Citation/r:Title/r:String/@xml:lang | Mandatory if ...r:Title/r:String is present. | not displayed (internal info). | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used. |
| /ddi:DDIInstance/g:Group/r:Citation/r:Title/r:String/@isTranslated | Recommended | not displayed (internal info). | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/r:ResourcePackage/pi:PhysicalInstance/r:Citation/r:Title/r:String | Mandatory | to be displayed in EQB v2.0. | Content element | Yes | A file name of the data set. |
| /ddi:DDIInstance/r:ResourcePackage/pi:PhysicalInstance/r:Citation/r:Title/r:String/@xml:lang | Mandatory if ...r:Title/r:String is present. | not displayed (internal info). | Attribute | | The language of the content of the element. ISO 639-1 codes are
strongly encouraged to be used. |
| ddi:DDIInstance/r:ResourcePackage/pi:PhysicalInstance/r:Citation/r:InternationalIdentifier/r:IdentifierContent | Optional | to be displayed in EQB v2.0. | Content element | Yes | An identifier that captures information on the type and value of a PID.
For the associated r:ManagingAgency element, specify the identification of the agency
which assigns and manages the identifier, i.e., ISBN, ISSN, DOI, etc. |
| /ddi:DDIInstance/g:ResourcePackage/a:OrganizationScheme/a:Organization/a:OrganizationIdentification/a:OrganizationName/r:String | Optional | Publisher | Content element | Yes | A name of the organization or institution. |
| /ddi:DDIInstance/g:ResourcePackage/a:OrganizationScheme/a:Organization/a:OrganizationIdentification/a:OrganizationName/r:String/@xml:lang | Mandatory if a:OrganizationIdentification/a:OrganizationName is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used. |
| /ddi:DDIInstance/g:ResourcePackage/a:OrganizationScheme/a:Organization/a:OrganizationIdentification/a:OrganizationName/r:Abbreviation/r:String | Optional | to be displayed in EQB v2.0 | Content element | Yes | If applicable - abbreviation of the institution's name. |
| ddi:DDIInstance/g:ResourcePackage/a:OrganizationScheme/a:Individual/a:IndividualIdentification/a:IndividualName/a:FirstGiven | Optional | Publisher. | Content element | Yes | The first name of a person. |
| ddi:DDIInstance/g:ResourcePackage/a:OrganizationScheme/a:Individual/a:IndividualIdentification/a:IndividualName/a:Middle | Optional | Publisher. | Content element | Yes | The middle name of a person. |
| ddi:DDIInstance/g:ResourcePackage/a:OrganizationScheme/a:Individual/a:IndividualIdentification/a:IndividualName/a:LastFamily | Optional | Publisher. | Content element | Yes | The last name of a person. |
| /ddi:DDIInstance/g:ResourcePackage/a:OrganizationScheme/r:Relation/a:SourceObject/a:IndividualReference/r:TypeOfObject | Optional | not displayed (internal info). | Content element | Yes | States the type of object being referenced based on a persistent
list of valid DDI object types. Always 'Individual'. |
| /ddi:DDIInstance/g:ResourcePackage/a:OrganizationScheme/r:Relation/a:TargetObject/a:Role/r:Description/r:Content | Optional | not displayed (internal info). | Content element | Yes | Identifies the target organization or individual in the relationship. Always 'Affiliation'. |
| /ddi:DDIInstance/g:ResourcePackage/a:OrganizationScheme/r:Relation/a:TargetObject/a:OrganizationReference/r:TypeOfObject | Optional | not displayed (internal info). | Content element | Yes | States the type of object being referenced based on a persistent list of valid DDI object
types. Always 'Organization'. |
| /ddi:DDIInstance/g:ResourcePackage/c:ConceptScheme/c:Concept/c:ConceptName/r:String | Optional | Concepts | Content element | Yes | A name of the concept. |
| /ddi:DDIInstance/g:ResourcePackage/c:ConceptScheme/c:Concept/c:ConceptName/r:String/@xml:lang | Mandatory if '..c:ConceptName/r:String' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/c:ConceptScheme/c:Concept/r:Label/r:Content | Optional | Concepts | Content element | Yes | A label of the concept. |
| /ddi:DDIInstance/g:ResourcePackage/c:ConceptScheme/c:Concept/r:Label/r:Content/@xml:lang | Mandatory if '..c:ConceptName/r:Label/r:Content' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/c:ConceptScheme/c:Concept/r:Description/r:Content | Optional | Concept Descriptions | Content element | Yes | A description of the concept. |
| /ddi:DDIInstance/g:ResourcePackage/c:ConceptScheme/c:Concept/r:Description/r:Content/@xml:lang | Mandatory if '..c:ConceptName/r:Description/r:Content' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:InterviewerInstructionScheme/d:Instruction/d:InstructionText/d:LiteralText/d:Text | Recommended | Interviewer instruction | Content element | Yes | An instruction for the interviewer.
Referenced by QuestionItem and QuestionGrid |
| /ddi:DDIInstance/g:ResourcePackage/d:InterviewerInstructionScheme/d:Instruction/d:InstructionText/d:LiteralText/d:Text/@xml:lang | Mandatory if 'd:InstructionText/d:LiteralText' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:InterviewerInstructionScheme/d:Instruction/d:InstructionText/d:LiteralText/d:Text/@isTranslated | Recommended | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/d:ControlConstructScheme/d:StatementItem/d:DisplayText/d:LiteralText/d:Text | Recommended | Pre-/Post-question text | Content element | Yes | A prequestion and/or postquestion and other statements as part of the question item text. |
| /ddi:DDIInstance/g:ResourcePackage/d:ControlConstructScheme/d:StatementItem/d:DisplayText/d:LiteralText/d:Text/@xml:lang | Mandatory if 'd:StatementItem/d:DisplayText/d:LiteralText/d:Text' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:ControlConstructScheme/d:StatementItem/d:DisplayText/d:LiteralText/d:Text/@isTranslated | Recommended | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/d:ControlConstructScheme/d:Sequence/d:ControlConstructReference/r:TypeOfObject | Mandatory | not displayed (internal info) | Content element | | Top level sequence, to be referenced from Instrument. In this context, r:TypeOfObject='Sequence'
This top level sequence holds to one or more d:ControlConstructScheme/d:Sequence elements (one per question),
each of refers to (1) a QuestionConstruct (d:ControlConstructReference/r:TypeOfObject='QuestionConstruct') which itself refers to a QuestionItem
or QuestionGrid and (2)an optional Statement where d:ControlConstructReference/r:TypeOfObject='StatementItem'.
|
| /ddi:DDIInstance/g:ResourcePackage/d:ControlConstructScheme/d:QuestionConstruct/d:QuestionReference/r:TypeOfObject | Mandatory | not displayed (internal info) | Content element | | Either 'QuestionGrid' or 'QuestionItem', depending on whether this is a refernce to Question item or Question Grid.
In summary:
to get from Instrument to Question, you have to follow:
-reference to TopLevelSequence
-has reference to Sequence (for each question there is 1)
-has reference to QuestionConstruct
-has reference to QuestionGrid or QuestionItem
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/r:UserID | Optional | Question ID | Content element | Yes | An identifier provided by the user for the question. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/r:UserID/@typeOfUserID | Mandatory if '..d:QuestionItem/r:UserID' is present. | not displayed (internal info) | Attribute | | Type of UserID for question. Always 'QuestionID'. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:QuestionItemName/@context | Mandatory if '..d:QuestionItem/d:QuestionItemName' element is present | not displayed (internal info) | Attribute | | Two use cases:
(1) Identify the context related to the question item name,
in this case to separate between number and label for example..
Examples: examples: 'title-english', 'title-originallang'
(2) Identify the context related to the question item name,
in this case to separate between number and label for example.Always 'questionNumber'.
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:QuestionItemName/r:String | Mandatory | Name; Question number | Content element | Yes | Two use cases:
(1) A label of a question item the metadata refers to for display.
(2) A number of the question item the metadata refers to within the associated instrument.
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:QuestionItemName/r:String/@xml:lang | Mandatory if '..d:QuestionItemName/r:String/' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:QuestionItemName/r:String/@isTranslated | Recommended | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:QuestionText/d:LiteralText/d:Text | Mandatory | Question text. | Content element | Yes | A literal question item text. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:QuestionText/d:LiteralText/d:Text/@xml:lang | Mandatory if '..d:QuestionText/d:LiteralText/d:Text' is present | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:QuestionText/d:LiteralText/d:Text/@isTranslated | Recommended | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:DateTimeDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionItem ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:MissingValuesDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionItem ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:NumericDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionItem ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:ScaleDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionItem ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:TextDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionItem ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/r:ConceptReference/r:TypeOfObject | Recommended | not displayed (internal info). | Content element | Yes | States the type of object being referenced based on a persistent list of valid DDI object types.
Alwys 'Concept'. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:ExternalAid/r:Description/r:Content | Optional | to be displayed in EQB v2.0. | Content element | Yes | A file name of the showcard. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:ExternalAid/r:Description/r:Content/@xml:lang | Mandatory if '..d:ExternalAid/r:Description/r:Content' element is present | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:ExternalAid/r:Description/r:Content/@isTranslated | Recommended | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:ExternalAid/r:ExternalURLReference | Optional | to be displayed in EQB v2.0. | Content element | Yes | A link to the showcard. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionItem/d:InterviewerInstructionReference/r:TypeOfObject | Optional | not displayed (internal info) | Content element | Yes | Needed to connect the interviewerinstruction with the question item. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/r:UserID | Optional | not displayed (internal info). | Content element | Yes | An identifier for a question grid the metadata refer to. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/r:UserID/@typeOfUserID | Required: Mandatory if '..d:QuestionGrid/r:UserID' element is present. | not displayed (internal info). | Attribute | | A required attribute containing the local user identification system
that maintains and defines the UserID. Always 'QuestionID'. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:QuestionGridName/@context | Mandatory if '..d:QuestionGrid/d:QuestionGridName' element is present | not displayed (internal info) | Attribute | | Two use cases:
(1)Identify the context related to the question grid name,
in this case to separate between Question Number and Label, for example:
'title-english', 'title-originallang'
(2) Identify the context related to the question grid name,
in this case to separate between Question Number and Label, for example. Always 'questionNumber'.
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:QuestionGridName/r:String | Optional | Name. | Content element | Yes | Two use cases:
(1) A label of a question grid the metadata refer to for display.
(2) A number of the question grid the metadata refers to within the associated instrument.
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:QuestionGridName/r:String/@xml:lang | Mandatory if '..d:QuestionGridName/r:String/' element is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:QuestionGridName/r:String/@isTranslated | Recommended | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:QuestionText/d:LiteralText/d:Text | Optional | Question text. | Content element | Yes | |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:QuestionText/d:LiteralText/d:Text/@xml:lang | Mandatory if '..d:/QuestionGrid/d:QuestionText/d:LiteralText/d:Text' is present | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:QuestionText/d:LiteralText/d:Text/@isTranslated | Recommended | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:GridDimension/d:CodeDomain/r:CodeListReference/r:TypeOfObject | Recommended | not displayed (internal info). | Content element | Yes | Holds subquestion number and subquestion text. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:GridDimension/d:CodeDomain/r:Description/r:Content | Optional | Subquestion number | Content element | Yes | A value for the subquestion of a question grid. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:GridDimension/d:CodeDomain/r:Description/r:Content/@xml:lang | Mandatory if '..d:CodeDomain/r:Description/r:Content' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:GridDimension/d:CodeDomain/r:Description/r:Content/@isTranslated | Recommended if '..d:CodeDomain/r:Description/r:Content' is present. | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:DateTimeDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionGrid ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:MissingValuesDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionGrid ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:NumericDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionGrid ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:ScaleDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionGrid ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:TextDomainReference/r:TypeOfObject | Optional - mutually exclusive with other QuestionGrid ResponseDomainReferences | not displayed (internal info). | Content element | Yes | States the type of ResponseDomain being referenced based on a persistent list of valid DDI object types. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:StructuredMixedGridResponseDomain/d:GridResponseDomain/d:CodeDomain/r:OutParameter | Optional - mutually exclusive with other QuestionGrid ResponseDomainReferences | not displayed (internal info). | Content element | Yes | Defines an out parameter that can be used by variable to connect it with.
For example, /ddi:DDIInstance/g:ResourcePackage/l:VariableScheme/l:Variable/r:SourceParameterReference
can point to this item. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:StructuredMixedGridResponseDomain/d:GridResponseDomain/d:GridAttachment/d:CellCoordinatesAsDefined/d:SelectDimension/@rank | Optional | not displayed (internal info). | Attribute | | Defines the grid dimension and the subquestion for the response value. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/r:ConceptReference/r:TypeOfObject | Recommended | not displayed (internal info). | Content element | Yes | States the type of object being referenced based on a persistent list of valid DDI object types.
Alwys 'Concept'. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:ExternalAid/r:Description/r:Content | Optional | to be displayed in EQB v2.0. | Content element | Yes | A file name of the showcard. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:ExternalAid/r:Description/r:Content/@xml:lang | Mandatory if '..d:ExternalAid/r:Description/r:Content' element is present | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:ExternalAid/r:Description/r:Content/@isTranslated | Recommended | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:ExternalAid/r:ExternalURLReference | Optional | to be displayed in EQB v2.0. | Content element | Yes | A link to the showcard. |
| /ddi:DDIInstance/g:ResourcePackage/d:QuestionScheme/d:QuestionGrid/d:InterviewerInstructionReference/r:TypeOfObject | Optional | not displayed (internal info) | Content element | Yes | Needed to connect the interviewerinstruction with the question grid. |
| /ddi:DDIInstance/g:ResourcePackage/l:CategoryScheme/l:Category/l:CategoryName/r:String | Optional | Subquestion text | Content element | Yes | A statement/or question which is part of the question grid
and comes after the preceding question grid text. |
| /ddi:DDIInstance/g:ResourcePackage/l:CategoryScheme/l:Category/l:CategoryName/r:String/@xml:lang | Mandatory if '..l:CategoryName/r:String element is present'. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/l:CategoryScheme/l:Category/l:CategoryName/r:String/@isTranslated | Recommended | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/l:CategoryScheme/l:Category/@isMissing | Optional | Answer code/Response category | Attribute | | A value for missing data. If the category is describing a classification of
"missing data" set the value of isMissing to "true". |
| /ddi:DDIInstance/g:ResourcePackage/l:CategoryScheme/l:Category/l:Label/r:Content | Optional | Response category | Content element | Yes | A description of a particular category or response. |
| /ddi:DDIInstance/g:ResourcePackage/l:CategoryScheme/l:Category/l:Label/r:Content/@xml:lang | Mandatory if '..l:Category/l:Label/r:Content element is present'. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/l:CategoryScheme/l:Category/l:Label/r:Content/@isTranslated | Recommended | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/r:UserID | Optional | not displayed (internal info). | Content element | Yes | An user identifier of the codelist the metadata refers to. |
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/r:UserID/@typeOfUserID | Mandatory if '../l:CodeList/r:UserID/' is present. | not displayed (internal info). | Attribute | Yes | Use 'UserID' for the attribute value. |
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/l:CodeListName/r:String | Optional | to be displayed in EQB v2.0 | Content element | Yes | A name of the codelist. |
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/l:CodeListName/r:String/@xml:lang | Mandatory if '..l:CodeListName/r:String' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/r:Label/r:String | Optional | to be displayed in EQB v2.0 | Content element | Yes | A label of the codelist. |
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/r:Label/r:String/@xml:lang | Mandatory if '..l:CodeList/r:Label/r:String' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/r:Description/r:String | Optional | to be displayed in EQB v2.0 | Content element | Yes | A description of the codelist. |
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/r:Description/r:String/@xml:lang | Mandatory if '..l:CodeList/r:Description/r:String' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/l:Code/r:CategoryReference/r:TypeOfObject | Optional | not displayed (internal info) | Content element | Yes | States the type of object being referenced based on a persistent list
of valid DDI object types. Always 'Category'. |
| /ddi:DDIInstance/g:ResourcePackage/l:CodeListScheme/l:CodeList/l:Code/r:Value | Optional | Answer code | Content element | Yes | A structure that links a unique value of a code to a specified category. |
| /ddi:DDIInstance/g:ResourcePackage/l:VariableScheme/l:Variable/r:UserID/@typeOfUserID | Mandatory if '..l:Variable/r:UserID' is present. | Variables. | Attribute | xxxxx | Required attribute indicating that the 'l:Variable/r:UserID' element defines the variable type
(e.g. "numeric") according to the ways that the variable can be studied, measured, and presented.
Always 'variableType'. |
| /ddi:DDIInstance/r:ResourcePackage/l:VariableScheme/l:Variable/l:VariableName/r:String | Mandatory | Variables. | Content element | Yes | A name of a variable within a dataset. |
| /ddi:DDIInstance/r:ResourcePackage/l:VariableScheme/l:Variable/l:VariableName/r:String/@xml:lang | Mandatory if '..l:VariableName/r:String' is present. | not displayed (internal info). | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used.
|
| /ddi:DDIInstance/r:ResourcePackage/l:VariableScheme/l:Variable/l:VariableName/r:String/@isTranslated | Recommended | not displayed (internal info). | Attribute | | Is the content of the element translated?
|
| /ddi:DDIInstance/r:ResourcePackage/l:VariableScheme/l:Variable/r:Label/r:Content | Optional | Variables. | Content element | Yes | A label of a variable for display. |
| /ddi:DDIInstance/r:ResourcePackage/l:VariableScheme/l:Variable/r:Label/r:Content/@xml:lang | Mandatory if '..l:Variable/r:Label/r:Content' is present. | not displayed (internal info). | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used.
|
| /ddi:DDIInstance/r:ResourcePackage/l:VariableScheme/l:Variable/r:Label/r:Content/@isTranslated | Recommended | not displayed (internal info). | Attribute | | Is the content of the element translated?
|
| /ddi:DDIInstance/r:ResourcePackage/l:VariableScheme/l:Variable/r:Description/r:Content | Optional | Variables. | Content element | Yes | An additional description of the variable or the file content. |
| /ddi:DDIInstance/r:ResourcePackage/l:VariableScheme/l:Variable/r:Description/r:Content/@xml:lang | Mandatory if '..l:Variable/r:Description/r:Content' is present. | not displayed (internal info). | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used.
|
| /ddi:DDIInstance/r:ResourcePackage/l:VariableScheme/l:Variable/r:Description/r:Content/@isTranslated | Recommended | not displayed (internal info). | Attribute | | Is the content of the element translated?
|
| /ddi:DDIInstance/g:ResourcePackage/l:VariableScheme/l:Variable/r:QuestionReference/r:TypeOfObject | Mandatory | not displayed (internal info) | Content element | Yes | States the type of object being referenced based on a persistent list
of valid DDI object types. Always 'QuestionItem'. |
| /ddi:DDIInstance/g:ResourcePackage/l:VariableScheme/l:Variable/l:VariableRepresentation/r:CodeRepresentation/r:CodeListReference/r:TypeOfObject | Mandatory | not displayed (internal info) | Content element | Yes | States the type of object being referenced based on a persistent list
of valid DDI object types. Always 'CodeList'. |
| /ddi:DDIInstance/g:ResourcePackage/d:InstrumentScheme/d:Instrument/d:InstrumentName/r:String | Optional | to be displayed in EQB v2.0. | Content element | Yes | A name of the instrument. |
| /ddi:DDIInstance/g:ResourcePackage/d:InstrumentScheme/d:Instrument/d:InstrumentName/r:String/@xml:lang | Mandatory if '../d:InstrumentName/r:String' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/d:InstrumentScheme/d:Instrument/d:InstrumentName/r:String/isTranslated | Recommended | not displayed (internal info) | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/g:ResourcePackage/d:InstrumentScheme/d:Instrument/d:ControlConstructReference/@objectLanguage | Mandatory if '..d:InstrumentScheme/d:Instrument/d:ControlConstructReference' element is present. | Interview Language | Attribute | | A language for the instrument that is being used in the study.
ISO 639-1 codes are strongly encouraged to be used. |
| /ddi:DDIInstance/g:ResourcePackage/d:InstrumentScheme/d:Instrument/d:ControlConstructReference/r:TypeOfObject | Mandatory if '..d:InstrumentScheme/d:Instrument/d:ControlConstructReference' element is present. | not displayed (internal info) | | | Part of structure for the reference to the top level sequence;
from there the hierarchy allows access to all sub-sequences,
controlconstructs, questionconstructs and questionitems/grids.
NB - 5.4 and 5.5 definitions in in the EQB Excel spreadsheet are misleading.
to get from Instrument to Question, you have to follow:
-From here, refer to TopLevelSequence
-has reference to Sequence (for each question there is 1)
-has reference to QuestionConstruct
-has reference to QuestionGrid or QuestionItem
|
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedDateTimeRepresentation | Optional | to be displayed in EQB v2.0 | Container element | Yes | A response domain capturing a Date/Time response from a question item or grid. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedMissingValuesRepresentation | Optional | to be displayed in EQB v2.0 | Container element | Yes | A response domain capturing a MissingValues response from a question item or grid. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedScaleRepresentation | Optional | to be displayed in EQB v2.0 | Container element | Yes | A response domain capturing a Scale response from a question item or grid. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedNumericRepresentation/r:ManagedNumericRepresentationName/r:String | Optional | to be displayed in EQB v2.0. | Content element | Yes | A name of a numeric domain. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedNumericRepresentation/r:ManagedNumericRepresentationName/r:String/@xml:lang | Mandatory if '..r:ManagedNumericRepresentationName/r:String' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedNumericRepresentation/r:Label/r:Content | Optional | to be displayed in EQB v2.0. | Content element | Yes | A label of a numeric domain. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedNumericRepresentation/r:Label/r:Content/@xml:lang | Mandatory if '..r:ManagedNumericRepresentation/r:Label/r:Content' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedNumericRepresentation/r:Description/r:Content | Optional | to be displayed in EQB v2.0. | Content element | Yes | A description of a numeric domain. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedNumericRepresentation/r:Description/r:Content/@xml:lang | Mandatory if '..r:ManagedNumericRepresentation/r:Description/r:Content' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedNumericRepresentation/r:NumberRange/r:Low | Optional | to be displayed in EQB v2.0. | Content element | Yes | Structures a numeric range. Low value is designated |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedNumericRepresentation/r:NumberRange/r:High | Optional | to be displayed in EQB v2.0. | Content element | Yes | Structures a numeric range. High value is designated |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedTextRepresentation/@minLength | Optional | to be displayed in EQB v2.0. | Attribute | | Length of the text: Min length. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedTextRepresentation/r:ManagedTextRepresentationName/r:String | Optional | to be displayed in EQB v2.0. | Content element | Yes | A name of a text domain. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedTextRepresentation/r:ManagedTextRepresentationName/r:String/@xml:lang | Mandatory if '..r:ManagedTextRepresentationName/r:String' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedTextRepresentation/r:Label/r:Content | Optional | to be displayed in EQB v2.0. | Content element | Yes | A label of a text domain. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedTextRepresentation/r:Label/r:Content/@xml:lang | Mandatory if '..r:ManagedTextRepresentation/r:Label/r:Content' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedTextRepresentation/r:Description/r:Content | Optional | to be displayed in EQB v2.0. | Content element | Yes | A description of a text domain. |
| /ddi:DDIInstance/g:ResourcePackage/r:ManagedRepresentationScheme/r:ManagedTextRepresentation/r:Description/r:Content/@xml:lang | Mandatory if '..r:ManagedTextRepresentation/r:Label/r:Content' is present. | not displayed (internal info) | Attribute | | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/s:StudyUnit/r:UserID | Mandatory | Study number/Further information on study and data/Versionnumber/Versiondate/ | Content element | Yes | This element serves four 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. [This element not visible in the UI, it is only needed for the link].
The @typeOfUserID attribute must be "URLServiceProvider".
(3) A number of the version (free text) that the Service Provider uses to
identify this version of the study.
The @typeOfUserID attribute must be "Versionnumber".
(4) A date of the version that the Service Provider uses to identify this version of the study.
The @typeOfUserID attribute must be "Versiondate".
|
| /ddi:DDIInstance/s:StudyUnit/r:UserID/@typeOfUserID | Mandatory | not displayed (internal info) | Attribute | | Must be specifed when the "ddi:DDIInstance/s:StudyUnit/r:UserID"
element is used for the unique archival number. |
| /ddi:DDIInstance/s:StudyUnit/r:UserID/@typeOfUserID | Mandatory | not displayed (internal info) | 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. |
| /ddi:DDIInstance/s:StudyUnit/r:UserID/@typeOfUserID | Optional | not displayed (internal info) | Attribute | | Must be specifed when the "ddi:DDIInstance/s:StudyUnit/r:UserID"
element is used for the date of the version that the Service Provider uses to
identify this version of the study. NOT used in CDC. |
| /ddi:DDIInstance/s:StudyUnit/r:UserID/@typeOfUserID | Optional | not displayed (internal info) | Attribute | | Must be specifed when the "ddi:DDIInstance/s:StudyUnit/r:UserID"
element is used for the number of the version (free text) that the Service Provider
uses to identify this version of the study. NOT used in CDC. |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:Title/r:String | Mandatory | Title. | Content element | Yes | Title of the Study (as opposed to the title of the XML document). |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:Title/r:String/@xml:lang | Mandatory | not displayed (internal info). | Attribute | | Language of the study title. ISO 639-1 codes are strongly encouraged
to be used. |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:Title/r:String/@isTranslated | Recommended | not displayed (internal info). | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:Creator/r:CreatorReference/r:TypeOfObject | Optional | not displayed (internal info). | Content element | Yes | Used when r:CreatorReference is a reference of a study to a person who is a principal investigator.
Principal investigators are the main researchers involved in producing the data. |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:Creator/r:CreatorReference/r:TypeOfObject | Optional | not displayed (internal info). | Content element | Yes | Used when r:CreatorReference is a reference of a study to an organization who is a principal investigator.
Principal investigators are the main institutions involved in producing the data. |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:Publisher/r:PublisherName/r:String | Mandatory | Publisher. | Content element | Yes | The name of the institution publishing the metadata (at the study level) i.e. CESSDA Service Provider
providing the metadata information or the name of the actual publisher of the metadata , who
is not the SP. |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:Publisher/r:PublisherName/r:String/@xml:lang | Mandatory | not displayed (internal info). | Attribute | | Language of the organisation name. ISO codes are strongly encouraged
to be used. |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:Publisher/r:PublisherName/r:String/@isTranslated | Recommended | not displayed (internal info). | Attribute | | Is the content of the element translated? |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:PublicationDate/r:SimpleDate | Mandatory | Publication date. | Content element | Yes | This element refers to the date (ISO 8601) when the data of the study was
or will be made publicly available. If there is an embargo on the data in effect, use
the date when the embargo period ends. |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:InternationalIdentifier/r:IdentifierContent | Mandatory | Study PID | Content element | Yes | Used for the study PID. PID must be one of these four types: ARK, DOI, Handle or URN. |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/r:InternationalIdentifier/r:ManagingAgency | Mandatory | to be displayed in EQB v2.0 | 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 |
| /ddi:DDIInstance/s:StudyUnit/r:Citation/dc:extent | Recommended | Link to study in CESSDA Data Catalogue. | Content element | Yes | A URL or URN (a reference to a web resource that specifies its location)
linking to the study to a CDC page. |
| /ddi:DDIInstance/s:StudyUnit/r:Abstract/r:Content | Mandatory | Abstract | Content element | Yes | The abstract for the study |
| /ddi:DDIInstance/s:StudyUnit/r:Abstract/r:Content/@xml:lang | Mandatory | not displayed (internal info) | Attribute | | Language of the abstract. ISO 639-1 codes are strongly encouraged to
be used. |
| /ddi:DDIInstance/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. |
| /ddi:DDIInstance/s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Subject/@xml:lang | Mandatory if "/r:TopicalCoverage/r:Subject" element is
present | not displayed (internal info). | Attribute | | Language of the subject classification term. ISO 639-1 codes are
strongly encouraged to be used. |
| /ddi:DDIInstance/s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Subject/@codeListName | Recommended | not displayed (internal info). | Attribute | | name of the vocabulary. If possible, use "CESSDA Topic Classification"
(regardless of language) but other vocabularies are permitted. |
| /ddi:DDIInstance/s:StudyUnit/r:Coverage/r:TopicalCoverage/r:Subject/@codeListURN | Recommended | not displayed (internal info). | Attribute | | 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 |
| /ddi:DDIInstance/s:StudyUnit/r:Coverage/r:SpatialCoverage/r:Description/r:Content | Recommended | not displayed (internal info) | Content element | Yes | Countries relevant to the study area |
| /ddi:DDIInstance/s:StudyUnit/r:Coverage/r:SpatialCoverage/r:Description/r:Content/@xml:lang | Mandatory if '..r:SpatialCoverage/r:Description/r:Content' element
is present | not displayed (internal info) | Attribute | | Language of the country label. ISO 639-1 codes are strongly encouraged
to be used. |
| /ddi:DDIInstance/s:StudyUnit/r:Coverage/r:SpatialCoverage/r:Country_2 | Recommended | Country. | Content element | | Use this element only if the country has an
ISO 3166-1 2-letter code. |
| /ddi:DDIInstance/s:StudyUnit/r:OtherMaterial/r:UserID | Optional | ID | Content element | Yes | An identifier for the document. |
| /ddi:DDIInstance/s:StudyUnit/r:OtherMaterial/r:UserID/r:TypeOfObject | Optional | not displayed (internal info) | Content element | Yes | Type of ID for the document ID. Always 'DocumentID'. |
| /ddi:DDIInstance/s:StudyUnit/r:OtherMaterial/r:TypeOfMaterial | Optional | Type. | Content element | Yes | A controlled vocabulary of the type of document that is provided. |
| /ddi:DDIInstance/s:StudyUnit/r:OtherMaterial/r:Citation/r:Title/r:String | Optional | Title. | Content element | Yes | A title for the document. |
| /ddi:DDIInstance/s:StudyUnit/r:OtherMaterial/r:Citation/r:Title/r:String/@xml:lang | Mandatory if '..r:OtherMaterial/r:Citation/r:Title/r:String' is present. | not displayed (internal info) | Attribute | Yes | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/s:StudyUnit/r:OtherMaterial/r:ExternalURLReference | Recommended | displayed as hyperlink. | Content element | Yes | URL / Webadress of the document the metadata refer to. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:Methodology/d:TimeMethod/d:TypeofTimeMethod | Recommended | not displayed (internal info. | Content element | Yes | Code value of the CV "DDI Time Method". Describes the time dimension
of the data collection. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:Methodology/d:TimeMethod/d:TypeofTimeMethod/@CodeListName | Recommended | not displayed (internal info). | Attribute | | Use the string "DDI Time Method" regardless of language. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:Methodology/d:TimeMethod/d:TypeofTimeMethod/@CodeListURN | Optional | not displayed (internal info) | Attribute | | The Canonical URL of the CV version that is being used e.g.
https://vocabularies.cessda.eu/v2/vocabularies/TimeMethod/1.2?languageVersion=en-1.2 |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/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. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:Methodology/d:TimeMethod/r:Description/r:Content/@xml:lang | Mandatory if 'TypeofTimeMethod' element is present | not displayed (internal info) | Attribute | | Language of the Time Dimenstion descriptive term. ISO 639-1 codes are
strongly encouraged to be used. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:Methodology/d:SamplingProcedure/d:TypeOfSamplingProcedure | Recommended | not displayed (internal info) | 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" |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:Methodology/d:SamplingProcedure/d:TypeOfSamplingProcedure/@codeListName | Recommended | not displayed (internal info) | Attribute | | Use the string "DDI Sampling Procedure" regardless of
language. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:Methodology/d:SamplingProcedure/d:TypeOfSamplingProcedure/@codeListURN | Optional | not displayed (internal info) | Attribute | | 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 |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/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. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:Methodology/d:SamplingProcedure/r:Description/r:Content/@xml:lang | Mandatory if 'TypeOfSamplingProcedure' element is
present | not displayed (internal info) | Attribute | | Language of the Sampling Procedure Descriptive term. ISO 639-1 codes
are strongly encouraged to be used. |
| /ddi:DDIInstance/s:StudyUnit/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. |
| /ddi:DDIInstance/s:StudyUnit/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. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:CollectionEvent/d:ModeofCollection/d:TypeofModeofCollection | Recommended | not displayed (internal info) | 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”" |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:CollectionEvent/d:ModeofCollection/d:TypeofModeofCollection@codeListName | Recommended | not displayed (internal info) | Attribute | | Use the string "DDI Mode of Collection" regardless of
language. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:CollectionEvent/d:ModeofCollection/d:TypeofModeofCollection@codeListURN | Optional | not displayed (internal info) | Attribute | | 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 |
| /ddi:DDIInstance/s:StudyUnit/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 langiage. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:CollectionEvent/d:ModeOfCollection/r:Description/r:Content/@xml:lang | Mandatory if 'TypeofModeofCollection' element is
present | not displayed (internal info) | Attribute | | Language of the Mode of Data Collection descriptive term. ISO 639-1
codes are strongly encouraged to be used. |
| /ddi:DDIInstance/s:StudyUnit/d:DataCollection/d:InstrumentScheme/d:InstrumentReference/r:TypeOfObject | Recommended | not displayed (internal info). | Content element | Yes | States the type of object being referenced based on a persistent
list of valid DDI object types. Always 'Instrument'. |
| /ddi:DDIInstance/s:StudyUnit/r:PhysicalInstanceReference/r:TypeOfObject | Mandatory | not displayed (internal info). | Content element | Yes | States the type of object being referenced based on a persistent
list of valid DDI object types. Always 'PhysicalInstance'. |
| /ddi:DDIInstance/s:StudyUnit/a:Archive/a:ArchiveSpecific/a:Item/a:Access/r:Description/r:Content | Mandatory | to be displayed in EQB v2.0 | Content element | Yes | Freetext description of possibilities to access data. |
| /ddi:DDIInstance/s:StudyUnit/a:Archive/a:ArchiveSpecific/a:Item/a:Access/r:Description/r:Content/@xml:lang | Mandatory if '..a:Item/a:Access/r:Description/r:Content' is present. | to be displayed in EQB v2.0 | Attribute | Yes | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/s:StudyUnit/a:Archive/a:ArchiveSpecific/a:Item/a:Access/a:AccessConditions/r:Content | Recommended | to be displayed in EQB v2.0 | Content element | Yes | If the preserved content is subject to any access restrictions, those must be expressed in
as much detail as possible in the information package in accordance with cataloguing rules and metadata
formats used. Examples of such restrictions are the copyright status, usage restrictions based on
legislation, a license, or other agreement concerning the content usage. Should the information package
contain several digital objects with different restrictions, these restrictions should be attached
correctly and individually to those objects that the restrictions concern. |
| /ddi:DDIInstance/s:StudyUnit/a:Archive/a:ArchiveSpecific/a:Item/a:Access/a:AccessConditions/r:Content/@xml:lang | Mandatory if '..a:Item/a:Access/a:AccessConditions/r:Content' is present. | to be displayed in EQB v2.0 | Attribute | Yes | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|
| /ddi:DDIInstance/s:StudyUnit/a:Archive/a:ArchiveSpecific/a:Collection/a:DefaultAccess/a:AccessConditions/r:Content | Recommended | to be displayed in EQB v2.0 | Content element | Yes | Freetext description on the metadata access conditions for the provided metadata if there
is one access condition for both study- and question-related metadata. Examples of such conditions are
the copyright status, usage regulations based on legislation, a license, or other agreement concerning
the metadata usage. |
| /ddi:DDIInstance/s:StudyUnit/a:Archive/a:ArchiveSpecific/a:Collection/a:Item/a:Access/a:AccessConditions/r:Content | Recommended | to be displayed in EQB v2.0. | Content element | Yes | Freetext description on the metadata access conditions for the provided metadata for the
study-related information only. Examples of such conditions are the copyright status, usage regulations
based on legislation, a license, or other agreement concerning the metadata usage. Use in conjunction with
ddi:DDIInstance/s:StudyUnit/a:Archive/a:ArchiveSpecific/a:Collection/a:Item/a:CallNumber
(='ZA1234' Studynumber, for example)
Can also be used for Question-related access info etc. etc. Could refer to question call number from here
|
| /ddi:DDIInstance/s:StudyUnit/a:Archive/a:ArchiveSpecific/a:Collection/a:Item/a:Access/a:AccessConditions/r:Content/@xml:lang | Mandatory if '..a:Collection/a:Item/a:Access/a:AccessConditions/r:Content' is present. | to be displayed in EQB v2.0. | Content element | Yes | The language of the content of the element.
ISO 639-1 codes are strongly encouraged to be used
|