XML Schema "ddiprofile.xsd"
Target Namespace:
ddi:ddiprofile:3_3
Defined Components:
elements (8 global + 4 local), complexTypes (4)
Default Namespace-Qualified Form:
Local Elements: qualified; Local Attributes: unqualified
Schema Location:
C:\Users\utnvjdj\DDITC-ddi-l_3\XMLSchema\ddiprofile.xsd; see XML source
Imports Schemas (1):
reusable.xsd [src]
Imported by Schemas (3):
group.xsd [src], instance.xsd [src], studyunit.xsd [src]
All Element Summary
AlternateName
An alternate name for the object expressed using an International String to support multiple language versions of the same content.
Type:
r:InternationalStringType
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
at 1 location
ApplicationOfProfile
Allows for the use of a controlled vocabulary to designate intended applications of the profile.
Type:
r:CodeValueType
Content:
simple, 7 attributes
Defined:
globally; see XML source
Used:
at 1 location
DDINamespace
Provides the version of DDI schemas used.
Type:
xs:decimal
Content:
simple
Defined:
locally within DDIProfileType complexType; see XML source
DDIProfile
Describes the subset of valid DDI objects used by an agency for a specified purpose.
Type:
DDIProfileType
Content:
complex, 9 attributes, 25 elements
Defined:
globally; see XML source
Used:
at 5 locations
DDIProfileName
Name of the DDI Profile using the DDI Name structure.
Type:
r:NameType
Content:
complex, 2 attributes, 1 element
Defined:
globally; see XML source
Used:
at 1 location
Instructions
Instructions for use of the profile.
Type:
r:StructuredStringType
Content:
complex, 1 element
Defined:
globally; see XML source
Used:
at 2 locations
NotUsed
Identifies DDI objects expressed as an XPath that are not supported by the system or agency using this profile.
Type:
NotUsedType
Content:
simple, 1 attribute
Defined:
globally; see XML source
Used:
at 1 location
Used
Specifies a DDI object and all its sub-objects supported by the DDIProfile.
Type:
UsedType
Content:
complex, 4 attributes, 4 elements
Defined:
globally; see XML source
Used:
at 1 location
XMLNamespace
Specify the namespace which the prefix represents.
Type:
xs:string
Content:
simple
Defined:
locally within XMLPrefixMapType complexType; see XML source
XMLPrefix
Specify the exact prefix used.
Type:
xs:string
Content:
simple
Defined:
locally within XMLPrefixMapType complexType; see XML source
XMLPrefixMap
Maps a specified prefix to a namespace.
Type:
XMLPrefixMapType
Content:
complex, 2 elements
Defined:
globally; see XML source
Used:
at 1 location
XPathVersion
Provides the version of XPath used.
Type:
xs:decimal
Content:
simple
Defined:
locally within DDIProfileType complexType; see XML source
Complex Type Summary
DDIProfileType
Describes the subset of valid DDI objects used by an agency for a specified purpose.
Content:
complex, 9 attributes, 25 elements
Defined:
globally; see XML source
Includes:
definitions of 11 elements
Used:
at 1 location
NotUsedType
Identifies DDI objects expressed as an XPath that are not supported by the system or agency using this profile.
Content:
simple, 1 attribute
Defined:
globally; see XML source
Includes:
definition of 1 attribute
Used:
at 1 location
UsedType
Specifies a DDI object and all its sub-objects supported by the DDIProfile.
Content:
complex, 4 attributes, 4 elements
Defined:
globally; see XML source
Includes:
definitions of 4 attributes, 4 elements
Used:
at 1 location
XMLPrefixMapType
Maps a specified prefix to a namespace.
Content:
complex, 2 elements
Defined:
globally; see XML source
Includes:
definitions of 2 elements
Used:
at 1 location
XML Source
<?xml version="1.0" encoding="UTF-8"?>
<!--

Copyright (c) 2019 DDI Alliance, DDI 3.3 release, 2019-11-22

This file is part of DDI 3.3 XML Schema.

DDI 3.3 XML Schema is licenced under the terms of the Creative Commons Attribution 4.0 International (CC BY 4.0) License.

This is a human-readable summary of (and not a substitute for) the license (https://creativecommons.org/licenses/by/4.0/legalcode)

You are free to:

Share — copy and redistribute the material in any medium or format

Adapt — remix, transform, and build upon the material
for any purpose, even commercially.

The licensor cannot revoke these freedoms as long as you follow the license terms.

Under the following terms:

Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made.
You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

No additional restrictions — You may not apply legal terms or technological measures that legally restrict others
from doing anything the license permits.

Notices:

You do not have to comply with the license for elements of the material in the public domain or where your use is permitted
by an applicable exception or limitation.

No warranties are given. The license may not give you all of the permissions necessary for your intended use.
For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.

-->
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="ddi:ddiprofile:3_3" xmlns="ddi:ddiprofile:3_3" xmlns:r="ddi:reusable:3_3" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<xs:import namespace="ddi:reusable:3_3" schemaLocation="reusable.xsd"/>
<xs:element name="DDIProfile" type="DDIProfileType">
<xs:annotation>
<xs:documentation>
Describes the subset of valid DDI objects used by an agency for a specified purpose.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="DDIProfileType">
<xs:annotation>
<xs:documentation>
Describes the subset of valid DDI objects used by an agency for a specified purpose. This may be the required and supported objects for a specific system, a profile for deposit in an archive, requirements at different points of production, etc. In addition to the standard name, label, and description the DDI Profile describes the intended application of the profile, its purpose, the version of XPath used in describing the supported objects, the DDI namespace (major and minor version numbers), a mapping of schema to prefixes (if different from the standard DDI model), a set of instructions for use of the profile, and a listing of used and unsupported objects. These objects may be constrained (i.e., change from optional to required), provided a fixed value, or provided a local name.
</xs:documentation>
</xs:annotation>
<xs:complexContent>
<xs:extension base="r:MaintainableType">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="DDIProfileName">
<xs:annotation>
<xs:documentation>
A name for the profile. May be expressed in multiple languages. Repeat the element to express names with different content, for example different names for different systems.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="r:Label">
<xs:annotation>
<xs:documentation>
A display label for the profile. Supports multiple language versions of the same content as well as optional formatting of the content. Repeat for labels with different content, for example, labels with differing length limitations.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the profile. Supports multiple language versions of the same content as well as optional formatting of the content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="ApplicationOfProfile">
<xs:annotation>
<xs:documentation>
A brief description of the intended applications of the profile. Supports the use of an external controlled vocabulary.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Purpose">
<xs:annotation>
<xs:documentation>
Purpose describes the purpose of creating the profile such as describing the coverage of a distribution software system.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element default="1.0" name="XPathVersion" type="xs:decimal">
<xs:annotation>
<xs:documentation>
Provides the version of XPath used. Values are 1.0, 2.0 at this time.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="DDINamespace" type="xs:decimal">
<xs:annotation>
<xs:documentation>
Provides the version of DDI schemas used. Values are 2.5, 3.0, 3.1, etc. Note that only the Major.Minor portion of the version number is used.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="XMLPrefixMap">
<xs:annotation>
<xs:documentation>
If you are not using the standard DDI prefix or the full DDI name then provide mapping. For each XML namespace used in the profile's XPath expressions, the XML namespaces must have their prefix specified using this element.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="Instructions">
<xs:annotation>
<xs:documentation>
Instructions for use of the profile. Supports multiple language versions of the same content as well as optional formatting of the content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice maxOccurs="unbounded" minOccurs="0">
<xs:element ref="Used">
<xs:annotation>
<xs:documentation>
Indicates an element in the DDI which is used by the profile expressed as an XPath. Note that including a complex element will include all of its component parts.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element ref="NotUsed">
<xs:annotation>
<xs:documentation>
Indicates an element in the DDI which is not used by the profile expressed as an XPath. You cannot list anything which is required in the DDI schemas, as this would produce invalid XML instances.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:element name="DDIProfileName" type="r:NameType">
<xs:annotation>
<xs:documentation>
Name of the DDI Profile using the DDI Name structure.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="XMLPrefixMap" type="XMLPrefixMapType">
<xs:annotation>
<xs:documentation>Maps a specified prefix to a namespace.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Instructions" type="r:StructuredStringType">
<xs:annotation>
<xs:documentation>
Instructions for use of the profile. Supports multiple language versions of the same content as well as optional formatting of the content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="AlternateName" type="r:InternationalStringType">
<xs:annotation>
<xs:documentation>
An alternate name for the object expressed using an International String to support multiple language versions of the same content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ApplicationOfProfile" type="r:CodeValueType">
<xs:annotation>
<xs:documentation>
Allows for the use of a controlled vocabulary to designate intended applications of the profile.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="XMLPrefixMapType">
<xs:annotation>
<xs:documentation>
Maps a specified prefix to a namespace. For each XML namespace used in the profile's XPath expressions, the XML namespaces must have their prefix specified using this element.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="XMLPrefix" type="xs:string">
<xs:annotation>
<xs:documentation>Specify the exact prefix used.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="XMLNamespace" type="xs:string">
<xs:annotation>
<xs:documentation>
Specify the namespace which the prefix represents.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:complexType name="UsedType">
<xs:annotation>
<xs:documentation>
Specifies a DDI object and all its sub-objects supported by the DDIProfile. May specify an alternate local name and description of an object, instructions for its use, and set limits on its allowed usage.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element minOccurs="0" ref="AlternateName">
<xs:annotation>
<xs:documentation>
Provides an alternate name for the element, for presentation purposes (not for use in the XML instance). It may be supplied in several language-versions.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:Description">
<xs:annotation>
<xs:documentation>
A description of the content and purpose of the object. Supports multiple language versions of the same content as well as optional formatting of the content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="Instructions">
<xs:annotation>
<xs:documentation>
Instructions for the use of the object within the context of the profile. Supports multiple language versions of the same content as well as optional formatting of the content.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" ref="r:DefaultValue">
<xs:annotation>
<xs:documentation>
This field provides a default value for the specified element or attribute if it holds simple content, and the value must be a valid one per the DDI schemas. This assumes that the value is not specified in the DDI instance itself, which would override the default. The value should also be provided as part of the XPath expression supplied for the field.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute default="false" name="isRequired" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true indicates that an element described as optional in DDI is required by the profile.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="xpath" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Contains an XPath which points to an element or attribute in DDI instances which is used by the profile. All subelements of a used element are assumed to be supported unless explicitly addressed by the profile. The number of supported repetitions may be included in the XPath expression.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="limitMaxOccurs" type="xs:string" use="optional">
<xs:annotation>
<xs:documentation>
This field allows for limiting the maximum occurrences of this field. If the number is greater than the maxOccurs value in DDI it will be ignored and the DDI specification will remain in use.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute default="false" name="fixedValue" type="xs:boolean">
<xs:annotation>
<xs:documentation>
This field, if set to true, provides an indication that the default value supplied in the fixedValue attribute is the only one which is allowed for the profile - other values will be overridden with the default (a warning should be issued to the creator of the instance); the value must be a valid one per the DDI schemas.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
<xs:complexType name="NotUsedType">
<xs:annotation>
<xs:documentation>
Identifies DDI objects expressed as an XPath that are not supported by the system or agency using this profile.
</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="xpath" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
Contains an XPath which points to an element or attribute in DDI instances which is not used by the profile. All subelements of an unused element are assumed to be included unless explicitly addressed by the profile. The number of supported repetitions may be included in the XPath expression.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>
<xs:element name="Used" type="UsedType">
<xs:annotation>
<xs:documentation>
Specifies a DDI object and all its sub-objects supported by the DDIProfile.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="NotUsed" type="NotUsedType">
<xs:annotation>
<xs:documentation>
Identifies DDI objects expressed as an XPath that are not supported by the system or agency using this profile.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:schema>
XML schema documentation generated with DocFlex/XML 1.12 using DocFlex/XML XSDDoc 2.9.0 template set