ddi:archive:3_0
Imports: ddi:reusable:3_0 (reusable.xsd)
Global Elements
Archive (ArchiveType): Archive is the element which contains relevant archival information pertinent to the contents of a DDI instance.
ArchiveOrganizationReference (r:ReferenceType): A reference to the organization acting as the archive.
ArchiveSpecific (ArchiveSpecificType): Contains metadata specific to a particular archive's holding.
ClassDescription (r:InternationalStringType): Human-readable description of the type of the study.
ClassType (r:CodeValueType): Description of the type of the study taken from a controlled vocabulary.
Item (ItemType): Describes individual items held or distributed by the archive in connection with a study. These may be data file(s) in a variety of formats, statistical setups, codebooks, questionnaires, etc.
Collection (CollectionType): Describes a collection of items held or distributed by the archive in connection with a study. These may be data file(s) in a variety of formats, statistical setups, codebooks, questionnaires, etc.
DefaultAccess (AccessType): Describes the aspects of access to the archive's holding.
Access (AccessType): Describes the aspects of access to the archive's holding.
LocationInArchive (r:InternationalStringType): Describes the location of the item in an archive. Can be repeated to support different languages.
Format (r:InternationalStringType): Describes the format of data or metadata holdings. Can be repeated to support different languages.
Media (r:InternationalStringType): Describes the media of data or metadata holdings. Can be repeated to support different languages.
StudyClass (StudyClassType): The type of study which is documented by the DDI instance.
OriginalArchiveOrganizationReference (r:ReferenceType): The original archive for the documented material, expressed in human-readable form. Can be repeated to support different languages.
AvailabilityStatus (r:StructuredStringType): A human-readable description of the availability status. Can be repeated to support different languages.
CollectionCompleteness (r:StructuredStringType): The completeness of the collection, described in human-readable terms.
ConfidentialityStatement (r:StructuredStringType): Provides confidentiality statement and/or reference to its network location.
AccessPermission (FormType): Gives the network location and identifying number of the access permission and confidentiality agreement forms, and whether they are required or not.
Restrictions (r:StructuredStringType): Restrictions to access, described in a human-readable fashion.
CitationRequirement (r:StructuredStringType): Describes a citation requirement. May be repeated for different languages.
DepositRequirement (r:StructuredStringType): Describes deposit requirements. May be repeated for different languages.
AccessConditions (r:StructuredStringType): Describes conditions for access. May be repeated for different languages.
Disclaimer (r:StructuredStringType): Describes a disclaimer. May be repeated for different languages.
AccessRestrictionDate (r:AccessRestrictionDateType): Provides dates for which access is restricted. Describes the date or range of dates for access restrictions to all or portions of the data.
ContactOrganizationReference (r:ReferenceType): Provides contact information regarding the archive's holding.
Statement (r:InternationalStringType): Provides a textual statement regarding access forms.
OrganizationScheme (OrganizationSchemeType): Contains descriptions of organizations and individuals which are referenced by other areas of the DDI. All agencies must be defined as an Organization in an Archive module (which can be defined inline or resolved externally). Where noted, elements map directly to vCard, a file format standard for electronic business cards.
OrganizationSchemeReference (r:SchemeReferenceType):
Organization (OrganizationType): Describes an organization or an individual
OrganizationReference (r:ReferenceType): Reference to an existing organization.
Individual (IndividualType): Describes an organization or an individual
Role (RoleType): Describes the role of organizations and/or individuals in relation to a DDI entity like a survey
Relation (RelationType): Describes relations between two actors (organizations and/or individuals)
Nickname (r:InternationalStringType):
Keyword (r:InternationalStringType): For classification,
Location (LocationType): A physical (or virtual) location
Telephone (TelephoneType):
URL (URLType): Organization web site
Email (r:EmailType): Generic email address
InstantMessaging (InstantMessagingType): Instant messaging for the organization (can be used for live technical support, sales, etc.)
RegionalCoverage (r:CodeValueType): A coded value or string indicating the region where the organization is active.
IndividualName (IndividualNameType):
Position (PositionType): The job title, functional position or function. Applies only to individuals. Maps to vCard TITLE.
Language (IndividualLanguageType): Language spoken by individual
LocationReference (r:ReferenceType): Reference to a related location for an individual or organization.
EntityReference (r:ReferenceType):
IndividualReference (r:ReferenceType):
Period (r:DateType): Time period of this role.
Name (r:InternationalStringType):
Address (AddressType):
Country (r:CountryType):
GeographicLocation (r:PointType):
OrganizationName (r:InternationalStringType): The official name of the organization. This may be repeated for multiple languages. Alternate names should be placed in Nickname.
Complex Types
ArchiveType: Includes documentation about the archive and its relationship to the data being described. This encompasses metadata about the archive, relevant organizations, access, funding for the archive process, and contents and lifecycle events for the data.
- Content:
- Extends: r:MaintainableType
- Base Content
- Extends: AbstractMaintainableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- agency (xs:NCName) - optional
- Maintaining agency as described in Part 1 of the Technical Specification.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ArchiveSpecific)
- Contains metadata specific to a particular archive's holding.
- [Reference] (OrganizationScheme)
- A list of the organizations related to the DDI instance. This includes information on the archives responsible for creating and maintaining the instance. All agencies must be defined as an Organization in an Archive schema (which can be defined inline or resolved externally).
- [Reference] (r:LifecycleInformation) - min. 0
- LifecycleInformation contains the description of a set of events in the life cycle of the data. It may be extended by specific users.
- [Reference] (r:OtherMaterial) - min. 0 - max. unbounded
- Material related to this item from the archive's perspective.
- [Reference] (r:Note) - min. 0 - max. unbounded
- Notes on any archival information presented in this module.
ArchiveSpecificType: Contains metadata specific to a particular archive's holding.
- Content:
- Sequence of:
- [Reference] (ArchiveOrganizationReference)
- A reference to the organization or an individual acting as the archive.
- [Reference] (Item) - min. 0 - max. unbounded
- Describes the subject of the DDI metadata as viewed by the archive (e.g., as a single item which has been archived). This may be a Group, Element, or StudyUnit.
- [Reference] (Collection) - min. 0 - max. unbounded
- Describes the archive's collections.
- [Reference] (DefaultAccess) - min. 0 - max. unbounded
- Describes access to the archive in general. The restrictions noted at this level apply to all holdings of the archive unless overridden for specified collections or items.
- [Reference] (r:FundingInformation) - min. 0 - max. unbounded
- Describes the archive's sources of funding (grants, etc.)
ItemType: Describes individual items held or distributed by the archive in connection with a study. These may be data file(s) in a variety of formats, statistical setups, codebooks, questionnaires, etc.
- Content:
- Sequence of:
- [Reference] (LocationInArchive) - min. 0 - max. unbounded
- Describes the location of the item in an archive. Can be repeated to support different languages.
- CallNumber (xs:string) - min. 0
- The Item's call number as used by the archive.
- URI (xs:anyURI) - min. 0
- The URL or URN for the described item.
- [Reference] (Format) - min. 0 - max. unbounded
- Describes the item's format. Can be repeated to support different languages.
- [Reference] (Media) - min. 0 - max. unbounded
- Describes the medium, or media, for the item. Can be repeated to support different languages.
- [Reference] (StudyClass) - min. 0
- The type of study according to an internal description and controlled vocabulary.
- [Reference] (Access) - min. 0
- The access restrictions specific to the item.
- [Reference] (OriginalArchiveOrganizationReference) - min. 0 - max. unbounded
- The original archive for item, expressed as a reference to the organization listed in the organization scheme.
- [Reference] (AvailabilityStatus) - min. 0 - max. unbounded
- A human-readable description of the availability status. Can be repeated to support different languages.
- DataFileQuantity (xs:integer) - min. 0
- The number of data files of the documented holding, expressed as an integer.
- [Reference] (CollectionCompleteness) - min. 0 - max. unbounded
- The completeness of the collection, described in human-readable terms.
- [Reference] (Item) - min. 0 - max. unbounded
- Describes an item that is subordinated to the current item.
CollectionType: Describes a collection of items held or distributed by the archive in connection with a study. These may be data file(s) in a variety of formats, statistical setups, codebooks, questionnaires, etc.
- Content:
- Sequence of:
- [Reference] (LocationInArchive) - min. 0 - max. unbounded
- Describes the location of the collection in an archive. Can be repeated to support different languages.
- CallNumber (xs:string) - min. 0
- The call number used by the archive.
- URI (xs:anyURI) - min. 0
- The URL or URN for the collection.
- ItemQuantity (xs:integer) - min. 0
- The number of items in the collection..
- [Reference] (StudyClass) - min. 0
- The type of study which is documented by the DDI instance.
- [Reference] (DefaultAccess) - min. 0
- Default access restriction information applying to all of the items in the collection.
- [Reference] (OriginalArchiveOrganizationReference) - min. 0 - max. unbounded
- The original archive for the described collection, expressed as a reference to an organization listed in the organization scheme.
- [Reference] (AvailabilityStatus) - min. 0 - max. unbounded
- A human-readable description of the availability status. Can be repeated to support different languages.
- DataFileQuantity (xs:integer) - min. 0
- The number of data files in the described collection, expressed as an integer.
- [Reference] (CollectionCompleteness) - min. 0 - max. unbounded
- The completeness of the collection, described in human-readable terms.
- [Reference] (Item) - min. 0 - max. unbounded
- Describes an item that is part of this collection.
- [Reference] (Collection) - min. 0 - max. unbounded
- Documents a sub-collection that is part of the current collection.
StudyClassType: The type of study documented by the DDI metadata, expressed in human-readable form and as a value from a controlled vocabulary.
- Content:
- Sequence of:
- [Reference] (ClassDescription) - min. 0 - max. unbounded
- Human-readable description of the type of the study.
- [Reference] (ClassType) - min. 0 - max. unbounded
- Description of the type of the study taken from a controlled vocabulary.
AccessType: Describes the aspects of access to the archive's holding.
- Content:
- Extends: r:IdentifiableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (ConfidentialityStatement) - min. 0 - max. unbounded
- Provides confidentiality statement and/or reference to its network location.
- [Reference] (AccessPermission) - min. 0 - max. unbounded
- Gives the network location and identifying number of the access permission and confidentiality agreement forms, and whether they are required or not.
- [Reference] (Restrictions) - min. 0 - max. unbounded
- Restrictions to access, described in a human-readable fashion.
- [Reference] (CitationRequirement) - min. 0 - max. unbounded
- Describes a citation requirement. May be repeated for different languages.
- [Reference] (DepositRequirement) - min. 0 - max. unbounded
- Describes deposit requirements. May be repeated for different languages.
- [Reference] (AccessConditions) - min. 0 - max. unbounded
- Describes conditions for access. May be repeated for different languages.
- [Reference] (Disclaimer) - min. 0 - max. unbounded
- Describes a disclaimer related to use of the data. May be repeated for different languages.
- [Reference] (AccessRestrictionDate) - min. 0
- Provides dates for which access is restricted. Describes the date or range of dates for access restrictions to all or portions of the data.
- [Reference] (ContactOrganizationReference) - min. 0 - max. unbounded
- Provides contact information regarding the archive's holding, expressed as a reference to an individual or organization listed in the organization scheme.
FormType: FormType describes the forms needed for such functions as access permission to the archive and statements of confidentiality.
- Content:
- Sequence of:
- Required (xs:boolean) - min. 0
- States whether or not the form is required.
- FormNumber (xs:string) - min. 0
- Provides the number of the concerned form.
- URI (xs:anyURI) - min. 0
- An Internet location such as a URL or URN where the form is to be found.
- [Reference] (Statement) - min. 0 - max. unbounded
- Provides a textual statement regarding access forms.
OrganizationSchemeType:
- Content:
- Extends: r:MaintainableType
- Base Content
- Extends: AbstractMaintainableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- agency (xs:NCName) - optional
- Maintaining agency as described in Part 1 of the Technical Specification.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (Organization) - min. 0 - max. unbounded
- Describes an organization.
- [Reference] (Individual) - min. 0 - max. unbounded
- [Reference] (Role) - min. 0 - max. unbounded
- Describes the role played by organizations and individuals in the life cycle of the data.
- [Reference] (Relation) - min. 0 - max. unbounded
- Describes relations between two organizations and/or individuals.
- [Reference] (OrganizationSchemeReference) - min. 0 - max. unbounded
- Used to import other Organization schemes into this one by reference.
OrganizationType: Describes an organization. All agencies must be defined as an Organization in an Archive module (which can be defined inline or resolved externally).
- Content:
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- Choice Of:
- [Reference] (OrganizationReference)
- Reference to an organization described externally.
- Sequence of:
- [Reference] (OrganizationName) - max. unbounded
- The official name of the organization. This may be repeated for multiple languages. Alternate names should be placed in Nickname.
- [Reference] (Nickname) - min. 0 - max. unbounded
- An abbreviation or a brief name for an organization.
- [Reference] (r:Description) - min. 0 - max. unbounded
- Description of the organization.
- [Reference] (Keyword) - min. 0 - max. unbounded
- Keyword used to classify the organization or its activities.
- [Reference] (Location) - min. 0 - max. unbounded
- A physical (or virtual) location.
- [Reference] (Telephone) - min. 0 - max. unbounded
- Telephone number of an organization.
- [Reference] (URL) - min. 0 - max. unbounded
- URL of organization's Web site
- [Reference] (Email) - min. 0 - max. unbounded
- Generic email address of organization
- [Reference] (InstantMessaging) - min. 0 - max. unbounded
- IMessaging identification for the organization (can be used for live technical support, sales, etc.)
- [Reference] (RegionalCoverage) - min. 0
- The geographic coverage for the activity and/or jurisdiction of the organization
- [Reference] (r:Note) - min. 0 - max. unbounded
- Generic note about the organization.
- [Reference] (Individual) - min. 0 - max. unbounded
- Provides flexibility to define individuals directly within an organization (i.e. staff).
- [Reference] (Relation) - min. 0 - max. unbounded
- Describes relations between actors in the context of the organization.
- [Reference] (r:Image) - min. 0 - max. unbounded
- Provides an external link to images associated with the organization (logos, etc.).
- Extended Attributes
IndividualType: Describes an individual
- Content:
- Extends: r:VersionableType
- Base Content
- Extends: AbstractVersionableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Extended Content
- Sequence of:
- VersionResponsibility (xs:string) - min. 0
- Person and/or organization within the MaintenanceAgency responsible for the version change. This is primarily intended for internal use.
- [Reference] (VersionRationale) - min. 0 - max. unbounded
- Textual description of the rationale/purpose for a version change.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- version (NewVersionType) - optional
- Restricted string - numeric with optional decimal points.
- versionDate (BaseDateType) - optional
- Date of version. Duration should not be used in this field, even though allowed by the ISO format enforced by the parser.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (IndividualName) - min. 0
- Full name of the individual.
- DisplayName (xs:string) - min. 0
- Name of the individual used for display.
- [Reference] (Nickname) - min. 0 - max. unbounded
- Brief name of the individual.
- [Reference] (Organization) - min. 0 - max. unbounded
- Organization with which an individual is associated if the individual is not nested within an organization or if the individual is associated with an additional organziation.
- [Reference] (Position) - min. 0 - max. unbounded
- The job title, functional position or function of the individual - Maps to vCard TITLE
- [Reference] (r:Description) - min. 0 - max. unbounded
- Additional information about the individual
- [Reference] (Keyword) - min. 0 - max. unbounded
- Keyword used to classify the individual or its activities.
- [Reference] (Location) - min. 0 - max. unbounded
- Physical address of the individual
- [Reference] (Telephone) - min. 0 - max. unbounded
- Telephone number of the individual
- [Reference] (URL) - min. 0 - max. unbounded
- URL of the individual's website
- [Reference] (Email) - min. 0 - max. unbounded
- [Reference] (InstantMessaging) - min. 0 - max. unbounded
- IMessaging identification for the individual
- [Reference] (Language) - min. 0 - max. unbounded
- Language used by individual (may be repeated to cover multiple languages)
- [Reference] (r:Note) - min. 0 - max. unbounded
- Note regarding the individual described
- [Reference] (Relation) - min. 0 - max. unbounded
- Describes relations between this individual and other organizations or individuals
- [Reference] (r:Image) - min. 0 - max. unbounded
- Provides an external link to images associated with the individual.
- Extended Attributes
IndividualNameType: An individual name
- Content:
- Sequence of: - min. 0
- Prefix (xs:string) - min. 0
- Title that preceded the name of the individual, such as Ms., or Dr.
- First (xs:string) - min. 0
- First (given) name of the individual
- Middle (xs:string) - min. 0 - max. unbounded
- Middle name or initial of the individual
- Last (xs:string) - min. 0
- Last (family) name /surname of the individual
- Suffix (xs:string) - min. 0
- Title that follows the name of the individual, such as Esq.
PositionType: Title and position of an individual, with provision for referencing an organization to provide context.
- Content:
- Sequence of:
- Title (xs:string)
- Title / position of an individual
- [Reference] (OrganizationReference) - min. 0
- Referfence to the organization in which the individual holds the title.
- [Reference] (Period) - min. 0 - max. unbounded
- The period(s) when the individual held the position.
- Attributes:
IndividualLanguageType: Language of an individual
RoleType: Describes the role of individuals or organizations in relation to the DDI instance.and the life cycle of the data that is being documented
- Content:
- Extends: r:IdentifiableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (EntityReference) - max. unbounded
- Reference to the entity described as playing this role
- Choice Of: - max. unbounded
- [Reference] (r:Description) - max. unbounded
- Description of the role played by the actor referenced above
- [Reference] (Keyword) - min. 0 - max. unbounded
- Keyword used to classify the role of the organization or individual
- [Reference] (Period) - min. 0 - max. unbounded
- Time period when this role is/was being played
- Note (xs:string) - min. 0 - max. unbounded
- Note regarding the role being described.
- Extended Attributes
RelationType: Describes a relation between actors (organizations and/or individuals)
- Content:
- Sequence of:
- Choice Of: - max. unbounded
- [Reference] (r:Description) - max. unbounded
- Description of the relationship
- [Reference] (Keyword) - min. 0 - max. unbounded
- Keyword used to classify the relationship
- [Reference] (Period) - min. 0 - max. unbounded
- Time period during which this relationship is valid.
- Note (xs:string) - min. 0 - max. unbounded
- Note regarding the relationship being described
- Attributes:
LocationType: Describes a physical location
- Content:
- Extends: r:IdentifiableType
- Base Content
- Extends: AbstractIdentifiableType
- Base Content
- Sequence of:
- [Reference] (Name) - min. 0 - max. unbounded
- Human-readable name given the entity being identified. May be repeated to provide language and/or geographic alternatives.
- Base Attributes
- id (BaseIDType) - required
- Assigned ID, unique within its maintainable object.
- urn (xs:anyURI) - optional
- DDI-structured URN of the element as described in Part I of the Technical Documentation.
- action (ActionCodeType) - optional
- Used for inheritance to indicate that the element being described is being added, updated, or deleted at the local level. Add: This element is added to the inherited structure. Update: This element is to be used in place of the inherited element with this ID for local processing. Delete: This element has been removed from the inherited group for local processing. There will be a new ID only in the case of Add.
- Extended Attributes
- Extended Content
- Sequence of:
- [Reference] (LocationReference) - min. 0
- Allows for inclusion by reference of a location
- [Reference] (Name) - min. 0 - max. unbounded
- [Reference] (Nickname) - min. 0 - max. unbounded
- Brief name for the location
- [Reference] (Address) - min. 0 - max. unbounded
- Street address of the location
- [Reference] (Country) - min. 0
- [Reference] (Telephone) - min. 0 - max. unbounded
- Telephone number for the location
- [Reference] (URL) - min. 0 - max. unbounded
- URL for the location's website.
- [Reference] (Email) - min. 0 - max. unbounded
- Generic email address for the location
- [Reference] (InstantMessaging) - min. 0 - max. unbounded
- IMessaging identification for the location
- [Reference] (GeographicLocation) - min. 0
- Geographic coordinate point for the location
- [Reference] (RegionalCoverage) - min. 0
- The region where the organization is active.
- [Reference] (r:TimeZone) - min. 0
- Time zone of the location expressed as code.
- Note (xs:string) - min. 0 - max. unbounded
- Note regarding the location being described.
- Extended Attributes
- type (xs:string)
- Type of location e.g. home, primary office, alternate office etc.
AddressType: A location address. (Note that country is not included in this element)
- Content:
- Sequence of:
- Line (xs:string) - min. 0 - max. unbounded
- Number and street including office or suite number. May use multiple lines.
- City (xs:string) - min. 0
- State (xs:string) - min. 0
- Postal (xs:string) - min. 0
- Attributes:
- type (xs:string) - optional
- Indicates address type (i.e. home, office, etc.)
- vcardType (xs:NMTOKENS) - optional
- Indicates the vCard address type
TelephoneType: A telephone number
InstantMessagingType: Indicates type of Instant messaging account identification
URLType: A web site URL
Simple Types
PrivacyCodeType: Element's privacy/security
RecommendedPrivacyCodeType: Enumeration of recommended privacy type
- Restricts: xs:string
- Code: public -
- Code: restricted -
- Code: private -
LanguageLevelCodeType: Describes the level of fluency of an individual in a natural language.
- Restricts: xs:NMTOKENS
- Code: Native -
- Code: Fluent -
- Code: Good -
- Code: Basic -
- Code: Unspecified -
AddressTypeCodeType: Type of address
VCardAddressTypeCodeType: Enumeration of vCard address types. Default is intl postal parcel work
- Restricts: xs:NMTOKENS
- Code: dom -
- Code: intl -
- Code: postal -
- Code: parcel -
- Code: home -
- Code: pref -
TelephoneTypeCodeType: Indicates type of telephone number
VCardTelephoneTypeCodeType: Enumeration of telephone type defined by the vCard specification. Default is voice
- Restricts: xs:NMTOKENS
- Code: home -
- Code: msg -
- Code: work -
- Code: pref -
- Code: voice -
- Code: fax -
- Code: cell -
- Code: video -
- Code: pager -
- Code: bbs -
- Code: modem -
- Code: car -
- Code: isdn -
InstantMessagingTypeCodeType: Type of Instant Messaging account
CommonInstantMessagingTypeCodeType: Enumeration of common public instant messaging networks. See http://en.wikipedia.org/wiki/Instant_messaging
- Restricts: xs:string
- Code: aim -
AOL Instant Messenger
- Code: icq -
ICQ
- Code: jabber -
Jabber
- Code: google -
Google Talk
- Code: msn -
Microsoft Messenger
- Code: qq -
QQ or OICQ (China)
- Code: skype -
Skype
- Code: yahoo -
Yahoo Messenger
This documentation is extracted from the inline documentation of DDI 3.0 XML Schema and is licensed under the terms of the GNU General Public License as the schema itself.