Emergency Data Exchange Language (EDXL) Distribution Element Version 2.0
Committee Specification Draft 02 /
Public Review Draft 02
11 September 2012
Specification URIs
This version:
http://docs.oasis-open.org/emergency/edxl-de/v2.0/csprd02/edxl-de-v2.0-csprd02.odt (Authoritative)
http://docs.oasis-open.org/emergency/edxl-de/v2.0/csprd02/edxl-de-v2.0-csprd02.html
http://docs.oasis-open.org/emergency/edxl-de/v2.0/csprd02/edxl-de-v2.0-csprd02.pdf
Previous version:
https://www.oasis-open.org/committees/download.php/44554/edxl-de-v2.0-csprd01.zip
Latest version:
http://docs.oasis-open.org/emergency/edxl-de/v2.0/edxl-de-v2.0.odt (Authoritative)
http://docs.oasis-open.org/emergency/edxl-de/v2.0/edxl-de-v2.0.html
http://docs.oasis-open.org/emergency/edxl-de/v2.0/edxl-de-v2.0.pdf
Technical Committee:
Chair:
Elysa Jones (elysajones@yahoo.com), Individual
Editor:
Jeff Waters (jeff.waters@navy.mil), US Department of Defense (DoD)
Additional artifacts:
This prose specification is one component of a Work Product which also includes:
Related work:
This specification replaces or supersedes:
This specification is related to:
Declared XML namespace:
Abstract:
This Distribution Element 2.0 (DE 2.0) specification describes a standard message distribution format for data sharing among emergency information systems. The DE 2.0 serves two important purposes: (1) The DE 2.0 allows an organization to wrap separate but related pieces of emergency information, including any of the EDXL message types, into a single “package” for easier and more useful distribution; (2) The DE 2.0 allows an organization to “address” the package to organizations or individuals with specified roles, located in specified locations or those interested in specified keywords. This version of the DE expands the ability to use local community-defined terms, uses a profile of the Geographic Markup Language (GML) , follows best practices for naming conventions, provides the capability to link content objects, and is reorganized for increased flexibility and reuse of common types. The DE 2.0 packages and addresses emergency information for effective distribution with improved standardization and ability to be tailored for user needs.
Status:
This document was last revised or approved by the OASIS Emergency Management TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document.
Technical Committee members should send comments on this Work Product to the Technical Committee’s email list. Others should send comments to the Technical Committee by using the "Send A Comment" button on the Technical Committee’s web page at http://www.oasis-open.org/committees/emergency/.
For information on whether any patents have been disclosed that may be essential to implementing this Work Product, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page (http://www.oasis-open.org/committees/emergency/ipr.php).
Citation format:
When referencing this Work Product the following citation format should be used:
[EDXL-DE-v2.0]
Emergency Data Exchange Language (EDXL) Distribution Element Version 2.0. 11 September 2012. OASIS Committee Specification Draft 02 / Public Review Draft 02. http://docs.oasis-open.org/emergency/edxl-de/v2.0/csprd02/edxl-de-v2.0-csprd02.html.
Notices
Copyright © OASIS Open 2012. All Rights Reserved.
All capitalized terms in the following text have the meanings assigned to them in the OASIS Intellectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at the OASIS website.
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published, and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this section are included on all such copies and derivative works. However, this document itself may not be modified in any way, including by removing the copyright notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.
The limited permissions granted above are perpetual and will not be revoked by OASIS or its successors or assigns.
This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.
OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include such claims on its website, but disclaims any obligation to do so.
OASIS takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will at any time be complete, or that any claims in such list are, in fact, Essential Claims.
The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see http://www.oasis-open.org/policies-guidelines/trademark for above guidance.
Table of Contents
2.3.2 Encapsulation and Distribution of One or More Emergency Messages or Alerts or Notifications 13
1.1 Purpose
The primary purpose of the Distribution Element 2.0 is to facilitate the routing of any properly formatted emergency message to recipients. The Distribution Element may be thought of as a "container". It provides the information to route "payload" message sets (such as Alerts or Resource Messages), by including key routing information such as distribution type, geography, incident, and sender/recipient Ids.
The DE 2.0 specification joins the published EDXL suite of standards.The Emergency Data eXchange Language suite of standards continuing goal is to facilitate emergency information sharing and data exchange across the local, state, tribal, national and non-governmental organizations of different professions that provide emergency response and management services. EDXL accomplishes this goal by focusing on the standardization of specific messages (messaging interfaces) to facilitate emergency communication and coordination particularly when more than one profession or governmental jurisdiction is involved.
The published suite of EDXL Standards includes:
• The Common Alerting Protocol v1.2 specification (EDXL-CAP)
• The Distribution Elements specification v1.0 (EDXL-DE)
• The Hospital AVailability Exchange specification v1.0 (EDXL-HAVE)
• The Resource Messaging specification v1.0 (EDXL-RM)
• The Situation Reporting v1.0 (EDXL-SitRep)
1.2 History
The Disaster Management (DM) eGov Initiative of the Department of Homeland Security (DHS) determined in 2004 to launch a project to develop interagency emergency data communications standards. It called together a group of national emergency response practitioner leaders and sought their guidance on requirements for such standards. In June, 2004 the first such meeting identified the need for a common distribution element for all emergency messages. Subsequent meetings of a Standards Working Group developed detailed requirements and a draft specification for such a distribution element (DE).
During the same period the DM Initiative was forming a partnership with industry members of the Emergency Interoperability Consortium (EIC) to cooperate in the development of emergency standards. EIC had been a leading sponsor of the Common Alerting Protocol (CAP). Both organizations desired to develop an expanded family of data formats for exchanging operational information beyond warning.
EIC members participated in the development of the DE, and in the broader design of the design of a process for the development of additional standards. This was named Emergency Data Exchange Language (EDXL).
The goal of the EDXL project is to facilitate emergency information sharing and data exchange across the local, state, tribal, national and non-governmental organizations of different professions that provide emergency response and management services. EDXL will accomplish this goal by focusing on the standardization of specific messages (messaging interfaces) to facilitate emergency communication and coordination particularly when more than one profession is involved. It is not just an "emergency management" domain exercise.
It is a national effort including a diverse and representative group of local, state and federal emergency response organizations and professionals, following a multi-step process. Just as a data-focused effort targets shared data elements, the EDXL process looks for shared message needs, which are common across a broad number of organizations. The objective is to rapidly deliver implementable standard messages, in an incremental fashion, directly to emergency response agencies in the trenches, providing seamless communication and coordination supporting each particular process. The effort first addresses the most urgent needs and proceeds to subsequent message sets in a prioritized fashion. The goal is to incrementally develop and deliver standards.
EDXL is intended as a suite of emergency data message types including resource queries and requests, situation status, message routing instructions and the like, needed in the context of cross-disciplinary, cross-jurisdictional communications related to emergency response.
The priorities and requirements are created by the DM EDXL Standards Working Group (SWG) which is a formalized group of emergency response practitioners, technical experts, and industry.
The original draft DE specification was trialed by a number of EIC members starting in October, 2004. In November, 2004, EIC formally submitted the draft to the OASIS Emergency Management Technical Committee for standardization.
Since its official release, the DE has been adopted and used by a number of communities and applications and as a result, a few significant enhancements were recommended. The OASIS Infrastructure Framework Subcommittee took on the task of assembling the list of suggestions, considering potential solutions, and recommending an evolved version DE 2.0. This document describes the DE 2.0 and contains references to the schema and examples for download.
1.3 Structure of the EDXL Distribution Element
The EDXL Distribution Element (DE) comprises an <EDXLDistribution> element as described hereafter, optional <TargetArea> elements describing geospatial or political target area for message delivery, and a set of <ContentObject> elements each containing specific information regarding a particular item of content. The included content may be any XML or other content type or a URI to access the content.
The <EDXLDistribution> block may be used without content to form the body of a routing query to, or response from, a directory service.
1.3.1 <EDXLDistribution>
The <EDXLDistribution> element asserts the originator’s intent as to the dissemination of that particular message or set of messages.
Note that use of the <EDXLDistribution> element does not guarantee that all network links and nodes will implement the asserted dissemination policy or that unintended disclosure will not occur. Where sensitive information is transmitted over distrusted networks, it should be encrypted in accordance with the Web Services Security (WSS) standard http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf with any updates and errata published by the OASIS Web Services Security Technical Committee http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wss, or some other suitable encryption scheme.
1.3.2 <Descriptor>
The <Descriptor> element enables the user to describe the message with information useful for routing the message, including elements such as SenderRole, RecipientRole and Keyword.
1.3.3 <TargetArea>
The <TargetArea> is a container element for a geospatial or political area representing the source, target, or other area relevant for distributing the message content. It contains data necessary to the originator's intent, based on location targeting, as to the dissemination of that particular message or set of messages. Multiple <TargetArea> elements are allowed and can be grouped under a <TargetAreas> element, specifying the <AreaKind> and the type of <AreaGrouping>, such as union or intersection . If multiple <TargetArea> elements are used, then the order top-to-bottom represents precedence, with the top <TargetArea> preferred.
1.3.4 <ContentObject>
The <ContentObject> is a container element for specific messages. The <ContentObject> element MUST either contain a <ContentXML> content container or a <OtherContent> container. Additional elements (metadata) used for specific distribution of the <ContentObject> payload or hints for processing the payload are also present in the <ContentObject> container element.
1.3.5 ValueLists and Defaults
The EDXL-DE 2.0 uses a ValueList structure to enable communities to have user-defined lists of values for elements such as SenderRole, DistributionStatus, Confidentiality, and many others. The first example is a user-defined Valuelist specifying recipient roles:
<RecipientRole>
<ct:ValueListURI>urn:myagency:gov:sensors:recipientRole</ct:ValueListURI>
<ct:Value>Situational Awareness Apps</ct:Value>
<ct:Value>Warning Devices</ct:Value>
</RecipientRole>
This first example contains two recipient roles, one role whose value is “Situational Awareness Apps” and one role whose value is “Warning Devices”. These are notional roles created for this example. The roles are identified as values from a list whose unique Uniform Reference Identifier (URI) is “urn:myagency:gov:sensors:recipientRole”. When using a ValueList the user can can specify a user-defined list by URI (either using the “urn:...” format or the more familiar “http://...” format) and then include user-defined values from that list. This ValueList structure has several advantages, the ValueList: (a) provides flexibility for local communities to use community-defined terms and vocabulary; (b) allows for the external maintenance of local or standardized lists; and (c) avoids the problems inherent in attempting to constantly update hardcoded enumerations in a specification.
The ValueList is supplemented for many of the EDXL-DE 2.0 elements with an optional default list and values. These defaults are useful when no community-defined or standardized lists are available. This second example is a default for a ValueList specifying the type or kind of DE 2.0 message:
<DistributionKind>
<DistributionKindDefault>
<ct:ValueListURI>urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:DistributionType</ct:ValueListURI>
<ct:Value>Report</ct:Value>
</DistributionKindDefault>
</DistributionKind>
This example specifies a default value of “Report” from the default list whose URI is “urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:DistributionType”. When utilizing the default, a specific URI must be used and only the specified values can be included. The default URIs and values are specified in the schema and mentioned in the data dictionary, where applicable.
The EXDL-DE 2.0 ValueList and default mechanism provide a reasonable compromise between allowing flexibility for using local or standardized lists and enabling the convenience of utilizing default values with schema validation as needed.
1.3.6 Linking Content Objects and Other DE 2.0 Components
A new feature of the EDXL-DE 2.0 is the ability to specify links between content objects. This linking ability is a useful new feature of the DE 2.0, allowing users to specify meaningful connections among content objects.
For example, if a DE 2.0 message contains two alerts and three images, it's now possible to specify by links that two of the images go with the first alert and the third image is tied to the other alert.
The linking feature can also be used to link separable parts of a DE 2.0 message. These separable parts are the global elements, EDXLDistribution, Descriptor, Content, ContentDescriptor, and ContentObject.
For example, the new EDXL-DE 2.0 allows the Descriptor portion of the DE 2.0 to be used independently of the Content portion of the DE 2.0, as would be commonly done when using a “wrapper” other then the DE-provided EDXLDistribution element. In a SOAP message, the DE 2.0 Descriptor might appear in the SOAP header while the DE 2.0 Content appears in the SOAP body. If needed or desired, a link can be used to tie the Descriptor to the Content to make the connection between the two explicit. The new DE 2.0 linking feature supports two use cases: one where the user wants to show a connection between or among content objects and the other where the user wants to explicitly link other separable DE 2.0 components.
The new linking feature is enabled using the W3C standard Xlink. For example, here is a link tying a DE 2.0 Descriptor element to a DE 2.0 Content element:
<de:Link xlink:from="de_descriptor" xlink:to="de_content" xlink:arcrole="http://www.oasis.org/de/arcroles/isDescriptorOf" xlink:title="is Descriptor of"/>
Here are a few examples linking content objects:
<de:Link xlink:from="contentObject_1" xlink:to="contentObject_2" xlink:arcrole="http://www.oasis.org/de/arcroles/isImageOf" xlink:title="is Image of"/>
<de:Link xlink:from="contentObject_3" xlink:to="contentObject_4" xlink:arcrole="http://www.oasis.org/de/arcroles/isVideoOf" xlink:title="is Video of"/>
<de:Link
xlink:from="contentObject_5" xlink:to="contentObject_6"
xlink:arcrole="http://www.oasis.org/de/arcroles/isAudioOf"
xlink:title="is Audio of"/>
Xlink is a standard specification providing several attributes which can be added to elements to support linking. In the examples above, the “from” and “to” attributes reference the values of xlink label attributes that have been added to the DE 2.0 components or content objects respectively. In the second example, the link is referring to a content object whose xlink:label attribute has been set to “contentObject_2” and is also referring to another content object whose xlink:label attribute has been set to “contentObject_1”. By using these labels as element identifiers, the link connects one to another. Users can specify user-defined labels and roles, and thereby create meaningful connections among content objects or among DE 2.0 components.
This section is merely an introduction to the linking concept. For more details, see the examples and also see the Xlink specification itself and referenced tutorials.
1.3.7 Common Types
Several Element Types, such as TargetArea, borrow re-usable elements from the EDXL Common Types that apply to and support multiple areas of the DE 2.0 messages. For instance TargetArea relies on the EDXL-CIQ profile for geopolitical info and on the EDXL-GSF profile for geographical information.
The Supporting Elements Model distinguishes three groups of elements: CommonTypes (EDXL-CT), Contact Information (EDXL-CIQ) and Location Information (EDXL-GSF).
The following elements are used in this specification and can be found at the locations cited in the normative references in Section 1.6 below.
1.4 Applications of the EDXL Distribution Element
The primary use of the EDXL Distribution Element is to identify and provide information to enable the routing of encapsulated payloads, called Content Objects. It is used to provide a common mechanism to encapsulate content information.
1.5 Terminology
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this specification are to be interpreted as described in IETF RFC 2119.
In addition, within this Specification, the keyword “CONDITIONAL” should be interpreted as potentially “REQUIRED” or “OPTIONAL” depending on the surrounding context. The term payload refers to some body of information contained in the distribution element. The term “REQUIRED” means that empty elements or NULL values are NOT allowed.
1.6 Normative References
S. Bradner. Key words for use in RFCs to Indicate Requirement Levels.
http://www.ietf.org/rfc/rfc2119.txt,IETF RFC2119, March 1997.
N. Freed, Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types, http://www.ietf.org/rfc/rfc2046.txt, IETF RFC 2046, November 1996.
S. Bradner, Key words for use in RFCs to Indicate Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.
H. Alvestrand, Tags for the Identification of Languages, http://www.ietf.org/rfc/rfc3066.txt, IETF RFC 3066, January 2001.
[WGS 84]
National Geospatial Intelligence Agency, Department of Defense World Geodetic System 1984, http://earth-info.nga.mil/GandG/publications/tr8350.2/tr8350_2.html, NGA Technical Report TR8350.2, January 2000.
[XML 1.0]
T. Bray, Extensible Markup Language (XML) 1.0 (Third Edition), http://www.w3.org/TR/REC-xml/, W3C REC-XML-20040204, February 2004.
T. Bray, Namespaces in XML, http://www.w3.org/TR/REC-xml-names/, W3C REC-xml-names-19990114, January 1999.
[dateTime]
N. Freed, XML Schema Part 2: Datatypes Second Edition, http://www.w3.org/TR/xmlschema-2/#dateTime, W3C REC-xmlschema-2, October 2004.
[xlink]
S. DeRose et al, XML Linking Language (Xlink) Version 1.1, http://www.w3.org/TR/xlink11/, W3C REC-xlink11, May 2010.
[EDXL-CIQ]
W. Joerg, OASIS Committee Specification Draft Emergency Data Exchange Language Customer Information Quality http://docs.oasis-open.org/emergency/edxl-ciq/v1.0/csd02/ , September, 2011
[EDXL-CT]
W. Joerg, OASIS Committee Specification Draft Emergency Data Exchange Language Common Types http://docs.oasis-open.org/emergency/edxl-ct/v1.0/csd02/ , November, 2011
[EDXL-GSF]
W. Joerg, OASIS Committee Specification Draft Emergency Data Exchange Language GML Simple Features http://docs.oasis-open.org/emergency/edxl-gsf/v1.0/csd01/ , September, 2011[
[EDXL-HAVE]
Emergency Data Exchange Language (EDXL) Hospital AVailablity Exchange.. OASIS Standard 01 http://docs.oasis-open.org/emergency/edxlhave/v1.0/emergency_edxl_have-1.0.html, 1 November 2008
[EDXL-RM]
Emergency Data Exchange Language (EDXL) Resource Messaging. OASIS Standard. V1.0. http://docs.oasis-open.org/emergency/edxl-rm/v1.0/errata/EDXL-RM-v1.0-OS-errata-os.html, 1 November 2008
[EDXL-SitRep]
Emergency Data Exchange Language Situation Reporting (EDXL-SitRep) Version 1.0. 4 May 2012. OASIS Committee Specification Draft 01 / Working Draft 18.
1.7 Non-normative References
[EDXL General Functional Requirements]
EDXL General Functional Requirements, http://www.oasis-open.org/committees/document.php?document_id=10031&wg_abbrev=emergency, November 2004.
[EDXL Distribution Element Implementer's Guide]
EDXL Distribution Element Implementer's Guide, http://www.oasis-open.org/committees/document.php?document_id=14120&wg_abbrev=emergency, August 2005.
2.1 Design Philosophy
Below are some of the guiding principles of the Distribution Element:
1. Provide an Open Container Model to enable dissemination of one or more emergency messages
2. Provide flexible mechanisms to inform message routing and/or processing decisions
3. Enable dissemination of messages based on geographic delivery area
4. Use and re-use of data content and models developed by other initiatives
5. Support business process-driven specific messaging needs across emergency professions
6. Support everyday events and incident preparedness, as well as disasters
7. Facilitate emergency information sharing and data exchange across the local, state, tribal, national and non-governmental organizations of different professions that provide emergency response and management services
8. Multi-use format - One message schema supports multiple message types (e.g., alert / update / cancellations / acknowledgments / error messages) in various applications (actual / exercise / test / system message.)
2.2 Requirements for Design
The Distribution Element specification should:
1. Define a compound XML structure (or an equivalent single structure if transcoded into another format) including the required and optional elements defined below.
2. Specify a desired delivery area, expressed in geospatial coordinates or using political/administrative codes.
3. Allow the ability to encapsulate a payload or set of payloads
4. Take a modular approach to the enumerations of element values which may evolve over time, e.g. by referring to a separate schema for those enumerations.
5. Specify unique distribution and sender identifiers
6. Specify the date and time the distribution was sent
7. Specify the actionability of the distribution message (e.g., real-world, test, exercise)
8. Specify the functional type of the distribution message (e.g., report, request, update, cancellation, etc.)
9. Specify that the following elements may be present in a valid payload:
(a) A specification of the format of the distribution message (e.g., the URI of an XML Schema for the message)
(b) The functional role and/or type of the sender of the distribution message
(c) One or more functional role and/or type of desired recipients of the distribution message
(d) One or more types of response activity involved
(e) A reference to the type of incident
(f) One or more characterizations of the etiology of the subject event or incident (e.g., terrorism, natural, under investigation, etc.)
(g) The incident name or other identifier of one or more event or incident
(h) A reference to one or more response types.
(i) One or more specific recipient addresses (as a URI).
(j) Specify an assertion of the confidentiality level of the combined payloads.
10. In addition, the Content Object element contained within the Distribution Element SHOULD:
(a) Allow the encapsulation of one or more payloads in each of the Content Object elements.
(b) Specify the functional role and/or type of the sender of each payload
(c) Specify one or more functional roles and/or types of desired recipients of each payload
(d) Specify an assertion of the confidentiality level of each payload.
11. Provide or refer to specific lists (enumerations) of values and definitions for:
(a) Types of incidents
(b) Types of hazards and/or events
(c) Types of agencies
(d) Types of response activity
(e) The functional role and/or type of the sender
(f) The functional roles and/or types of desired recipients
(g) The incident name or other identifier of one or more event or incident.
2.3 Example Usage Scenarios
Note: The following examples of use scenarios were used as a basis for design and review of the EDXL Distribution Element Message format. These scenarios are non-normative and not intended to be exhaustive or to reflect actual practices.
2.3.1 Distribution of Emergency Messages or Alerts Based on Geographic Delivery Area and Incident Type
The terror alert level has been raised to RED. Credible intelligence indicates that terrorist groups in the Mid-Atlantic region are seeking to conduct an attack in the next 48 hours. The Department of Homeland Security sends an emergency alert message, and using the Distribution Element, distributes it to all emergency agencies in the specified area.
2.3.2 Encapsulation and Distribution of One or More Emergency Messages or Alerts or Notifications
A Radiological sensor triggered at a prominent Tunnel toll booth. Radiation alarm levels indicates possible dirty bomb. Authorities decide to send multiple messages to a number of jurisdictions. The user sends an EDXL Distribution Element with two encapsulated CAP messages. The first one notifies the area where the sensor has been triggered. The second one is an alert to emergency response agencies that the state Emergency Operation Center (EOC) has been activated, and requests the agencies to be on alert.
2.3.3 Distribution of Resource Messages or Reports
The Local EOC has a need for additional resource/support, but is unsure what specifically to request. A free-form request for information and resource availability is prepared, and is sent to the state EOC and other organizations (person to person) using the Distribution Element. The Local EOC receives an acknowledgment message from the State EOC, as well as a request for Information on additional details of the requested resource. Both of these messages are contained within a single Distribution Element.
2.3.4 Distribution of Well-Formed XML Messages
A huge crash, involving a car and a HAZMAT truck, occurs at a busy junction on an inter-state freeway. Separate automatic notifications of both the car crash and the HAZMAT carrier are sent using the Vehicular Emergency Data Set (VEDS), contained in the Distribution Element. The Transportation Management Center (TMC) shares information (related to the above incident) with the adjacent TMC, using the IEEE 1512 Incident Management Message Set. These sets of messages are exchanged using the EDXL Distribution Element.
3.1 Document Object Model
3.2 Data Dictionary
3.2.1 EDXLDistribution Element and Sub-elements
The Distribution Element, <EDXLDistribution> is the container element for all data necessary to the originator’s intent as to the dissemination of the contained message or set of messages.
|
EDXLDistribution |
|
|
Type |
XML Structure |
|
Usage |
CONDITIONAL, MUST be used once and only once when an EDXL envelope is desired, top level container |
|
Definition |
A container of all of the elements related to the distribution of the content messages. |
|
Comments |
1. The <EDXLDistribution> element includes administrative envelope information as well as optionally one <Descriptor> block and one <Content> block.
2. Use of the <EDXLDistribution> element does not guarantee that all network links and nodes will implement the asserted dissemination policy or that unintended disclosure will not occur. Where sensitive information is transmitted over untrusted networks, it should be encrypted in accordance with the Web Services Security (WSS) standard (<http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0.pdf>) with any updates and errata published by the OASIS Web Services Security Technical Committee (<http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wss>), or some other suitable encryption scheme. 3. This element can be the source or destination for a link. See Section 1.3.5. |
|
|
|
|
Sub-elements |
DistributionID [1..1]
SenderID [1..1]
DateTimeSent [1..1]
DateTimeExpires [1..1]
DistributionStatus [1..1]
DistributionKind [1..1]
DistributionReference [0..*]
Descriptor [0..1]
Content [0..1]
Other [0..*] |
|
Used In |
top level element |
|
Element |
Descriptor |
|
Type |
XML Structure |
|
Usage |
OPTIONAL, MAY be used once and only once; can be used as a top level element when used outside of the EDXLDistribution envelope. |
|
Definition |
A container of all of the substantive elements related to describing the distribution of the content messages as a whole. |
|
Comments |
1. This element can be the source or destination for a link. See Section 1.3.5. |
|
Sub-elements |
CombinedConfidentiality [0..1]
SenderRole [0..*]
RecipientRole [0..*]
Keyword [0..*]
ExplicitAddress [0..*]
TargetAreas [0..*]
Urgency [0..1]
Severity [0..1]
Certainty [0..1]
IncidentID [0..*]
IncidentDescription [0..*]
Link [0..*] |
|
Used In |
EDXLDistribution or independently if an alternative envelope is used. |
|
Content |
|
|
Type |
XML Structure |
|
Usage |
OPTIONAL, MAY be used once and only once; may be used outside of EDXLDistribution if an alternative envelope to <EDXLDistribution> is used. |
|
Definition |
A container for the ContentObject and any Links among content objects |
|
Comments |
1.The <Content> block must contain one or more <ContentObject> blocks and optionally one ore more <Link> elements. 2. This element can be the source or destination for a link. See Section 1.3.5. |
|
Sub-elements |
ContentObject [1..*]
Link [0..*] |
|
Used In |
EDXLDistribution or independently if an alternative envelope is used. |
|
Link |
|
|
Type |
XML Structure |
|
Usage |
OPTIONAL, MAY be used multiple times |
|
Definition |
A method for linking <ContentObject> elements or other elements |
|
Comments |
1.The Link element includes attributes from the xlink:arcLink attributeGroup, consisting of type=”arc”, xlink:arcrole, xlink:title , xlink:show, xlink:actuate, xlink:from, and xlink:to. The role attribute indicates a property of the resource, the title indicates a human-readable description of the resource, and the label attribute provides a way for an arc-type element to refer to it. The xlink:from attribute defines the start of a link by referencing a resource's “label” attribute while the xlink:to attribute defines the endpoint of a link by referencing the ending resource label. Since label attributes are available in the DE Content, ContentObject, and Descriptor elements, the Link element can be used to link any of these elements. For example, content objects can be linked to each other and to descriptor elements. The linkage is useful to associate content objects when multiple pieces of content are included in one DE or to link a descriptor to content when the two elements are separated, as when using an alternative envelope to the EDXLDistribution element, for example when using a SOAP envelope. For more information on xlink, see the XLINK specification referenced in Section 1. 2. See Section 1.3.5 for a summary overview of the new DE linking capability. 3. <Descriptor> elements can utilize the resourceLink attributes defined in Xlink 1.1. |
|
Used In |
Descriptor |
|
DistributionID |
|
|
Type |
ct:EDXLStringType |
|
Usage |
REQUIRED, MUST be used once and only once |
|
Definition |
The unique identifier of this distribution message. |
|
Comments |
1.Uniqueness is assigned by the sender to be unique for that sender. 2.The identifier MUST be a properly formed -escaped if necessary- XML string. 3.The string length of the identifier MUST be less than 1024. |
|
Used In |
|
Element |
SenderID |
|
Type |
ct:EDXLStringType |
|
Usage |
REQUIRED, MUST be used once and only once |
|
Definition |
The unique identifier of the sender. |
|
Comments |
1.Uniquely identifies human parties, systems, services, or devices that are all potential senders of the distribution message. 2. In the form actor@domain-name. 3.Uniqueness of the domain-name is guaranteed through use of the Internet Domain Name System, and uniqueness of the actor name enforced by the domain owner. 4.The identifier MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
|
DateTimeSent |
|
|
Type |
ct:EDXLDateTimeType |
|
Usage |
REQUIRED, MUST be used once and only once |
|
Definition |
The date and time the distribution message was sent. |
|
Comments |
1. The Date Time combination must include the offset time for time zone. Must be in the restricted W3C format for the XML [dateTime] data type, see ct:EDXLDateTimeType. |
|
Used In |
|
DateTimeExpires |
|
|
Type |
ct:EDXLDateTimeType |
|
Usage |
REQUIRED, MUST be used once and only once |
|
Definition |
The date and time the distribution message should expire. |
|
Comments |
1. The Date Time combination must include the offset time for time zone. Must be in the restricted W3C format for the XML [dateTime] data type, see ct:EDXLDateTimeType. |
|
Used In |
|
DistributionStatus |
|
|
Type |
A choice between a user-defined value or a default value |
|
Usage |
REQUIRED, MUST be used once and only once |
|
Definition |
The action-ability of the message. |
|
Comments |
1. If the default value list is used, then the ValueListURI must be: “urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:StatusType” and the Value must be one of:
a. Actual - "Real-world" information for action
b. Exercise - Simulated information for exercise participants
c. System - Messages regarding or supporting network functions
d. Test - Discardable messages for technical testing only.
2. The status MUST be a properly formed -escaped if necessary- XML string. |
|
Sub-elements |
Either StatusKindValueList or StatusKindDefault |
|
Used In |
|
StatusKindDefault |
|
|
Type |
ct:StatusKindDefaultType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the default distribution status list and value, for example “Actual” or “Exercise”. |
|
Comments |
1. The list and associated value(s) are in the form:
|
|
Sub-elements |
ct:ValueListURI
ct:Value |
|
Used In |
DistributionStatus |
|
StatusKindValueList |
|
|
Type |
ct:ValueKeyType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the distribution status of the message”. |
|
Comments |
1. The list and associated value(s) are in the form:
2. One and only one instance of <ct:Value> MUST occur.
|
|
Sub-elements |
ct:ValueListURI [1..1]
ct:Value [1..1] |
|
Used In |
DistributionStatus |
|
DistributionKind |
|
|
Type |
A choice between a user-defined value or a default value |
|
Usage |
REQUIRED, MUST be used once and only once |
|
Definition |
The function of the message. |
|
Comments |
1. The list and associated value(s) are in the form:
2. Only a single value may be specified 3. If the default value list is used, the ValueListURI must be:”urn:oasis;names:tc:emergency:EDXL:DE2.0:Defaults:StatusType” and the Value must be one of:
a. Report - New information regarding an incident or activity
b. Update - Updated information superseding a previous message
c. Cancel - A cancellation or revocation of a previous message
d. Request - A request for resources, information or action
e. Response - A response to a previous request
f. Dispatch - A commitment of resources or assistance
g. Ack - Acknowledgment of receipt of an earlier message
h. Error - Rejection of an earlier message (for technical reasons)
i. SensorConfiguration - These messages are for reporting configuration during power up or after Installation or Maintenance.
j. SensorControl - These are messages used to control sensors/sensor concentrator components behavior.
k. SensorStatus - These are concise messages which report sensors/sensor concentrator component status or state of health.
l. SensorDetection - These are high priority messages which report sensor detections.
4. The status MUST be a properly formed -escaped if necessary- XML string. |
|
Sub-elements |
|
|
Used In |
|
DistributionKindDefault |
|
|
Type |
ct:DistributionDefaultType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the default kind of distribution list and value, for example “Report” or “Update”. |
|
Comments |
1. The list and associated value(s) are in the form:
|
|
Sub-elements |
ct:ValueListURI [1..1]
ct:Value [1..1] |
|
Used In |
DistributionKind |
|
DistributionKindValueList |
|
|
Type |
ct:ValueKeyType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the kind of distribution of the message”. |
|
Comments |
1. The list and associated value(s) are in the form:
2. One and only one instance of <value> MUST occur.
|
|
Sub-elements |
ct:ValueListURI
ct:Value |
|
Used In |
DistributionKind |
|
CombinedConfidentiality |
|
|
Type |
A choice between a user-defined value or a default value |
|
Usage |
CONDITIONAL, Must be present when confidentiality is used in a content object |
|
Definition |
Confidentiality of the combined distribution message’s content. |
|
Comments |
1.The list and associated value are in the form:
<CombinedConfidentiality> <ct:ValueListURI>ValueListURI</ct:ValueListURI> <ct:Value>value</ct:Value> </CombinedConfidentiality>
2. Only one value can be specified
3. When present, the combined ContentObjects MUST use the same <ct:ValueListURI> where the values in the referenced list are ordered from highest confidentiality at the top to the lowest at the bottom.
4. The <CombinedConfidentiality> indicates the confidentiality of the combined <ContentObject> sub-elements. Generally the combined confidentiality is the most restrictive of the <Confidentiality> elements in the container <ContentObject> element, but it can be more restrictive than any of the individual <Confidentiality> elements.
5. The <CombinedConfidentiality> element MUST be present if a <Confidentiality> element is present in any of the <ContentObject> elements. 6. The confidentiality MUST be a properly formed -escaped if necessary- XML string.
7. If the default value list is used, the ValueListURI must be:”urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:ConfidentialityType” and the Value must be one of:
a. Unclassified
b. Classified
|
|
Sub-elements |
ConfidentialityDefault [1..1] ConfidentialityValueList [1..1] |
|
Used In |
|
ConfidentialityDefault |
|
|
Type |
ct:ConfidentialityDefaultType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the default confidentiality list and value, for example “Classified” or “Unclassified”. |
|
Comments |
1. The list and associated value(s) are in the form:
|
|
Sub-elements |
ct:ValueListURI
ct:Value |
|
Used In |
CombinedConfidentiality, Confidentiality |
|
ConfidentialityValueList |
|
|
Type |
ct:ValueKeyType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the confidentiality of the message. |
|
Comments |
1. The list and associated value(s) are in the form:
2. One and only one instance of <ct:Value> MUST occur.
|
|
Sub-elements |
ct:ValueListURI [1..1]
ct:Value [1..1] |
|
Used In |
CombinedConfidentiality, Confidentiality |
|
Language |
|
|
Type |
xsd:language |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
The primary language (but not necessarily exclusive) used in the payloads. |
|
Comments |
1. Valid language values are supplied in the ISO standard [RFC3066].
2. The language MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
|
|
SenderRole |
|
|
Type |
ct:ValueListType |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
The functional role of the sender, as it may determine message routing decisions. |
|
Comments |
1. The list and associated value(s) is in the form:
3. Multiple instances of the <ct:Value>, May occur with a single <ct:ValueListURI> within the <senderRole> container.
4. Multiple instances of <SenderRole> MAY occur within a single <Descriptor> container
5. Numerous organizations provide role definitions; the
external role references provided are examples only. The IF committee does
not endorse and/or approve any particular role definition -external
references. |
|
Sub-elements |
ValueListURI [1..1] Value [1..*] |
|
Used In |
|
RecipientRole |
|
|
Type |
ct:ValueListType |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
The functional role of the recipient, as it may determine message routing decisions. |
|
Comments |
1 1. The list and associated value(s) are in the form:
3. Multiple instances of the <ct:Value>, MAY occur with a single <ct:ValueListURI> within the <recipientRole> container. 4. Multiple instances of <RecipientRole> MAY occur within a single <Descriptor> container. 5. Numerous organizations provide role definitions; the external role references provided are examples only. The IF committee does not endorse and/or approve any particular role definition -external references. Example Role External References: |
|
Sub-elements |
ct:ValueListURI [1..1] ct:Value [1..*] |
|
Used In |
|
Keyword |
|
|
Type |
ct:ValueListType |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
The topic related to the distribution message, as it may determine message routing decisions. |
|
Comments |
1. The list and associated value(s) is in the form:
3. Multiple instances of the <ct:Value>, MAY occur with a single <ct:ValueListURI> within the <Keyword> container.
4. Multiple instances of <Keyword> MAY occur within a single <EDXLDistribution> container. 5 Examples of things <Keyword> might be used to describe include event type, event etiology, incident ID and response type. |
|
Sub-elements |
ct:ValueListURI [1..1] ct:Value [1..*] |
|
Used In |
|
ExplicitAddress |
|
|
Type |
XML Structure |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
The identifier of an explicit recipient. |
|
Comments |
1. Identifies human parties, systems, services, or devices that are all potential recipients of the distribution message.
2. The explicit address of a recipient in the
form:<ExplicitAddress>
3. Multiple instances of the < ExplicitAddressValue > MAY occur with a single < ExplicitAddressScheme > within the <ExplicitAddress > container.
4. Multiple instances of <ExplicitAddress > MAY occur within a single <Descriptor> container. |
|
Sub-elements |
ExplicitAddressScheme [1..1] ExplicitAddressValue [1..*] |
|
Used In |
|
Urgency |
|
|
Type |
A choice between a user-defined value or a default value |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
The urgency of the content of the message. |
|
Comments |
1. The list and associated value are in the form:
2. Only a single value may be specified 3. If the default value list is used, then the ValueListURI must be: “urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:Urgency” and the Value must be one of:
a.“Immediate” - Responsive action SHOULD be taken immediately
b.“Expected” - Responsive action SHOULD be taken soon (within next hour)
c.“Future” - Responsive action SHOULD be taken in the near future
d.“Past” - Responsive action is no longer required
e.“Unknown” - Urgency not known
4. The value MUST be a properly formed -escaped if necessary- XML string. |
|
Sub-elements |
Either UrgencyDefault [0..1] or UrgencyValueList [0..1] |
|
Used In |
|
UrgencyDefault |
|
|
Type |
ct:UrgencyDefaultType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the default urgency list and value, for example “Immediate” or “Expected”. |
|
Comments |
1. The list and associated value(s) are in the form:
|
|
Sub-elements |
ct:ValueListURI
ct:Value |
|
Used In |
Urgency |
|
UrgencyValueList |
|
|
Type |
ct:ValueKeyType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the urgency of the message”. |
|
Comments |
1. The list and associated value(s) are in the form:
2. One and only one instance of <ct:Value> MUST occur.
|
|
Sub-elements |
ct:ValueListURI [1..1]
ct:Value [1..1] |
|
Used In |
Urgency |
|
Severity |
|
|
Type |
A choice between a user-defined value or a default value |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
The severity of the content of the message. |
|
Comments |
1. The list and associated value are in the form:
2. Only a single value may be specified 3. If the default value list is used, then the ValueListURI must be: “urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:Severity” and the Value must be one of:
a.“Extreme” - Extraordinary threat to life or property
b.“Severe” - Significant threat to life or property
c. “Moderate” - Possible threat to life or property
d.“Minor” – Minimal to no known threat to life or property
e. “Unknown” - Severity unknown
4. The value MUST be a properly formed -escaped if necessary- XML string. |
|
Sub-elements |
Either SeverityDefault or SeverityValueList |
|
Used In |
|
SeverityDefault |
|
|
Type |
ct:SeverityDefaultType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the default severity list and value, for example “Extreme” or “Severe”. |
|
Comments |
1. The list and associated value(s) are in the form:
|
|
Sub-elements |
ct:ValueListURI [1..1]
ct:Value [1..1] |
|
Used In |
Severity |
|
SeverityValueList |
|
|
Type |
ct:ValueKeyType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the severity of the message”. |
|
Comments |
1.The list and associated value(s) are in the form:
2. One and only one instance of <ct:Value> MUST occur.
|
|
Sub-elements |
ct:ValueListURI [1..1] ct:Value [1..1] |
|
Used In |
Severity |
|
Certainty |
|
|
Type |
A choice between a user-defined value or a default value |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
The certainty of the content of the message. |
|
Comments |
1. The list and associated value are in the form:
2. Only a single value may be specified 3. If the default value list is used, then the ValueListURI must be: “urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:Certainty” and the Value must be one of:
a.“Observed” – Determined to have occurred or to be ongoing
b.“Likely” - Likely (p > ~50%)
c.“Possible” - Possible but not likely (p <= ~50%)
d. “Unlikely” - Not expected to occur (p ~ 0)
e. “Unknown” - Certainty unknown
4. The value MUST be a properly formed -escaped if necessary- XML string. |
|
Sub-elements |
Either CertaintyDefault [0..1] or CertaintyValueList [0..1] |
|
Used In |
|
CertaintyDefault |
|
|
Type |
ct:SeverityDefaultType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the default certainty list and value, for example “Observed” or “Likely”. |
|
Comments |
1. The list and associated value(s) are in the form:
|
|
Sub-elements |
ct:ValueListURI [1..1]
ct:Value [1..1] |
|
Used In |
Certainty |
|
CertaintyValueList |
|
|
Type |
ct:ValueKeyType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the certainty of the message”. |
|
Comments |
1. The list and associated value(s) are in the form:
2. One and only one instance of <ct:Value> MUST occur.
|
|
Sub-elements |
ct:ValueListURI [1..1]
ct:Value [1..1] |
|
Used In |
Certainty |
|
Element |
IncidentID |
|
Type |
ct:EDXLStringType |
|
Usage |
OPTIONAL, MAY use multiple times |
|
Definition |
The human-readable text uniquely identifying the incident/event/situation associated with the Content. |
|
Comments |
1. MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
|
Element |
IncidentDescription |
|
Type |
ct:EDXLStringType |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
The human-readable text describing the incident/event/situation associated with the ContentObject. |
|
Comments |
1. MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
3.2.2 TargetAreas Element and Sub-elements
The <TargetAreas> is a container element for the geospatial or political areas targeting or describing the message content. It indicates the originator’s intent based on location targeting as to the dissemination of that particular message or set of messages. The <TargetArea> utilizes the EDXL GML SimpleFeatures Profile, which should be consulted for detailed description of <TargetArea> sub-elements.
|
TargetAreas |
|
|
Type |
XML Structure |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
A container for TargetArea information. |
|
Comments |
1. The <TargetAreas> block must contain one <AreaKind> block, one <AreaGrouping> block, and one or more <TargetArea> elements.
|
|
Sub-elements |
AreaKind [1..1]
AreaGrouping [1..1]
TargetArea [1..*]
|
|
Used In |
|
AreaGrouping |
|
|
Type |
XML Structure |
|
Usage |
REQUIRED, MAY use multiple |
|
Definition |
The container element for location information. |
|
Comments |
1. The value must be one of: “Intersection”, “Union”, “ExclusiveOr”, “Complement”, “OtherGroupingType”.
|
|
Used In |
TargetAreas |
|
TargetArea |
|
|
Type |
XML Structure |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
The container element for location information. |
|
Comments |
1. If multiple Sub-elements appear in a single <TargetArea> element then it should be in the document order with most accurate representation first.
2. Multiple <TargetArea> blocks may appear in a single <TargetAreas>element. |
|
Sub-elements |
edxl-gsf:EDXLGeoLocation [0..*]
ct:EDXLGeoPoliticalLocation [0..*]
|
|
Used In |
TargetAreas |
|
AreaKind |
|
|
Type |
A choice between a user-defined value or a default value |
|
Usage |
REQUIRED, MUST use once and only once. |
|
Definition |
Specifies the kind of area, for example “target” or “source”. |
|
Comments |
1. The list and associated value(s) are in the form:
2. One and only one instance of <ct:Value> MUST occur.
3. If the default is used, the ValueListURI must be “urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:AreaKind” and the Value must be “DistributionTargetArea” or “SourceTargetArea”
|
|
Sub-elements |
Either AreaKindDefault [0..1] or AreaKindValueList [0..1] |
|
Used In |
TargetAreas |
|
AreaKindDefault |
|
|
Type |
ct:AreaKindDefaultType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the default kind of area, for example “target” or “source”. |
|
Comments |
1. The list and associated value(s) are in the form:
|
|
Sub-elements |
ct:ValueListURI [1..1]
ct:Value [1..1] |
|
Used In |
AreaKind |
|
AreaKindValueList |
|
|
Type |
ct:ValueKeyType |
|
Usage |
OPTIONAL, MAY be used once and only once |
|
Definition |
Specifies the default kind of area, for example “target” or “source”. |
|
Comments |
1. The list and associated value(s) are in the form:
2. One and only one instance of <ct:Value> MUST occur.
|
|
Sub-elements |
ct:ValueListURI [1..1]
ct:Value [1..1] |
|
Used In |
AreaKind |
3.2.3 ContentObject Element and Sub-elements
The <ContentObject> element is the container element for specific messages. The <ContentObject> element MUST either contain a <ContentXML> content container or a <OtherContent> content container. Additional elements (metadata) used for specific distribution of the <ContentObject> payload or hints for processing the payload are also present in the <ContentObject> container element.
|
ContentObject |
|
|
Type |
XML Structure |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
The container element for message data and content. |
|
Comments |
1. The <ContentObject> is the container element for specific messages.
2. The <ContentObject> may have an optional attribute that defines a namespace prefix which resolves ambiguous element names.
3. The <ContentObject> contains an optional <ContentDescriptor> to describe the content.
4. The <ContentObject> element MUST contain exactly one of the two content formats: <ContentXML>, for valid namespaced XML content
or
<OtherContent>, containing either a <Uri> element, for reference to the content’s location, or a <ContentData> element, for data encapsulated in the message.
5. This element can be the source or destination for a link. See Section 1.3.5. |
|
Sub-elements |
ContentDescriptor [0..1] Either ContentXML [1..1] or OtherContent [1..1]) Other [0..*] |
|
Used In |
EDXLDistribution or Stand-alone |
|
ContentDescriptor |
|
|
Type |
XML Structure |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
The description of the message content object |
|
Comments |
1. This element can be the source or destination for a link. See Section 1.3.5. |
|
Sub-elements |
ContentDescription [0..1]
ContentKeyword [0..*]
OriginatorRole [0..*]
ConsumerRole [0..*]
ContentID [0..*]
Confidentiality [0..1]
ContentLanguage [0..1] |
|
Used In |
EDXLDistribution or Stand-alone |
|
Element |
ContentDescription |
|
Type |
ct:EDXLStringType |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
The human-readable text describing the content object. |
|
Comments |
MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
|
ContentKeyword |
|
|
Type |
ct:ValueListType |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
The topic related to the message data and content, as it may determine message distribution and presentation decisions. |
|
Comments |
1. The list and associated value(s) are in the form:
2. Multiple instances of the <ct:Value>, MAY occur with a single <ct:ValueListURI> within the <ContentKeyword> container.
3. Multiple instances of <ContentKeyword> MAY occur within a single <ContentObject> container. |
|
Sub-elements |
ValueListURI [1..1] Value [1..*] |
|
Used In |
|
OriginatorRole |
|
|
Type |
ct:ValueListType |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
The functional role of the message originator, as it may determine message distribution and presentation decisions. |
|
Comments |
1. The list and associated value(s) are in the form:
<OriginatorRole>
2. Multiple instances of the <Value>, MAY occur with a single <ValueListURI> within the <OriginatorRole> container. 3. Multiple instances of <OriginatorRole> MAY occur within a single <ContentObject> container. |
|
Sub-elements |
ct:ValueListURI [1..1] ct:Value [1..*] |
|
Used In |
|
ConsumerRole |
|
|
Type |
ct:ValueListType |
|
Usage |
OPTIONAL, MAY use multiple |
|
Definition |
The functional role of the message consumer, as it may determine message distribution and presentation decisions. |
|
Comments |
1. The list and associated value(s) are in the form:
</ConsumerRole>
2. Multiple instances of the <ct:Value>, MAY occur with a single <ct:ValueListURI> within the <consumerRole> container.
3. Multiple instances of <ConsumerRole> MAY occur within a single<ContentObject> container. |
|
Sub-elements |
ct:ValueListURI [1..1] ct:Value [1..*] |
|
Used In |
|
Element |
ContentID |
|
Type |
ct:EDXLStringType |
|
Usage |
OPTIONAL, MAY be used multiple times. |
|
Definition |
An identifier for a ContentObject. |
|
Comments |
1. Multiple instances of ContentID MAY occur within a ContentDescriptor. 2.The identifier MUST be a properly formed -escaped if necessary- XML string. 3.The string length of the identifier MUST be less than 1024. |
|
Used In |
ContentDescriptor |
|
Confidentiality |
|
|
Type |
A choice between a user-defined value or a default value |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
Special requirements regarding confidentiality of the content of this <ContentObject>. |
|
Comments |
1. The list and associated value are in the form:
<Confidentiality> <ct:ValueListURI>ValueListURI</ct:ValueListURI> <ct:Value>value</ct:Value> </Confidentiality>
2. MUST be a properly formed -escaped if necessary- XML string.
3. Only one ct:Value may be specified.
4. If the default value list is used, the ValueListURI must be:”urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:ConfidentialityType” and the Value must be one of:
a. Unclassified
b. Classified |
|
Sub-elements |
Either ConfidentialityDefault [1..1] or ConfidentialityValueList [1..1] |
|
Used In |
|
ContentLanguage |
|
|
Type |
xsd:language |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
Specifies the language of this particular content object |
|
Comments |
1. Valid language values are supplied in the ISO standard [RFC3066].
2. The language MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
|
Other |
|
|
Type |
XML content from any namespace other than the DE 2.0 namespace |
|
Usage |
OPTIONAL, MAY be use to add an unlimited number of XML elements for enveloped signing process. |
|
Definition |
Special requirements allowing for signature of the content of a <ContentObject>. |
|
Comments |
1. There is no mandatory validation of the elements if the namespace reference can not be located.
2. MUST be a properly formed XML string – escaped, if necessary.
3. Element names cannot duplicate other element names in the ContentObject. Such duplication would prevent validation due to the ambiguity introduced.
4. This element may be used for signatures. If this element is used for experimental extensions, such extensions may not be supported by all users or in future versions of EDXL-DE. |
|
Used In |
3.2.4 OtherContent Element and Sub-elements
|
OtherContent |
|
|
Type |
XML Structure |
|
Usage |
CONDITIONAL, MUST use once if ContentXML is not used |
|
Definition |
Container for content provided in a non-XML MIME type. |
|
Comments |
1. The <OtherContent> container MUST contain either <ContentData> or <Uri> or both. 2. If the <Uri> element is used in conjunction with the <ContentData> element, it must reference a data location that contains the same data as is contained in the <ContentData> element. |
|
Sub-elements |
Uri [0..1] ContentData [0..1] |
|
Used In |
|
MimeType |
|
|
Type |
ct:EDXLStringType |
|
Usage |
REQUIRED, MUST be used once and only once |
|
Definition |
The format of the payload. |
|
Comments |
1. MIME content type and sub-type as described in [RFC 2046].
2. The string length of the identifier MUST be less than 1024.
3. MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
|
Size |
|
|
Type |
xsd:integer |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
The file size of the payload. |
|
Comments |
1. Value must be in bytes and represent the raw file size (not encoded or encrypted). |
|
Used In |
|
Digest |
|
|
Type |
xsd:base64Binary |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
The digest value for the payload. |
|
Comments |
1. Used to ensure the integrity of the payload.
2. Calculated using the Secure Hash Algorithm (SHA-1) 3. MUST be a hexadecimal representation of a SHA-1 Hash followed by a BASE 64-encoding to be carried in a non-CDATA element. |
|
Used In |
OtherContent |
|
Uri |
|
|
Type |
xsd:anyURI |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
A Uniform Resource Identifier that can be used to retrieve the identified resource. |
|
Comments |
1. May be a full absolute URI, typically a Uniform Resource Locator, that can be used to retrieve the resource over the Internet. 2. May be a relative URI naming a file. This may be just a pointer to a file or specifically to the file represented in the <ContentData>. |
|
Used In |
|
ContentData |
|
|
Type |
xsd:base64Binary |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
The base-64 encoded data content. |
|
Comments |
1. MAY be used either with or instead of the <Uri> element in contexts where retrieval of a resource via a URI is not feasible. 2. MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
3.2.5 ContentXML Element and Sub-elements
|
ContentXML |
|
|
Type |
XML Structure |
|
Usage |
CONDITIONAL, MUST use once and only once if OtherContent is not used |
|
Definition |
Container for valid-namespaced XML data. |
|
Comments |
An optional namespace attribute may be included. |
|
Sub-elements |
KeyXMLContent [0..1]
EmbeddedXMLContent [1..1] |
|
Used In |
|
KeyXMLContent |
|
|
Type |
XML content from any namespace other than the DE 2.0 namespace |
|
Usage |
OPTIONAL, MAY use once and only once |
|
Definition |
A container element for collected fragments of valid XML. |
|
Comments |
1. Extracts must come from the XML document contained within the
<EmbeddedXMLContent> element within the current <ContentObject> block.
2. All content within this element MUST be explicitly namespaced as defined in the enclosing <ContentObject> tag. 3. MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
|
EmbeddedXMLContent |
|
|
Type |
XML content from any namespace other than the DE 2.0 namespace |
|
Usage |
CONDITIONAL, REQUIRED if parent element ContentXml is present, MAY use only one per content object |
|
Definition |
The <EmbeddedXMLContent> element is an open container for valid XML from an explicit namespaced XML Schema. |
|
Comments |
1. The content MUST be a separately-namespaced well-formed XML document.
2. The enclosed XML content MUST be explicitly namespaced as defined in the enclosing <EmbeddedXMLContent> tag. 3. Enclosed XML content may be encrypted and/or signed within this element. 4. This element MUST be present if parent element, ContentXML, is present. |
|
Used In |
3.2.6 Explicit Addressing
|
Element |
ExplicitAddressScheme |
|
Type |
ct:EDXLStringType |
|
Usage |
REQUIRED, MUST use once and only once |
|
Definition |
Identifies the distribution addressing scheme used. |
|
Comments |
1. MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
|
Element |
ExplicitAddressValue |
|
Type |
ct:EDXLStringType |
|
Usage |
REQUIRED, MAY use multiple |
|
Definition |
A properly formed -escaped if necessary- XML string denoting the addressees value. |
|
Comments |
1. MUST be a properly formed -escaped if necessary- XML string. |
|
Used In |
An XML 1.0 element is a conforming EDXL-DE-v2.0 Message if and only if:
a) it meets the general requirements specified in Section 3;
b) if its namespace name is "urn:oasis:names:tc:emergency:EDXL:DE:2.0", and the element is valid according to the schema located at http://docs.oasis-open.org/emergency/EDXL-DE-v2.0/EDXL-DE-v2.0.xsd
c) if its namespace name is "urn:oasis:names:tc:emergency:EDXL:DE:2.0", then its content(which includes the content of each of its descendants) meets all the additional mandatory requirements provided in the specific subsection of Section 3 corresponding to the element’s name.
The following individuals have participated in the creation of this specification and are
gratefully acknowledged
Participants:
Rex Brooks, Network Centric Operations Industry Consortium (NCOIC)
Martena Gooch, SAIC,Contractor for the FEMA NPD P-TAC Center
Gary Ham, Individual
Werner Joerg, IEM
Hans Jespersen, Solace Systems
Elysa Jones, Individual
Lew Leinenweber, Evolution Technologies, Inc.
Don McGarry, The MITRE Corporation
Jeff Waters, DOD
The EDXL-DistributionElement XML Schema is provided here for convenience,the schema can be downloaded at the OASIS website: http://docs.oasis-open.org/emergency/
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:edxl-gsf="urn:oasis:names:tc:emergency:edxl:gsf:1.0"
xmlns:ct="urn:oasis:names:tc:emergency:edxl:ct:1.0" xmlns="urn:oasis:names:tc:emergency:EDXL:DE:2.0"
xmlns:gml="http://www.opengis.net/gml/3.2" targetNamespace="urn:oasis:names:tc:emergency:EDXL:DE:2.0"
elementFormDefault="qualified"
attributeFormDefault="unqualified" version="1.0CD">
<xs:import namespace="http://www.w3.org/1999/xlink" schemaLocation="./other-supporting-schema/xlink.xsd"/>
<xs:import namespace="urn:oasis:names:tc:emergency:edxl:gsf:1.0" schemaLocation="./other-supporting-schema/EDXLCT_wd05/edxl-gsf.v1.0.xsd"/>
<xs:import namespace="urn:oasis:names:tc:emergency:edxl:ct:1.0" schemaLocation="./edxl-de-dvl-v2.0-wd09.xsd"/>
<xs:element name="EDXLDistribution" type="DEDistributionType"/>
<xs:complexType name="DEDistributionType">
<xs:complexContent>
<xs:extension base="DEEnvelopeType">
<xs:sequence>
<xs:element ref="Descriptor" minOccurs="0" maxOccurs="1"/>
<xs:element ref="Content" minOccurs="0" maxOccurs="1"/>
<xs:element name="Other" type="AnyXMLType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attributeGroup ref="xlink:extendedAttrs"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
<xs:complexType name="DEEnvelopeType">
<xs:sequence>
<xs:element name="DistributionID" type="ct:EDXLStringType" minOccurs="1"/>
<xs:element name="SenderID" type="ct:EDXLStringType" minOccurs="1"/>
<xs:element name="DateTimeSent" type="ct:EDXLDateTimeType" minOccurs="1"/>
<xs:element name="DateTimeExpires" type="ct:EDXLDateTimeType" minOccurs="1"/>
<xs:element name="DistributionStatus" type="DistributionStatusType" minOccurs="1"/>
<xs:element name="DistributionKind" type="DistributionType" minOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:element name="Descriptor" type="DEDescriptorType"/>
<xs:complexType name="DEDescriptorType">
<xs:sequence>
<xs:element name="CombinedConfidentiality" type="ConfidentialityType" minOccurs="0"/>
<xs:element name="Language" type="xs:language" minOccurs="0"/>
<xs:element name="SenderRole" type="ct:ValueListType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="RecipientRole" type="ct:ValueListType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="Keyword" type="ct:ValueListType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="ExplicitAddress" type="ValueSchemeType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="TargetAreas" type="TargetAreasType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="Urgency" type="UrgencyType" minOccurs="0"/>
<xs:element name="Severity" type="SeverityType" minOccurs="0"/>
<xs:element name="Certainty" type="CertaintyType" minOccurs="0"/>
<xs:element name="IncidentID" type="ct:EDXLStringType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="IncidentDescription" type="ct:EDXLStringType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element ref="Link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attributeGroup ref="xlink:resourceAttrs"/>
</xs:complexType>
<xs:element name="Content" type="DEContentType"/>
<xs:complexType name="DEContentType">
<xs:sequence>
<xs:element ref="ContentObject" minOccurs="1" maxOccurs="unbounded"/>
<xs:element ref="Link" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attributeGroup ref="xlink:resourceAttrs"/>
</xs:complexType>
<xs:element name="Link" type="DELinkType"/>
<xs:complexType name="DELinkType">
<xs:attributeGroup ref="xlink:arcAttrs"/>
</xs:complexType>
<xs:element name="ContentDescriptor" type="DEContentDescriptorType"/>
<xs:complexType name="DEContentDescriptorType">
<xs:sequence>
<xs:element name="ContentDescription" type="ct:EDXLStringType" minOccurs="0" maxOccurs="1"/>
<xs:element name="ContentKeyword" type="ct:ValueListType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="OriginatorRole" type="ct:ValueListType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="ConsumerRole" type="ct:ValueListType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="ContentID" type="ct:EDXLStringType" minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="Confidentiality" type="ConfidentialityType" minOccurs="0" maxOccurs="1"/>
<xs:element name="ContentLanguage" type="xs:language" minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:element name="ContentObject" type="DEContentObjectType"/>
<xs:complexType name="DEContentObjectType">
<xs:sequence>
<xs:element ref="ContentDescriptor" minOccurs="0" maxOccurs="1"/>
<xs:choice minOccurs="1" maxOccurs="1">
<xs:element name="ContentXML" type="ContentXmlType"/>
<xs:element name="OtherContent" type="OtherContentType"/>
</xs:choice>
<xs:element name="Other" type="AnyXMLType" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attributeGroup ref="xlink:resourceAttrs"/>
</xs:complexType>
<xs:complexType name="OtherContentType" mixed="false">
<xs:sequence>
<xs:element name="MimeType" type="ct:EDXLStringType" minOccurs="1"/>
<xs:element name="Size" type="xs:integer" minOccurs="0"/>
<xs:element name="Digest" type="xs:base64Binary" minOccurs="0"/>
<xs:element name="Uri" type="xs:anyURI" minOccurs="0"/>
<xs:element name="ContentData" type="xs:base64Binary" minOccurs="0" />
</xs:sequence>
</xs:complexType>
<xs:complexType name="ContentXmlType" mixed="false">
<xs:sequence>
<xs:element name="KeyXMLContent" type="AnyXMLType" minOccurs="0" maxOccurs="1"/>
<xs:element name="EmbeddedXMLContent" type="AnyXMLType" minOccurs="1" maxOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="AnyXMLType">
<xs:sequence>
<xs:any namespace="##other"
processContents="lax" maxOccurs="1"/>
</xs:sequence>
<xs:anyAttribute namespace="##other"
processContents="lax"/>
</xs:complexType>
<xs:complexType name="TargetAreasType">
<xs:sequence>
<xs:element name="AreaKind" type="AreaKindType" minOccurs="1" maxOccurs="1"/>
<xs:element name="AreaGrouping" type="AreaGroupingType" minOccurs="1" maxOccurs="1"/>
<xs:element name="TargetArea" type="TargetAreaType" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="TargetAreaType">
<xs:choice>
<xs:element ref="edxl-gsf:EDXLGeoLocation" minOccurs="1" maxOccurs="1"/>
<xs:element name="GeoPoliticalLocation" type="ct:EDXLGeoPoliticalLocationType" minOccurs="1" maxOccurs="1"/>
</xs:choice>
</xs:complexType>
<xs:complexType name="ValueSchemeType">
<xs:sequence>
<xs:element name="ExplicitAddressScheme" type="ct:EDXLStringType"/>
<xs:element name="ExplicitAddressValue" type="ct:EDXLStringType" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="AreaKindType">
<xs:choice>
<xs:element name="AreaKindValueList" type="ct:ValueKeyType"/>
<xs:element name="AreaKindDefault" type="ct:AreaKindDefaultType"/>
</xs:choice>
</xs:complexType>
<xs:simpleType name="AreaGroupingType">
<xs:restriction base="xs:string">
<xs:enumeration value="Intersection"/>
<xs:enumeration value="Union"/>
<xs:enumeration value="ExclusiveOr"/>
<xs:enumeration value="Complement"/>
<xs:enumeration value="OtherGroupingType"></xs:enumeration>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="ConfidentialityType">
<xs:choice>
<xs:element name="ConfidentialityValueList" type="ct:ValueKeyType"/>
<xs:element name="ConfidentialityDefault" type="ct:ConfidentialityDefaultType"/>
</xs:choice>
</xs:complexType>
<xs:complexType name="CertaintyType">
<xs:choice>
<xs:element name="CertaintyValueList" type="ct:ValueKeyType"/>
<xs:element name="CertaintyDefault" type="ct:CertaintyDefaultType"/>
</xs:choice>
</xs:complexType>
<xs:complexType name="DistributionType">
<xs:choice>
<xs:element name="DistributionKindValueList" type="ct:ValueKeyType"/>
<xs:element name="DistributionKindDefault" type="ct:DistributionDefaultType"/>
</xs:choice>
</xs:complexType>
<xs:complexType name="DistributionStatusType">
<xs:choice>
<xs:element name="StatusKindValueList" type="ct:ValueKeyType"/>
<xs:element name="StatusKindDefault" type="ct:StatusKindDefaultType"/>
</xs:choice>
</xs:complexType>
<xs:complexType name="SeverityType">
<xs:choice>
<xs:element name="SeverityValueList" type="ct:ValueKeyType"/>
<xs:element name="SeverityDefault" type="ct:SeverityDefaultType"/>
</xs:choice>
</xs:complexType>
<xs:complexType name="UrgencyType">
<xs:choice>
<xs:element name="UrgencyValueList" type="ct:ValueKeyType"/>
<xs:element name="UrgencyDefault" type="ct:UrgencyDefaultType"/>
</xs:choice>
</xs:complexType>
</xs:schema>
The EDXL-DistributionElement 2.0 XML Schema imports a separate schema for providing defaults. This defaults schema is provided below for convenience, but it is also available at: http://docs.oasis-open.org/emergency/
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ct="urn:oasis:names:tc:emergency:edxl:ct:1.0"
targetNamespace="urn:oasis:names:tc:emergency:edxl:ct:1.0" elementFormDefault="qualified" attributeFormDefault="unqualified">
<xs:include schemaLocation="./other-supporting-schema/EDXLCT_wd05/edxl-ct-v1.0-wd05.xsd"/>
<!--Default ValueLists-->
<!--
*************** AREA KIND ******************* -->
<xs:simpleType name="AreaKindTypeDefaultURI">
<xs:restriction base="ct:ValueListURIType">
<xs:enumeration value="urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:AreaKindType"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="AreaKindTypeDefaultValues">
<xs:restriction base="ct:ValueType">
<xs:enumeration value="SourceTargetArea"/>
<xs:enumeration value="DistributionTargetArea"/>
<xs:enumeration value="OtherTargetArea"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="AreaKindDefaultType">
<xs:complexContent>
<xs:restriction base="ct:ValueKeyType">
<xs:sequence maxOccurs="1">
<xs:element name="ValueListURI" type="ct:AreaKindTypeDefaultURI"/>
<xs:element name="Value" type="ct:AreaKindTypeDefaultValues"/>
</xs:sequence>
</xs:restriction>
</xs:complexContent>
</xs:complexType>
<!-- *************** DISTRIBUTION TYPE *******************
-->
<xs:simpleType name="DisTypeDefaultURI">
<xs:restriction base="ct:ValueListURIType">
<xs:enumeration value="urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:DistributionType"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="DistTypeDefaultValues">
<xs:restriction base="ct:ValueType">
<xs:enumeration value="Report"/>
<xs:enumeration value="Update"/>
<xs:enumeration value="Cancel"/>
<xs:enumeration value="Request"/>
<xs:enumeration value="Response"/>
<xs:enumeration value="Dispatch"/>
<xs:enumeration value="Ack"/>
<xs:enumeration value="Error"/>
<xs:enumeration value="SensorConfiguration"/>
<xs:enumeration value="SensorControl"/>
<xs:enumeration value="SensorStatus"/>
<xs:enumeration value="SensorDetection"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="DistributionDefaultType">
<xs:complexContent>
<xs:restriction base="ct:ValueKeyType">
<xs:sequence maxOccurs="1">
<xs:element name="ValueListURI" type="ct:DisTypeDefaultURI"/>
<xs:element name="Value" type="ct:DistTypeDefaultValues"/>
</xs:sequence>
</xs:restriction>
</xs:complexContent>
</xs:complexType>
<!-- *************** CONFIDENTIALITY *******************
-->
<xs:simpleType name="ConfidentialityTypeDefaultURI">
<xs:restriction base="ct:ValueListURIType">
<xs:enumeration value="urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:ConfidentialityType"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="ConfidentialityTypeDefaultValues">
<xs:restriction base="ct:ValueType">
<xs:enumeration value="Unclassified"/>
<xs:enumeration value="Classified"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="ConfidentialityDefaultType">
<xs:complexContent>
<xs:restriction base="ct:ValueKeyType">
<xs:sequence maxOccurs="1">
<xs:element name="ValueListURI" type="ct:ConfidentialityTypeDefaultURI"/>
<xs:element name="Value" type="ct:ConfidentialityTypeDefaultValues"/>
</xs:sequence>
</xs:restriction>
</xs:complexContent>
</xs:complexType>
<!-- *************** STATUS ******************* -->
<xs:simpleType name="StatusKindDefaultURI">
<xs:restriction base="ct:ValueListURIType">
<xs:enumeration value="urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:StatusKind"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="StatusKindDefaultValues">
<xs:restriction base="ct:ValueType">
<xs:enumeration value="Actual"/>
<xs:enumeration value="Exercise"/>
<xs:enumeration value="System"/>
<xs:enumeration value="Test"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="StatusKindDefaultType">
<xs:complexContent>
<xs:restriction base="ct:ValueKeyType">
<xs:sequence maxOccurs="1">
<xs:element name="ValueListURI" type="ct:StatusKindDefaultURI"/>
<xs:element name="Value" type="ct:StatusKindDefaultValues"/>
</xs:sequence>
</xs:restriction>
</xs:complexContent>
</xs:complexType>
<!-- *************** CERTAINTY ******************* -->
<xs:simpleType name="CertaintyTypeDefaultURI">
<xs:restriction base="ct:ValueListURIType">
<xs:enumeration value="urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:Certainty"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="CertaintyTypeDefaultValues">
<xs:restriction base="ct:ValueType">
<xs:enumeration value="Observed"/>
<xs:enumeration value="Likely"/>
<xs:enumeration value="Possible"/>
<xs:enumeration value="Unlikely"/>
<xs:enumeration value="Unknown"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="CertaintyDefaultType">
<xs:complexContent>
<xs:restriction base="ct:ValueKeyType">
<xs:sequence maxOccurs="1">
<xs:element name="ValueListURI" type="ct:CertaintyTypeDefaultURI"/>
<xs:element name="Value" type="ct:CertaintyTypeDefaultValues"/>
</xs:sequence>
</xs:restriction>
</xs:complexContent>
</xs:complexType>
<!-- *************** SEVERITY ******************* -->
<xs:simpleType name="SeverityTypeDefaultURI">
<xs:restriction base="ct:ValueListURIType">
<xs:enumeration value="urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:Severity"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="SeverityTypeDefaultValues">
<xs:restriction base="ct:ValueType">
<xs:enumeration value="Extreme"/>
<xs:enumeration value="Severe"/>
<xs:enumeration value="Moderate"/>
<xs:enumeration value="Minor"/>
<xs:enumeration value="Unknown"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="SeverityDefaultType">
<xs:complexContent>
<xs:restriction base="ct:ValueKeyType">
<xs:sequence maxOccurs="1">
<xs:element name="ValueListURI" type="ct:SeverityTypeDefaultURI"/>
<xs:element name="Value" type="ct:SeverityTypeDefaultValues"/>
</xs:sequence>
</xs:restriction>
</xs:complexContent>
</xs:complexType>
<!-- *************** URGENCY ******************* -->
<xs:simpleType name="UrgencyTypeDefaultURI">
<xs:restriction base="ct:ValueListURIType">
<xs:enumeration value="urn:oasis:names:tc:emergency:EDXL:DE:2.0:Defaults:Urgency"/>
</xs:restriction>
</xs:simpleType>
<xs:simpleType name="UrgencyTypeDefaultValues">
<xs:restriction base="ct:ValueType">
<xs:enumeration value="Immediate"/>
<xs:enumeration value="Expected"/>
<xs:enumeration value="Future"/>
<xs:enumeration value="Past"/>
<xs:enumeration value="Unknown"/>
</xs:restriction>
</xs:simpleType>
<xs:complexType name="UrgencyDefaultType">
<xs:complexContent>
<xs:restriction base="ct:ValueKeyType">
<xs:sequence maxOccurs="1">
<xs:element name="ValueListURI" type="ct:UrgencyTypeDefaultURI"/>
<xs:element name="Value" type="ct:UrgencyTypeDefaultValues"/>
</xs:sequence>
</xs:restriction>
</xs:complexContent>
</xs:complexType>
<!--/Default ValueLists-->
</xs:schema>
|
Revision |
Date |
Editor |
Changes Made |
|
Edxl-de-v2.0-wd02 |
26 Sept 2011 |
Jeff Waters |
First Full Working Draft |
|
Edxl-de-v2.0-wd03 |
11 Oct 2011 |
Jeff Waters |
Added recommended changes by Martena Gooch, as recorded in the document at http://www.oasis-open.org/apps/org/workgroup/emergency-if/download.php/43842/de-notes-fixed-in-wd02.doc |
|
Edxl-de-v2.0-wd04 |
18 Oct 2011 |
Jeff Waters |
Added recommended changes by Martena Gooch. |
|
Edxl-de-v2.0-wd05 |
25 Oct 2011 |
Jeff Waters |
Added recommended changes by Werner Joerg, including multiplicities for sub elements |
|
Edxl-de-v2.0-wd08 |
31 Jul 2012 |
Jeff Waters |
Removed DistributionReference, added AreaGrouping, and addressed other recommended changes to add flexibility and streamline schema |
|
Edxl-de-v2.0-wd09 |
21 Aug 2012 |
Jeff Waters |
Restored RecipientRole, SenderRole, Keyword, updated diagram, and performed other cleanup |