XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace http://www.211taxonomy.org/resources/xml_schema/taxonomy.xsd
Version 8
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations have no namespace.
Documentation The AIRS/INFO LINE Taxonomy of Human Services. For schema documentation see <a href="http://211taxonomy.org/resources/xml_schema/docs/docs.html"> http://211taxonomy.org/resources/xml_schema/docs/docs.html</a> as well as <a href="http://211taxonomy.org/resources/xml_schema/explanation"> http://211taxonomy.org/resources/xml_schema/explanation</a>
Application Data <csv-id>
$Id: taxonomy.xsd.html,v 1.1.1.1 2009/11/16 23:30:18 alex Exp $
</csv-id>

Declared Namespaces

Prefix Namespace
Default namespace http://www.w3.org/2001/XMLSchema
xml http://www.w3.org/XML/1998/namespace
tx http://www.211taxonomy.org/resources/xml_schema/taxonomy.xsd
Schema Component Representation
<schema targetNamespace="http://www.211taxonomy.org/resources/xml_schema/taxonomy.xsd" elementFormDefault="qualified" attributeFormDefault="unqualified" version="8">
...
</schema>
top

Global Declarations

Element: bibliographicReference

Name bibliographicReference
Type string
Nillable no
Abstract no
Documentation A list of references which credits sources used in writing taxonomy definitions or structuring taxonomy sections.
Diagram
XML Instance Representation
<tx:bibliographicReference> string </tx:bibliographicReference>
Schema Component Representation
<element name="bibliographicReference" type="string"/>
top

Element: comments

Name comments
Type string
Nillable no
Abstract no
Documentation Comments on the term in plain text.
Diagram
XML Instance Representation
<tx:comments> string </tx:comments>
Schema Component Representation
<element name="comments" type="string"/>
top

Element: createdDate

Name createdDate
Type date
Nillable no
Abstract no
Documentation The date a term was first added to the taxonomy.
Diagram
XML Instance Representation
<tx:createdDate> date </tx:createdDate>
Schema Component Representation
<element name="createdDate" type="date"/>
top

Element: definition

Name definition
Type string
Nillable no
Abstract no
Documentation A plain text description of the meaning of the taxonomy term.
Diagram
XML Instance Representation
<tx:definition> string </tx:definition>
Schema Component Representation
<element name="definition" type="string"/>
top

Element: externalCode

Name externalCode
Type token
Nillable no
Abstract no
Documentation A code in an external classification system. Not to be confused with a taxonomy code.
Diagram
XML Instance Representation
<tx:externalCode> token </tx:externalCode>
Schema Component Representation
<element name="externalCode" type="token"/>
top

Element: externalTerm

Name externalTerm
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A term in another classification system which corresponds to this taxonomy term.
Diagram
XML Instance Representation
<tx:externalTerm>
<tx:system> ... </tx:system> [1] ?
<tx:externalCode> ... </tx:externalCode> [1] ?
<tx:name> ... </tx:name> [1] ?
</tx:externalTerm>
Schema Component Representation
<element name="externalTerm">
<complexType>
<sequence>
<element ref="tx:system"/>
<element ref="tx:externalCode"/>
<element ref="tx:name"/>
</sequence>
</complexType>
</element>
top

Element: facet

Name facet
Type string
Nillable no
Abstract no
Documentation The intended use of the term. Allowable values are: Service, Target, Organization/Facility Type, Modality, and Named Program
Diagram
XML Instance Representation
<tx:facet> string </tx:facet>
Schema Component Representation
<element name="facet" type="string"/>
top

Element: lastModifiedDate

Name lastModifiedDate
Type date
Nillable no
Abstract no
Documentation The last date that this term was substantively modified. This date does not reflect minor changes such as typographical corrections.
Diagram
XML Instance Representation
<tx:lastModifiedDate> date </tx:lastModifiedDate>
Schema Component Representation
<element name="lastModifiedDate" type="date"/>
top

Element: name

Name name
Type token
Nillable no
Abstract no
Documentation The name of a taxonomy term.
Diagram
XML Instance Representation
<tx:name> token </tx:name>
Schema Component Representation
<element name="name" type="token"/>
top

Element: oldCode

Name oldCode
Type token
Nillable no
Abstract no
Documentation Oldcode is a list of every no-longer-used taxonomy code that has moved (moved, merged or split) to the current code.
Diagram
XML Instance Representation
<tx:oldCode> token </tx:oldCode>
Schema Component Representation
<element name="oldCode" type="token"/>
top

Element: record

Name record
Type Locally-defined complex type
Nillable no
Abstract no
Documentation Each record is a single taxonomy term.
Diagram
XML Instance Representation
<tx:record
code="ID [1] ?">
<!--
Uniqueness Constraint - uRecordSeeAlso
Selector - seeAlso
Field(s) - .
-->

<tx:name> ... </tx:name> [1]
<tx:definition> ... </tx:definition> [1]
<tx:facet> ... </tx:facet> [0..1]
<tx:comments> ... </tx:comments> [0..1]
<tx:bibliographicReference> ... </tx:bibliographicReference> [0..1]
<tx:createdDate> ... </tx:createdDate> [1]
<tx:lastModifiedDate> ... </tx:lastModifiedDate> [1]
<tx:seeAlso> ... </tx:seeAlso> [0..*] ?
<tx:useReference> ... </tx:useReference> [0..*]
<tx:relatedConcept> ... </tx:relatedConcept> [0..*]
<tx:externalTerm> ... </tx:externalTerm> [0..*]
<tx:oldCode> ... </tx:oldCode> [0..*]
<tx:record> ... </tx:record> [0..*]
</tx:record>
Schema Component Representation
<element name="record">
<complexType>
<sequence>
<element ref="tx:name"/>
<element ref="tx:definition"/>
<element ref="tx:facet" minOccurs="0"/>
<element ref="tx:comments" minOccurs="0"/>
<element ref="tx:bibliographicReference" minOccurs="0"/>
<element ref="tx:createdDate"/>
<element ref="tx:lastModifiedDate"/>
<element ref="tx:seeAlso" minOccurs="0" maxOccurs="unbounded"/>
<element ref="tx:useReference" minOccurs="0" maxOccurs="unbounded"/>
<element ref="tx:relatedConcept" minOccurs="0" maxOccurs="unbounded"/>
<element ref="tx:externalTerm" minOccurs="0" maxOccurs="unbounded"/>
<element ref="tx:oldCode" minOccurs="0" maxOccurs="unbounded"/>
<element ref="tx:record" minOccurs="0" maxOccurs="unbounded"/>
</sequence>
<attribute name="code" type="ID" use="required"/>
</complexType>
<unique name="uRecordSeeAlso">
<selector xpath="seeAlso"/>
<field xpath="."/>
</unique>
</element>
top

Element: relatedConcept

Name relatedConcept
Type Locally-defined complex type
Nillable no
Abstract no
Documentation The concept to which this taxonomy term is related.
Diagram
XML Instance Representation
<tx:relatedConcept
code="token [0..1]">
token
</tx:relatedConcept>
Schema Component Representation
<element name="relatedConcept">
<complexType>
<simpleContent>
<extension base="token">
<attribute name="code" type="token"/>
</extension>
</simpleContent>
</complexType>
</element>
top

Element: relatedConceptCode

Name relatedConceptCode
Type token
Nillable no
Abstract no
Documentation A list of concepts which serve as an alternate index to the taxonomy.
Diagram
XML Instance Representation
<tx:relatedConceptCode> token </tx:relatedConceptCode>
Schema Component Representation
<element name="relatedConceptCode" type="token"/>
top

Element: seeAlso

Name seeAlso
Type IDREF
Nillable no
Abstract no
Documentation Another taxonomy term whose meaning is related to this term.
Diagram
XML Instance Representation
<tx:seeAlso> IDREF </tx:seeAlso>
Schema Component Representation
<element name="seeAlso" type="IDREF"/>
top

Element: system

Name system
Type Locally-defined simple type
Nillable no
Abstract no
Documentation An external classification system.
Diagram
XML Instance Representation
<tx:system> NCName </tx:system>
Schema Component Representation
<element name="system">
<simpleType>
<restriction base="NCName"/>
</simpleType>
</element>
top

Element: taxonomy

Name taxonomy
Type Locally-defined complex type
Nillable no
Abstract no
Documentation A complete set of taxonomy terms.
Diagram
XML Instance Representation
<tx:taxonomy
name="token [1] ?"
releaseDate="dateTime [1] ?"
country="string [0..1] ?"
language="string [0..1] ?">
<tx:record> ... </tx:record> [1..*]
</tx:taxonomy>
Schema Component Representation
<element name="taxonomy">
<complexType>
<sequence>
<element ref="tx:record" maxOccurs="unbounded"/>
</sequence>
<attribute name="name" type="token" use="required"/>
<attribute name="releaseDate" type="dateTime" use="required"/>
<attribute name="country" type="string"/>
<attribute name="language" type="string"/>
</complexType>
</element>
top

Element: useReference

Name useReference
Type token
Nillable no
Abstract no
Documentation A synonym or frequently used alternative name for the taxonomy term.
Diagram
XML Instance Representation
<tx:useReference> token </tx:useReference>
Schema Component Representation
<element name="useReference" type="token"/>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Super-types: Address < AusAddress (by extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base="Address">
<sequence>
<element name="state" type="AusStates"/>
<element name="postcode">
<simpleType>
<restriction base="string">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type="string" fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top