NIEM Examples - Homeland Security (HS/HSL)
NIEM
Homeland Security NIEM Specifications
This section provides NIEM format and examples for Homeland Security (HS) and Homeland Security Law Enforcement Only (HSL) messages.
The purpose of the Homeland Security message (HS) is to notify First Responders, i.e. the Police, Public Safety and other emergency type agencies in the event of National, Regional or local area threat situation. The Homeland Security Law Enforcement Only (HSL) option gives the sender that capability of sending only to Law Enforcement Agencies. The HSL option will add the caveat "LAW ENFORCEMENT DISSEMINATION ONLY".
All Nlets NIEM messages must be based on the Nlets NIEM Message Structure and include the standard Nlets XML Header as detailed in Message Structure. The NIEM header and hierarchy of the elements in this section have been omitted to avoid redundancy. The associated schemas and instances should be consulted to determine the correct XPaths of the elements.
Element Dictionary
Transaction types detailed below include: Homeland Security Alert (HS,HSL).
Message Formats
Homeland Security Alert (HS,HSL)
Mail Data (n2:NLETSMailData)
This element will contain all elements specific to this transaction.
Condition Code (n2:ConditionCode)
This element identify the condition code; must be R,O,Y,B,G or T.
Alert Text (n2:MailMessageText)
This free text element contains the text of the homeland security alert.
nc:Image
Optional image tag. This element will contain an image if one is available.
nc:BinaryBase64Object
NIEM: A binary encoding of data.
nc:BinaryCaptureDate
NIEM:A date on which a binary object is captured or created.
nc:BinaryDescriptionText
NIEM:A description of a binary object.
nc:BinaryFormatID
NIEM:An identifier for a file format or content type of a binary object.
nc:BinarySizeValue
NIEM:A size of a binary object in kilobytes.
nc:BinaryCategoryText
NIEM:A kind of object that has been encoded.
nc:PersonDigitalImage
Optional image tag. This element will contain an image if one is available.
nc:BinaryBase64Object
NIEM: A binary encoding of data.
nc:BinaryCaptureDate
NIEM:A date on which a binary object is captured or created.
nc:BinaryDescriptionText
NIEM:A description of a binary object.
nc:BinaryFormatID
NIEM:An identifier for a file format or content type of a binary object.
nc:BinarySizeValue
NIEM:A size of a binary object in kilobytes.
nc:BinaryCategoryText
NIEM:A kind of object that has been encoded.
Homeland Security NIEM Examples
Example 1: A Homeland Security Message received by a user.
<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nh2="http://www.nlets.org/niem/nlets-hdr/1.0" xmlns:niem-xsd="http://niem.gov/niem/proxy/xsd/2.0"
xmlns:s="http://niem.gov/niem/structures/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
n2:version="4.00" xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>HS</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>DCFBIWAE6</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS20</nh2:DestinationORIID>
<nh2:MessageReceiveDate>01/09/2011</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>18:14</nh2:MessageReceiveTime>
<nh2:MessageSendDate>01/09/2011</nh2:MessageSendDate>
<nh2:MessageSendTime>18:14</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>76148</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>45216</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSMailData n2:key="HS">
<n2:ConditionCode>R</n2:ConditionCode>
<n2:MailMessageText>THERE HAS BEEN AN UNSUBSTANTIATED THREAT TO ALL TALL BUILDINGS IN THE
CONTINENTAL UNITED STATES.
ETC, ETC.
END OF MESSAGE.
</n2:MailMessageText>
</n2:NLETSMailData>
</n2:NLETS>