Documentation for WITSML_Composite

Table of Contents

Master schema documentation file: WITSML_Composite.xsd.html


Schema Document Properties

Target Namespace
Version 1.3.1
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.
Schema Composition

Declared Namespaces

Prefix Namespace
Schema Component Representation
<xsd:schema elementFormDefault="qualified" attributeFormDefault="unqualified" targetNamespace="" version="1.3.1">
<xsd:include schemaLocation="cs_personName.xsd"/>
<xsd:include schemaLocation="cs_generalAddress.xsd"/>
<xsd:include schemaLocation="typ_dataTypes_New.xsd"/>
<xsd:include schemaLocation="attgrp_uid.xsd"/>

Global Definitions

Complex Type: cs_businessAssociate

Super-types: None
Sub-types: None
Name cs_businessAssociate
Abstract no
Documentation The business associate describes any company, person, group, consultant, etc, which is associated within a context (e.g., a well). The information contained in this module is: (1) contact information, such as address, phone numbers, email, (2) alternate name, or aliases, and (3) associations, such as the business associate that this one is associated with, or a contact who is associated with this business associate.
XML Instance Representation
uid=" witsml:uidString [0..1]

'The unique identifier of a container element. This attribute is generally required within the context of a WITSML server. There should be no assumption as to the semantic content of this attribute. This should only be used with recurring container types (i.e., maxOccurs greater than one). The value is only required to be unique within the context of the nearest recurring parent element.'

<witsml:name> witsml:nameString </witsml:name> [1]

'The name of the business associate. This can be the name of a person, business, group, etc.'

<witsml:role> witsml:nameStruct </witsml:role> [1..*]

'The role of the business associate within the context. For example, \"driller\" or \"operator\", \"lead agency - CEQA compliance\" \"regulatory contact\", \"safety contact\". A business associate will generally have one role but the role may be called different things in different naming systems.'

<witsml:personName> witsml:cs_personName </witsml:personName> [0..1]

'If the business associate is a person, this specifies the component names of the person.'

<witsml:alias> witsml:nameStruct </witsml:alias> [0..*]

'The alias is an alternate name of a business associate. It is generally associated with a naming system. An alias is not necessarily unique within the naming system.'

<witsml:address> witsml:cs_generalAddress </witsml:address> [0..*]

'Note that address may occur more than once, because it may be necessary to give a physical address, a mailing address, or both.'

<witsml:phoneNumber> witsml:phoneNumberStruct </witsml:phoneNumber> [0..*]

'The various types of phone numbers may be given. The may be office or home, they may be a number for a cell phone, or for a fax, etc. Attributes of PhoneNumber declare the type of phone number that is being given.'

<witsml:email> witsml:emailQualifierStruct </witsml:email> [0..*]

'The email address may be home, office, or permanent. More than one may be given.'

<witsml:contactPreference> witsml:ContactPreference </witsml:contactPreference> [0..*]

'The preferred method of being contacted within the context of this role.'

<witsml:associatedWith> witsml:refNameString </witsml:associatedWith> [0..1]

'A pointer to another business associate that this business associate is associated with. The most common situation is that of an employee being associated with a company. But it may also be, for example, a work group associated with a university.'

<witsml:contact> witsml:refNameString </witsml:contact> [0..*]

'A pointer to a business associate (generally a person) who serves as a contact for this business associate.'

<witsml:personnelCount> witsml:nonNegativeCount </witsml:personnelCount> [0..1]

'The count of the number of personnel in a group.'

<witsml:comment> witsml:commentString </witsml:comment> [0..1]

'A general comment. This should not be used to carry semantic information. This is not intended to be machine interpretable.'

h-269201247 h-269190043 h1104948842 h-269190043 h597731286 h-1451773113 h-2083244600 h642855734 h65068842 h65068842 h-1583229326 h-793122037 h-1931220815
Schema Component Representation
<xsd:complexType name="cs_businessAssociate">
<xsd:element name="name" type=" witsml:nameString " minOccurs="1" maxOccurs="1"/>
<xsd:element name="role" type=" witsml:nameStruct " minOccurs="1" maxOccurs="unbounded"/>
<xsd:element name="personName" type=" witsml:cs_personName " minOccurs="0" maxOccurs="1"/>
<xsd:element name="alias" type=" witsml:nameStruct " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="address" type=" witsml:cs_generalAddress " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="phoneNumber" type=" witsml:phoneNumberStruct " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="email" type=" witsml:emailQualifierStruct " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="contactPreference" type=" witsml:ContactPreference " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="associatedWith" type=" witsml:refNameString " minOccurs="0" maxOccurs="1"/>
<xsd:element name="contact" type=" witsml:refNameString " minOccurs="0" maxOccurs="unbounded"/>
<xsd:element name="personnelCount" type=" witsml:nonNegativeCount " minOccurs="0" maxOccurs="1"/>
<xsd:element name="comment" type=" witsml:commentString " minOccurs="0"/>
<xsd:attributeGroup ref=" witsml:attgrp_uid "/>


Complex Type:

Schema Component Type


Schema Component Name
Super-types: Address < AusAddress (by extension)
  • 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">
<extension base=" Address ">
<element name="state" type=" AusStates "/>
<element name="postcode">
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
<attribute name="country" type=" string " fixed="Australia"/>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)


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:

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See:

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:

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See:

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:

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 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:

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:

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: