NIEM Examples - Concealed Weapons Permit Information (CWQ/CWR)
Concealed Weapons Permit NIEM Specifications
This section describes how Nlets users may exchange concealed weapon permit information in NIEM format between state, local and federal law enforcement and criminal justice agencies. NIEM examples are provided.
CWQ messages may be sent to only a single 2-character state code. Full nine-character destination ORIs will cause rejection of the entire message.
Users of this system must also recognize that each state will deal with the searching of their database in their own way. For example, some states may not support a search of social security number. Others may support this but not permit number.
Nlets now provides a standardized response format for this message type in addition to the free-form format. The standardized format for this message is anticipated to be supported on the Nlets production system by July of 2016. Please contact Kate Silhol at ksilhol@nlets.org for additional information regarding implementation.
All CWQ queries should be answered by a CWR from the destination.
States should attempt to show what action was taken on the search. For example, a record may be available on the <n2:Person>/<nc:PersonBirthDate> however, no information was found on the permit number. The requestor should be told this.
If the state does not have the ability to search their file by one of the indices the requestor should be so notified.
In all cases, the original inquiry should be the first part of all responses in order to let the requester identify their request.
States may have reciprocity with certain states and not others. This information should be included in each state's help file record.
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: Query by Name and DOB (CWQ), Query by Social Security Number (CWQ), Query by Permit Number (CWQ), Response to Query - Free Form (CWR) and Response to Query (CWR) - Standardized (CWR).
Query Formats
Query by Name and DOB (CWQ)
n2:NLETSInquiryData
This element will contain all elements specific to this transaction.
n2:Person
A human being
This element encapsulates the information about the person being queried.
nc:PersonBirthDate
A date a person was born.
This element contains the DOB for the person being queried on. This data in this element must be in xsd:date
format, that is: yyyy-mm-dd.
nc:Date
A full date.
nc:PersonName
A combination of names and/or titles by which a person is known.
This element encloses subelements containing name data for query.
nc:PersonGivenName
A first name of a person.
This optional element containing a person's first name may be sent via XML if available but will only be forwarded
onto states receiving XML.
nc:PersonMiddleName
A middle name of a person.
This optional element containing a person's middle name may be sent via XML if available but will only be
forwarded onto states receiving XML.
nc:PersonSurName
A last name or family name of a person.
This optional element containing a person's last name may be sent via XML if available but will only be forwarded
onto states receiving XML.
nc:PersonFullName
A complete name of a person.
This required element must contain the full name of the person in the format LAST,FIRST MIDDLE. The data from
this element is the only name data that will be passed onto states receiving text.
Query by Social Security Number (CWQ)
n2:NLETSInquiryData
This element will contain all elements specific to this transaction.
n2:Person
A human being
nc:PersonSSNIdentification
A unique reference to a living person; assigned by the United States Social Security Administration.
nc:IdentificationID
A value that identifies something.
Optional element containing SSN.
Query by Permit Number (CWQ)
n2:NLETSInquiryData
This element will contain all elements specific to this transaction.
n2:Person
A human being
This element encapsulates the information about the person being queried.
n2:PersonConcealedCarryPermit
Contains information about a concealed carry permit issued to a person.
nc:DocumentIdentification
An identification that references a document.
nc:IdentificationID
A value that identifies something.
Optional element containing permit number.
nc:IdentificationCategoryText
A kind of identification.
Should contain the value "Concealed Weapons Permit" to indicate the type of data.
Response Formats
Response to Query (CWR) - Free Form
n2:NLETSResponseData
n2:ResponseText
This element will contain the free text response. Nlets recommends the use of
<![CDATA[]]>
tags to ensure that the
response does not contain any characters illegal in XML.
Response to Query (CWR) - Standardized
n2:NLETSResponseData
n2-cwr:ConcealedWeaponPermitRecord
The concealed weapon permit information
nc:Person
A human being
This element contains the information about the person that has been issued the permit. This element should also contain the attribute
structures:id to allow it to be linked to the contact information
nc:PersonBirthDate
A date a person was born.
This data in this element must be in xsd:date format, that is: yyyy-mm-dd.
nc:Date
A full date.
nc:PersonCitizenshipText
A country that assigns rights, duties, and privileges to a person because of the birth or naturalization of the person in
that country.
nc:PersonDeathDate
A date a person died or was declared legally dead.
nc:Date
A full date.
nc:PersonEyeColorText
A color of the eyes of a person.
nc:PersonHairColorText
A color of the hair of a person.
nc:PersonHeightMeasure
A measurement of the height of a person.
nc:MeasureValueText
A textual description of a measurement value.
nc:PersonMilitarySummary
A service of a person in a military.
nc:MilitaryStatus
A status of military service of a person.
nc:StatusDescriptionText
A description of a status or condition of something or someone.
nc:PersonName
A combination of names and/or titles by which a person is known.
This element encloses subelements containing name data for query.
nc:PersonGivenName
A first name of a person.
This optional element containing a person's first name may be sent via XML if available but will only be forwarded
onto states receiving XML.
nc:PersonMiddleName
A middle name of a person.
This optional element containing a person's middle name may be sent via XML if available but will only be
forwarded onto states receiving XML.
nc:PersonSurName
A last name or family name of a person.
This optional element containing a person's last name may be sent via XML if available but will only be forwarded
onto states receiving XML.
nc:PersonFullName
A complete name of a person.
This required element must contain the full name of the person in the format LAST,FIRST MIDDLE. The data from
this element is the only name data that will be passed onto states receiving text.
nc:PersonRaceText
A classification of a person based on factors such as geographical locations and genetics.
nc:PersonSexCode
A gender or sex of a person.
Value must be M, F or U.
nc:PersonSSNIdentification
A unique reference to a living person; assigned by the United States Social Security Administration.
nc:IdentificationID
A value that identifies something.
Optional element containing SSN.
nc:PersonWeightMeasure
A measurement of the weight of a person.
nc:MeasureValueText
A textual description of a measurement value.
n2-cwr:PersonAugmentation
Additional information about the person
n2-cwr:PersonDeceasedIndicator
A boolean indicator as to whether or not the person is deceased. Value must be true if the person is deceased
and false if the person is believed to be living.
n2-cwr:PersonDeceasedIndicator
A boolean indicator as to whether or not the person is deceased. Value must be true if the person is deceased
and false if the person is believed to be living.
j:PersonAugmentation
Additional information about a person.
j:DriverLicense
A license issued to a person granting driving privileges.
j:DriverLicenseIdentification
A driver license identification or driver license permit identification, including the number and
state.
nc:IdentificationID
An identifier.
j:PersonConcealedFirearmPermitIdentification
A permit identification that allows a person to carry a concealed weapon.
nc:IdentificationID
An identifier.
nc:IdentificationJurisdiction
An area, region, or unit where a unique identification is issued.
nc:JurisdictionText
An area in which an organization or person has some kind of authoritative
capacity or responsibility over.
nc:IdentificationEffectiveDate
A date an identification takes effect.
nc:Date
A full date.
nc:IdentificationExpirationDate
A date after which an identification is no longer valid.
nc:Date
A full date.
nc:IdentificationSourceText
A person, organization, or locale which issues an identification.
nc:IdentificationStatus
A status of an identification.
nc:StatusDescriptionText
A description of a status or condition of something or someone.
n2-cwr:IdentificationAugmentation
Additional information about an identification.
n2-cwr:IdentificationApplication
Information about an application for a permit.
n2-cwr:ApplicationPendingIndicator
True if the application is pending, false otherwise.
n2-cwr:ApplicationDate
The date on which a concealed weapons permit was applied for.
nc:Date
A full date.
n2-cwr:ResidentIdentificationIndicator
True if the permit holder is a resident of the state.
n2-cwr:IdentificationCommentText
Remarks about the permit.
n2-cwr:PermittedWeapon
Information about the specific weapon that the permit is for.
Optional structure that may be included if the permit is specific to a
particular weapon.
nc:RoleOfItem
An entity of whom the role object is a function.
nc:ItemCategoryText
A kind of property item.
nc:ItemMakeName
A name of the manufacturer that produced an item.
nc:ItemModelName
A name of a specific design or kind of item made by a
manufacturer.
n2-cwr:ItemAugmentation
Additional information about an item.
j:FirearmBoreSizeText
A size of the inside diameter of a
firearm barrel or bore.
The caliber of a gun.
j:PersonStateFingerprintIdentification>
An identifier assigned to a person by a state identification bureau, generally based on submission of
the person's fingerprints to the state's Automated Fingerprint Identification System (AFIS).
nc:IdentificationID
An identifier.
j:PersonBirthplaceCode
A state or country of a person's birth.
nc:ContactInformationAssociation>
An association between contact information and an entity.
nc:ContactEntity
An entity that may be contacted by using the given contact information.
This element should contain an attribute structures:ref linking to the nc:Person element.
nc:ContactInformation
A set of details about how to contact a person or an organization.
nc:ContactMailingAddress
A postal address by which a person or organization may be contacted.
nc:AddressFullText
A complete address.
Concealed Weapons Permit NIEM Examples
Example 1: Concealed Weapons query by Name and Date of Birth.
<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>CWQ</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>ID</nh2:DestinationORIID>
<nh2:DocumentControlFieldText><![CDATA[1234567890]]></nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="CWQ">
<n2:Person>
<nc:PersonBirthDate>
<nc:Date>1956-05-24</nc:Date>
</nc:PersonBirthDate>
<nc:PersonName>
<nc:PersonFullName>PUBLIC, CARL</nc:PersonFullName>
</nc:PersonName>
</n2:Person>
</n2:NLETSInquiryData>
</n2:NLETS>
Example 2: Concealed Weapons query by Social Security Number.
<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>CWQ</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZ</nh2:DestinationORIID>
<nh2:DocumentControlFieldText><![CDATA[1234567890]]></nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="CWQ">
<n2:Person>
<nc:PersonSSNIdentification>
<nc:IdentificationID>123456789</nc:IdentificationID>
</nc:PersonSSNIdentification>
</n2:Person>
</n2:NLETSInquiryData>
</n2:NLETS>
Example 3: Concealed Weapons query by Permit Number.
<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>CWQ</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>AZNLETS20</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZ</nh2:DestinationORIID>
<nh2:DocumentControlFieldText><![CDATA[1234567890]]></nh2:DocumentControlFieldText>
</n2:NLETSMessageHeader>
<n2:NLETSInquiryData n2:key="CWQ">
<n2:Person>
<n2:PersonConcealedCarryPermit>
<nc:DocumentIdentification>
<nc:IdentificationID>X1111111</nc:IdentificationID>
</nc:DocumentIdentification>
</n2:PersonConcealedCarryPermit>
</n2:Person>
</n2:NLETSInquiryData>
</n2:NLETS>
Example 4: Concealed Weapons response.
<n2:NLETS xmlns:i="http://niem.gov/niem/appinfo/2.0" xmlns:nc="http://niem.gov/niem/niem-core/2.0"
xmlns:nc4="http://release.niem.gov/niem/niem-core/4.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:j5="http://release.niem.gov/niem/domains/jxdm/5.0/"
xmlns:j6="http://release.niem.gov/niem/domains/jxdm/6.1/" xmlns:ct="http://release.niem.gov/niem/conformanceTargets/3.0/"
xmlns:structures="http://release.niem.gov/niem/structures/3.0/"
xmlns:n2="http://www.nlets.org/niem/1.0">
<n2:NLETSMessageHeader>
<nh2:MessageKeyCodeText>CWR</nh2:MessageKeyCodeText>
<nh2:OriginatingORIID>IDIHOT000</nh2:OriginatingORIID>
<nh2:DestinationORIID>AZNLETS42</nh2:DestinationORIID>
<nh2:DocumentControlFieldText><![CDATA[1234567890]]></nh2:DocumentControlFieldText>
<nh2:MessageReceiveDate>06/23/2019</nh2:MessageReceiveDate>
<nh2:MessageReceiveTime>08:05</nh2:MessageReceiveTime>
<nh2:MessageSendDate>06/23/2019</nh2:MessageSendDate>
<nh2:MessageSendTime>08:05</nh2:MessageSendTime>
<nh2:ReceiveMessageNumeric>00950</nh2:ReceiveMessageNumeric>
<nh2:SendMessageNumeric>00008</nh2:SendMessageNumeric>
</n2:NLETSMessageHeader>
<n2:NLETSResponseData n2:key="CWR">
<n2:ResponseText><![CDATA[ILED REPLY
AZNLETS42
MKE/CONCEALED WEAPON LICENSE
**** RETIRED OFFICER ****
ORI/IDBCI0020 IDAHO STATE POLICE BCI
SIC/CW00158118
TYP/S Standard Concealed License
NAM/PUBLIC,CARL RAC/W SEX/M HAI/BRO EYE/BLU
DOB/19560524 HGT/509 WGT/150
SOC/711111111
ADR/3311 W STATE ST
CTY/BOISE STA/ID ZIP/83707 COU/ADA
IDN/BCI0020 ISD/20140404 EXP/20190404
MIS/STANDARD CWL EXAMPLE
DTE/20130919 DTM/20190104
***** END OF RECORD *****
ORIGINATING ORI/IDBCI0001
TYP/E Enhanced Concealed License
ISSUE DATE/20180701 EXPIRE DATE/20230701
MIS/ENHANCED CWL EXAMPLE
DTE/20130919
ORIGINATING ORI/ID0200000
TYP/LE Law Enforcement
ISSUE DATE/20140404 EXPIRE DATE/20190404
MIS/RETIRED LE EXAMPLE
DTE/20130919
AKA/TEST,CARL
AKA/PUBLIC,JOHN Q
AKA/TESTER,CARLOS
AKA/PUBLIC, BUDDY]]></n2:ResponseText>
</n2:NLETSResponseData>
</n2:NLETS>