search

usnistgov / CastVoteRecords

Common data format specification for cast vote records
https://pages.nist.gov/CastVoteRecords
Other
20 stars 2 forks source link

Documentation Clarification of `BallotSheetId` #37

Open adghayes opened 1 year ago

adghayes commented 1 year ago

Organization Name: VotingWorks

Organization Type: 2, Industry

Document (e.g., CastVoteRecords): CastVoteRecords

Reference (Include section and paragraph number):

Comment (Include rationale for comment):

We think there may be a mistake in the documentation for a couple of the identifiers on CVR.CVR:

For BallotPrePrintedId, this description makes sense:

A unique identifier for the ballot (or sheet of a multi-sheet ballot) that this CVR represents, used if ballots are pre-marked with unique identifiers. If provided, this number would be the same on all CVRs that represent individual sheets from the same multi-sheet ballot. This identifier is not the same as one that may be impressed on the corresponding ballot as it is scanned or otherwise associated with the corresponding ballot; see the BallotAuditId attribute.

But for BallotSheetId, the description seems incorrect:

A unique number for the ballot (or sheet of a multi-sheet ballot) that this CVR represents, used if ballots are pre-marked with unique numbers. If provided, this number would be the same on all CVRs that represent individual sheets from the same multi-sheet ballot. This number is not the same as one that may be impressed on the corresponding ballot as it is scanned or otherwise associated with the corresponding ballot; see the BallotAuditId attribute.

Since it is the BallotSheetId, shouldn't it be unique to each sheet? Whether it is unique within a multi-sheet ballot or universally unique is another question, but based on the name I would think that it is not the case that "this number would be the same on all CVRs that represent individual sheets from the same multi-sheet ballot."

The reason this is relevant is because VVSG 1.1.5-G.5 specifies:

The voting system must be capable of recording audit-related information in the CVR or collection of CVRs as they are created, that includes: ...for multi-sheet ballots, identification of the individual sheet corresponding to the CVR, along with the identification of the ballot style.

It seems like BallotSheetId would be the appropriate place for this information, but not if the existing description above is correct.

Suggested Change:

Clarify what BallotSheetId is meant to mean and update documentation accordingly.

Organization Type: 1 = Federal, 2 = Industry, 3 = Academia, 4 = Self, 5 = Other

JDziurlaj commented 1 year ago

You are correct that BallotSheetId corresponds roughly to the requirement identified. It’s the identifier unique to the ballot style sheet impressed on all instances. BallotPrePrintedId on the other hand is a identifier unique to a particular instance of a sheet (i.e. unique across all sheets of this ballot style).