U.S.Department of Justice[Date]
Logical Entity Exchange Specification 3.1[Program] Interop Profile ([filename])
This document can be used as a template for the creation of a LEXS Interoperability Profile specific to a program, such as OneDOJ.
Where this document shows text contained in brackets, you should replace the contents, including the brackets, with your own content. For example, if you see [Agency Name], replace it with your own agency name, such as Department of Justice. Note that the headers and footers of this document should be updated as well.
Sections that are not required for your profile may be removed from the outline provided in this document.
Text and XML snippets that are provided in the various sections do not have to be used as is, but are provided as examples.
Refer to existing interoperability profile documents for additional details of the contents of a profile.
While this template specifically mentions LEXS-SR, this template can also be used for PD as well with appropriate modifications.
The filename must be changed to reflect your program, whether it is LEXS SR or LEXS PD, the version of your profile, and a revision (such as to correct typos or add clarifications) to a version if applicable. For example, OneDOJ-LEXS-SR-IP-1.0-Rev2.doc.
This page should be removed from your profile document.
[Your Logo]
[Agency Name]
[Your Program]LEXS SR InteroperabilityProfile 1.0
([YourProgram]-LEXS-SR-IP [X].0)
for LEXS-SR 3.1
Revision[Y]
[Date]
Change History
Revision / Date / Author / Description of Revision1
Table of Contents
1.Introduction
2.The “lexs:SRMessageMetadata” Element
2.1 lexs:LEXSVersion
2.2 lexs:MessageOriginMetadata
2.2.1lexs:SystemIdentifier
2.2.2lexs:SystemContact
2.2.3lexs:DomainAttribute
2.3 lexs:MessageDestinationMetadata
2.4 lexs:ORI or lexs:OriginatingAgencyID
2.4.1nc:OrganizationName
2.4.2lexs:SystemID
2.5 lexs:DomainAttribute
3.The “lexs:UserAssertion” Element
3.1 lexs:UserID
3.2 User name and contact information
3.3 nc:OrganizationName
3.4 lexs:ORI or lexs:OriginatingAgencyID
3.5 lexs:DomainAttribute
4.Interacting with [program] LEXS SR Server
4.1 Scenarios
5.Working with Attachments
6.Supported Searches
7.Data Profiles
1.Introduction
[Introduction for the program to which this profile applies. May include information about policies involved with information exchanges that utilize this profile.]
2.The “lexs:SRMessageMetadata” Element
This element applies to the Message that contains it. In addition to the elements required by the Schema and mandated in the User Guide, this element must contain the following sub-elements and/or specific values:
2.1lexs:LEXSVersion
The “lexs:LEXSVersion” element announces the major, minor and patch version of LEXS that the message conforms to. In order to comply with this profile,the submission must conform to LEXS-SR[version]and the value for this element is [value]as shown below:
lexs:LEXSVersion3.1.3</lexs:LEXSVersion
2.2lexs:MessageOriginMetadata
The “lexs:MessageOriginMetadata” describes the origin of the message.
2.2.1lexs:SystemIdentifier
In order to comply with this profile, the "lexs:SystemIdentifier" element mustcontain [profile specific information as defined by program].
2.2.2lexs:SystemContact
In order to comply with this profile, the "lexs:SystemContact" element must contain [profile specific information as defined by program].
2.2.3lexs:DomainAttribute
In order to comply with this profile, the "lexs:DomainAttribute" element must contain [profile specific information as defined by program].
2.3lexs:MessageDestinationMetadata
The “lexs:MessageDestinationMetadata” describes the organization and system that an SR message is being sent.
2.4lexs:ORI or lexs:OriginatingAgencyID
[In order to comply with this profile, the [profile element(s)] must be provided as [profile specific information as defined by program].
2.4.1nc:OrganizationName
In order to comply with this profile, the "nc:OrganizationName" element must contain [profile specific information as defined by program].
2.4.2lexs:SystemID
In order to comply with this profile, the "lexs:SystemID" element must contain [profile specific information as defined by program].
2.5lexs:DomainAttribute
The “lexs:DomainAttribute” provides a placeholder for domain attributes that may be required or optional for use by the consuming application.
[In order to comply with this profile, the "lexs:DomainAttribute" element must contain [profile specific information as defined by program].
3.The “lexs:UserAssertion” Element
The lexs:UserAssertion element describes the user on whose behalf the LEXS SR client is sending the message. Note that requests that come from applications, such as get capabilities, get data owners, and get availability do not include a user assertion. This element is included in:
- StructuredSearchRequestMessage (in a doStructuredSearchRequest)
- TextSearchRequestMessage (in a doTextSearchRequest)
- DataItemRequestMessage (in a getDataItemRequest)
- AttachmentRequestMessage (in a getAttachmentRequest)
[Information specific to program, such as what is required for logging and/or for access control]
3.1lexs:UserID
[Information regarding policy requirements of the program and what should be provided to conform to this profile.]
3.2User name and contact information
In order to comply with this profile, the following elements must/should be provided for user name and contact information elements:
[Profile specific information as defined by program]
3.3nc:OrganizationName
[Information regarding the organization name that must be provided to conform to this profile.]
3.4lexs:ORI or lexs:OriginatingAgencyID
[In order to comply with this profile, the [profile element(s)] must be provided as [profile specific information as defined by program].
3.5lexs:DomainAttribute
The “lexs:DomainAttribute” provides a placeholder for domain attributes that may be required or optional for use by the consuming application.
[In order to comply with this profile, the "lexs:DomainAttribute" element must contain [profile specific information as defined by program].
4.Interacting with [program]LEXS SRServer
4.1Scenarios
This section describes possible scenarios for interacting with the [program] J LEXS SR Server. It providesa recommended choreographywhen using the LEXS SR operations described in detail in the LEXS User Guide. It is not intended to be exclusive; additional scenarios may be supported by LEXS SR clients.
[Details on scenarios supported by this profile.]
5.Working with Attachments
This section describes special considerations forretrieving and rendering attachments to LEXS data items.
[Any other information that may be useful for how the program works with attachments.]
6.Supported Searches
[Information regarding valid search fields, supported query match parameters, etc.]
7.Data Profiles
[Informationthat provides general characteristics of the types of data returned by the program’s LEXS SR Server. This includeskinds of attachments (and approximate numbers), general structural information, representative examples, etc.]
Document Revision [#]Page 1 of 7