e_citation Producer schema generated on 2017-07-07T10:13:19.165-05:00 against version #FLT16-2993
General notes on this schema:
EXTERNAL SPEC REFERENCES
The e-citation spec contains a data element listing which identifies a DDN number. This corresponds to the data elements in the ADR spec (6/18/2013 version of ADR spec). This can be used to locate data items in this schema: to find ADR data element #60, search for 'DDN 60'
All e-citation spec/std. references herein are from the 5/14/2014 version of the e-citation spec
NOT ALL SCHEMA DATA IS NECESSARILY IN USE
The presence of a data element in the this schema doesn't necessarily mean that it is used by Judici.com.
DATA SECRITY AND PRIVACY RESTRICTIONS
Judici courts implement a variety of restrictions on what data is shown to the public. Some of these restrictions are required and others are at the court's discretion. For a list of all data subject to possible restriction as Secure Data or Private Data, see https://www.judici.com/agreements/Exhibit_D_to_Web_Service_Subscriber_Agreement
NOTICE: DERIVED DATA VALUES
All data defined herein as "Derived Data" is set by court, and is for internal Judici.com use only. It is derived by the court from one or more underlying case data elements, which can be quite complex. Derived Data may control restrictions on whether case data will be made public under the data security and privacy restrictions (see previous note) and/or applicable statutes or regulations such as the federal Fair Credit Reporting Act (FCRA) requirements on reporting past non-convictions. Derived Data might not, at any given time, be calculated in accordance with applicable statutes and regulations and it is subject to change. Derived Data is shown on an "as is" basis, given the relevant underlying case data. In the event of any conflict between such data and the underlying data, the latter shall govern and the conflict should be brought to the attention of the court.
Retention in Compiled Index Record not allowed for any Derived Data.
CODE, DESCRIPTION AND TEXT ATTRIBUTES
Enumerations are used when the code/value list is modest in size and fairly static. If the code is meaningful text (e.g. BLK, BLU...) it will be used as the enumeration Otherwise, the enum will contain the VALUE. This is because most codes are sequence/ordinal numbers which can be effectively be derived from the ordinal position in the enum (and even when the number sequences have GAPS, the right code can still be derived).
When there is no enum:
-Code can be required
-Value should be optional (unless there is a write-in value such as with 999999 offenses)
-Schema may include enumerations, if the codes meaningless numerics and the list of values is not long.
MORE ON CODES
- Courts often use "standard" codes in different ways (e.g. indicating modified judgments using a different sequence of dispositions). So while Service Provider may provide guidance on interpreting court offense data, it is recommended that any user of this data work directly with the court for a full, complete and correct interpretation of that court's data.
BOOLEAN
In order to be able to convey explicit "Unknown" value, the schema uses an enumeration (Yes/No/Unknown) rather than Boolean.
DATE FORMAT
Producers have to supply Date type attributes, while Consumer schemas will continue to be text
CODES FOR STATES, PROVINCES, TERRITORIAL POSSESSIONS AND COUNTRIES
Wherever the schema calls for a state/province code for the U.S., Canada or Mexico, use one of the applicable two-character codes in Appendix A in ADR spec.
Wherever the schema calls for a country code, these can also be found in ADR spec Appendix A. With the following additions. US = United States, MX = Mexico, CA = Canada.
For most data values associated with table lookups, Judici can OUTPUT any combination of the following:
- An attribute containing "Code" contains the code value (e.g. a value of "405" for the <CriminalDisposition> Code attribute)
- An attribute containing "Name", or "Description" holds the exact text corresponding to the code (e.g. "Withhold Judgment/720 ILCS 5/12-4.3").
- An optional third attribute containing "Text"- this exists to give courts the option to provide more human-readable content. But practically speaking, courts rarely do this. So this last attribute is typically just a concatenation of teh other two.
Each civil case litigant or criminal defendant is represented by an Actor element. Otherr individuals, including judges and law enforcement officers, use the RelatedActor element
The data producer's ID for this Actor, which Judici may or may not retain/use.
You can have any number of these (e.g. one for home address and another for work address.) Not required for e-citations, beccause a traffic voiolator may be unlicensed.
Per ADR spec (DDN 31), this is 20 char. CMS will truncate.
Ref. ADR spec (DDN 32). See note on state/province codes, in comments at top of schema
'empty string' = Other/Unknown
Ref. ADR spec (DDN 33). In in U.S. addresses, this is zip code.
Ref. ADR spec (DDN 32 and DDN 327). See note on state/province/country codes, in comments at top of schema
Producers are required to always include a two letter country code.
US = United States
MX = Mexico
CA = Canada
'empty string' = Other/Unknown Non-US
Distinguishes home address from work, etc.
An ordinal number for each street address segment provided.
The street address text segment. Per ADR spec (DDN 29/30), this is A/N 60. CMS will truncate.
It is possible to have more than one <ArrestData> because a defendant MIGHT get arrested more than once on the case (e.g. after jumping bail). That said. there is no reason for an E-CITATION to have more than one.
Ref. ADR spec (DDN 42). The ID associated with the fingerprint card from the booking process. If the violator actually gets BOOKED, this is critical to connecting them to their case so that their criminal history is accurate.
Ref. ADR spec (DDN 48). This is what was SET by law or by a judge. What (if anything) is actually PAID is in a Payment. This is always full face value, never 10%
This is required if CashBondType exists. This cannot be enforced by schema, so it is checked in pre-processing.
One of the monetary bond options in Section (4)l of the e-citation since that is a subset of the values in the ADR spec (DDN 46). Can be used to indicate 10% bonds vs. 100% bonds. "Unknown" is an option, so this can be required.
If this element exists, then the BondAmount attribute must be non-zero and a Payment element must exist. This cannot be enforced by schema, so it is checked in pre-processing.
"None" is an option, so this can be required
Use one of the non-monetary bond options in Section (4)l of the e-citation standard, since that is a subset of the values in the ADR spec (DDN 47).
The e-citation spec allows a value of E-Bond, which isn't in any non-draft ADR spec. So that bond type should be mapped to "Other", a type allowed by ADR but not be the e-citation spec.
See ADR spec (DDN 40) for further info.
Ref. ADR spec (DDN 145). Not required, since the citation might not even concern a vehicle. But if it IS provided, the e-citation spec requires a definitve answer. That is why the Unknown option isn't allowed for e-citation.
Not required, since the citation might not even concern a vehicle. But if it IS provided, the e-citation spec requires a definitve answer. That is why the Unknown option isn't allowed for e-citation.
Per ADR spec DDN 143.
See ADR spec (DDN 150). This is just text, as there are no Illinois standard codes for vehicle make
See ADR spc, DDN 151
Per ADR spec (DDN 148)
Per ADR spec (DDN 147)
Per ADR spec, DDN 149. See note on state/province codes, in comments at top of schema
'empty string' = Other/Unknown
Per ADR spec (DDN 146). Indicates whether the violator was a driver or passenger. ADR-allowed values don't quite match e-citation spec, so some values may have to be mapped to U (Unknown). Not required, because the offense may not even involve a vehicle.
Per ADR spec (DDN 55): N-7. Indicates the relevant criminal offense, based on the standards used in the court. In Illinois, these standard values are mandated by, and distributed by, the Administrative Office of the Illinois Courts.
Must be zero padded.
Retention in Compiled Index Record not allowed.
If the offense is a non-traffic local ordinance, for which there is no offense code, provide a value of 0000000. Though this can't be enforced by schema, a code of 0000000 will be rejected in pre-processing if the StatuteReferenceSource is not "Local" (which indicates a non-traffic local ordinance).
No code, 9999999 or otherwise, shall be used when the a citation is written for an offense not in AOIC's standard list of offenses. A code of 9999999 cannot be prevented by schema, but will be rejected in pre-processing.
Reference ADR spec (DDN 56).
This should be used to convey descriptions on non-traffic ordinance violations, which have no offense code. When a data Producer provides this WITH an offense code, the court's CMS will ignore it and rely SOLELY upon the Code attribute- the description will not be checked against the AOIC offense table. This is for a variety of reasons, including the fact that the AOIC is requiring e-citation vendors to use verbose descriptions which aren't even IN the offense table).
Distinguishes committed offenses from "attempted", or "conspiracy".
Judici uses a list of values matching the requirements of ADR spec (DDN 53), but the values are shortened. IRS is no longer in effect, so Producers cannnot use those.
This is for regular state statute violations.
This is for local ordinance which are equivalent to state statute violations. Typically, these are traffic violations which have been adopted into local ordinances.
This is for local ordinance which are NOT equivalent to state statute violations. For example: Failure to Mow Property.
The most severe charge must be first in the e-citation xml, as that will determine which traffic case the bond goes on if there is more than one offense. This should be no problem because officers have to be aware which charge is most severe to set bond [see SCR 503(a)(2)] and they typically input the most severe charge first.
The data producer's ID for this charge, which Judici may or may not retain/use. Optional, for diagnostic purposes.
The Administrative Office of the Illinois Courts has indicated that the ticket numbers should not contain the officer's badge ID. So if the badge ID is a part of the ticket number, it should be removed before e-citation data is reported. When the ticket number is too long, the presence of the badge ID is often the reason. So the AOIC's restriction may prove helpful in meeting the maximum length constraint as well.
See ADR spec, DDN 64. In traffic cases, this will be the ticket number issued by law enforcement. In non-traffic cases, some courts might use it for other kinds of data.
Per ADR spec (DDN 60): A-1, with allowed values which essentially match those in the e-citation std. Indicates whether injury, death or damages occurred.
The date on which the criminal offense occurred. Apparently, this is not required in many participating Judici courts. See also ADR spec, DDN 41.
There is no ADR Per ADR spec for this, but the courts use it and it is required by the e-citation spec. The e-citation spec only asks for it when it is affirmative, so this is another situation where booleans won't work (see note above on Booleans)
This is the root element for any data that is associated with a court (e.g. Judges, Cases, Incidents, Holiday events)
The file contains only one Court/Incident in order to minimize the amount of data hug up in the event of a validation error.
Per ADR spec (DDN 4): A/N 9. The ORI number for the court, as issued by the federal government. Follow ADR std.
Common name of the court. Required, for diagnostic reasons.
This is the main root element. Among other things, it results from a "get" call to obtain the details on a case in the search results
Limited the file to just one court/incident in order to minimize how much data is hung up in the event of a validation error.
A timestamp corresponding to when the data transfer file was created. Used only for diagnostic purposes.
Can be used to check data integrity by verifying whether data has been tampered with in transit.
This is an md5 of the serialized xml. jdom's pretty format is the serialization engine that is used. Any of the following transient data, if present, should be removed:
- FileCreationDateTime or FileCreationDateTimeTyped attribute of CourtDataTransferFile element
- ErrorLog atttribute of CourtDataTransferFile element
- md5 attribute
Provider element
- //Case/@LastUpdateDate attribute removed
This is a unique ID for the case, reflecting its precise data state at the time when it was obtained.
Can be used to spot duplicate data in the same batch of incidents/tickets downloaded for processing by Clerk staff
The version of the schema used in creating the file
Inline data of the document itself
The encoding format of the documnent data
The encoding format of the documnent data
This element contains any information about actual documents associated with this case. The actual documents may be inlined using the data element.
Title or Descrption of document
Date the document was created
N = NO
Y = yes
D = deleted/removed
A reference to the associated litigant in this xml. On submission, this can be the result of ../Actor/position()
A reference to the associated Count element index in this litigant/ActorID. It should always be a number greater than 0.
These can be on cases (e.g. a hearing), or on a court (e.g. a court holiday).
Notice: While courts may have event data indicating past dates, it isn't possible to know whether an event actually occured or not.
E-citation will provide the hearing date and time indicated on the ticket. E-citation standard does allow for this to be determined later, so this cannot be required for e-citations.
Ref. ADR spec (DDN 218 and DDN 219)
One of the courtroom numbers used by the court (e.g. 2, or B). Because it is court-specific, no enum is available. But incoming data from Producers, if any, will be validated by JIMS.
E-citation spec says to provide courtroom, "where available". No ADR DDN provided.
There may be a Code/Description pair, if the event is table-driven.
The hearing type is not required in e-citation, but will be accepted if known.
Provide the real (not alias identity information) for the violator.
The format for a PERSON's name is: LastName, FirstName [MiddleInitialOrMiddleName] [Suffix]. Follow all requirements on ADR spec (DDN 11, 12, 13, and 14). Example: SMITH, JAMES M JR
The name of an ENITITY, such as for the landlord who received the ordinance violation, is also acceptable (e.g. ACME RENTALS INC).
Per ADR spec (DDN 19). Often provided to help confirm identity on name-only searches. Due to ADR constraints, this is required even when the litigant is an entity.
Height in inches, even though e-citation spec stays ft and inches. ADR spec (DDN 21) is silent on units. Required by JIMS only for warrants.
E-citation spec calls for weights to be in pounds. ADR spec (DDN 22) is silent on data type.
Per ADR spec (DDN 23) and Appendix E of the e-citation spec. Maroon, Pink and Unknown values are missing because they aren't in the court's CMS yet. Without Unknown, this can't be required. Needed for warrants.
Hair color, per Appendix F of the e-citation standards (a subset of the ADR standard list in DDN 24). Required from Producers, since there is a code for Unknown. Needed for warrants.
See ADR spec, DDN 27. Reqd. by MANY agencies in ADR, but not reqd in all courts participating in Judici, because the offender might be unlicensed or uncooperative.
Cannot be required, because E-citation spec calls for a court date, but notes that some agencies can just use a blurb indicating that court will advise later.
This is the NCIC ORI code for the law enforcement agency which is reporting the incident.
This is the incident ID or police report number for the incident.
A Producer's internal ID (e.g. compound database key) for this data item. Judici may not use this for anything other than diagnostic purposes
Per ADR spec DDN 174.
Per ADR spec DDN 175.
There is no universal standard (such as NCIC code) for townships. So this code is assigned by the Clerk their arresting agency table in their case management system. The only time that a township NEEDS to be set up in this way is when the township is supposed to get some money from the ticket. Not all townships have this deal with local law enforcement. But in those that do, the TownshipRoadFlag should be set and TownshipName/TownshipCode should be provided.
This provides much of the details, on the defendant/violator actors.
Must have one of these elements if CashBondType exists. This cannot be enforced by schema, so it is checked in pre-processing.
Derived Data, based on hearing data. Indicates whether or not the litigant must appear in court, based on the charge(s) involved. Used in determining eligibility to plead online in a case. Per draft ADR Spec DDN 221.
AOIC advised (see e-mails from early April 2015) that the COURT is ultimately responsible for the correct determination of whether court appearance is required. So this data is being provided only for diagnostic purposes.
In order to determine what case type(s) to make from the charges, each charge shall be accompanied by the case type associated with it in the official AOIC offense table which e-sitation vendors are supposed to use as the basis for the offense code they're reporting.
This is the code which identifies a particular offense in the AOIC offense table.
This is the case type under which the charge offense would be filed if it were the only offense on the case. This is drawn from the AOIC offense table.
This is the amount of cash bond paid, if any. Corresponds to ADR spec, DDN 49.
The Audit value is used on records which correspond to the change/deletion of a previous payment. NOTE: In courts using the JIMS case management system- payments originally receipted by a collection agency will have a Type value of "Collect agn chk" or "Collect agn EFT", depending upon how the funds were conveyed to the court by the agency.
Becuase it takes a couple of days to actually have the money "in hand", Clerk staff would have trouble knowing whether to input th ebond or not. So for now, the Clerk's interface won't all credit card payments.
Indicates the type of ID (e.g. SID code, state/DLN).
A concetantation of the issuing state code (see note on state/province codes, in comments at top of schema) and the driver's license number. Ref. ADR spec (DDN 37 and DDN 36)
The actual identifier. Driver's licenses are represented as a concatenation of a "state" code (if any) and the driver's license number. Ref. ADR spec (DDN 37/36). For Illinois data, the non-U.S. "state" codes are based on a standard set by the Administrative Office of the Illinois Courts.
Assigned by the entity producing the CourtDataTransferFile as they see fit, for debugging purposes.
Indicates the software tool which produced the data. For example: "Tickets R Us, Bulk Ticket Export Engine"
The version of the software tool that produced the data.
Indicates the entity that produced the data (e.g. Tickets R Us).
Each arresting officer is represented by a RelatedActor associated with the court data transfer file. For more on how to represent an ArrestingOfficer, see general notes following.
These are individuals not associated with cases. Some are associated with a Court (e.g. judges), while others are even higher-level (e.g. law enforcement agents). Since the attributes used depend on what role the individual plays, and because the structure of some attributes is dictated for performance reasons, a few examples will best illustrate what is required:
Examples:
INDIVIDUALS DIRECTLY ASSOCIATED WITH THE COURT
Judge- <RelatedActor Type="Judge" ActorId="IL001025JWAPNER" Name="WAPNER" Id="IL001025JWAPNER" OrganizationCode="IL001025J"/>
Court reporter- <RelatedActor Type="CourtReporter" ActorId="IL001025JCRLP" Name="LP" Id="IL001025JLP" OrganizationCode="IL001025J"/>
OrganizationCode- NCIC from Court
ID- a composite value with a required structure using special delimiters
NCIC from Court
The court's internal ID for the individual
ActorID- a composite value with a required structure using special delimiters
- NCIC from Court
- If it is a court reporter, add CR
- The court's internal ID for the individual
INDIVIDUALS NOT DIRECTLY ASSOCIATED WITH THE COURT
Arresting officer- <RelatedActor Type="LawEnforcementAgent" ActorId="IL001025JO9N791" Name="GUNDERSON" Id="791" OrganizationCode="9" OrganizationName="MAPLETON PD" NCIC="IL001013A"/>
ID- the officer's badge number
NCIC- the ORI code assigned to the law enforcement agency with whom the officer is associated.
OrganizationCode-the court's internal ID for the officer's agency
OrganizationName- if OrganizationCode is provided
ActorID is a composite value with a required structure using special delimiters
- NCIC code for the officer
- O (Officer)
- OrganizationCode
- N (Number)
- ID (badge number)
Attorney- <RelatedActor Type="Attorney" ActorId="IL001025JA1234567" Name="DARROW, CLARENCE" Id="1234567" OrganizationCode="123"/>
ID- ideally, courts use the attorney registration number under which the attorney practices in the court
OrganizationCode-the court's internal ID for the firm with which the attorney is associated. If attorney is a solo practitioner, use the court's internal ID for the attorney, or attorney registration number again.
OrganizationName- if OrganizationCode is provided
ActorID is a composite value with a required structure using special delimiters
- NCIC from Court
- A (Attorney)
- ID (attorney registration number)
Among other things, this attribute is used for an officer's badge number (ADR spec DDN 142). For badge numbers, the value should be numeric, up to five digits. Letters (if any) probably represent the jurisdiction, and should be stripped.
Ref. ADR spec (DDN 59). This is the NCIC ORI code for the arresting officer's agency.
There are other valid NCIC codes as well, and this field should be to indicate them, if available.
Ref. ADR spec (DDN 323), though CMS requires "Lastname, Firstname" format. Warning: This feature means that failure to match EXACTLY the value in the court's CMS will result in the creation of a duplicate officer in the CMS. The same thing will occur if you provide the wrong agency NCIC code for an officer.