contract
What a dataset promises, when the promises hold, and the proof that they are kept
Applies to: Meaning and contracts. What a value and its absence mean, and the promises a dataset makes: contracts, periods, controls and consent.
Written in commons/data/models/contract/mod.ts:156. Requires nothing. 7 concepts, 4 code lists.
Diagram source
flowchart LR
contract_field -->|contract| dataContract
control_run -->|control| controlConcepts
| Concept | Definition | Attributes | Written in |
|---|---|---|---|
canaryToken | A made-up value planted in a dataset or an environment that no honest process has a use for, so that its appearance elsewhere shows a leak | 4 | commons/data/models/contract/mod.ts:147 |
consent | A subject's consent to a purpose between two dates, and whether it was taken back: what makes a use of their data allowed or not | 6 | commons/data/models/contract/mod.ts:131 |
contractField | One field a data contract promises: its name, its datatype, whether it may be missing and how it is classified | 5 | commons/data/models/contract/mod.ts:73 |
control | A control: what must hold, who answers for it, how often it is checked and the test or evidence that checks it, one row of the control matrix | 6 | commons/data/models/contract/mod.ts:106 |
controlRun | What one run of a control found and when, with the evidence of it: a row of the history of a control, only added to | 4 | commons/data/models/contract/mod.ts:122 |
dataContract | What a dataset promises to those who read it, in one version: its owner, its status and the dates between which the version holds; its fields are the fields of the contract | 7 | commons/data/models/contract/mod.ts:56 |
period | A span of time of one scope (a month of a ledger, a reporting quarter) that takes changes while it is open and is closed when its figures are final | 8 | commons/data/models/contract/mod.ts:88 |
Code lists
| Code list | Definition | Codes |
|---|---|---|
consentStatus | Whether a consent is in force | 2 |
contractStatus | Where a data contract is in its life | 4 |
controlResult | What a run of a control found | 4 |
periodStatus | Whether a period still takes changes | 3 |