element <referencePeriod> (global)
Namespace:
ddi:codebook:2_5
Type:
eventDateType
Content:
simple, 9 attributes
Defined:
globally in codebook.xsd; see XML source
Used:
at 1 location
XML Representation Summary
<referencePeriod
   
ID
 = 
 xs:ID
xml-lang
 = 
 xs:NMTOKEN
xml:lang
 = 
 xs:language
source
 = 
 ("archive" | "producer") : "producer"
elementVersion
 = 
 xs:string
elementVersionDate
 = 
 (xs:dateTime | xs:date | xs:gYearMonth | xs:gYear)
ddiLifecycleUrn
 = 
 xs:anyURI
ddiCodebookUrn
 = 
 xs:anyURI
event
 = 
 ("start" | "end" | "single")
    >
   
Content: 
 { xs:dateTime | xs:date | xs:gYearMonth | xs:gYear }
</referencePeriod>
Included in content model of elements (1):
sampleFrame
Known Usage Locations
Annotation

Reference Period

Description

Indicates the period of time in which the sampling frame was actually used for the study in question. Use ISO 8601 date/time formats to enter the relevant date(s).

Example

<referencePeriod event="single">2009-06-01</referencePeriod>
XML Source (w/o annotations (1); see within schema source)
<xs:element name="referencePeriod" type="eventDateType"/>
Attribute Detail (all declarations; 9/9)
ddiCodebookUrn
Type:
xs:anyURI, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Used to capture the DDI-Codebook type URN for the element. This is used to assign a DDI-Codebook specific URN to the element, according the format prescribed by the DDI-Codebook standard.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="ddiCodebookUrn" type="xs:anyURI" use="optional"/>
ddiLifecycleUrn
Type:
xs:anyURI, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Used to capture the DDI-Lifecycle type URN for the element. This may be captured during translation from DDI-Lifecycle to DDI-Codebook structure or in preparation for transferring to a DDI-Lifecycle structure.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="ddiLifecycleUrn" type="xs:anyURI" use="optional"/>
elementVersion
Type:
xs:string, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Captures version of the element
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="elementVersion" type="xs:string" use="optional"/>
elementVersionDate
Type:
dateSimpleType
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Indicates version date for the element. Use YYYY-MM-DD, YYYY-MM, or YYYY formats.
Attribute Value
xs:dateTime | xs:date | xs:gYearMonth | xs:gYear
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="elementVersionDate" type="dateSimpleType" use="optional"/>
event
Type:
anonymous simpleType (restriction of xs:NMTOKEN)
Use:
optional
Defined:
locally within eventDateType complexType
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
 "start", "end", "single"
Anonymous simpleType
Type Derivation Tree
xs:NMTOKEN (restriction)
  simpleType
Derivation:
restriction of xs:NMTOKEN
Facets:
enumeration:
"start", "end", "single"
XML Source (see within schema source)
<xs:attribute name="event">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="start"/>
<xs:enumeration value="end"/>
<xs:enumeration value="single"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
ID
Type:
xs:ID, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
XML Source (see within schema source)
<xs:attribute name="ID" type="xs:ID" use="optional"/>
source
Type:
anonymous simpleType (restriction of xs:NMTOKEN)
Use:
optional
Defined:
locally within GLOBALS attributeGroup
Attribute Value
enumeration of xs:NMTOKEN
Enumeration:
 "archive", "producer"
Default:
"producer"
Anonymous simpleType
Type Derivation Tree
xs:NMTOKEN (restriction)
  simpleType
Derivation:
restriction of xs:NMTOKEN
Facets:
enumeration:
"archive", "producer"
XML Source (see within schema source)
<xs:attribute default="producer" name="source">
<xs:simpleType>
<xs:restriction base="xs:NMTOKEN">
<xs:enumeration value="archive"/>
<xs:enumeration value="producer"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
xml-lang
Type:
xs:NMTOKEN, predefined
Use:
optional
Defined:
locally within GLOBALS attributeGroup
DO NOT USE THIS ATTRIBUTE. Its inclusion is an error that was persisted to retain backward compatibility. If this attribute has been used, transfer the content to xml:lang.
XML Source (w/o annotations (1); see within schema source)
<xs:attribute name="xml-lang" type="xs:NMTOKEN" use="optional"/>
xml:lang
Type:
xs:language, predefined
Use:
optional
Defined:
by reference within GLOBALS attributeGroup
XML Source (see within schema source)
<xs:attribute ref="xml:lang" use="optional"/>
XML schema documentation generated with DocFlex/XML 1.8.7 using DocFlex/XML XSDDoc 2.7.0 template set