As detailed in the EDXL-DE Specification, 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 or governmental jurisdiction is involved.
The primary purpose of the Emergency Data
Exchange Language Resource Messaging (EDXL-RM) Specification is to provide a
set of standard formats for XML emergency response messages. These Resource
Messages are specifically designed as payloads of Emergency Data Exchange
Language Distribution Element- (EDXL-DE)-routed messages. Together EDXL-DE and EDXL-RM
are intended to expedite all activities associated with resources needed to
respond and adapt to emergency incidents. 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 Resource Message is constrained to the set
of Resource Message Types contained in this specification. The Resource Message
is intended to be the payload or one of the payloads of the Distribution
Element which contains it.
Disaster Management (DM) is a communications program in the
Department of Homeland Security’s (DHS) Office for Interoperability and
Compatibility (OIC) and managed by the Science and Technology (S&T)
Directorate. The program was initiated as one of the President’s e-government
initiatives. DM’s mission is to serve as the program within the Federal
Government to help local, tribal, state, and federal public safety and
emergency response agencies improve public safety response through more effective
and efficient interoperable data sharing. The DHS DM program sponsors a
Practitioner Steering Group (PSG).
The DM Practitioner Steering Group (PSG) governance was
formalized following publication of the EDXL Distribution Element. It plays a
key role in the direction, prioritization, definition, and execution of the DHS-DM
program. The group is comprised of representatives of major emergency response
associations, setting priorities and providing recommendations regarding messaging
standards development as well as the other facets of the DM program.
The PSG specified messaging standards-based
systems interoperability as the top priority for the DHS Disaster Management
program. The EDXL Resource Messaging Specification effort was identified
as the top priority standard by this group following the EDXL-DE. The
requirements and specification effort was initiated by this group in partnership
with industry members of the Emergency Interoperability
Consortium (EIC) in a Standards Working Group (SWG). That group developed a
draft specification which was submitted to the OASIS Emergency Management
Technical Committee to begin work on this EDXL-RM specification.
The process remained the same as with the EDXL-DE
specification with the exception that the Technical Committee requested that
the initial candidate specification submitted by the expert group be recast as
a formal Requirements Document according to a template that the Technical
Committee provided to the expert group. The candidate specification was then
resubmitted along with this requested requirements document.
As stated in Section 1.1, the EDXL Resource Message specification defines
16 separate and specific message types supporting the major communication requirements
for allocation of resources across the emergency incident life-cycle. This
includes preparedness, pre-staging of resources, initial and ongoing response,
recovery and demobilization / release of resources.
The EDXL Resource Message structure is defined
using successively more detailed or constrained artifacts in the form of
diagrams, figures and tables. The overall structure of the EDXL Resource
Message is first represented in a reference model referred to as the
Element Reference Model (ERM). This overall model is the foundation from which
individual constraint schemas (individual resource message types) are
defined. The ERM (Section 3.2) with
the Data Dictionary (Section 4)
defines the overall structure of Resource Messages including message structure
(element cardinality), message element definitions and cardinality which must
be adhered to. An overall XML schema is also provided for the ERM.
Following overall Resource Message definition,
each individual EDXL Resource Message type is defined. Table 2 provides a matrix defining required, optional and conditional message
elements for each EDXL Resource Message. A section is then provided for each
individual EDXL Resource Message (each message constrains the overall
ERM or reference model), providing the normative ERM, element cardinality and
optionality, business rules and message flow that defines each individual
message type. Message XML and example XML is also provided for each message.
The following descriptions of these artifacts
are here only as preparation to better understand how to use these diagrams,
figures and tables
The non-normative Abstract Reference Model
diagram in Figure 1 shows the abstract structural
relationships of the main components or elements. The normative ERM diagram in Figure 2 shows the structural relationships of the main Resource
Messaging elements. Elements are logical groupings of message elements
for purposes of defining message structure
- The EDXLResourceMessage element
itself is the top level element of this specification as a whole, and
contains the message elements that identify and describe the message with
information such as ID, DateTime, ContactInformation, MessageDescription
and previous message references;
- An IncidentInformation element identifies
and describes the incident with which the message is concerned;
- A MessageRecall element is needed when
a message updates or cancels a previous message;
- A Funding element specifies
applicable codes and specific funding information;
- A ResourceInformation element specifies
the resource information or resource requirement. The
ResourceInformation element contains:
- A Resource element to
identify and describe the specific resource or resources with which the
message is concerned, such as ID, Name, Type and Description.
The Resource element contains the following additional elements:
i. An OwnershipInformation element; and,
ii. A ResourceStatus element.
- A ResponseInformation element that
identifies the Resource to which it applies, specifies the ResponseType
such as Accept or Decline, a ResponseCode and ResponseReason;
- An AssignmentInformation element to
specify information such as Quantity, PriceQuote and OrderID.
The AssignmentInformation element includes:
i. An AssignmentInstructions element for specifying ModeOfTransportation,
NavigationInstructions and ReportingInstructions; and,
- A ScheduleInformation element to
specify a ScheduleType, such as RequestedArrival, RequestedDeparture,
ActualArrival and Actual Departure, as well as DateTime
and Location;
- A ContactInformation element is
organized separately to be reused in Resource Message Elements as needed,
and it reuses the OASIS Customer Information Quality Specifications;
- A LocationType element is organized
separately to be used in Resource Message elements as needed, using the
geo-oasis:WhereType;
- A ValueListType element is organized and
specified separately to be used in Resource Message elements as needed.
Table 1 provides a Resource Message Type
Summary of the 16 specific types of Resource Message. This is useful for
getting a quick overview of the message types contained in the specification.
Figure 3 illustrates the three primary types
of behavior which Resource Messages enable:
·
Discovery;
·
Ordering; and
·
Deployment.
Table 2 provides a Resource Message Type – Element Matrix
where each row represents a specific message element grouped by element group and
each column represents a specific message type. Using this matrix, one can
determine whether any combination of message element and message type is
Required, Conditional, or Optional.
Finally, each specific message type is fully defined in
Sections 3.4 through 3.19.
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL
NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this
document are to be interpreted as described in [RFC2119].
The term “Conditional” as used in this
specification is to be interpreted that a message element MUST be
used, according to specified rules, within a particular message type (elements MUST
be one of “Required,” “Optional” or “Conditional”).
The term “Provisional” as used in this specification
is to be interpreted that the Request, Requisition or Commit is accepted on a tentative;
constrained or probationary basis; or that a Release is made on a tentative,
constrained or probationary basis.
[RFC2046] N.
Freed, Multipurpose Internet
Mail Extensions (MIME) Part Two: Media Types, http://www.ietf.org/rfc/rfc2046.txt, IETF RFC 2046, November 1996.
[RFC2119] S. Bradner, Key words for use in RFCs to Indicate
Requirement Levels, http://www.ietf.org/rfc/rfc2119.txt, IETF RFC 2119, March 1997.
[RFC3066] 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/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.
[namespaces] 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.
[EDXL-HAVE] Emergency Data Exchange Language Hospital AVailablity Exchange http://www.oasis-open.org/apps/org/workgroup/emergency/download.php/25719/emergency_edxl_have-1.0-spec-pr03.pdf
[OGC 03-105r1] OpenGIS Geography Markup Language (GML) Implementation Specification, http://portal.opengeospatial.org/files/?artifact_id=4700,
Version 3.1.1, 2003
[OGC CRS] Open
Geospatial Consortium, Topic 2 - Spatial Referencing by Coordinates (Topic
2) (CRS Abstract Specification), https://portal.opengeospatial.org/files/?artifact_id=6716,
Version 3, 2004.
[OGC 04-092r4] Open Geospatial Consortium, GML
3.1.1 schemas, http://schemas.opengis.net/gml/3.1.1/,
2004
OASIS CIQ OASIS,
Customer Information Quality (CIQ) Specifications Version 3.0, Name (xNL),
Address (xAL), and Party (xPIL), http://docs.oasis-open.org/ciq/v3.0/specs/,
15 June 2007
[EDXL GFR] EDXL General Functional Requirements,
http://www.oasis-open.org/committees/download.php/10031/EDXL%20General%20Functional%20Requirements.doc, November 2004
[EDXL-DE IG] EDXL Distribution Element
Implementer's Guide, http://www.oasis-open.org/committees/download.php/14120/EDXL_Implementer%27sGuide.doc, August 2005
[EDXL-RM SRS] EDXL Resource Messaging Standard Requirements Supplement, workgroup http://www.oasis-open.org/committees/download.php/14981/EDXLRqmtsSupplement101905.doc, October 19, 2005
[EDXL-RM SF] EDXL Resource Messaging Standard Format for Resource Messaging
(candidate specification) http://www.oasis-open.org/committees/download.php/13690/EDXL_ResourceDraft07152005.doc, July 15, 2005
[ISO 4217] ISO 4217:2001, Codes
for the representation of currencies and funds
[ISO 4217 codes] ISO 4217 currency
names and code elements, http://www.iso.org/iso/support/faqs/faqs_widely_used_standards/widely_used_standards_other/currency_codes/currency_codes_list-1.htm
[UCUM] Gunther
Schadow, Clement J. McDonald, The Unified Code for Units of Measure,Version
1.6, http://aurora.regenstrief.org/UCUM/ucum.html, Regenstrief Institute for Health Care, 2005
Below are some of the guiding principles behind
the development of EDXL-RM:
- Provide a standard message format for the
Resource Message
- Provide separate specific formats for the
distinct Resource Message Types
- Enable dissemination of messages based on
geographic delivery area
- Use and reuse of data content and models
developed by other initiatives
- Business process-driven specific messaging
needs across emergency professions
- Supporting everyday events and incident
preparedness, as well as disasters
- 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
The initial requirements submitted to the
Technical Committee by the EDXL Standards Working Group described in Section 1.2 can be reviewed:
EDXL Resource Messaging Standard Requirements Supplement, workgroup
http://www.oasisopen.org/committees/download.php/14981/EDXLRqmtsSupplement101905.doc,
October 19, 2005
In summary, the EDXL Resource Messaging
specification should
1. Define a detailed message structure for the following specific EDXL
Resource Message Types: (Note that requirements that are self-evident from
Message Type names are not separately listed)
a. RequestResource
b. ResponseToRequestResource
c.
RequisitionResource
d. CommitResource
e. RequestInformation
f. ResponseToRequestInformation
g. OfferUnsolicitedResource
h. ReleaseResource
i. RequestReturn
j. ResponseToRequestReturn
k. RequestQuote
l. ResponseToRequestQuote
m. RequestResourceDeploymentStatus
n. ReportResourceDeploymentStatus
o. RequestExtendedDeploymentDuration
p. ResponseToRequestExtendedDeploymentDuration
2. Explicitly specify use of EDXL-DE as the routing mechanism for the EDXL
Resource Message
3. Provide the ability to specify a desired geographic Resource delivery
area, provide for notice of Resource demobilization and the ability to
communicate information to provide for returning Resource
4. Provide ability to accept or decline in a ResponseToRequestResource
that indicates availability of the requested Resource or to accept or decline to
an OfferUnsolicitedResource
5. Provide the ability to cancel any Resource Message (actual method is
MessageRecall)
6. Provide the ability to reference specific incidents in Resource Message
7. Provide unique identifier for each message as well as the ability to
reference previous messages, including but not limited to originating message
in a given sequence
8. Provide the ability to specify Date and Time of Resource Message,
referenced messages, scheduling information, assignment information and
specific instructions
9. Provide the ability to report Disposition of referenced Resource
Message(s)
10. Provide
the ability to specify contact information of individuals responsible for
Resource Message(s) and/or Resource(s)
11. Provide
the ability to specify funding information for Resources
12. Provide
the ability to reference external lists for Resource Message content
13. Provide
the ability to fully describe Resource(s)
14. Provide
the ability to specify Special Requirements such as protective equipment or
specific skill credentials, e.g. certifications, licenses
15. Provide
the ability to specify Resource Information for purposes beyond identification
and qualification such as scheduling and assignment.
2.2 Distribution of EDXL-RM
The primary purpose of the Emergency Data
Exchange Language Resource Messaging (EDXL-RM) Specification is to provide a
set of standard formats for XML emergency messages. These Resource Messages are
specifically designed as payloads of the EDXL-DE. Together EDXL-DE and EDXL-RM
are intended to expedite activities associated with managing resources during
all phases of Emergency Management. Routing and distribution information is found
only in the EDXL-DE and not in the EDXL-RM.
EDXL
Distribution Element (EDXL-DE) V 1.0 was approved as an OASIS standard in April
2006. The EDXL-DE provides a flexible message-distribution framework for data
sharing among emergency information systems using XML. The EDXL-DE may be used
over any data transmission system, including, but not limited to, the SOAP HTTP
binding.
The
primary purpose of the Distribution Element is to facilitate the routing of
emergency messages to recipients. The Distribution Element may be thought of as
a "container". It provides the information to route
"payload" message sets by including key routing information such as
distribution type, geography, incident, and sender/recipient IDs. Messages may
be distributed to specific recipients, to a geographic area, or based on codes
such as agency type (police, fire, etc.).
The
EDXL-DE is designed to carry one or more payloads called Content Objects. Each
Content Object may be well-formed XMLContent, or NonXMLContent. The EDXL-RM is designed to be well-formed XMLContent for routing using the
EDXL-DE. The EDXL-DE supports both context sensitive routing via metadata (i.e.
information about the Content Objects) and directed distribution (i.e. the
sender specifies specific recipients).
While the EDXL-RM is designed to be an EDXL-DE payload, other routing
mechanisms may be used to distribute EDXL-RM content if the message metadata is
provided in the same form or if the sender specifies specific recipients of the
payload.
Note: The following examples of usage scenarios
were used as a basis for design and review of the EDXL Resource Messaging
Specification. These scenarios are non-normative and not intended to be
exhaustive or to reflect actual practices.
This scenario follows the detection of a noxious
aerosol substance leak at a chemical plant that produces toxic materials. This
scenario involves evacuations, requests for hazmat teams and the evolution of
the incident into an explosion that destroys the leak site and an adjacent
building with casualties requiring emergency healthcare teams, full incident
command establishment, responses of various kinds and cleanup.
Full use case
available: http://www.oasis-open.org/committees/download.php/26805/EDXL_use_example_SafecomExplosion%20060805.doc
Explosion scenarios from the following source document provided
scenario content for this use case:
“SAFECOM
Statement of Requirements for Public Safety Wireless Communications and Interoperability”
The SAFECOM Program
Department of Homeland Security
Version 1.0
March 10, 2004
2.3.2 Cedar Fire Incident
This is an actual use case that follows the
events of the “Cedar” fire incident in late October and November 2003 in San Diego County, California. Operation Center (EOC) has been activated, and requests the
agencies to be on alert. This scenario represents a large scale incident
involving activation of the state Emergency Operation Center (EOC). This use
example is based upon four official source documents which provide a detailed
description of the incident and response, and provides independent evaluations
of overall response. The use example chronicles a lack of radio
interoperability coupled with poor coordination of mutual aid in the area, due
to several concurrent fires back to back with other recent fires in this geographical
region.
Full use case available: http://www.oasis-open.org/committees/download.php/26803/EDXL_use_example_Fire061005.doc
The following source documents provided
scenario content for this use case:
1.
Final
Draft_ 2003 SD Co Fire Safety Review-no pics.pdf http://www.oasis-open.org/committees/download.php/26809/Final%20Draft_%202003%20SD%20Co%20Fire%20Safety%20Review-no%20pics.pdf
2.
Cedar
Fire SDFD.pdf http://www.oasis-open.org/committees/download.php/26808/Cedar%20Fire%20SDFD.pdf
3.
City
of SD City Mgr Rpt Fire 2003.pdf http://www.oasis-open.org/committees/download.php/26810/City%20of%20SD%20City%20Mgr%20Rpt%20Fire%202003.pdf
Firestorm
2003 Case Study – Final.pdf http://www.oasis-open.org/committees/download.php/26807/Firestorm%202003%20Case%20Study%20-%20Final.pdf
This scenario modeled a category 5 hurricane
several months prior to the start of the 2005 hurricane season in earnest, and
follows many different kinds of resource requests and evolving situations as a
widespread incident with mass casualties and damage occurs.
Full use case available:
http://www.oasis-open.org/committees/download.php/26804/EDXL_use_example_Hurricane061005.doc
The following source
document provided scenario content for this use case: “Planning Scenarios,
Executive Summaries, Created for use in National, Federal, State and Local
Homeland Security Preparedness Activities” – Version 2.0 – The Homeland
Security Council, David Howe, Senior Director for Response and Planning – July
2004”
“Scenario 10: Natural Disaster – Major Hurricane http://www.altheim.com/lit/planning_scenarios_exec_summary.html#p36
2.3.4 Pandemic Influenza
This scenario models
an Influenza Pandemic outbreak at Phase 6 (Increased and pre-sustained
transmission in general population) as determined by the State Health
Agency/Public Health Department. It includes such activities as requesting
medical facilities to take stock and determine what resources are readily
available and on hand (inventory of available supplies). It includes a wide
range of resource messages such as requests for vaccines and antivirals.
Full use
case available: http://www.oasis-open.org/committees/download.php/26806/EDXL_use_example_Influenza_06152005%20LaniGrahmRev.doc
3 EDXL Resource Messaging Model (Normative unless otherwise stated)
Section 3 of this Standard is normative unless otherwise
stated. If any differences are found between any XML schema and its associated
model, diagram, table or other artifact or text, then the XML schema shall
always take precedence and the other artifact(s) must be changed to match the
XML schema.
NOTE: Please report any such errors to OASIS
Figure 1 below shows the Resource Messaging
Abstract Reference Model (RM-ARM). The purpose of the RM-ARM is to highlight
the high-level structure of the RM framework and the relationships between the
main entities.
The Resource Message contains one of two major
message categories: a Request or a Response message; or a minor message
category type, or a Report message. These two major and one minor message
categories form the underlying framework for all messages. The Resource Message
also contains information on the Party or Parties (person or organization)
that plays a significant Role in the message transaction. Funding information
can also be specified.
Figure 1: Resource Messaging –
Abstract Reference Model
The core of any message is the Resource or
Resources with which it is concerned. A Resource contains information about its
Identity, Description and Status. A Resource owner can also be identified.
A Resource may also have a schedule which
includes Temporal and Spatial details. For example, the expected arrival time
and place for a specific resource. There are a number of types for Schedules.
A Resource may also have information about its
Assignment including the identified Incident and Instructions related to the
incident assignment.
Figure 2 below shows the EDXL–RM Element
Reference Model (ERM). The purpose of the ERM is to highlight the low-level
structure of the RM framework and the relationships between the main entities
and their elements.
It is important to note that the ERM should
not be used as an implementation model as the exact semantics and structure are
captured in the subsequent sections on the Resource Message Types.
Figure 2: Resource Messaging –
Element Reference Model
The RM-ERM shows the
element-level details for the main entities in the RM. The semantics for each
of the elements is defined in Section 3.3.
The general RM framework is based on a Request/Response
model. Most of the Request messages expect a Response, and in some cases,
messages are used to notify others of changes or offers of resources.
An RM message MUST be carried as the payload of the EDXL-DE
or a distribution mechanism with the distribution type values of Report,
Update, Cancel, Request, Response, Dispatch, Ack and Error, as defined in
EDXL-DE. For example, the acknowledgement of an RM message is handled by the distribution
mechanism.
When a message recipient receives an RM message, it uses the
EDXL-DE DistributionType value of Ack as an acknowledgement. An acknowledgement
is intended to inform the sender that the RM message has been received.
The EDXL-RM provides the mechanism to recall or update a
previously sent resource message through the EDXL MessageRecall element. The
MessageRecall element, when present, contains the RecalledMessageID and the
RecallType. The RecalledMessageID contains the MessageID of the message
previously sent that is being either canceled or updated. If the RecallType
element contains the value “Cancel”, then the entire message specified in
RecalledMessageID is to be canceled. If the RecallType element contains the value
“Update”, then the entire message specified in RecalledMessageID is replaced by
the new message.
This two-way communication is characterized by two classes
of primary actors. The Resource Consumer is an actor that needs or requires
resources to undertake response to an incident. The Resource Supplier is an
owner, or distributor, or manager of resources that can meet the needs of
Resource Consumers. There may be more than one actor of each class for a given
sequence of message exchanges, and there may also be other classes of actors
besides these two primary types.
There are 16 resource messages defined in this
specification, which are summarized in Table 1 below.
Table 1: Resource Message Type
Summary
|
Message Type
|
Description
|
Message
Sender
|
|
RequestResource
|
Message used to request
needed resources from one or many recipients, possibly spawning multiple
responses.
|
Resource Consumer
|
|
ResponseToRequestResource
|
Message used as the response
to a “RequestResource”. Allows sender to list resource(s) which they feel
represent suitable match with a resource request.
|
Resource Supplier
|
|
RequisitionResource
|
Message used to “order”
specific resource, or to confirm specific resource to be “ordered” relating
to one or more responses to a “RequestResource”.
|
Resource Consumer
|
|
CommitResource
|
Message used to agree or
commit specific resource in response to a RequestResoure or RequisitionResource,”.
|
Resource Supplier
|
|
RequestInformation
|
Message used to ask resource
questions or provide general description of situation and general resources
needs.
|
Resource Consumer,
Resource Supplier
|
|
ResponseToRequestInformation
|
Message used as the response
to a RequestInformation message providing general information or to list
resource that may meet the specified need.
|
Resource Supplier, Resource
Consumer
|
|
OfferUnsolicitedResource
|
Message used to offer
available resources (that have not been requested) to assist with an
emergency response.
|
Resource Supplier
|
|
ReleaseResource
|
Message used at the incident
to “release” (demobilize) resource back to its original Supplier.
|
Resource Consumer
|
|
RequestReturn
|
Message used to request
release (demobilize) of resources back to its original point of assignment or
to another location / assignment ("I want my stuff back").
|
Resource Supplier
|
|
ResponseToRequestReturn
|
Message used as the response
to a "RequestReturn" indicating whether the resource may be
released, with relevant time-line information.
|
Resource Consumer
|
|
RequestQuote
|
Message used to request a
price quote from a seller or supplier.
|
Resource Consumer
|
|
ResponseToRequestQuote
|
Message used as the response
to a “RequestQuote”. Allows sender to list resource(s) which they feel
represent suitable match with the request, with pricing information.
|
Resource Supplier
|
|
RequestResourceDeploymentStatus
|
Message used to request
current “status” of resource.
|
Resource Consumer,
Resource Supplier
|
|
ReportResourceDeploymentStatus
|
Message used to report on
the current “status” of any resource.
|
Resource Consumer,
Resource Supplier
|
|
RequestExtendedDeploymentDuration
|
A request initiated by the
requester / receiver of resource, “I want to extend how long I need to keep
this resource”
|
Resource Consumer
|
|
ResponseToRequestExtendedDeployment
Duration
|
Message used as the response
to “RequestExtendedDeploymentDuration”.
|
Resource Supplier
|
Table 1 above and Figure 3 below are informative only. They are included to show how the resource
messages might flow between the Resource Consumer and Resource Supplier during
resource management. Note, however, that this specification does not prescribe the
sequence of message exchanges, except for some dependencies between messages
which are described in Section3.3.
The Resource Messages can be used in three
phases of resource management:
·
Discovery,
·
Ordering, and
·
Deployment, as shown in Figure 3.
The Discovery phase enables Resource Consumers
to find out about available resources, including their costs, and offers of
resources from Resource Suppliers.
The Ordering phase enables Resource Consumers
to explicitly requisition Resources from Resource Suppliers.
The Deployment phase enables both actors to
find about the current status of resources in the field, request extensions and
returns.
It is important to note that this specification
does not mandate an exact order and workflow of Resource Messages. For example,
the Ordering phase may actually only require the CommitResource message for
some actors.
Figure 3: Resource Message
Phases
Table 2 (below) summarizes all the Message
Types and their element contents. The specific details on each of the
Message Types are outlined in the following sections.
Table 2: Resource Message Type – Element Matrix (Key: R = Required, C = Conditional, O = Optional)
N/A – Not Applicable to the message type)
|
Schema Element
|
Message Element
|
Request Resource
|
ResponseTo Request Resource
|
Requisition Resource
|
Commit Resource
|
Request Information
|
ResponseTo Request Information
|
Offer Unsolicited Resource
|
Release Resource
|
Request Return
|
ResponseTo Request Return
|
Request Quote
|
ResponseTo Request Quote
|
Request Resource Deployment
Status
|
Report Resource Deployment
Status
|
Request Extended Deployment
Duration
|
ResponseTo Request Extended
Deployment Duration
|
|
Resource
Message
|
MessageID
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
SentDateTime
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
MessageContentType
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
MessageDescription
|
O
|
O
|
O
|
O
|
R
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
OriginatingMessageID
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
PrecedingMessageID
|
N/A
|
R
|
O
|
R
|
O
|
R
|
N/A
|
O
|
O
|
R
|
O
|
R
|
O
|
O
|
O
|
R
|
|
Incident Information
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
MessageRecall
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Funding
|
O
|
O
|
R
|
O
|
O
|
O
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
ContactInformation
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
Resource Information
|
R
|
R
|
R
|
R
|
O
|
O
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
Incident Information
|
IncidentID
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
|
IncidentDescription
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
|
Message Recall
|
RecalledMessageID
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
RecallType
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
Funding
|
FundCode
|
C
|
C
|
C
|
C
|
C
|
C
|
N/A
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
|
FundingInfo
|
C
|
C
|
C
|
C
|
C
|
C
|
N/A
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
|
Resource Information
|
ResourceInfoElementID
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
Response Information
|
N/A
|
R
|
N/A
|
R
|
N/A
|
O
|
N/A
|
O
|
N/A
|
R
|
O
|
R
|
N/A
|
O
|
N/A
|
R
|
|
Resource
|
R
|
O
|
R
|
C
|
O
|
O
|
R
|
R
|
R
|
O
|
R
|
C
|
R
|
O
|
R
|
C
|
|
AssignmentInformation
|
O
|
O
|
R
|
C
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Schedule Information
|
O
|
O
|
O
|
C
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Response Information
|
PrecedingResourceInfoElementID
|
N/A
|
R
|
N/A
|
R
|
N/A
|
R
|
N/A
|
R
|
N/A
|
R
|
R
|
R
|
N/A
|
R
|
N/A
|
R
|
|
ResponseType
|
N/A
|
R
|
N/A
|
R
|
N/A
|
R
|
N/A
|
R
|
N/A
|
R
|
R
|
R
|
N/A
|
R
|
N/A
|
R
|
|
ReasonCode
|
N/A
|
C
|
N/A
|
C
|
N/A
|
C
|
N/A
|
C
|
N/A
|
C
|
C
|
C
|
N/A
|
C
|
N/A
|
C
|
|
ResponseReason
|
N/A
|
C
|
N/A
|
C
|
N/A
|
C
|
N/A
|
C
|
N/A
|
C
|
C
|
C
|
N/A
|
C
|
N/A
|
C
|
|
Resource
|
ResourceID
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
|
Name
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
|
TypeStructure
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
|
TypeInfo
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Keyword
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Description
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Credentials
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Certifications
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
SpecialRequirements
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
ResponsibleParty
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
OwnershipInformation
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Resource Status
|
N/A
|
O
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
R
|
N/A
|
O
|
NA
|
O
|
O
|
O
|
|
Ownership Information
|
Owner
|
N/A
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
|
OwningJurisdiction
|
N/A
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
C
|
|
HomeDispatch
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
HomeUnit
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Resource Status
|
InventoryRefreshDateTime
|
N/A
|
O
|
N/A
|
O
|
O
|
O
|
O
|
N/A
|
N/A
|
N/A
|
N/A
|
O
|
N/A
|
O
|
N/A
|
N/A
|
|
DeploymentStatus
|
N/A
|
O
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
R
|
N/A
|
O
|
N/A
|
O
|
O
|
O
|
|
Availability
|
N/A
|
O
|
N/A
|
N/A
|
O
|
O
|
O
|
O
|
O
|
R
|
N/A
|
O
|
N/A
|
O
|
O
|
O
|
|
Assignment
Information
|
Quantity
|
O
|
C
|
R
|
R
|
O
|
O
|
O
|
R
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Restrictions
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
AnticipatedFunction
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
PriceQuote
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
N/A
|
R
|
O
|
O
|
O
|
O
|
|
OrderID
|
N/A
|
N/A
|
N/A
|
O
|
O
|
O
|
N/A
|
O
|
O
|
O
|
N/A
|
N/A
|
O
|
O
|
O
|
O
|
|
Assignment
Instructions
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
N/A
|
O
|
|
Assignment
Instructions
|
ModeOfTransportation
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
N/A
|
O
|
|
NavigationInstructions
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
N/A
|
O
|
|
ReportingInstructions
|
N/A
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
N/A
|
O
|
|
Schedule Information
|
ScheduleType
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
R
|
|
DateTime
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
|
Location
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
O
|
Table 3: ScheduleTypes – Message Matrix
|
|
RequestResource
|
ResponseToRequestResource
|
RequisitionResource
|
CommitResource
|
RequestInformation
|
ResponseToRequestInformation
|
OfferUnsolicitedResource
|
ReleaseResource
|
RequestReturn
|
ResponseToRequestReturn
|
RequestQuote
|
ResponseToRequestQuote
|
RequestResourceDeploymentStatus
|
ReportResourceDeploymentStatus
|
RequestExtendedDeploymentDuration
|
ResponseToRequestExtendedDeploymentDuration
|
|
RequestedArrival
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
EstimatedArrival
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
x
|
x
|
x
|
x
|
|
ActualArrival
|
|
|
|
|
x
|
x
|
|
x
|
x
|
x
|
|
|
x
|
x
|
x
|
x
|
|
RequestedDeparture
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
EstimatedDeparture
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
x
|
x
|
x
|
x
|
|
ActualDeparture
|
|
|
|
x
|
x
|
x
|
|
x
|
x
|
x
|
|
|
x
|
x
|
x
|
x
|
|
RequestedReturnArrival
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
x
|
x
|
x
|
x
|
|
EstimatedReturnArrival
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
ActualReturnArrival
|
|
|
|
|
x
|
x
|
|
|
|
|
|
|
x
|
x
|
|
|
|
RequestedReturnDeparture
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
x
|
x
|
x
|
x
|
|
EstimatedReturnDeparture
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
ActualReturnDeparture
|
|
|
|
|
x
|
x
|
|
x
|
|
x
|
|
|
x
|
x
|
|
|
|
Committed
|
|
|
|
x
|
x
|
x
|
|
x
|
x
|
x
|
|
|
x
|
x
|
x
|
x
|
|
BeginAvailable
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
x
|
x
|
|
|
|
EndAvailable
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
x
|
x
|
|
x
|
|
Current
|
|
|
|
x
|
x
|
x
|
|
x
|
x
|
x
|
|
x
|
x
|
x
|
x
|
x
|
|
ReportTo
|
x
|
x
|
x
|
x
|
x
|
x
|
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
|
Route
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
x
|
The “RequestResource” message is used as an
announcement to a broad audience of potential suppliers as well as potential
suppliers in the local geographic area of interest. It is intended to be used
by Emergency Managers, Incident Commanders and other First Responders to
request information on availability of needed resources.
Figure 4 below shows
the EDXL–RM Element Reference Model (ERM) tailored for the RequestResource
Message. The ERM shows the element-level details for the
main entities in the RM.
Figure 4: EDXL-RM ERM for
RequestResource Message
The following table outlines the element cardinalities for
this message type, as follows:
–
bold indicates an element that is required
–
italics indicate an element that is conditional (the
applicable rules for these elements appear below the table)
–
an asterisk (*) indicates that an element can appear multiple
times
–
a caret symbol (^) indicates that the values of an element are
constrained, as per the rules shown below the table.
All elements that are not shown in bold or italics are
optional.
Table 4: RequestResource Message Elements
|
Parent Element
|
Sub-Elements
|
|
RequestResource
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, IncidentInformation*,
MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, Resource,
AssignmentInformation, ScheduleInformation*
|
|
Resource
|
ResourceID, Name, TypeStructure, TypeInfo,
Keyword*, Description, Credentials, Certifications, SpecialRequirements
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements: The
following notation is used throughout this document: a colon is used as a
separator between the name of an element and the name of a child of that
element.
·
The RequestResource:MessageID, RequestResource:SentDateTime, RequestResource:MessageContentType,
RequestResource:OriginatingMessageID, RequestResource:ContactInformation, and RequestResource:ResourceInformation
elements MUST be present.
·
The value of RequestResource:MessageContentType MUST be “RequestResource”.
·
If a RequestResource:IncidentInformation element is present, then
at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription MUST be present.
·
If the RequestResource:MessageRecall element is present, then the
MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST be
present.
·
If a RequestResource:Funding element is present, then at least
one of Funding:FundCode and/or Funding:FundingInfo MUST be present.
·
The ResourceInformation:ResourceInfoElementID and ResourceInformation:Resource
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name and/or
Resource:TypeStructure MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType MUST be present and contain
one of the following values:
·
“RequestedArrival”, “RequestedDeparture”, “EstimatedReturnDeparture”,
“EstimatedReturnArrival”, “ReportTo”, or “Route”.
The schema for a
RequestResource message can be found in Appendix A.3.
The RequestResource message is an initial message created
and sent by the Resource Consumer to any number of Resource Suppliers.
The potential responses to this message include:
·
ResponseToRequestResource (See Section 3.5)
·
Response may include Accept, Decline, and Provisional responses.
The message may
be canceled or updated through the RequestResource:MessageRecall element.
Below is an example of a RequestResource Message, in which
three resource requests are shown:
·
Small Animal Sheltering Team (ResourceInfoElementID=001)
·
Patrol and Surveillance Helicopters (ResourceInfoElementID =002)
·
Electrical Power Restoration Team (ResourceInfoElementID =003).
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<RequestResource
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMRequestResource.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis"
xmlns:gml="http://www.opengis.net/gml">
<MessageID>urn:au-qld-eoc:12332</MessageID>
<SentDateTime>2006-03-21T11:58:00+10:00</SentDateTime>
<MessageContentType>RequestResource</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
<xpil:ContactNumbers>
<xpil:ContactNumber xpil:CommunicationMediaType="Telephone"
xpil:ContactHours="9:00AM - 5:00PM">
<xpil:ContactNumberElement
xpil:Type="CountryCode">61</xpil:ContactNumberElement>
<xpil:ContactNumberElement
xpil:Type="AreaCode">7</xpil:ContactNumberElement>
<xpil:ContactNumberElement xpil:Type="LocalNumber">
3000
1234
</xpil:ContactNumberElement>
</xpil:ContactNumber>
</xpil:ContactNumbers>
<xpil:ElectronicAddressIdentifiers>
<xpil:ElectronicAddressIdentifier>alexj@emergencyservices.gov.au
</xpil:ElectronicAddressIdentifier>
</xpil:ElectronicAddressIdentifiers>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small Animal Sheltering Team</rm:Value>
</TypeStructure>
<Description>
5-person response team to advise and support local efforts to set up a
small animal shelter
</Description>
<SpecialRequirements>A qualified veterinary
surgeon</SpecialRequirements>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>RequestedArrival</ScheduleType>
<DateTime>2006-03-24T09:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail Animal
Refuge</rm:LocationDescription>
<rm:Address>
<xal:Country>
<xal:NameElement>Australia</xal:NameElement>
</xal:Country>
<xal:AdministrativeArea>
<xal:NameElement>QLD</xal:NameElement>
</xal:AdministrativeArea>
<xal:Locality>
<xal:NameElement>Innisfail</xal:NameElement>
</xal:Locality>
<xal:Thoroughfare>
<xal:NameElement>Downing St</xal:NameElement>
<xal:Number>27</xal:Number>
</xal:Thoroughfare>
<xal:PostCode>
<xal:Identifier>4860</xal:Identifier>
</xal:PostCode>
</rm:Address>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedReturnDeparture</ScheduleType>
<DateTime>2006-03-30T17:00:00+10:00</DateTime>
</ScheduleInformation>
</ResourceInformation>
<ResourceInformation>
<ResourceInfoElementID>002</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Patrol and Surveillance Helicopters</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>3</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<AnticipatedFunction>
Aerial surveillance to determine extent of
flooding
</AnticipatedFunction>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>RequestedArrival</ScheduleType>
<DateTime>2006-03-22T09:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
</ResourceInformation>
<ResourceInformation>
<ResourceInfoElementID>003</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Electrical Power Restoration Team</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>2</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<AnticipatedFunction>
Restore power to critical infrastructure in and around the
Innisfail area
</AnticipatedFunction>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>RequestedArrival</ScheduleType>
<DateTime>2006-03-22T08:00:00+10:00</DateTime>
<Location>
<rm:TargetArea>
<gml:Point>
<gml:pos> 146.03 -17.53 </gml:pos>
</gml:Point>
</rm:TargetArea>
</Location>
</ScheduleInformation>
</ResourceInformation>
</RequestResource>
The “ResponseToRequestResource” message
is used by potential resource suppliers (e.g. mutual aid partners, equipment
suppliers, etc.) to respond to RequestResource messages from Emergency
Managers, Incident Commanders and First Responders or others with logistics
responsibilities. The response may identify availability, limitations and other
pertinent information related to resources in the original request.
Figure 5 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the ResponseToRequestResource Message. The ERM shows the element-level details for the main entities in the RM.
Figure 5: EDXL-RM ERM for
ResponseToRequestResource Message
The following table outlines the element cardinalities for
this message type.
Table 4: ResponseToRequestResource Message Elements
|
Parent Element
|
Sub-Elements
|
|
ResponseToRequestResource
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID,
IncidentInformation*, MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, ResponseInformation, Resource,
AssignmentInformation, ScheduleInformation*
|
|
ResponseInformation
|
PrecedingResourceInfoElementID, ResponseType,
ReasonCode, ResponseReason
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
InventoryRefreshDateTime, DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction,
PriceQuote, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The ResponseToRequestResource:MessageID, ResponseToRequestResource:SentDateTime,
ResponseToRequestResource:MessageContentType, ResponseToRequestResource:OriginatingMessageID,
ResponseToRequestResource:PrecedingMessageID, ResponseToRequestResource:ContactInformation,
and ResponseToRequestResource:ResourceInformation elements MUST be present.
·
The value of ResponseToRequestResource:MessageContentType MUST be
“ResponseToRequestResource”.
·
If a ResponseToRequestResource:IncidentInformation element is
present, then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription MUST be present.
·
If the ResponseToRequestResource:MessageRecall element is
present, then the MessageRecall:RecalledMessageID and MessageRecall:RecallType
elements MUST be present.
·
If a ResponseToRequestResource:Funding element is present, then
at least one of Funding:FundCode and/or Funding:FundingInfo elements MUST be
present.
·
The ResourceInformation:ResourceInfoElementID and
ResourceInformation:ResponseInformation elements MUST be present.
·
The ResponseInformation:PrecedingResourceInfoElementID and
ResponseInformation:ResponseType elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or
Resource:TypeStructure elements MUST be present.
·
If a ResourceInformation:Resource element is present, then at
least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure element
MUST be present.
·
If Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or OwnershipInformation:OwningJurisdiction
element MUST be present.
·
If the ResourceInformation:AssignmentInformation element is
present and the ResponseInformation:ResponseType contains a value of “Accept”
or “Provisional”, then the AssignmentInformation:Quantity element MUST be
present.
·
If ResourceInformation:ScheduleInformation is present then
ScheduleInformation:ScheduleType MUST be present and contain one of the
following values:
·
“EstimatedArrival”, “EstimatedDeparture”, “RequestedReturnDeparture”,
“RequestedReturnArrival”, “BeginAvailable”, “EndAvailable”, “RequestedArrival”,
“RequestedDeparture”, “EstimatedReturnArrival”, “ReportTo” or “Route”.
The schema for a ResponseToRequestResource
message can be found in Appendix A.4.
The ResponseToRequestResource message is sent by a Resource
Supplier in response to an original RequestResource message.
The potential
responses to this message include:
·
RequisitionResource (See Section 3.6).
The message may
be canceled or updated through the ResponseToRequestResource:MessageRecall
element.
Below is an example of a ResponseToRequestResource Message.
This is an example response to the original request shown in Section 3.4.5 . In this example, the three requests have different responses:
·
The “Small Animal Sheltering Team” (ResourceInfoElementID=001)
has Conditional changes to the request. In this case the Schedule information
is different from that requested.
·
The “Patrol and Surveillance Helicopters” (ResourceInfoElementID=002)
is Declined.
·
The “Electrical Power Restoration Team” (ResourceInfoElementID=003)
is Accepted.
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<ResponseToRequestResource
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMResponseToRequestResource.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis"
xmlns:gml="http://www.opengis.net/gml">
<MessageID>urn:au-qld-eoc:12334</MessageID>
<SentDateTime>2006-03-21T12:34:00+10:00</SentDateTime>
<MessageContentType>ResponseToRequestResource</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<PrecedingMessageID>urn:au-qld-eoc:12332</PrecedingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Charlotte</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Ryan</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>EMA</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
<xpil:ContactNumbers>
<xpil:ContactNumber xpil:CommunicationMediaType="Telephone">
<xpil:ContactNumberElement
xpil:Type="CountryCode">61</xpil:ContactNumberElement>
<xpil:ContactNumberElement
xpil:Type="AreaCode">2</xpil:ContactNumberElement>
<xpil:ContactNumberElement xpil:Type="LocalNumber">
9864
4321
</xpil:ContactNumberElement>
</xpil:ContactNumber>
</xpil:ContactNumbers>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>001</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Provisional</rm:ResponseType>
<rm:ResponseReason>Earliest arrival date is 2006-03-25</rm:ResponseReason>
</ResponseInformation>
<ScheduleInformation>
<ScheduleType>EstimatedDeparture</ScheduleType>
<DateTime>2006-03-25T08:10:00</DateTime>
<Location>
<rm:LocationDescription>Cairns Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedArrival</ScheduleType>
<DateTime>2006-03-25T09:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedArrival</ScheduleType>
<DateTime>2006-03-25T09:30:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail Animal Refuge</rm:LocationDescription>
<rm:Address>
<xal:Country>
<xal:NameElement>Australia</xal:NameElement>
</xal:Country>
<xal:AdministrativeArea>
<xal:NameElement>QLD</xal:NameElement>
</xal:AdministrativeArea>
<xal:Locality>
<xal:NameElement>Innisfail</xal:NameElement>
</xal:Locality>
<xal:Thoroughfare>
<xal:NameElement>Downing St</xal:NameElement>
<xal:NameElement>27</xal:NameElement>
</xal:Thoroughfare>
<xal:PostCode>
<xal:Identifier>4860</xal:Identifier>
</xal:PostCode>
</rm:Address>
</Location>
</ScheduleInformation>
</ResourceInformation>
<ResourceInformation>
<ResourceInfoElementID>002</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>002</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Accept</rm:ResponseType>
</ResponseInformation>
</ResourceInformation>
<ResourceInformation>
<ResourceInfoElementID>003</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>003</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Decline</rm:ResponseType>
</ResponseInformation>
</ResourceInformation>
</ResponseToRequestResource>
The “RequisitionResource” message is used by
Resource Consumers to order resources from Resource Suppliers. These may relate
to one or more responses to a previous Request Resource message.
Figure 6 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the RequisitionResource Message. The ERM shows the element-level details for the main entities in the RM.
Figure 6: EDXL-RM ERM for RequisitionResource
Message
The following table outlines the element cardinalities for
this message type.
Table 5: RequisitionResource Message Elements
|
Parent Element
|
Sub-Elements
|
|
RequisitionResource
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID,
IncidentInformation*, MessageRecall, Funding*, ContactInformation*,
ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, Resource, AssignmentInformation,
ScheduleInformation*
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote,
AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The RequisitionResource:MessageID, RequisitionResource:SentDateTime,
RequisitionResource:MessageContentType, RequisitionResource:OriginatingMessageID,
RequisitionResource:Funding, RequisitionResource:ContactInformation, and RequisitionResource:ResourceInformation
elements MUST be present.
·
The value of RequisitionResource:MessageContentType MUST be “RequisitionResource”.
·
If a RequisitionResource:IncidentInformation element is present,
then at least one of IncidentInformation:IncidentID and/or IncidentInformation:IncidentDescription
elements MUST be present.
·
If the RequisitionResource:MessageRecall element is present, then
the MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST be
present.
·
If a RequisitionResource:Funding element is present, then at
least one of Funding:FundCode and/or Funding:FundingInfo elements MUST be
present.
·
The ResourceInformation:ResourceInfoElementID, ResourceInformation:Resource
and ResourceInformation:AssignmentInformation elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or
Resource:TypeStructure elements MUST be present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
The AssignmentInformation:Quantity element MUST be present.
·
If ResourceInformation:ScheduleInformation is present, then the
ScheduleInformation:ScheduleType element MUST be present and contain one of the
following values:
·
“RequestedArrival”, “RequestedDeparture”, “EstimatedArrival”,
“EstimatedDeparture”, “RequestedReturnArrival”, “EstimatedReturnArrival”, “RequestedReturnDeparture”,
“EstimatedReturnDeparture”, “BeginAvailable”, “EndAvailable”, “ReportTo”, or
“Route”
The schema for a
RequisitionResource message can be found in Appendix A.5.
The RequisitionResource message is a
message created and sent by the Resource Consumer to any number of Resource
Suppliers.
The potential responses to this message include:
·
CommitResource (See Section 3.7)
·
This includes Accept, Decline and Provisional responses.
The message may
be canceled or updated through the RequisitionResource:MessageRecall element.
Below is an example of a RequisitionResource
Message, in which two resource requisitions are shown:
·
Small Animal Sheltering Team (ResourceInfoElementID=001)
·
Patrol and Surveillance Helicopters (ResourceInfoElementID=002).
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<RequisitionResource
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMRequisitionResource.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis"
xmlns:gml="http://www.opengis.net/gml">
<MessageID>urn:au-qld-eoc:987654</MessageID>
<SentDateTime>2006-03-21T12:39:00+10:00</SentDateTime>
<MessageContentType>RequisitionResource</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<Funding>
<rm:FundCode>HP4347</rm:FundCode>
</Funding>
<ContactInformation>
<rm:ContactRole>Requester</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
<xpil:ContactNumbers>
<xpil:ContactNumber xpil:CommunicationMediaType="Telephone"
xpil:ContactHours="9:00AM - 5:00PM">
<xpil:ContactNumberElement
xpil:Type="CountryCode">61</xpil:ContactNumberElement>
<xpil:ContactNumberElement
xpil:Type="AreaCode">7</xpil:ContactNumberElement>
<xpil:ContactNumberElement xpil:Type="LocalNumber">
3000
1234
</xpil:ContactNumberElement>
</xpil:ContactNumber>
</xpil:ContactNumbers>
<xpil:ElectronicAddressIdentifiers>
<xpil:ElectronicAddressIdentifier>alexj@emergencyservices.gov.au
</xpil:ElectronicAddressIdentifier>
</xpil:ElectronicAddressIdentifiers>
</rm:AdditionalContactInformation>
</ContactInformation>
<ContactInformation>
<rm:ContactRole>Approver</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Michelle</xnl:NameElement>
<xnl:NameElement xnl:ElementType="LastName">Yates</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>QLD Police</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
<xpil:ContactNumbers>
<xpil:ContactNumber xpil:CommunicationMediaType="Cellphone">
<xpil:ContactNumberElement xpil:Type="NationalNumber">
0422 877
665
</xpil:ContactNumberElement>
</xpil:ContactNumber>
</xpil:ContactNumbers>
<xpil:Occupations>
<xpil:Occupation>
<xpil:OccupationElement xpil:Type="Role">
District Disaster
Coordinator
</xpil:OccupationElement>
</xpil:Occupation>
</xpil:Occupations>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small Animal Sheltering Team</rm:Value>
</TypeStructure>
<Description>
5-person response team to advise and support local efforts to set up a
small animal shelter
</Description>
<SpecialRequirements>A qualified veterinary
surgeon</SpecialRequirements>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<AssignmentInstructions>
<rm:ReportingInstructions>
Report to Mark Darcy, Innisfail Animal
Refuge
</rm:ReportingInstructions>
</AssignmentInstructions>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>EstimatedArrival</ScheduleType>
<DateTime>2006-03-25T09:30:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail Animal
Refuge</rm:LocationDescription>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedReturnDeparture</ScheduleType>
<DateTime>2006-03-30T17:00:00+10:00</DateTime>
</ScheduleInformation>
</ResourceInformation>
<ResourceInformation>
<ResourceInfoElementID>002</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Patrol and Surveillance Helicopters</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>3</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<AnticipatedFunction>
Aerial surveillance to determine extent of
flooding
</AnticipatedFunction>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>RequestedArrival</ScheduleType>
<DateTime>2006-03-22T09:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
</ResourceInformation>
</RequisitionResource>
The “CommitResource” message is used by a
Resource Supplier to confirm that resources have been committed to a Resource
Consumer request. Usually, the CommitResource is in response to a RequisitionResource,
or even a RequestResource. The CommitResource is the only message used to
indicate the resources have been allocated to an assignment/incident.
Figure 7 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the CommitResource Message. The ERM shows the element-level details for the main entities in the RM.
Figure 7: EDXL-RM ERM for
CommitResource Message
The following table outlines the element cardinalities for
this message type.
Table 6: CommitResource Message Elements
|
Parent Element
|
Sub-Elements
|
|
CommitResource
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID,
IncidentInformation*, MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, ResponseInformation, Resource,
AssignmentInformation, ScheduleInformation*
|
|
ResponseInformation
|
PrecedingResourceInfoElementID, ResponseType, ReasonCode,
ResponseReason
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
InventoryRefreshDateTime, DeploymentStatus
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction,
PriceQuote, OrderID, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The CommitResource:MessageID, CommitResource:SentDateTime, CommitResource:MessageContentType,
CommitResource:OriginatingMessageID, CommitResource:PrecedingMessageID, CommitResource:ContactInformation,
and CommitResource:ResourceInformation elements MUST be present.
·
The value of CommitResource:MessageContentType MUST be “CommitResource”.
·
If a CommitResource:IncidentInformation element is present, then
at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the CommitResource:MessageRecall element is present, then the
MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST be
present.
·
If a CommitResource:Funding element is present, then at least one
of Funding:FundCode and/or Funding:FundingInfo elements MUST be present.
·
The ResourceInformation:ResourceInfoElementID and
ResourceInformation:ResponseInformation elements MUST be present.
·
If ResponseInformation:ResponseType has a value of “Accept” or “Provisional”,
then the ResourceInformation:Resource element MUST be present.
·
If ResponseInformation:ResponseType has a value of “Accept” or “Provisional”,
then the ResourceInformation:AssignmentInformation element MUST be present. If
ResponseInformation:ResponseType has a value of “Decline”, then the
ResourceInformation:AssignmentInformation is not applicable.
·
If ResponseInformation:ResponseType has a value of “Accept” or “Provisional”,
then the ResourceInformation:ScheduleInformation element MUST be present. If
ResponseInformation:ResponseType has a value of “Decline”, then the
ResourceInformation:ScheduleInformation is not applicable.
·
The ResponseInformation:PrecedingResourceInfoElementID and
ResponseInformation:ResponseType elements MUST be present.
·
If ResponseInformation:ResponseType has a value of “Provisional”,
then at least one of ResponseInformation:ReasonCode and/or ResponseInformation:ResponseReason
elements MUST be present.
·
If a ResourceInformation:Resource element is present, then at
least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure elements
MUST be present.
·
If a Resource:OwnershipInformation is present, then at least one
of OwnershipInformation:Owner and/or OwnershipInformation:OwningJurisdiction
elements MUST be present.
·
If a ResourceInformation:AssignmentInformation element is
present, then the AssignmentInformation:Quantity element MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“RequestedArrival”, “EstimatedArrival “, “EstimatedDeparture”, “RequestedDeparture”,
“ActualDeparture”, “RequestedReturnArrival”, “EstimatedReturnArrival“, “RequestedReturnDeparture”,
”EstimatedReturnDeparture”, “Committed”, “BeginAvailable”, “EndAvailable”, “Current”,
“ReportTo” or “Route”.
The schema for a
CommitResource message can be found in Appendix A.6.
The CommitResource message is sent by a Resource Supplier in
response to either a RequestResource or RequisitionResource message sent by the
Resource Consumer.
The message may
be canceled or updated through the CommitResource:MessageRecall element.
Below is an example of a CommitResource Message. This is an
example Response to the original RequisitionResource shown in Section 3.6.5. In this example, the two requests have different responses:
·
The “Small Animal Sheltering Team” (ResourceInfoElementID=001) is
Accepted. In this case the Schedule information is updated with Committed date.
·
The “Patrol and Surveillance Helicopters” (ResourceInfoElementID=002)
is Declined.
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<CommitResource
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMCommitResource.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis"
xmlns:gml="http://www.opengis.net/gml">
<MessageID>urn:au-qld-eoc:997754</MessageID>
<SentDateTime>2006-03-21T12:46:00+10:00</SentDateTime>
<MessageContentType>CommitResource</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<PrecedingMessageID>urn:au-qld-eoc:987654</PrecedingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<Funding>
<rm:FundCode>HP4347</rm:FundCode>
</Funding>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Charlotte</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Ryan</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>EMA</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>001</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Accept</rm:ResponseType>
</ResponseInformation>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small Animal Sheltering Team</rm:Value>
</TypeStructure>
<Description>
5-person response team to advise and support local efforts to set up a
small animal shelter
</Description>
<SpecialRequirements>A qualified veterinary
surgeon</SpecialRequirements>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>Committed</ScheduleType>
<DateTime>2006-03-21T12:46:00+10:00</DateTime>
</ScheduleInformation>
</ResourceInformation>
<ResourceInformation>
<ResourceInfoElementID>002</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>002</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Decline</rm:ResponseType>
</ResponseInformation>
</ResourceInformation>
</CommitResource>
One use of the “RequestInformation” message is
to ask questions about specific resources. In this case, the message can be the
initial message sent from the Resource Consumer to the Resource Suppliers, or
it can be a follow up message seeking further information after the Resource
Consumer has sent a RequestResource or other resource messages. A
RequestInformation can be used in this manner even after a resource has been
committed and/or deployed; however, if the request is related to the status of
a deployed resource, the RequestResourceDeploymentStatus message MUST be used
instead.
A second use of this message type is to
provide a general description of the sender’s situation and needs, with the
expectation of receiving responses suggesting suitable resources. This is useful
when the Resource Consumer is not able to issue a specific RequestResource
message because of a lack of knowledge about the resources that would be most
appropriate for the situation.
Figure 8 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the RequestInformation Message. The ERM shows the element-level details for the main entities in the RM.
Figure 8: EDXL-RM ERM for
RequestInformation Message
The following table outlines the element cardinalities for
this message type.
Table 7: RequestInformation Message Elements
|
Parent Element
|
Sub-Elements
|
|
RequestInformation
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID, IncidentInformation*,
MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, Resource, AssignmentInformation,
ScheduleInformation*
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
InventoryRefreshDateTime, DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote,
OrderID, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The RequestInformation:MessageID, ResourceMessage:SentDateTime ResourceMessage:MessageContentType,
ResourceMessage:MessageDescription, ResourceMessage:OriginatingMessageID, and ResourceMessage:ContactInformation
elements MUST be present.
·
The value of RequestInformation:MessageContentType MUST be “RequestInformation”.
·
If a RequestInformation:IncidentInformation element is present,
then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the ResourceMessage:MessageRecall element is present, then the
MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST be
present.
·
If a RequestInformation:Funding element is present, then at least
one of Funding:FundCode and/or Funding:FundingInfo elements MUST be present.
·
If a RequestInformation:ResourceInformation element is present,
then the ResourceInformation:ResourceInfoElementID element MUST be present.
·
If a ResourceInformation:Resource element is present, then at
least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure elements
MUST be present.
·
If a Resource:OwnershipInformation is present, then at least one
of OwnershipInformation:Owner and/or OwnershipInformation:OwningJurisdiction
elements MUST be present.
·
If the ResourceInformation:ScheduleInformation element is present,
then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“RequestedArrival”, “EstimatedArrival”, “ActualArrival”, “RequestedDeparture”,
“EstimatedDeparture”, “ActualDeparture”, “RequestedReturnDeparture”,
“EstimatedReturnDeparture”, “ActualReturnDeparture”, “RequestedReturnArrival”, “EstimatedReturnArrival”,
“ActualReturnArrival”, “BeginAvailable”, “EndAvailable”, “Committed”,
“Current”, “ReportTo” or “Route”.
The schema for a
RequestInformation message can be found in Appendix A.7.
The RequestInformation message may be sent by the Resource
Consumer to any number of Resource Suppliers, or may it may be sent vice versa.
The RequestInformation message may follow earlier resource messages.
The potential responses to this message include:
·
ResponseToRequestInformation (See Section 3.9)
·
ReportResourceDeploymentStatus
·
This includes Accept, Decline, and Provisional responses.
The message may be canceled or updated through the RequestInformation:MessageRecall
element.
Below is an example RequestInformation
messages. The first is intended as a follow up message to the RequestResource
and ResponseToRequestResource messages shown in Sections 3.4.5 and 3.5.5, requesting further information about the
third resource that was requested (two electrical power restoration teams).
[Note: The XML examples
shown in this section are informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<RequestInformation
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMRequestInformation.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="http://www.oasis-open.org/oasis/10"
xmlns:gml="http://www.opengis.net/gml">
<MessageID>urn:au-qld-eoc:12338</MessageID>
<SentDateTime>2006-03-21T12:35:00+10:00</SentDateTime>
<MessageContentType>RequestInformation</MessageContentType>
<MessageDescription>
Could you please advise the size (personnel and equipment) of each power
restoration team?
</MessageDescription>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<PrecedingMessageID>urn:au-qld-eoc:12332</PrecedingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Charlotte</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Ryan</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>EMA</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Electrical Power Restoration Team</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<AnticipatedFunction>
Restore power to critical infrastructure in and around the
Innisfail area
</AnticipatedFunction>
</AssignmentInformation>
</ResourceInformation>
</RequestInformation>
The “ResponseToRequestInformation” message is
used by Resource Suppliers to respond to a RequestInformation message from
Resource Consumers. If the RequestInformation message contained one or more ResourceInformation
elements, the response MUST Accept or Decline for each ResourceInformation element
with a separate ResponseInformation element. However, accepting here only
entails agreeing to supply the requested information, not agreeing to supply
resources. If the RequestInformation message did not contain any ResourceInformation
elements, one or more ResponseInformation elements MAY be included in the
response message.
Figure 9 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the ResponseToRequestInformation Message. The
ERM shows the element-level details for the main entities
in the RM.
Figure 9: EDXL-RM ERM for
ResponseToRequestInformation Message
The following table outlines the element cardinalities for
this message type.
Table 8: ResponseToRequestInformation Message Elements
|
Parent Element
|
Sub-Elements
|
|
ResponseToRequestInformation
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID, IncidentInformation*,
MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, ResponseInformation,
Resource, AssignmentInformation, ScheduleInformation*
|
|
ResponseInformation
|
PrecedingResourceInfoElementID, ResponseType, ReasonCode,
ResponseReason
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
InventoryRefreshDateTime, DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote,
OrderID, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType, DateTime, Location
|
The following rules apply to the above elements:
·
The ResponseToRequestInformation:MessageID, ResponseToRequestInformation:SentDateTime
ResponseToRequestInformation:MessageContentType, ResponseToRequestInformation:OriginatingMessageID,
ResponseToRequestInformation:PrecedingMessageID, and ResponseToRequestInformation:ContactInformation
elements MUST be present.
·
The value of ResponseToRequestInformation:MessageContentType MUST
be “ResponseToRequestInformation”.
·
If a ResponseToRequestInformation:IncidentInformation element is
present, then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the ResponseToRequestInformation:MessageRecall element is
present, then the MessageRecall:RecalledMessageID and MessageRecall:RecallType
elements MUST be present.
·
If a ResponseToRequestInformation:Funding element is present,
then at least one of Funding:FundCode and/or Funding:FundingInfo elements MUST
be present.
·
If a ResponseToRequestInformation:ResourceInformation element is
present, then the ResourceInformation:ResourceInfoElementID element MUST be
present.
·
If the ResourceInformation:ResponseInformation element is
present, then the ResponseInformation:PrecedingResourceInfoElementID and
ResponseInformation:ResponseType elements MUST be present.
·
If the ResourceInformation:ResponseInformation element is present
and the ResponseInformation:ResponseType element has a value of “Provisional”,
then at least one of ResponseInformation:ReasonCode and/or ResponseInformation:ResponseReason
elements MUST be present.
·
If a ResourceInformation:Resource element is present, then at
least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure elements
MUST be present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and
contain one of the following values:
·
“RequestedArrival”, “EstimatedArrival”, “ActualArrival”, “RequestedDeparture”,
“EstimatedDeparture”, “ActualDeparture”, “RequestedReturnDeparture”,
“EstimatedReturnDeparture”, “ActualReturnDeparture”, “RequestedReturnArrival”, “EstimatedReturnArrival”,
“ActualReturnArrival”, “BeginAvailable”, “EndAvailable”, “Committed”,
“Current”, “ReportTo” or “Route”.
The schema for a ResponseToRequestInformation message can be
found in Appendix A.8.
The ResponseToRequestInformation message is sent by a
Resource Supplier or Resource Consumer in response to an original RequestInformation
message.
The potential responses to this message include:
·
RequisitionResource message from the Resource Consumer. (See
Section 3.6)
The message may
be canceled or updated through the ResponseToRequestInformation:MessageRecall
element.
3.9.5 Message
Example
Below are two example ResponseToRequestInformation
messages. These are example responses to the RequestInformation messages shown
in Section 3.8.5.
[Note: The XML examples
shown in this section are informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<ResponseToRequestInformation
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMResponseToRequestInformation.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3" xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis"
xmlns:gml="http://www.opengis.net/gml">
<MessageID>urn:au-qld-eoc:12346</MessageID>
<SentDateTime>2006-03-21T12:37:00+10:00</SentDateTime>
<MessageContentType>ResponseToRequestInformation</MessageContentType>
<MessageDescription>
Team consists of 5 overhead (2 person) crews with material handlers; 1
overhead (2 person) crew; 2 designers; 1 team leader; 1 safety specialist and
fleet
services support. Each team is additionally equipped with
digger derrick/pole
trailer
and auxiliary (material handler or 36' bucket).
</MessageDescription>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<PrecedingMessageID>urn:au-qld-eoc:12338</PrecedingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
<xpil:ContactNumbers>
<xpil:ContactNumber xpil:CommunicationMediaType="Telephone"
xpil:ContactHours="9:00AM - 5:00PM">
<xpil:ContactNumberElement
xpil:Type="CountryCode">61</xpil:ContactNumberElement>
<xpil:ContactNumberElement
xpil:Type="AreaCode">7</xpil:ContactNumberElement>
<xpil:ContactNumberElement xpil:Type="LocalNumber">
3000
1234
</xpil:ContactNumberElement>
</xpil:ContactNumber>
</xpil:ContactNumbers>
<xpil:ElectronicAddressIdentifiers>
<xpil:ElectronicAddressIdentifier>alexj@emergencyservices.gov.au
</xpil:ElectronicAddressIdentifier>
</xpil:ElectronicAddressIdentifiers>
</rm:AdditionalContactInformation>
</ContactInformation>
</ResponseToRequestInformation>
<?xml version="1.0" encoding="UTF-8"?>
<ResponseToRequestInformation
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMResponseToRequestInformation.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis"
xmlns:gml="http://www.opengis.net/gml">
<MessageID>urn:au-qld-eoc:77397</MessageID>
<SentDateTime>2006-03-22T08:22:00+10:00</SentDateTime>
<MessageContentType>ResponseToRequestInformation</MessageContentType>
<MessageDescription>
QBuild can send a damage assessment team from Cairns this afternoon.
</MessageDescription>
<OriginatingMessageID>urn:au-qld-eoc:77388</OriginatingMessageID>
<PrecedingMessageID>urn:au-qld-eoc:77388</PrecedingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Barnaby</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">James</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>EMA</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
<xpil:ContactNumbers>
<xpil:ContactNumber xpil:CommunicationMediaType="Telephone">
<xpil:ContactNumberElement
xpil:Type="CountryCode">61</xpil:ContactNumberElement>
<xpil:ContactNumberElement xpil:Type="AreaCode">2</xpil:ContactNumberElement>
<xpil:ContactNumberElement xpil:Type="LocalNumber">
9864
4329
</xpil:ContactNumberElement>
</xpil:ContactNumber>
</xpil:ContactNumbers>
</rm:AdditionalContactInformation>
</ContactInformation>
<ContactInformation>
<rm:ContactRole>Requester</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Engineering Services: Damage Assessment Team</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<AnticipatedFunction>
Preliminary assessment of cracks in Centenary Bridge,
Innisfail.
</AnticipatedFunction>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>EstimatedDeparture</ScheduleType>
<DateTime>2006-03-22T15:00:00</DateTime>
<Location>
<rm:LocationDescription>Cairns Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedArrival</ScheduleType>
<DateTime>2006-03-25T16:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
</ResourceInformation>
</ResponseToRequestInformation>
The “OfferUnsolicitedResource” message is used
to offer available resources (that have not been requested) to assist with an
emergency response.
Figure 10 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the OfferUnsolicitedResource Message. The ERM shows the element-level details for the main entities in the RM.
Figure 10: EDXL-RM ERM for
OfferUnsolicitedResource Message
The following table outlines the element cardinalities for
this message type.
Table 9: OfferUnsolicitedResource Message Elements
|
Parent Element
|
Sub-Elements
|
|
OfferUnsolicitedResource
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, IncidentInformation*,
MessageRecall, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
ResourceInformation
|
ResourceInfoElementID, Resource,
AssignmentInformation, ScheduleInformation*
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
InventoryRefreshDateTime, DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The OfferUnsolicitedResource:MessageID, OfferUnsolicitedResource:SentDateTime
OfferUnsolicitedResource:MessageContentType, OfferUnsolicitedResource:OriginatingMessageID,
OfferUnsolicitedResource:ContactInformation, and OfferUnsolicitedResource:ResourceInformation
elements MUST be present.
·
The value of OfferUnsolicitedResource:MessageContentType MUST be
“OfferUnsolicitedResource”.
·
If an OfferUnsolicitedResource:IncidentInformation element is
present, then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the OfferUnsolicitedResource:MessageRecall element is present,
then the MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST
be present.
·
For each OfferUnsolicitedResource:ResourceInformation element,
the ResourceInformation:ResourceInfoElementID and ResourceInformation:Resource
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure
elements MUST be present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“EstimatedArrival”, “EstimatedDeparture”, “RequestedReturnDeparture”,
“RequestedReturnArrival”, “BeginAvailable”, “EndAvailable”, or “Route”.
The schema for an OfferUnsolicitedResource message can be
found in Appendix A.9.
The OfferUnsolicitedResource message is an initial message
created and sent by the Resource Supplier to any number of Resource Consumers.
The potential responses to this message include:
·
RequestInformation (See Section 3.8)
·
RequisitionResource (See Section 3.6)
The message may
be canceled or updated through the OfferUnsolicitedResource:MessageRecall
element.
Below is an example OfferUnsolicitedResource
message. This message offers a donation of 100 large and 100 small tarpaulins.
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<OfferUnsolicitedResource
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMOfferUnsolicitedResource.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3">
<MessageID>urn:au-qld-eoc:84313</MessageID>
<SentDateTime>2006-03-22T10:34:00+10:00</SentDateTime>
<MessageContentType>OfferUnsolicitedResource</MessageContentType>
<MessageDescription>
We would like to donate 100 small and 100 large tarps for use by residents
whose homes have been damaged by the cyclone.
</MessageDescription>
<OriginatingMessageID>urn:au-qld-eoc:84313</OriginatingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Owner</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Joe</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Williams</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Hardware Megastore Cairns</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
<xpil:Addresses>
<xpil:Address>
<xal:Country>
<xal:NameElement>Australia</xal:NameElement>
</xal:Country>
<xal:AdministrativeArea>
<xal:NameElement>QLD</xal:NameElement>
</xal:AdministrativeArea>
<xal:Locality>
<xal:NameElement>Cairns</xal:NameElement>
</xal:Locality>
<xal:Thoroughfare>
<xal:NameElement>Spence St</xal:NameElement>
</xal:Thoroughfare>
<xal:PostCode>
<xal:Identifier>4870</xal:Identifier>
</xal:PostCode>
</xpil:Address>
</xpil:Addresses>
<xpil:ContactNumbers>
<xpil:ContactNumber xpil:CommunicationMediaType="Telephone"
xpil:ContactHours="8:00AM - 6:00PM">
<xpil:ContactNumberElement
xpil:Type="CountryCode">61</xpil:ContactNumberElement>
<xpil:ContactNumberElement
xpil:Type="AreaCode">7</xpil:ContactNumberElement>
<xpil:ContactNumberElement xpil:Type="LocalNumber">
4052
0378
</xpil:ContactNumberElement>
</xpil:ContactNumber>
</xpil:ContactNumbers>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Large tarpaulin</rm:Value>
</TypeStructure>
<Description> 30 x 40 ft, 800 denier blue tarp </Description>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>100</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<AssignmentInstructions>
<rm:ModeOfTransportation>
We have a truck available to deliver to Innisfail (or other
preferred location).
</rm:ModeOfTransportation>
</AssignmentInstructions>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>BeginAvailable</ScheduleType>
<DateTime>2006-03-22T12:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Hardware Megastore
Cairns</rm:LocationDescription>
<rm:Address>
<xal:Country>
<xal:NameElement>Australia</xal:NameElement>
</xal:Country>
<xal:AdministrativeArea>
<xal:NameElement>QLD</xal:NameElement>
</xal:AdministrativeArea>
<xal:Locality>
<xal:NameElement>Cairns</xal:NameElement>
</xal:Locality>
<xal:Thoroughfare>
<xal:NameElement>Spence St</xal:NameElement>
</xal:Thoroughfare>
<xal:PostCode>
<xal:Identifier>4870</xal:Identifier>
</xal:PostCode>
</rm:Address>
</Location>
</ScheduleInformation>
</ResourceInformation>
<ResourceInformation>
<ResourceInfoElementID>002</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small tarpaulin</rm:Value>
</TypeStructure>
<Description> 8 x 10 ft, 800 denier blue tarp </Description>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>100</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<AssignmentInstructions>
<rm:ModeOfTransportation>
We have a truck available to deliver to Innisfail (or other
preferred location).
</rm:ModeOfTransportation>
</AssignmentInstructions>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>BeginAvailable</ScheduleType>
<DateTime>2006-03-22T12:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Hardware Megastore
Cairns</rm:LocationDescription>
<rm:Address>
<xal:Country>
<xal:NameElement>Australia</xal:NameElement>
</xal:Country>
<xal:AdministrativeArea>
<xal:NameElement>QLD</xal:NameElement>
</xal:AdministrativeArea>
<xal:Locality>
<xal:NameElement>Cairns</xal:NameElement>
</xal:Locality>
<xal:Thoroughfare>
<xal:NameElement>Spence St</xal:NameElement>
</xal:Thoroughfare>
<xal:PostCode>
<xal:Identifier>4870</xal:Identifier>
</xal:PostCode>
</rm:Address>
</Location>
</ScheduleInformation>
</ResourceInformation>
</OfferUnsolicitedResource>
The “ReleaseResource” message is used by
authorities at the incident to “release” (demobilize) a resource back to its
original point of assignment or to another location / assignment.
Figure 11 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the ReleaseResource Message. The ERM shows the element-level details for the main entities in the RM.
Figure 11: EDXL-RM ERM for ReleaseResource Message
The following table outlines the element cardinalities for
this message type.
Table 11: ReleaseResource Message Elements
|
Parent Element
|
Sub-Elements
|
|
ReleaseResource
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID,
IncidentInformation*, MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, ResponseInformation,
Resource, AssignmentInformation, ScheduleInformation*
|
|
ResponseInformation
|
PrecedingResourceInfoElementID, ResponseType, ReasonCode,
ResponseReason
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction,
PriceQuote, OrderID, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType, DateTime, Location
|
The following rules apply to the above elements:
·
The ReleaseResource:MessageID, ReleaseResource:SentDateTime, ReleaseResource
Message:MessageContentType, ReleaseResource:OriginatingMessageID, ReleaseResource:ContactInformation,
and ReleaseResource:ResourceInformation elements MUST be present.
·
The value of ReleaseResource:MessageContentType MUST be “ReleaseResource”.
·
If a ReleaseResource:IncidentInformation element is present, then
at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the ReleaseResource:MessageRecall element is present, then the
MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST be
present.
·
If a ReleaseResource:Funding element is present, then at least
one of Funding:FundCode and/or Funding:FundingInfo elements MUST be present.
·
For each ReleaseResource:ResourceInformation element, the
ResourceInformation:ResourceInfoElementID and ResourceInformation:Resource
elements MUST be present.
·
If a ResourceInformation:ResponseInformation element is present,
then the ResponseInformation:PrecedingResourceInfoElementID and
ResponseInformation:ResponseType elements MUST be present.
·
If a ResourceInformation:ResponseInformation element is present and
the ResponseInformation:ResponseType has a value of “Provisional”, then at
least one of ResponseInformation:ReasonCode and/or ResponseInformation:ResponseReason
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure
elements MUST be present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
If the ResourceInformation:AssignmentInformation element is
present, then the AssignmentInformation:Quantity element MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST must be present
and contain one of the following values:
·
“RequestedArrival”, “EstimatedArrival”, “ActualArrival”,
“RequestedDeparture” , “EstimatedDeparture”, “ActualDeparture”,
“RequestedReturnDeparture”, “EstimatedReturnDeparture”, “ActualReturnDeparture”
“RequestedReturnArrival”, “EstimatedReturnArrival”, “BeginAvailable”,
“EndAvailable”, “Committed”, “ReportTo”, “Current” or “Route”.
The schema for a ReleaseResource message can be found in
Appendix A.10.
The ReleaseResource message is sent by the Resource Consumer
to the Resource Supplier, and typically follows an earlier sequence of messages
(e.g., RequisitionResource and CommitResource messages).
The potential responses to this message include:
·
RequestInformation (See Section 3.8)
·
RequisitionResource (See Section 3.6)
·
Consumers waiting on the release of resources may send to a
RequisitionResource Message after receipt of a ReleaseResource Message.
The message may
be canceled or updated through the ReleaseResource:MessageRecall element.
3.11.5 Message Example
Below is an example ReleaseResource message. This
message releases the Small Animal Sheltering Team committed in the example in
Section 3.7.5.
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<ReleaseResource
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMReleaseResource.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis">
<MessageID>urn:au-qld-eoc:997985</MessageID>
<SentDateTime>2006-03-29T10:17:00+10:00</SentDateTime>
<MessageContentType>ReleaseResource</MessageContentType>
<MessageDescription>
Small Animal Sheltering Team will be flying back to Cairns this evening.
</MessageDescription>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
<xpil:ContactNumbers>
<xpil:ContactNumber xpil:CommunicationMediaType="Telephone"
xpil:ContactHours="9:00AM - 5:00PM">
<xpil:ContactNumberElement
xpil:Type="CountryCode">61</xpil:ContactNumberElement>
<xpil:ContactNumberElement
xpil:Type="AreaCode">7</xpil:ContactNumberElement>
<xpil:ContactNumberElement xpil:Type="LocalNumber">
3000
1234
</xpil:ContactNumberElement>
</xpil:ContactNumber>
</xpil:ContactNumbers>
<xpil:ElectronicAddressIdentifiers>
<xpil:ElectronicAddressIdentifier>
alexj@emergencyservices.gov.au
</xpil:ElectronicAddressIdentifier>
</xpil:ElectronicAddressIdentifiers>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small Animal Sheltering Team</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>Current</ScheduleType>
<Location>
<rm:LocationDescription>Innisfail Animal
Refuge</rm:LocationDescription>
<rm:Address>
<xal:Country>
<xal:NameElement>Australia</xal:NameElement>
</xal:Country>
<xal:AdministrativeArea>
<xal:NameElement>QLD</xal:NameElement>
</xal:AdministrativeArea>
<xal:Locality>
<xal:NameElement>Innisfail</xal:NameElement>
</xal:Locality>
<xal:Thoroughfare>
<xal:NameElement>Downing St</xal:NameElement>
<xal:Number>27</xal:Number>
</xal:Thoroughfare>
<xal:PostCode>
<xal:Identifier>4860</xal:Identifier>
</xal:PostCode>
</rm:Address>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedReturnDeparture</ScheduleType>
<DateTime>2006-03-29T19:05:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedReturnArrival</ScheduleType>
<DateTime>2006-03-29T19:55:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Cairns Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
</ResourceInformation>
</ReleaseResource>
The “RequestReturn” message is used to request
release (demobilization) of resource(s) back to its original owning
jurisdiction and location or to another location / assignment.
Figure 12 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the RequestReturn Message. The ERM shows the element-level details for the main entities in the RM.
Figure 12: EDXL-RM ERM for
RequestReturn Message
The following table outlines the element cardinalities for
this message type.
Table 12: RequestReturn Message Elements
|
Parent Element
|
Sub-Elements
|
|
RequestReturn
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID,
IncidentInformation*, MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, Resource,
AssignmentInformation, ScheduleInformation*
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote,
OrderID, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The RequestReturn:MessageID, ResourceMessage:SentDateTime, RequestReturn:MessageContentType,
RequestReturn:OriginatingMessageID, RequestReturn:ContactInformation, and RequestReturn:ResourceInformation
elements MUST be present.
·
The value of RequestReturn:MessageContentType MUST be “RequestReturn”.
·
If a RequestReturn:IncidentInformation element is present, then
at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the RequestReturn:MessageRecall element is present, then the
MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST be
present.
·
If a RequestReturn:Funding element is present, then at least one
of Funding:FundCode and/or Funding:FundingInfo elements MUST be present.
·
The ResourceInformation:ResourceInfoElementID and ResourceInformation:Resource
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure
elements MUST be present for each ResourceInformation:Resource element present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“RequestedArrival”, “EstimatedArrival”, “ActualArrival”,
“RequestedDeparture”, “EstimatedDeparture”, “ActualDeparture”, “RequestedReturnDeparture”,
“RequestedReturnArrival”, “BeginAvailable”, “Committed”, “EndAvailable”, “Current”,
“ReportTo” or “Route”.
The schema for a RequestReturn
message can be found in Appendix A.11.
3.12.4
Message Flow
The RequestReturn message is sent by the Resource Supplier
to the Resource Consumer, and typically follows an earlier sequence of messages
(e.g., RequisitionResource and CommitResource messages).
The potential responses to this message include:
·
ResponseToRequestReturn (See Section 3.13)
·
ReleaseResource (See Section 3.11)
·
This includes Accept, Decline, and Provisional responses.
The message may
be canceled or updated through the RequestReturn:MessageRecall element.
Below is an example of a RequestReturn Message, in which one
request return is shown:
·
Small Animal Sheltering Team (ResourceInfoElementID=001).
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<RequestReturn
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMRequestReturn.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis">
<MessageID>urn:au-qld-eoc:997821</MessageID>
<SentDateTime>2006-03-28T14:48:00+10:00</SentDateTime>
<MessageContentType>RequestReturn</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Charlotte</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Ryan</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>EMA</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small Animal Sheltering Team</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>RequestedReturnArrival</ScheduleType>
<DateTime>2006-03-29T20:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Cairns Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
</ResourceInformation>
</RequestReturn>
The “ResponseToRequestReturn” message is used
by Resource Consumers to respond to a RequestReturn message from Resource Suppliers.
The response identifies the resources in the original request message and how
the Resource Consumer has responded.
Figure 13 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the ResponseToRequestReturn Message. The ERM shows the element-level details for the main entities in the RM.
Figure 13: EDXL-RM ERM for
ResponseToRequestReturn Message
The following table outlines the element cardinalities for
this message type.
Table 13: ResponseToRequestReturn Message Elements
|
Parent Element
|
Sub-Elements
|
|
ResponseToRequestReturn
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID,
IncidentInformation*, MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, ResponseInformation, Resource,
AssignmentInformation, ScheduleInformation*
|
|
ResponseInformation
|
PrecedingResourceInfoElementID, ResponseType, ReasonCode,
ResponseReason
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote,
OrderID, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The ResponseToRequestReturn:MessageID, ResponseToRequestReturn:SentDateTime,
ResponseToRequestReturn:MessageContentType, ResponseToRequestReturn:OriginatingMessageID,
ResponseToRequestReturn:PrecedingMessageID, ResponseToRequestReturn:ContactInformation,
and ResponseToRequestReturn:ResourceInformation elements MUST be present.
·
The value of ResponseToRequestReturn:MessageContentType MUST be “ResponseToRequestReturn”.
·
If a ResponseToRequestReturn:IncidentInformation element is
present, then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the ResponseToRequestReturn:MessageRecall element is present,
then the MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST
be present.
·
If a ResponseToRequestReturn:Funding element is present, then at
least one of Funding:FundCode and/or Funding:FundingInfo elements MUST be
present.
·
The ResourceInformation:ResourceInfoElementID and ResourceInformation:ResponseInformation
elements MUST be present.
·
The ResponseInformation:PrecedingResourceInfoElementID and ResponseInformation:ResponseType
elements MUST be present.
·
If the ResponseInformation:ResponseType element has a value of “Provisional”,
then at least one of ResponseInformation:ReasonCode and/or ResponseInformation:ResponseReason
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure
elements MUST be present for each ResourceInformation:Resource element present.
·
The Resource:ResourceStatus element MUST be present for each
ResourceInformation:Resource element present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
The ResourceStatus:DeploymentStatus and
ResourceStatus:Availability elements MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“RequestedArrival”, “EstimatedArrival”, “ActualArrival”,
“RequestedDeparture”, “EstimatedDeparture”, “ActualDeparture”, RequestedReturnArrival”,
“EstimatedReturnArrival”,” “BeginAvailable”, “RequestedReturnDeparture”,
“EstimatedReturnDeparture”, “ActualReturnDeparture”, “EndAvailable”,
“Committed”, “Current”, “ReportTo” or “Route.”
The schema for a ResponseToRequestReturn message can be
found in Appendix A.12.
3.13.4 Message Flow
The ResponseToRequestReturn message is sent by a Resource Consumer
in response to an original RequestReturn message sent by the Resource Supplier.
The potential responses to this message include:
·
RequestReturn (See Section 3.12)
·
The Supplier may send this response when the Consumer has
specified return conditions with which the Supplier is not in agreement.
The message will
typically be followed by a ReleaseResource message (See Section 3.11) when the Resource Consumer is ready to return the resource to the Resource
Supplier.
The message may
be canceled or updated through the ResponseToRequestReturn:MessageRecall
element.
Below is an example of a ResponseToRequestReturn message.
This is an example response to the RequestReturn message shown in Section.3.12.5 The sender of the message is the original resource requester (Resource
Consumer). The response is an “Accept” (i.e., the Resource Consumer agrees to
return the resource according to the specified schedule).
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<ResponseToRequestReturn
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMResponseToRequestReturn.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis">
<MessageID>urn:au-qld-eoc:997981</MessageID>
<SentDateTime>2006-03-28T16:17:00+10:00</SentDateTime>
<MessageContentType>ResponseToRequestReturn</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<PrecedingMessageID>urn:au-qld-eoc:997821</PrecedingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>001</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Accept</rm:ResponseType>
</ResponseInformation>
</ResourceInformation>
</ResponseToRequestReturn>
The “RequestQuote” message is used by the
Resource Consumer to request a price quote from the Resource Supplier.
Figure 14 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the RequestQuote Message. The ERM shows the element-level details for the main entities in the RM.
Figure 14: EDXL-RM ERM for
RequestQuote Message
The following table outlines the element cardinalities for
this message type.
Table 14: RequestQuote Message Elements
|
Parent Element
|
Sub-Elements
|
|
RequestQuote
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID, IncidentInformation*,
MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, ResponseInformation,
Resource, AssignmentInformation, ScheduleInformation*
|
|
ResponseInformation
|
PrecedingResourceInfoElementID, ResponseType, ReasonCode,
ResponseReason
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The RequestQuote:MessageID, RequestQuote:SentDateTime, RequestQuote:MessageContentType,
RequestQuote:OriginatingMessageID, RequestQuote:ContactInformation, and RequestQuote:ResourceInformation
elements MUST be present.
·
The value of RequestQuote:MessageContentType MUST be “RequestQuote”.
·
If a RequestQuote:IncidentInformation element is present, then at
least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the RequestQuote:MessageRecall element is present, then the
MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST be
present.
·
If a RequestQuote:Funding element is present, then at least one
of Funding:FundCode and/or Funding:FundingInfo elements MUST be present.
·
The ResourceInformation:ResourceInfoElementID and ResourceInformation:Resource
elements MUST be present.
·
If the ResourceInformation:ResponseInformation element is
present, then the ResponseInformation:PrecedingResourceInfoElementID” and
“ResponseInformation:ResponseType MUST be present.
·
If ResponseInformation:ResponseType has a value of “Conditional”,
then at least one of ResponseInformation:ReasonCode and/or ResponseInformation:ResponseReason
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure
elements MUST be present for each ResourceInformation:Resource element present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“RequestedArrival”, “RequestedDeparture”, “EstimatedReturnDeparture”,
“EstimatedReturnArrival”, “ReportTo” or “Route”.
The schema for a RequestQuote message can be found in Appendix
A.13.
3.14.4 Message Flow
The RequestQuote message is usually an initial message
created and sent by the Resource Consumer to any number of Resource Suppliers.
The potential responses to this message include:
·
ResponseToRequestQuote (See 3.15)
·
This includes Accept, Decline, and Provisional responses.
The message may
be canceled or updated through the RequestQuote:MessageRecall element.
Below is an example RequestQuote message. This
message requests quotes for a “Debris Management Team” (ResourceInfoElementID=001)
and two “All Terrain Cranes” (ResourceInfoElementID=002).
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<RequestQuote
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMRequestQuote.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis">
<MessageID>urn:au-qld-eoc:77388</MessageID>
<SentDateTime>2006-03-30T10:45:00+10:00</SentDateTime>
<MessageContentType>RequestQuote</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:77388</OriginatingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
<xpil:ContactNumbers>
<xpil:ContactNumber xpil:CommunicationMediaType="Telephone"
xpil:ContactHours="9:00AM - 5:00PM">
<xpil:ContactNumberElement
xpil:Type="CountryCode">61</xpil:ContactNumberElement>
<xpil:ContactNumberElement
xpil:Type="AreaCode">7</xpil:ContactNumberElement>
<xpil:ContactNumberElement xpil:Type="LocalNumber">
3000
1234
</xpil:ContactNumberElement>
</xpil:ContactNumber>
</xpil:ContactNumbers>
<xpil:ElectronicAddressIdentifiers>
<xpil:ElectronicAddressIdentifier>alexj@emergencyservices.gov.au
</xpil:ElectronicAddressIdentifier>
</xpil:ElectronicAddressIdentifiers>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Debris Management Team</rm:Value>
</TypeStructure>
<Description>
5 person team to clear roads of debris incl. fallen
trees. </Description>
<SpecialRequirements>
Team to supply own equipment, such as trucks and chainsaws
</SpecialRequirements>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<AssignmentInstructions>
<rm:ModeOfTransportation>Team's own
trucks</rm:ModeOfTransportation>
</AssignmentInstructions>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>ReportTo</ScheduleType>
<DateTime>2006-04-01T09:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Johnstone Shire
Council</rm:LocationDescription>
<rm:Address>
<xal:Country>
<xal:NameElement>Australia</xal:NameElement>
</xal:Country>
<xal:AdministrativeArea>
<xal:NameElement>QLD</xal:NameElement>
</xal:AdministrativeArea>
<xal:Locality>
<xal:NameElement>Innisfail</xal:NameElement>
</xal:Locality>
<xal:Thoroughfare>
<xal:NameElement>Rankin St</xal:NameElement>
<xal:Number>70</xal:Number>
</xal:Thoroughfare>
</rm:Address>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedReturnDeparture</ScheduleType>
<DateTime>2006-04-21T09:00:00+10:00</DateTime>
</ScheduleInformation>
</ResourceInformation>
<ResourceInformation>
<ResourceInfoElementID>002</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>All Terrain Crane</rm:Value>
</TypeStructure>
<Description> Crane with minimum boom reach of 150 feet.
</Description>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>2</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>ReportTo</ScheduleType>
<DateTime>2006-04-01T09:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Johnstone Shire
Council</rm:LocationDescription>
<rm:Address>
<xal:Country>
<xal:NameElement>Australia</xal:NameElement>
</xal:Country>
<xal:AdministrativeArea>
<xal:NameElement>QLD</xal:NameElement>
</xal:AdministrativeArea>
<xal:Locality>
<xal:NameElement>Innisfail</xal:NameElement>
</xal:Locality>
<xal:Thoroughfare>
<xal:NameElement>Rankin St</xal:NameElement>
<xal:Number>70</xal:Number>
</xal:Thoroughfare>
</rm:Address>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedReturnDeparture</ScheduleType>
<DateTime>2006-04-21T09:00:00+10:00</DateTime>
</ScheduleInformation>
</ResourceInformation>
</RequestQuote>
The “ResponseToRequestQuote” message is used
by the Resource Supplier to respond to a RequestQuote Message. The supplier may
respond with pricing or decline to respond with pricing (i.e. a response that
says that the Resource Supplier is unable to supply a requested quote). The
Resource Supplier may provide quotes for several alternative resources that
match a single resource request.
Figure 15 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the ResponseToRequestQuote Message. The ERM shows the element-level details for the main entities in the RM.
Figure 15: EDXL-RM ERM for
ResponseToRequestQuote Message
The following table outlines the element cardinalities for
this message type.
Table 15: ResponseToRequestQuote Message Elements
|
Parent Element
|
Sub-Elements
|
|
ResponseToRequestQuote
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID, IncidentInformation*,
MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, ResponseInformation, Resource,
AssignmentInformation, ScheduleInformation*
|
|
ResponseInformation
|
PrecedingResourceInfoElementID, ResponseType, ReasonCode,
ResponseReason
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
InventoryRefreshDateTime, DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote,
AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The ResponseToRequestQuote:MessageID, ResponseToRequestQuote:SentDateTime,
ResponseToRequestQuote:MessageContentType, ResponseToRequestQuote:OriginatingMessageID,
ResponseToRequestQuote:PrecedingMessageID, ResponseToRequestQuote:ContactInformation,
and ResponseToRequestQuote:ResourceInformation elements MUST be present.
·
The value of ResponseToRequestQuote:MessageContentType MUST be
“ResponseToRequest Quote”.
·
If a ResponseToRequestQuote:IncidentInformation element is
present, then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the ResponseToRequestQuote:MessageRecall element is present,
then the MessageRecall:RecalledMessageID and MessageRecall:RecallType elements MUST
be present.
·
If a ResponseToRequestQuote:Funding element is present, then at
least one of Funding:FundCode and/or Funding:FundingInfo elements MUST be
present.
·
The ResourceInformation:ResourceInfoElementID and ResourceInformation:ResponseInformation
elements MUST be present.
·
If the ResponseInformation:ResponseType element has a value of
“Accept” or “Provisional”, then the ResourceInformation:Resource element MUST
be present.
·
The ResponseInformation:PrecedingResourceInfoElementID and ResponseInformation:ResponseType
elements MUST be present.
·
If ResponseInformation:ResponseType has a value of “Provisional”,
at least one of ResponseInformation:ReasonCode and/or ResponseInformation:ResponseReason
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or
Resource:TypeStructure elements MUST be present for each ResourceInformation:Resource
element present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction element MUST be present.
·
If a ResourceInformation:AssignmentInformation element is
present, then the AssignmentInformation:PriceQuote element MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“EstimatedArrival”, “RequestedArrival”, “RequestedDeparture”, “EstimatedDeparture”,
“RequestedReturnDeparture”, “EstimatedReturnDeparture”, “RequestedReturnArrival”,
“EstimatedReturnArrival”, “BeginAvailable”, EndAvailable”, “Current”, “ReportTo”
or “Route”.
The schema for a ResponseToRequestQuote
message can be found in Appendix A.14.
3.15.4 Message Flow
The ResponseToRequestQuote message is sent by the Resource
Supplier to the Resource Consumer in response to a RequestQuote message.
The potential responses to this message include:
·
Request Information (See Section 3.8)
·
RequisitionResource (See Section 3.6).
The message may
be canceled or updated through the ResponseToRequestQuote:MessageRecall
element.
Below is an example ResponseToRequestQuote
message. The message is a possible response to the RequestQuote message shown
in Section 3.14.5. The first quote
request (“Debris Management Team”, ResourceInfoElementID=001)
is accepted, while the second (“All Terrain Crane”, ResourceInfoElementID=002)
is declined.
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<ResponseToRequestQuote
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMResponseToRequestQuote.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis">
<MessageID>urn:au-qld-eoc:77396</MessageID>
<SentDateTime>2006-03-28T14:48:00+10:00</SentDateTime>
<MessageContentType>ResponseToRequestQuote</MessageContentType>
<MessageDescription>
This message provides a quote for the services of a debris management team
for the requested period of 3 weeks. We do not have any all-terrain cranes, and
therefore unable to quote on this element of the request.
</MessageDescription>
<OriginatingMessageID>urn:au-qld-eoc:77388</OriginatingMessageID>
<PrecedingMessageID>urn:au-qld-eoc:77388</PrecedingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Alison</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Smith</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>QBuild</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ContactInformation>
<rm:ContactRole>Requester</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>001</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Accept</rm:ResponseType>
</ResponseInformation>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Debris Management Team</rm:Value>
</TypeStructure>
<Description>
5 person team to clear roads of debris incl. fallen
trees. </Description>
<SpecialRequirements>
Team to supply own equipment, such as trucks and chainsaws
</SpecialRequirements>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
<PriceQuote>
<rm:QuantityText>Daily rate: $2100</rm:QuantityText>
<rm:QuantityText>Total before tax: $31500</rm:QuantityText>
<rm:QuantityText>Tax: $3150</rm:QuantityText>
<rm:QuantityText>Total including tax: $34650</rm:QuantityText>
<rm:QuantityText>
NOTES: Accommodation for the team will be organised
and paid by us. Team will
work Mon-Fri for 3 weeks.Total including tax: $34650</rm:QuantityText>
</PriceQuote>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>BeginAvailable</ScheduleType>
<DateTime>2006-03-31T15:00:00+10:00</DateTime>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>ReportTo</ScheduleType>
<DateTime>2006-04-01T09:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Johnstone Shire
Council</rm:LocationDescription>
<rm:Address>
<xal:Country>
<xal:NameElement>Australia</xal:NameElement>
</xal:Country>
<xal:AdministrativeArea>
<xal:NameElement>QLD</xal:NameElement>
</xal:AdministrativeArea>
<xal:Locality>
<xal:NameElement>Innisfail</xal:NameElement>
</xal:Locality>
<xal:Thoroughfare>
<xal:NameElement>Rankin St</xal:NameElement>
<xal:Number>70</xal:Number>
</xal:Thoroughfare>
</rm:Address>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedReturnDeparture</ScheduleType>
<DateTime>2006-04-21T09:00:00+10:00</DateTime>
</ScheduleInformation>
</ResourceInformation>
<ResourceInformation>
<ResourceInfoElementID>002</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>002</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Decline</rm:ResponseType>
</ResponseInformation>
</ResourceInformation>
</ResponseToRequestQuote>
The “RequestResourceDeploymentStatus” message
is used to request the current status of one or more deployed resources. It can
be sent by the Resource Supplier to the Resource Consumer (e.g., to check the
status of the resource after a “ReleaseResource” message) or by the Resource
Consumer to the Resource Supplier (e.g., to track the progress of a resource
after a “RequisitionResource” message).
Figure 16 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the RequestResourceDeploymentStatus Message.
The ERM shows the element-level details for the main
entities in the RM.
Figure 16: EDXL-RM ERM for
RequestResourceDeploymentStatus Message
The following table outlines the element cardinalities for
this message type.
Table 16: RequestResourceDeploymentStatus Message Elements
|
Parent Element
|
Sub-Elements
|
|
RequestResourceDeploymentStatus
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID, IncidentInformation*,
MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, Resource,
AssignmentInformation, ScheduleInformation*
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote,
OrderID, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The RequestResourceDeploymentStatus:MessageID, RequestResourceDeploymentStatus:SentDateTime,
RequestResourceDeploymentStatus:MessageContentType, RequestResourceDeploymentStatus:OriginatingMessageID,
RequestResourceDeploymentStatus:ContactInformation, and RequestResourceDeploymentStatus:ResourceInformation
elements MUST be present.
·
The value of RequestResourceDeploymentStatus:MessageContentType
MUST be “RequestResourceDeploymentStatus”.
·
If a RequestResourceDeploymentStatus:IncidentInformation element
is present, then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the RequestResourceDeploymentStatus:MessageRecall element is
present, then the MessageRecall:RecalledMessageID and MessageRecall:RecallType
elements MUST be present.
·
If a RequestResourceDeploymentStatus:Funding element is present,
then at least one of Funding:FundCode and/or Funding:FundingInfo elements MUST
be present.
·
The ResourceInformation:ResourceInfoElementID and ResourceInformation:Resource
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure
element MUST be present for each ResourceInformation:Resource element present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“RequestedArrival”, “EstimatedArrival”, “ActualArrival”, “RequestedDeparture”,
“EstimatedDeparture”, “ActualDeparture”, “RequestedReturnDeparture”,
“EstimatedReturnDeparture”, “ActualReturnDeparture”, “RequestedReturnArrival”, “EstimatedReturnArrival”,
“ActualReturnArrival”, “BeginAvailable”, “EndAvailable”, “Committed”, “Current”,
“ReportTo” or “Route”.
The schema for a RequestResourceDeploymentStatus
message can be found in Appendix A.15.
The RequestResourceDeploymentStatus message can be sent from
the Resource Supplier to the Resource Consumer, or from the Resource Consumer
to the Resource Supplier, any time after a resource is requisitioned or
committed.
The potential responses to this message include:
·
ReportResourceDeploymentStatus (See Section 3.17)
·
This may include Accept, Decline, and Provisional responses.
The message may
be canceled or updated through the RequestResourceDeploymentStatus:MessageRecall
element.
Below is an example RequestResourceDeploymentStatus
message. This message requests the deployment status of the “Small Animal
Sheltering Team”; it follows on from the example CommitResource message in
Section 3.7.5, and precedes the ReleaseResource
message in Section 3.11.5 .
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<RequestResourceDeploymentStatus
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMRequestResourceDeploymentStatus.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis">
<MessageID>urn:au-qld-eoc:997958</MessageID>
<SentDateTime>2006-03-25T09:05:00+10:00</SentDateTime>
<MessageContentType>RequestResourceDeploymentStatus</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small Animal Sheltering Team</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>EstimatedArrival</ScheduleType>
<DateTime>2006-03-25T09:30:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail Animal Refuge</rm:LocationDescription>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedReturnDeparture</ScheduleType>
<DateTime>2006-03-30T17:00:00+10:00</DateTime>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>Committed</ScheduleType>
<DateTime>2006-03-21T12:46:00+10:00</DateTime>
</ScheduleInformation>
</ResourceInformation>
</RequestResourceDeploymentStatus>
The “ReportResourceDeploymentStatus” message is
used to report on the current status of any deployed resource. The message can
be sent from the Resource Supplier to the Resource Consumer, or from the
Resource Consumer to the Resource Supplier.
Figure 17 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the ReportResourceDeploymentStatus Message. The
ERM shows the element-level details for the main entities
in the RM.
Figure 17: EDXL-RM ERM for ReportResourceDeploymentStatus
Message
The following table outlines the element cardinalities for
this message type.
Table 17: ReportResourceDeploymentStatus Message Elements
|
Parent Element
|
Sub-Elements
|
|
ReportResourceDeploymentStatus
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID,
IncidentInformation*, MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, ResponseInformation, Resource,
AssignmentInformation, ScheduleInformation*
|
|
ResponseInformation
|
PrecedingResourceInfoElementID, ResponseType, ReasonCode,
ResponseReason
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
InventoryRefreshDateTime, DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote,
OrderID, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The ReportResourceDeploymentStatus:MessageID, ReportResourceDeploymentStatus:SentDateTime,
ReportResourceDeploymentStatus:MessageContentType, ReportResourceDeploymentStatus:OriginatingMessageID,
ReportResourceDeploymentStatus:ContactInformation, and ReportResourceDeploymentStatus:ResourceInformation
elements MUST be present.
·
The value of ReportResourceDeploymentStatus:MessageContentType
MUST be “ReportResourceDeploymentStatus”.
·
If a ReportResourceDeploymentStatus:IncidentInformation element
is present, then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the ReportResourceDeploymentStatus:MessageRecall element is
present, then the MessageRecall:RecalledMessageID and MessageRecall:RecallType
elements MUST be present.
·
If a ReportResourceDeploymentStatus:Funding element is present,
then at least one of Funding:FundCode and/or Funding:FundingInfo elements MUST
be present.
·
The ResourceInformation:ResourceInfoElementID and ResourceInformation:Resource
elements MUST be present.
·
If the ResourceInformation:ResponseInformation element is
present, then the ResponseInformation:PrecedingResourceInfoElementID and
ResponseInformation:ResponseType elements MUST be present.
·
If the ResponseInformation:ResponseType element has a value of “Provisional”,
at least one of ResponseInformation:ReasonCode and/or ResponseInformation:ResponseReason
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or
Resource:TypeStructure element MUST be present for each
ResourceInformation:Resource element present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“RequestedArrival”, “EstimatedArrival”, “ActualArrival”, “RequestedDeparture”,
“EstimatedDeparture”, “ActualDeparture”, “RequestedReturnDeparture”,
“EstimatedReturnDeparture”, “ActualReturnDeparture”, “RequestedReturnArrival”, “EstimatedReturnArrival”,
“ActualReturnArrival”, “BeginAvailable”, “EndAvailable”, “Committed”, “Current”,
“ReportTo” or “Route”.
The schema for a ReportResourceDeploymentStatus message can
be found in Appendix A.16.
The ReportResourceDeploymentStatus message can be sent from
the Resource Supplier to the Resource Consumer, or from the Resource Consumer
to the Resource Supplier, any time after a resource is requisitioned or
committed. The message MAY be sent in response to an earlier
RequestResourceDeploymentStatus message. (See Section 3.16)
The message may
be canceled or updated through the EDXLResourceMessage:MessageRecall element.
Below is an example ReportResourceDeploymentStatus
message. This message shows a possible response to the
RequestResourceDeploymentStatus message in Section 3.16.
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<ReportResourceDeploymentStatus
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMReportResourceDeploymentStatus.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis">
<MessageID>urn:au-qld-eoc:997967</MessageID>
<SentDateTime>2006-03-25T09:16:00+10:00</SentDateTime>
<MessageContentType>ReportResourceDeploymentStatus</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<PrecedingMessageID>urn:au-qld-eoc:997958</PrecedingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Charlotte</xnl:NameElement>
<xnl:NameElement xnl:ElementType="LastName">Ryan</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>EMA</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ContactInformation>
<rm:ContactRole>Requester</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>001</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Accept</rm:ResponseType>
</ResponseInformation>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small Animal Sheltering Team</rm:Value>
</TypeStructure>
<ResourceStatus>
<DeploymentStatus>
<rm:ValueListURN>urn:x-hazard:vocab:deploymentStatusTypes</rm:ValueListURN>
<rm:Value>In Transit</rm:Value>
</DeploymentStatus>
</ResourceStatus>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>ActualDeparture</ScheduleType>
<DateTime>2006-03-25T08:20:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Cairns Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>ActualArrival</ScheduleType>
<DateTime>2006-03-25T09:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
<ScheduleInformation>
<ScheduleType>EstimatedArrival</ScheduleType>
<DateTime>2006-03-25T09:40:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Innisfail Animal
Refuge</rm:LocationDescription>
</Location>
</ScheduleInformation>
</ResourceInformation>
</ReportResourceDeploymentStatus>
The “RequestExtendedDeploymentDuration”
message is sent by the Resource Consumer to the Resource Supplier when the
Consumer wishes to retain one or more resources longer than previously agreed
(e.g., in the original RequisitionResource and CommitResource messages).
Figure 18 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the RequestExtendedDeploymentDuration
Message. The ERM shows the element-level details for the
main entities in the RM.
Figure 18: EDXL-RM ERM for
RequestExtendedDeploymentDuration Message
The following table outlines the element cardinalities for
this message type.
Table 18: RequestExtendedDeploymentDuration Message
Elements
|
Parent Element
|
Sub-Elements
|
|
RequestExtendedDeploymentDuration
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID, IncidentInformation*,
MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, Resource,
AssignmentInformation, ScheduleInformation*
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restriction, AnticipatedFunction, PriceQuote,
OrderID
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The RequestExtendedDeploymentDuration:MessageID, RequestExtendedDeploymentDuration:SentDateTime,
RequestExtendedDeploymentDuration:MessageContentType, RequestExtendedDeploymentDuration:OriginatingMessageID,
RequestExtendedDeploymentDuration:ContactInformation, and RequestExtendedDeploymentDuration:ResourceInformation
elements MUST be present.
·
The value of RequestExtendedDeploymentDuration:MessageContentType
MUST be “RequestExtendedDeploymentDuration”.
·
If a RequestExtendedDeploymentDuration:IncidentInformation
element is present, then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the RequestExtendedDeploymentDuration:MessageRecall element is
present, then the MessageRecall:RecalledMessageID and MessageRecall:RecallType
elements MUST be present.
·
If a RequestExtendedDeploymentDuration:Funding element is
present, then at least one of Funding:FundCode and/or Funding:FundingInfo
elements MUST be present.
·
The ResourceInformation:ResourceInfoElementID and ResourceInformation:Resource
elements MUST be present.
·
At least one of Resource:ResourceID, Resource:Name, and/or
Resource:TypeStructure element MUST be present for each ResourceInformation:Resource
element present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or
OwnershipInformation:OwningJurisdiction elements MUST be present.
·
If a ResourceInformation:ScheduleInformation element is present,
then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“RequestedArrival”, “EstimatedArrival”, “ActualArrival”,
“RequestedDeparture”, “EstimatedDeparture”, “ActualDeparture”, “RequestedReturnArrival”,
“EstimatedReturnArrival”, “RequestedReturnDeparture”, “EstimatedReturnDeparture”,
“Committed”, “Current”, “ReportTo”
or “Route”.
The schema for a
RequestExtendedDeploymenDuration message can be found in Appendix A.17.
The RequestExtendedDeploymentDuration message is sent from
the Resource Consumer to the Resource Supplier after the Commit Resource
message and prior to the Release Resource message.
The potential responses to this message include:
·
ResponseToRequestExtendedDeploymentDuration (See Section 3.19)
·
This includes Accept, Decline and Provisional responses.
The message may
be canceled or updated through the RequestExtendedDeploymentDuration:MessageRecall
element.
Below is an example
RequestExtendedDeploymentDuration message. This message follows on from the
CommitResource message in Section 3.7.5 and preceeds the RequestReturn and
ReleaseResource messages in Sections 3.12.5 and 3.11.5 respectively.
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<RequestExtendedDeploymentDuration
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMRequestExtendedDeploymentDuration.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis">
<MessageID>urn:au-qld-eoc:997814</MessageID>
<SentDateTime>2006-03-22T16:38:00+10:00</SentDateTime>
<MessageContentType>RequestExtendedDeploymentDuration</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small Animal Sheltering Team</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>RequestedReturnArrival</ScheduleType>
<DateTime>2006-04-07T17:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Cairns Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
</ResourceInformation>
</RequestExtendedDeploymentDuration>
The “ResponseToRequestExtendedDeploymentDuration”
message is used as the response to a “RequestExtendedDeploymentDuration”
message. It allows the sender to accept, decline, or offer conditions upon
which deployment duration of resources may be extended.
Figure 19 below shows the EDXL–RM Element
Reference Model (ERM) tailored for the ResponseToRequestExtendedDeploymentDuration
message. The ERM shows the element-level details for the
main entities in the RM.
Figure 19: EDXL-RM ERM for ResponseToRequestExtendedDeploymentDuration
Message
The following table outlines the element cardinalities for
this message type.
Table 19: Response to RequestExtendedDeploymentDuration
Message Elements
|
Parent Element
|
Sub-Elements
|
|
ResponseToRequestExtendedDeploymentDuration
|
MessageID, SentDateTime, MessageContentType^,
MessageDescription, OriginatingMessageID, PrecedingMessageID,
IncidentInformation*, MessageRecall, Funding*, ContactInformation*, ResourceInformation*
|
|
IncidentInformation
|
IncidentID, IncidentDescription
|
|
MessageRecall
|
RecalledMessageID, RecallType
|
|
Funding
|
FundCode, FundingInfo
|
|
ResourceInformation
|
ResourceInfoElementID, ResponseInformation, Resource,
AssignmentInformation, ScheduleInformation*
|
|
ResponseInformation
|
PrecedingResourceInfoElementID, ResponseType, ReasonCode,
ResponseReason
|
|
Resource
|
ResourceID, Name, TypeStructure,
TypeInfo, Keyword*, Description, Credentials, Certifications,
SpecialRequirements, ResponsibleParty, OwnershipInformation, ResourceStatus
|
|
OwnershipInformation
|
Owner, OwningJurisdiction, HomeDispatch, HomeUnit
|
|
ResourceStatus
|
DeploymentStatus, Availability
|
|
AssignmentInformation
|
Quantity, Restrictions, AnticipatedFunction, PriceQuote,
OrderID, AssignmentInstructions
|
|
AssignmentInstructions
|
ModeOfTransportation, NavigationInstructions,
ReportingInstructions
|
|
ScheduleInformation
|
ScheduleType^, DateTime, Location
|
The following rules apply to the above elements:
·
The ResponseToRequestExtendedDeploymentDuration:MessageID, ResponseToRequestExtendedDeploymentDuration:SentDateTime,
ResponseToRequestExtendedDeploymentDuration:MessageContentType, ResponseToRequestExtendedDeploymentDuration:OriginatingMessageID,
ResponseToRequestExtendedDeploymentDuration:PrecedingMessageID, ResponseToRequestExtendedDeploymentDuration:ContactInformation,
and ResponseToRequestExtendedDeploymentDuration:ResourceInformation elements
MUST be present.
·
The value of ResponseToRequestExtendedDeploymentDuration:MessageContentType
MUST be “ResponseToRequestExtendedDeploymentDuration”.
·
If a ResponseToRequestExtendedDeploymentDuration:IncidentInformation
element is present, then at least one of IncidentInformation:IncidentID and/or
IncidentInformation:IncidentDescription elements MUST be present.
·
If the ResponseToRequestExtendedDeploymentDuration:MessageRecall
element is present, then the MessageRecall:RecalledMessageID and
MessageRecall:RecallType elements MUST be present.
·
If a ResponseToRequestExtendedDeploymentDuration:Funding element
is present, then at least one of Funding:FundCode and/or Funding:FundingInfo
elements MUST be present.
·
The ResourceInformation:ResourceInfoElementID and ResourceInformation:ResponseInformation
elements MUST be present.
·
The ResponseInformation:PrecedingResourceInfoElementID and ResponseInformation:ResponseType
elements MUST be present.
·
If the ResponseInformation:ResponseType element has a value of
“Accept” or “Provisional”, then ResourceInformation:Resource element MUST be
present. Otherwise, the ResourceInformation:Resource element is optional.
·
If ResponseInformation:ResponseType has a value of “Provisional”,
at least one of ResponseInformation:ReasonCode and/or ResponseInformation:ResponseReason
elements MUST be present.
·
If a ResourceInformation:Resource element is present, then at
least one of Resource:ResourceID, Resource:Name, and/or Resource:TypeStructure elements
MUST be present.
·
If a Resource:OwnershipInformation element is present, then at
least one of OwnershipInformation:Owner and/or OwnershipInformation:OwningJurisdiction
elements MUST be present.
·
If the ResourceInformation:ScheduleInformation element is
present, then the ScheduleInformation:ScheduleType element MUST be present and contain
one of the following values:
·
“RequestedArrival”, “EstimatedArrival”, “ActualArrival”,
“RequestedDeparture”, “EstimatedDeparture”, “ActualDeparture”, “RequestedReturnArrival”,
“EstimatedReturnArrival”, “RequestedReturnDeparture”, “EstimatedReturnDeparture”,
“Committed”, “EndAvailable”, “Current”, “ReportTo” or “Route”.
The schema for a ResponseToRequestExtendedDeploymentDuration
message can be found in Appendix A.18.
The ResponseToRequestExtendedDeploymentDuration message is
sent from the Resource Supplier to the Resource Consumer in response to a
RequestExtendedDeploymentDuration message.
The message may
be canceled or updated through the ResponseToRequestExtendedDeploymentDuration:MessageRecall
element.
Below is an example ResponseToRequestExtendedDeploymentDuration
message. This message follows on from the example
RequestExtendedDeploymentDuration message shown in Section 3.18.5 (declining the request).
[Note: The XML example
shown in this section is informative only.]
<?xml
version="1.0" encoding="UTF-8"?>
<ResponseToRequestExtendedDeploymentDuration
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg
EDXL-RMResponseToRequestExtendedDeploymentDuration.xsd"
xmlns="urn:oasis:names:tc:emergency:EDXL:RM:1.0:msg"
xmlns:rm="urn:oasis:names:tc:emergency:EDXL:RM:1.0"
xmlns:xpil="urn:oasis:names:tc:ciq:xpil:3"
xmlns:xnl="urn:oasis:names:tc:ciq:xnl:3"
xmlns:xal="urn:oasis:names:tc:ciq:xal:3"
xmlns:geo-oasis="urn:oasis:names:tc:emergency:EDXL:HAVE:1.0:geo-oasis">
<MessageID>urn:au-qld-eoc:997816</MessageID>
<SentDateTime>2006-03-22T17:02:00+10:00</SentDateTime>
<MessageContentType>ResponseToRequestExtendedDeploymentDuration</MessageContentType>
<OriginatingMessageID>urn:au-qld-eoc:12332</OriginatingMessageID>
<PrecedingMessageID>urn:au-qld-eoc:997814</PrecedingMessageID>
<IncidentInformation>
<rm:IncidentDescription>Cyclone Larry</rm:IncidentDescription>
</IncidentInformation>
<ContactInformation>
<rm:ContactRole>Sender</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement xnl:ElementType="FirstName">Charlotte</xnl:NameElement>
<xnl:NameElement xnl:ElementType="LastName">Ryan</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>EMA</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ContactInformation>
<rm:ContactRole>Requester</rm:ContactRole>
<rm:AdditionalContactInformation>
<xpil:PartyName>
<xnl:PersonName>
<xnl:NameElement
xnl:ElementType="FirstName">Alex</xnl:NameElement>
<xnl:NameElement
xnl:ElementType="LastName">Jones</xnl:NameElement>
</xnl:PersonName>
<xnl:OrganisationName>
<xnl:NameElement>Dept of Emergency Services</xnl:NameElement>
</xnl:OrganisationName>
</xpil:PartyName>
</rm:AdditionalContactInformation>
</ContactInformation>
<ResourceInformation>
<ResourceInfoElementID>001</ResourceInfoElementID>
<ResponseInformation>
<rm:PrecedingResourceInfoElementID>001</rm:PrecedingResourceInfoElementID>
<rm:ResponseType>Decline</rm:ResponseType>
<rm:ResponseReason>
Team is already committed elsewhere for the period of
4 to April.
</rm:ResponseReason>
</ResponseInformation>
<Resource>
<TypeStructure>
<rm:ValueListURN>urn:x-hazard:vocab:resourceTypes</rm:ValueListURN>
<rm:Value>Small Animal Sheltering Team</rm:Value>
</TypeStructure>
</Resource>
<AssignmentInformation>
<Quantity>
<rm:MeasuredQuantity>
<rm:Amount>1</rm:Amount>
</rm:MeasuredQuantity>
</Quantity>
</AssignmentInformation>
<ScheduleInformation>
<ScheduleType>RequestedReturnArrival</ScheduleType>
<DateTime>2006-04-07T17:00:00+10:00</DateTime>
<Location>
<rm:LocationDescription>Cairns Airport</rm:LocationDescription>
</Location>
</ScheduleInformation>
</ResourceInformation>
</ResponseToRequestExtendedDeploymentDuration>
4
Data Dictionary (NORMATIVE)
|
Element
|
MessageID
|
|
Type
|
MessageIDType [xsd:string]
|
|
Usage
|
REQUIRED, MUST be used once and only once
|
|
Definition
|
Each EDXL resource message contains an identifier that
uniquely identifies the resource message.
|
|
Comments
|
·
The EDXL Distribution Element contains the "Distribution
ID", which identifies the "container" for the distribution
message information.
|
|
Requirements
Supported
|
20
|
|
Element
|
SentDateTime
|
|
Type
|
DateTimeType [xsd:dateTime]
|
|
Usage
|
REQUIRED, MUST be used once and only once
|
|
Definition
|
The system stamped date and time the resource message was sent. (1) The
date and time is represented in [dateTime]
format (e. g., "2002-05-24T16:49:00-07:00"
for 24 May 2002 at 16: 49 PDT). (2) Alphabetic time zone designators such
as “Z” MUST NOT be used. The time zone for UTC MUST be represented as
“-00:00”
or “+00:00.
|
|
Comments
|
·
Original requirement = ICS "Request Date/Time"
|
|
Requirements
Supported
|
21
|
|
Element
|
MessageContentType
|
|
Type
|
MessageContentTypeType
[xsd:string]
|
|
Usage
|
REQUIRED, MUST be used once and only once
|
|
Definition
|
Specifies the purpose / type of resource content / payload
being sent within the Resource Messaging – Element Reference Model
|
|
Constraints
|
·
Value MUST be one of the following:
1. RequestResource
2. ResponseToRequestResource
3. RequisitionResource
4. CommitResource
5. RequestInformation
6. ResponseToRequestInformation
7. OfferUnsolicitedResource
8. ReleaseResource
9. RequestReturn
10. ResponseToRequestReturn
11. RequestQuote
12. ResponseToRequestQuote
13. RequestResourceDeploymentStatus
14. ReportResourceDeploymentStatus
15. RequestExtendedDeploymentDuration
16. ResponseToRequestExtendedDeploymentDuration
|
|
Requirements
Supported
|
2,3,4,5,6,7,8,9,10,11,12,17
|
|
Element
|
MessageDescription
|
|
Type
|
MessageDescriptionType [xsd:string]
|
|
Usage
|
CONDITIONAL, MAY be used once and only once
|
|
Definition
|
Text field used to specify the information requested in a
request for information and the response to a request for information. May
also be used to include additional information in other message types.
|
|
Constraints
|
·
Conditional Usage:
- Required:
- EDXLResourceMessage:MessageContentType = “RequestInformation”
- Optional:
|
|
Requirements
Supported
|
20
|
|
Element
|
OriginatingMessageID
|
|
Type
|
MessageIDType [xsd:string]
|
|
Usage
|
REQUIRED, MUST be used
once and only once
|
|
Definition
|
Each EDXL resource message contains a MessageID that
uniquely identifies the resource message. OriginatingMessageID identifies the
MessageID of the first message in a message sequence to which the message
belongs. If the message is itself the originating message in a new sequence, OriginatingMessageID
will have the same value as the MessageID element. In some other cases, the OriginatingMessageID
element will have the same value as the PrecedingMessageID element. The OriginatingMessageID
value essentially forms a unique identifier for a group of related messages,
linking them together so that the relationship between the messages is made
explicit and unambiguous (and threads of messages can be tracked by resource
management software).
|
|
Comments
|
·
This MessageID is an EDXL-RM MessageID, not an EDXL-Distribution
Element MessageID.
|
|
Requirements Supported
|
20
|
|
Element
|
PrecedingMessageID
|
|
Type
|
MessageIDType [xsd:string]
|
|
Usage
|
CONDITIONAL, MAY be used
once and only once
|
|
Definition
|
The PrecedingMessageID identifies the message that
immediately preceded the current message in the message sequence. This
MessageID is an EDXL-RM MessageID not and EDXL-Distribution Element
MessageID.
|
|
Constraints
|
·
Conditional Usage:
- Required:
- EDXLResourceMessage:MessageContentType = “ResponseToRequestResource”
- EDXLResourceMessage:MessageContentType = “CommitResource”
- EDXLResourceMessage:MessageContentType = “ResponseToRequestInformation”
- EDXLResourceMessage:MessageContentType = “ResponseToRequestReturn”
- EDXLResourceMessage:MessageContentType = “ResponseToRequestQuote”
- EDXLResourceMessage:MessageContentType = “ResponseToRequestExtendedDeploymentDuration”
- Optional:
- EDXLResourceMessage:MessageContentType = “RequisitionResource”
- EDXLResourceMessage:MessageContentType =
“Request Information”
- EDXLResourceMessage:MessageContentType = “ReleaseResource”
- EDXLResourceMessage:MessageContentType = “RequestReturn”
- EDXLResourceMessage:MessageContentType = “RequestQuote”
- EDXLResourceMessage:MessageContentType = “RequestResourceDeploymentStatus”
- EDXLResourceMessage:MessageContentType = “ReportResourceDeploymentStatus”
- Not Applicable:
|
|
Element
|
ContactInformation
|
|
Type
|
ContactInformationType [XML structure]
|
|
Usage
|
REQUIRED, MUST be used
at least once
|
|
Definition
|
The contact associated with the resource message.
|
|
Comments
|
- Refer to Section 4.1.13.1 for ContactInformationType
- There may be more than one contact given – message
sender, requester, subject matter expert, approver, owner, etc.
|
4.1.2
IncidentInformation Element
|
Element
|
IncidentID
|
|
Type
|
IncidentIDType [xsd:string]
|
|
Usage
|
CONDITIONAL, MAY be used once and only once.
|
|
Definition
|
The name or other identifier of the incident to which the
current message refers.
|
|
Constraints
|
·
If an IncidentInformation element is present, then at least one
of IncidentInformation:IncidentID or IncidentInformation:IncidentDescription
MUST be present
|
|
Requirements Supported
|
19
|
|
Element
|
IncidentDescription
|
|
Type
|
IncidentDescriptionType [xsd:string]
|
|
Usage
|
CONDITIONAL, MAY be used once and only once.
|
|
Definition
|
A free form description of the incident to which the
current message refers.
|
|
Constraints
|
·
If an IncidentInformation element is present, then at least one
of IncidentInformation:IncidentID or IncidentInformation:IncidentDescription
MUST be present
|
|
Requirements Supported
|
19
|
4.1.3 MessageRecall Element
|
Element
|
RecalledMessageID
|
|
Type
|
MessageIDType [xsd:string]
|
|
Usage
|
REQUIRED, MUST be used once and only once.
|
|
Definition
|
The identifier of the previously sent message that is to
be recalled. MessageRecall is used to replace a previously sent message by
updating or canceling it.
|
|
Comments
|
·
The MessageRecall element is Optional.
|
|
Requirements Supported
|
14, 15
|
|
Element
|
RecallType
|
|
Type
|
RecallTypeType [xsd:string]
|
|
Usage
|
REQUIRED, MUST be used once and only once.
|
|
Definition
|
Specifies the recall type as either an update or a cancel
of the previously sent message. MessageRecall is used to replace a previously
sent message which is then updated or cancelled.
|
|
Constraints
|
§
Value MUST be one of the following:
1. Update
2. Cancel
|
|
Comments
|
·
The MessageRecall element is Optional.
|
|
Requirements Supported
|
14,15
|
4.1.4 Funding Element
|
Element
|
FundCode
|
|
Type
|
FundCodeType [xsd:string]
|
|
Usage
|
CONDITIONAL, MAY be used once and only once.
|
|
Definition
|
Identifies the funds that will pay for the resource
|
|
Constraints
|
·
The Funding element MUST be present in a Requisition Resource
message.
·
If a Funding element is present, then at least one of
Funding:FundCode or Funding:FundingInfo MUST be present
|
|
Comments
|
·
Identified in support of NIMS Resource Management Guide
NIC-GDL0004
· |
