Emergency Data Exchange Language (EDXL) Distribution Element, v. 1.0
Committee Draft, 19, August 2005
Document Identifier:
EDXL-DE-V1.0
OASIS Identifier:
{EMTC}-{EDXL-DE}-{1.0} (HTML) (Word) (PDF)
Location:
This Version: http://docs.oasis-open.org/emergency/EDXL-DE/V1.0
Technical Committee:
OASIS Emergency Management TC
Chair(s):
Elysa Jones, Warning Systems, Inc - <ejones@warningsystems.com>
Editor(s):
Michelle Raymond, Honeywell ACS Labs
Sylvia Webb, Individual
Subject / Keywords:
distribution element, dissemination, routing, payload, alert, resource message, emergency, information sharing, data exchange, emergency response, emergency management, geospatial, political, target area, message delivery, message sender, message recipient, distribution status, distribution type, sender role, recipient role, response type, event cause, confidentiality, circle, polygon, location, content object, consumer role, notification, XML message, distribution type, geography, incident, sender identification, sender id, recipient identification, recipient id, inter-agency, emergency information, functional role, recipient address, hazard, distribution status, distribution type, event type, event etiology, message processor, event stage, resource code and response type
Related Work:
This specification is related to:
Abstract:
This Distribution Element specification describes a standard message distribution framework for data sharing among emergency information systems using the XML-based Emergency Data Exchange Language (EDXL). This format may be used over any data transmission system, including but not limited to the SOAP HTTP binding.
Status:
This document was last revised or approved by the Emergency Management Technical Committee on the above date. The level of approval is also listed above. Check the current location noted above for possible later revisions of this document. This document is updated periodically on no particular schedule.
Technical Committee members should send comments on this specification 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 www.oasis-open.org/committees/emergency.
For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the Technical Committee web page at www.oasis-open.org/committees/emergency/ipr.php.
Notices
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's procedures with respect to rights in OASIS specifications can be found at 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 specification, can be obtained from the OASIS President.
OASIS invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to implement this specification. Please address the information to the OASIS President.
Copyright © OASIS Open 2004. All Rights Reserved.
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 paragraph are included on all such copies and derivative works. However, this document itself does not be modified in any way, such as by removing the copyright notice or references to OASIS, except as needed for the purpose of developing OASIS specifications, in which case the procedures for copyrights defined in the OASIS Intellectual Property Rights document 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 RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Table of Contents
1.1 Purpose
1.2 History
1.3 Structure of the EDXL Distribution Element
1.3.1 <EDXLDistribution>
1.3.2 <targetArea>
1.3.3 <contentObject>
1.4 Application of the EDXL Distribution Element
1.5 Terminology
2 Design Principles and Concepts (non-normative)
3 EDXLDistribution Element Structure (normative)
3.2 Data Dictionary
3.2.1 EDXLDistribution Element and Sub-elements
3.2.2 targetArea Element and Sub-elements
3.2.3 contentObject Element and Sub-elements
3.2.4 nonXMLContent Element and Sub-elements
3.2.5 xmlContent Element and Sub-elements
3.2.6 List and Associated Value(s) Support
A. XML Schema for the EDXLDistribution Element
C. Revisions
The primary purpose of the Distribution Element is to facilitate the routing of any properly formatted XML 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 ID’s.
The Disaster Management 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 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.
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.
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 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.
The <targetArea> is a container element for the geo-spatial or political area targeting of 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.
The <contentObject> is a container element for specific messages. The <contentObject> element MUST either contain an <xmlContent> content container or a <nonXMLContent> 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.
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.
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” are to be interpreted as described in [RFC2119].
In addition, within this Specification, the keyword “CONDITIONAL” should be interpreted as potentially “REQUIRED” or “OPTIONAL” depending on the surrounding context.
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.
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.
N. Freed, XML Schema Part 2: Datatypes Second Edition, http://www.w3.org/TR/xmlschema-2/#dateTime, W3C REC-xmlschema-2, October 2004.
[TODO: Add WGS84 from the CAP 1.1 CD.] [TODO: ADD IEEE 1512, ]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 Cookbook
EDXL Distribution Element Cookbook, http://www.oasis-open.org/committees/document.php?document_id=14120&wg_abbrev=emergency, August 2005
2. Design Principles and Concepts (non-normative)
Below are some of the guiding principles of the Distribution Element:
The Distribution Element specification should:
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 Message/s 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. They send 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 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, and 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 set of messages are exchanged using the EDXL Distribution Element.
3. EDXLDistribution Element Structure (normative)
Bold indicates required element.
* indicates multiple instances allowed
3.2.1 EDXLDistribution Element and Sub-elements
The Distribution Message 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.
Element | EDXLDistribution |
---|---|
Type | XML Structure |
Usage | REQUIRED, MUST use once, top level container |
Definition | The container of all of the elements related to the distribution of the content messages. |
Comments |
|
Sub-elements | |
Used In | top level element |
Element | distributionID |
---|---|
Type | xsd:string |
Usage | REQUIRED, MUST use once |
Definition | The unique identifier of this distribution message. |
Comments |
|
Used In | EDXLDistribution |
Element | senderID |
---|---|
Type | xsd:string |
Usage | REQUIRED, MUST use once |
Definition | The unique identifier of the sender. |
Comments |
|
Used In | EDXLDistribution |
Element | dateTimeSent |
---|---|
Type | xsd:dateTime |
Usage | REQUIRED, MUST use once |
Definition | The date and time the distribution message was sent. |
Comments |
|
Used In | EDXLDistribution |
Element | distributionStatus |
---|---|
Type | xsd:string with restrictions |
Usage | REQUIRED, MUST use once |
Definition | The actionability of the message. |
Comments |
Value must be one of:
|
Used In | EDXLDistribution |
Element | distributionType |
---|---|
Type | xsd:string with restrictions |
Usage | REQUIRED, MUST use once |
Definition | The function of the message. |
Comments |
Value must be one of:
|
Used In | EDXLDistribution |
Element | senderRole |
---|---|
Type | List and Associated Value(s) |
Usage | OPTIONAL, MAY use multiple |
Definition | The functional role of the sender, as it may determine message routing decisions. |
Comments |
|
Sub-elements | |
Used In | EDXLDistribution |
Element | recipientRole |
---|---|
Type | List and Associated Value(s) |
Usage | OPTIONAL, MAY use multiple |
Definition | The functional role of the recipient, as it may determine message routing decisions. |
Comments |
|
Sub-elements | |
Used In | EDXLDistribution |
Element | keyword |
---|---|
Type | List and Associated Value(s) |
Usage | OPTIONAL, MAY use multiple |
Definition | The topic related to the distribution message, as it may determine message routing decisions. |
Comments |
|
Sub-elements | |
Used In | EDXLDistribution |
Element | distributionReference |
---|---|
Type | xsd:string |
Usage | CONDITIONAL, MAY use multiple |
Definition | A reference to a previous distribution message. |
Comments |
|
Used In | EDXLDistribution |
Element | explicitAddress |
---|---|
Type | XML Structure |
Usage | OPTIONAL, MAY use multiple |
Definition | The identifier of an explicit recipient. |
Comments | Identifies human parties, systems, services, or devices that are all potential recipients of the distribution message. |
Sub-elements | |
Used In | EDXLDistribution |
Element | explicitAddressScheme |
---|---|
Type | xsd:string |
Usage | REQUIRED, MUST use only once |
Definition | Identifies the distribution addressing scheme used. |
Comments | MUST be a properly formed -escaped if necessary- XML string. Examples for this type of distribution includes - email, military USMTF, etc. . . |
Used In | explicitAddress |
Element | explicitAddressValue |
---|---|
Type | xsd:string |
Usage | REQUIRED, MAY use multiple |
Definition | A properly formed -escaped if necessary- XML string denoting the addressees value. |
Used In | explicitAddress |
Element | combindedConfidentiality |
---|---|
Type | xsd:string |
Usage | CONDITIONAL, MAY use once |
Definition | Confidentiality of the combined distribution message’s content. |
Comments |
|
Used In | EDXLDistribution |
3.2.2 targetArea Element and Sub-elements
The <targetArea> is a container element for the geospatial or political area targeting of 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.
Element | targetArea |
---|---|
Type | XML Structure |
Usage | OPTIONAL, MAY use multiple |
Definition | The container element for location information. |
Comments | Multiple <targetArea> blocks may appear in a single <EDXLDistribution> element, in which case the target area for the current message is the union of all areas described in the various <targetArea> structures. |
Sub-elements | |
Used In | EDXLDistribution |
Element | circle |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use multiple |
Definition | An enclosed geographic area within a given radius around a geographic point. |
Comments |
|
Used In | targetArea |
Element | polygon |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use multiple |
Definition | An enclosed geographic area within a simple closed polygon defined by an ordered set of vertices. |
Comments |
|
Used In | targetArea |
Element | country |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use multiple |
Definition | The code of the country. |
Comments |
|
Used In | targetArea |
Element | subdivision |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use multiple |
Definition | The ISO 3166-2 designator for the administrative subdivision concerned. |
Comments |
|
Used In | targetArea |
Element | locCodeUN |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use multiple |
Definition | The UN/LOCODE designator for the location concerned. |
Comments |
|
Used In | targetArea |
3.2.3 contentObject Element and Sub-elements
The <contentObject> element is the container element for specific messages. The <contentObject> element MUST either contain an <xmlContent> content container or a <nonXMLContent> 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.
Element | contentObject |
---|---|
Type | XML Structure |
Usage | OPTIONAL, MAY use multiple |
Definition | The container element for message data and content. |
Comments |
|
Sub-elements | |
Used In | EDXLDistribution |
Element | contentDescription |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use once |
Definition | The human-readable text describing the content object. |
Comments | MUST be a properly formed -escaped if necessary- XML string. Examples: "CAP message from FEMA", "Map of affected area" or "Photo of missing child". |
Used In | contentObject |
Element | contentKeyword |
---|---|
Type | List and Associated Value(s) |
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 |
|
Sub-elements | |
Used In | contentObject |
Element | originatorRole |
---|---|
Type | List and Associated Value(s) |
Usage | OPTIONAL, MAY use multiple |
Definition | The functional role of the message originator, as it may determine message distribution and presentation decisions. |
Comments |
|
Sub-elements | |
Used In | contentObject |
Element | consumerRole |
---|---|
Type | List and Associated Value(s) |
Usage | OPTIONAL, MAY use multiple |
Definition | The functional role of the message consumer, as it may determine message distribution and presentation decisions. |
Comments |
|
Sub-elements | |
Used In | contentObject |
Element | confidentiality |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use once |
Definition | Special requirements regarding confidentiality of the content of this <contentObject>. |
Comments | MUST be a properly formed -escaped if necessary- XML string. |
Used In | contentObject |
3.2.4 nonXMLContent Element and Sub-elements
Element | nonXMLContent |
---|---|
Type | XML Structure |
Usage | CONDITIONAL, optional |
Definition | Container for content provided in a non-XML MIME type. |
Comments |
|
Sub-elements | |
Used In | contentObject |
Element | mimeType |
---|---|
Type | xsd:string |
Usage | REQUIRED, MUST use once |
Definition | The format of the content. |
Comments |
|
Used In | nonXMLContent |
Element | size |
---|---|
Type | xsd:integer |
Usage | OPTIONAL, MAY use once |
Definition | The file size of the content object item . |
Comments | Value must be in bytes and represent the raw file size (not encoded or encrypted). |
Used In | nonXMLContent |
Element | digest |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use once |
Definition | The digest value for the content object. |
Comments |
|
Used In | nonXMLContent |
Element | uri |
---|---|
Type | xsd:anyURI |
Usage | OPTIONAL, MAY use once |
Definition | A Uniform Resource Identifier that can be used to retrieve the identified resource. |
Comments |
|
Used In | nonXMLContent |
Element | contentData |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use once |
Definition | The base-64 encoded data content. |
Comments |
|
Used In | nonXMLContent |
3.2.5 xmlContent Element and Sub-elements
Element | xmlContent |
---|---|
Type | XML Structure |
Usage | CONDITIONAL, optional |
Definition | Container for valid-namespaced XML data. |
Sub-elements | |
Used In | contentObject |
Element | keyXmlContent |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use once |
Definition | A container element for collected fragments of valid XML. |
Comments |
|
Used In | xmlContent |
Element | embeddedXMLContent |
---|---|
Type | xsd:string |
Usage | OPTIONAL, MAY use once |
Definition | The <embeddedXMLContent> element is an open container for valid XML from an explicit namespaced XML Schema. |
Comments |
|
Used In | xmlContent |
3.2.5 List and Associated Value(s) Support
Element | valueListUrn |
---|---|
Type | xsd:string |
Usage | conditional |
Definition | The name of a certified list maintained by the Community of Interest (COI) for the value referenced. |
Used In |
Element | value |
---|---|
Type | xsd:string |
Usage | conditional |
Definition | A value from a certified list maintained by the Community of Interest (COI) for the referenced element. |
Used In |
Appendix A. XML Schema for the EDXLDistribution Element
<?xml version="1.0" encoding="UTF-8"?> <schema xmlns="http://www.w3.org/2001/XMLSchema" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:ed="urn:oasis:names:tc:emergency:EDXL:DE:1.0" targetNamespace="urn:oasis:names:tc:emergency:EDXL:DE:1.0" elementFormDefault="qualified" attributeFormDefault="unqualified"> <!-- In a closed system where all content must be validated imports of allowed namespaces could be included: <import namespace="urn:oasis:names:tc:emergency:cap:1.1" schemaLocation="file://c://schemas//CAP1_1.xsd" /> <import namespace="http://www.incident.com/cap/1.0" schemaLocation="file://c://schemas//CAP1_0.xsd" /> <import namespace="http://www.dtra.mil/acrs/event" schemaLocation="file://c://schemas//UNWDSensorEvent.xsd" /> --> <element name="EDXLDistribution"> <annotation> <documentation> The container of all of the elements related to the distribution of the content messages. </documentation> <documentation> 1. The <EDXLDistribution> element MAY include <targetArea> and <contentObject> blocks. 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. </documentation> </annotation> <complexType> <sequence> <element name="distributionID" type="xsd:string" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The unique identifier of this distribution message. </documentation> <documentation> 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. </documentation> </annotation> </element> <element name="senderID" type="xsd:string" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The unique identifier of the sender. </documentation> <documentation> 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. MUST be a properly formed -escaped if necessary- XML string. Examples: dispatcher@centerville.gov, 0006.0e39.ad80@petroplant </documentation> </annotation> </element> <element name="dateTimeSent" type="xsd:dateTime" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The date and time the distribution message was sent. </documentation> <documentation> 1. The Date Time combination must include the +/- offset time for time zone. 2. Must be in the W3C format for the XML dateTime data type. Example: 2004-08-01T16:49:00-07:00 </documentation> </annotation> </element> <element name="distributionStatus" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The actionability of the message. </documentation> <documentation> Value must be one of: Actual - "Real-world" information for action Exercise - Simulated information for exercise participants System - Messages regarding or supporting network functions Test - Discardable messages for technical testing only </documentation> </annotation> <simpleType> <restriction base="xsd:string"> <enumeration value="Actual"/> <enumeration value="Exercise"/> <enumeration value="System"/> <enumeration value="Test"/> </restriction> </simpleType> </element> <element name="distributionType" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The function of the message. </documentation> <documentation> Value must be one of: Report - New information regarding an incident or activity Update - Updated information superseding a previous message Cancel - A cancellation or revocation of a previous message Request - A request for resources, information or action Response - A response to a previous request Dispatch - A commitment of resources or assistance Ack - Acknowledgment of receipt of an earlier message Error - Rejection of an earlier message (for technical reasons) </documentation> </annotation> <simpleType> <restriction base="xsd:string"> <enumeration value="Ack"/> <enumeration value="Cancel"/> <enumeration value="Dispatch"/> <enumeration value="Error"/> <enumeration value="Report"/> <enumeration value="Request"/> <enumeration value="Response"/> <enumeration value="Update"/> </restriction> </simpleType> </element> <element name="senderRole" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The functional role of the sender, as it may determine message routing decisions. </documentation> <documentation> 1. The list and associated value(s) is in the form: <senderRole> <valueListUrn>valueListUrn</valueListUrn> <value>value</value> <value>value</value> </senderRole> where the content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions, and the content of each <value> is a string (which may represent a number) denoting the value itself. 2. Multiple instances of the <value> MAY occur with a single <valueListUrn> within the <senderRole> structure. 3. Multiple instances of <senderRole> MAY occur within a single <EDXLDistribution> block. </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions. </documentation> </annotation> </element> <element ref="ed:value" minOccurs="1" maxOccurs="unbounded"> <annotation> <documentation> The content of <value> is a string (which may represent a number) denoting the value itself. </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="recipientRole" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The functional role of the recipient, as it may determine message routing decisions. </documentation> <documentation> 1. The list and associated value(s) is in the form: <recipientRole> <valueListUrn>valueListUrn</valueListUrn> <value>value</value> <value>value</value> </reciepientRole> where the content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions, and the content of each <value> is a string (which may represent a number) denoting the value itself. 2. Multiple instances of the <value> MAY occur with a single <valueListUrn> within the <recipientRole> structure. 3. Multiple instances of <recipientRole> MAY occur within a single <EDXLDistribution> block. </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions. </documentation> </annotation> </element> <element ref="ed:value" minOccurs="1" maxOccurs="unbounded"> <annotation> <documentation> The content of <value> is a string (which may represent a number) denoting the value itself. </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="keyword" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The topic related to the distribution message, as it may determine message routing decisions. </documentation> <documentation> 1. The list and associated value(s) is in the form: <keyword> <valueListUrn>valueListUrn</valueListUrn> <value>value</value> <value>value</value> </keyword> where the content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions, and the content of each <value> is a string (which may represent a number) denoting the value itself. 2. Multiple instances of the <value> MAY occur with a single <valueListUrn> within the <keyword> structure. 3. Multiple instances of <keyword> MAY occur within a single <EDXLDistribution> block. Examples of things <keyword> might be used to describe include event type, event etiology, incident ID and response type. </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions. </documentation> </annotation> </element> <element ref="ed:value" minOccurs="1" maxOccurs="unbounded"> <annotation> <documentation> The content of <value> is a string (which may represent a number) denoting the value itself. </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="explicitAddress" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The identifier of an explicit recipient. </documentation> <documentation> Identifies human parties, systems, services, or devices that are all potential recipients of the distribution message. </documentation> </annotation> <complexType> <sequence> <element name="explicitAddressScheme" type="xsd:string" minOccurs="1" maxOccurs="1"> <annotation> <documentation> Identifies the distribution addressing scheme used. </documentation> <documentation> MUST be a properly formed -escaped if necessary- XML string. Examples for this type of distribution includes - email, military USMTF, etc . . . </documentation> </annotation> </element> <element name="explicitAddressValue" type="xsd:string" minOccurs="1" maxOccurs="unbounded"> <annotation> <documentation> A properly formed -escaped if necessary- XML string denoting the addressees value. </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="distributionReference" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> A reference to a previous distribution message. </documentation> <documentation> 1. The <distributionID> and <senderID> and <dateTimeSent> of the referenced previous message, concatenated with a comma delimiter. 2. This element should appear at least once in any message which updates, cancels or otherwise refers to another message. 3. MUST be a properly formed -escaped if necessary- XML string. Example: msgID0074,actor@domain-name,2004-08-01T16:49:00-07:00 </documentation> </annotation> </element> <element name="combinedConfidentiality" type="xsd:string" minOccurs="0" maxOccurs="1"> <annotation> <documentation> Confidentiality of the combined distribution message's content. </documentation> <documentation> 1. The <combindedConfidentiality> indicates the confidentiality of the combined <messageObject> sub-elements. Generally the combined confidentiality is the most restrictive of the <confidentiality> elements in the container <messageObject> element, but it can be more restrictive than any of the individual <confidentiality> elements. 2. If this element is not present, all content messages are assumed to be unclassified and not sensitive. 3. The <combindedConfidentiality> element MUST be present if a <confidentiality> element is present in any of the <contentObject> elements. 4. Application specific mechanisms will be required to determine the minimum confidentiality level in cases where different confidentiality schemes are used in the <contentObject>. 5. MUST be a properly formed -escaped if necessary- XML string. </documentation> </annotation> </element> <element name="targetArea" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The container element for location information. </documentation> <documentation> Multiple <targetArea> blocks may appear in a single <EDXLDistribution> element, in which case the target area for the current message is the union of all areas described in the various <targetArea> structures. </documentation> </annotation> <complexType> <sequence> <element name="circle" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> An enclosed geographic area within a given radius around a geographic point. </documentation> <documentation> 1.Represented in the form "latitude, longitude radius". 2. The central point is represented by lat-long values conforming to the WGS84 coordinate reference system. 3. The fixed mandatory attribute of "urn:ogc:def:crs:OGC:1.3:CRS84" must be included. 4. The radius value is expressed in kilometers. 5. MUST be a properly formed -escaped if necessary- XML string. Example: 38.26295, -122.07454 15 </documentation> </annotation> </element> <element name="polygon" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> An enclosed geographic area within a simple closed polygon defined by an ordered set of vertices. </documentation> <documentation> 1. Represented by a space-delimited series of latitude, longitude pairs, with the last pair identical to the first. 2. The lat-long values conform to the WGS84 coordinate reference system. 3. The fixed mandatory attribute of <urn:ogc:def:crs:OGC:1.3:CRS84> must be included. 4. MUST be a properly formed -escaped if necessary- XML string. Example: 42,-124.2102 42,-120.1 39,-120 35.0,-114.6328 34.35,- 120.4418 38.9383,-123.817 42,-124.2102 </documentation> </annotation> </element> <element name="country" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The code of the country. </documentation> <documentation> 1. The two-character ISO 3166-1 Country Code for the country concerned. 2. More specific target location information can be defined in the subdivision elements. 3. MUST be a properly formed -escaped if necessary- XML string. </documentation> </annotation> </element> <element name="subdivision" type="xsd:string" minOccurs="0"> <annotation> <documentation> The ISO 3166-2 designator for the administrative subdivision concerned. </documentation> <documentation> 1. The first two characters, before the hyphen, are the two character ISO 3166-1 Country Code for the country within which the designated subdivision is located. 2. The following one-to-three characters following the hyphen designate the particular subdivision. Examples: US-TX (U.S. State of Texas), DK-025 (Danish county Roskilde), MG-T (Antananarivo province, Madagascar) </documentation> </annotation> </element> <element name="locCodeUN" type="xsd:string" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The UN/LOCODE designator for the location concerned. </documentation> <documentation> 1. The two first digits are the two character ISO3166-1 Country Code for the country in which the place is located. 2. The following three characters are the UN/LOCODE designator for the particular location within that country. 3. No spaces or punctuation are used within this designator. Examples: USFFB (Fairfield, Alabama, USA), USSUU (Fairfield, California, USA), GBFFD (Falfield, South Gloucestershire, UK) </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="contentObject" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The container element for message data and content. </documentation> <documentation> 1. The <contentObject> element is the container element for specific messages. 2. The <contentObject> element MUST contain one of the two Content Schemes: a. <xmlContent>, for valid namespaced XML content or b. <nonXMLContent>, containing one or both of the elements <uri>, for reference to the content’s location, and <contentData>, for data encapsalated in the message. </documentation> </annotation> <complexType> <sequence> <element name="contentDescription" type="xsd:string" minOccurs="0" maxOccurs="1"> <annotation> <documentation> The human-readable text describing the content object. </documentation> <documentation> MUST be a properly formed -escaped if necessary- XML string. Examples: "CAP message from FEMA", "Map of affected area" or "Photo of missing child". </documentation> </annotation> </element> <element name="contentKeyword" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The topic related to the message data and content, as it may determine message distribution and presentation decisions. </documentation> <documentation> 1. The list and associated value(s) is in the form: <contentKeyword> <valueListUrn>valueListUrn</valueListUrn> <value>value</value> <value>value</value> </contentKeyword> where the content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions, and the content of each <value> is a string (which may represent a number) denoting the value itself. 2. Multiple instances of the <value> MAY occur with a single <valueListUrn> within the <contentKeyword> structure. 3. Multiple instances of <contentKeyword> MAY occur within a single <contentObject> block. Examples of things <contentKeyword> might be used to describe include message processor, event stage, resource code and response type. </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn" minOccurs="1" maxOccurs="unbounded"> <annotation> <documentation> The content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions. </documentation> </annotation> </element> <element ref="ed:value" minOccurs="1" maxOccurs="unbounded"> <annotation> <documentation> The content of <value> is a string (which may represent a number) denoting the value itself. </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="originatorRole" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The functional role of the message originator, as it may determine message distribution and presentation decisions. </documentation> <documentation> 1. The list and associated value(s) is in the form: <originatorRole> <valueListUrn>valueListUrn</valueListUrn> <value>value</value> <value>value</value> </originatorRole> where the content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions, and the content of each <value> is a string (which may represent a number) denoting the value itself. 2. Multiple instances of the <value> MAY occur with a single <valueListUrn> within the <originatorRole> structure. 3. Multiple instances of <originatorRole> MAY occur within a single <contentObject> block. </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn" minOccurs="1" maxOccurs="unbounded"> <annotation> <documentation> The content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions. </documentation> </annotation> </element> <element ref="ed:value" minOccurs="1" maxOccurs="unbounded"> <annotation> <documentation> The content of <value> is a string (which may represent a number) denoting the value itself. </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="consumerRole" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> The functional role of the message consumer, as it may determine message distribution and presentation decisions. </documentation> <documentation> 1. The list and associated value(s) is in the form: <consumerRole> <valueListUrn>valueListUrn</valueListUrn> <value>value</value> <value>value</value> </consumerRole> where the content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions, and the content of each <value> is a string (which may represent a number) denoting the value itself. 2. Multiple instances of the <value> MAY occur with a single <valueListUrn> within the <consumerRole> structure. 3. Multiple instances of <consumerRole> MAY occur within a single <contentObject; block. Example: <valueListUrn>http://www.dhs.gov/NiemRoleType</valueListUrn> <value>ICS Operations Branch</value> </documentation> </annotation> <complexType> <sequence> <element ref="ed:valueListUrn" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The content of <valueListUrn> is the Uniform Resource Name of a published list of values and definitions. </documentation> </annotation> </element> <element ref="ed:value" minOccurs="1" maxOccurs="unbounded"> <annotation> <documentation> The content of <value> is a string (which may represent a number) denoting the value itself. </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="confidentiality" type="xsd:string" minOccurs="0" maxOccurs="1"> <annotation> <documentation> Special requirements regarding confidentiality of the content of this <contentObject>. </documentation> <documentation> MUST be a properly formed -escaped if necessary- XML string. </documentation> </annotation> </element> <choice id="contentContainer" minOccurs="1" maxOccurs="1"> <element name="nonXMLContent" minOccurs="1" maxOccurs="1"> <complexType> <sequence> <element name="mimeType" type="xsd:string" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The format of the content. </documentation> <documentation> 1. MIME content type and sub-type as described in [RFC 2046]. 2. MUST be a properly formed -escaped if necessary- XML string. Examples: application/pdf, text/xml </documentation> </annotation> </element> <element name="size" type="xsd:integer" minOccurs="0" maxOccurs="1"> <annotation> <documentation> The file size of the content object item. </documentation> <documentation> 1.Value must be in bytes and represent the raw file size (not encoded or encrypted). 2. The <size> element MUST be used to indicate the size of the embedded content when the <contentData> element is used within the <nonXMLContent>. container. 3. The <size> element MAY be used to indicate the size of the resource accessed by the URI when the <uri> element is used within the <nonXMLContent> container. </documentation> </annotation> </element> <element name="digest" type="xsd:string" minOccurs="0"> <annotation> <documentation> The digital digest ("hash") of the content item. </documentation> <documentation> 1. Used to ensure the integrity of the content object. 2. Calculated using the Secure Hash Algorithm (SHA-1) per [FIPS 180-2] 3. MUST be a properly formed -escaped if necessary- XML string. </documentation> </annotation> </element> <element name="uri" type="xsd:anyURI" minOccurs="0" maxOccurs="1"> <annotation> <documentation> A Uniform Resource Identifier that can be used to retrieve the identified resource. </documentation> <documentation> 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 a reference to a file or specifically to the file represented in the <contentData>. </documentation> </annotation> </element> <element name="contentData" type="xsd:string" minOccurs="0" maxOccurs="1"> <annotation> <documentation> The base-64 encoded data content. </documentation> <documentation> MAY be used either with or instead of the <uri> element in contexts where retrieval of a resource via a URI is not feasible. </documentation> </annotation> </element> </sequence> </complexType> </element> <element name="xmlContent" minOccurs="1" maxOccurs="1"> <complexType> <sequence> <element name="keyXMLContent" minOccurs="0" maxOccurs="unbounded"> <annotation> <documentation> A container element for collected fragments of valid XML. </documentation> <documentation> 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 <embeddedXMLContent> tag. </documentation> </annotation> <complexType> <sequence> <any namespace="##any" processContents="lax" maxOccurs="unbounded"/> </sequence> <anyAttribute namespace="##other" processContents="lax"/> </complexType> </element> <element name="embeddedXMLContent" minOccurs="1" maxOccurs="1"> <annotation> <documentation> The Content XML element is an open container for valid XML from an explicit namespaced XML Schema. </documentation> <documentation> 1. The enclosed XML content MUST be explicitly namepaced as defined in the enclosing <xmlContent> container. 2. Enclosed XML content may be encrypted and/or signed within this element. </documentation> </annotation> <complexType> <sequence> <any namespace="##any" processContents="lax" maxOccurs="unbounded"/> </sequence> <anyAttribute namespace="##other" processContents="lax"/> </complexType> </element> </sequence> <anyAttribute namespace="##other" processContents="lax" /> </complexType> </element> </choice> </sequence> </complexType> </element> </sequence> </complexType> </element> <element name="valueListUrn" type="xsd:string"> <annotation> <documentation> The name of the certified list maintained by the Community of Interest (COI) for the value referenced. </documentation> </annotation> </element> <element name="value" type="xsd:string"> <annotation> <documentation> A value from a certified list maintained by the Community of Interest (COI) for the referenced element. </documentation> </annotation> </element> </schema>
OASIS Emergency Management Technical Committee:
Revision | Date | Editor | Contributor | Changes Made |
---|---|---|---|---|