Citation
DatatypeDraftv1.0.0-rc.2
A published work that a record rests on, such as a regulation, a standard, a paper or a procedure.
https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Citation.json
Fields
titleRequiredtextnot emptyThe work's title.
texttextThe full citation, in any common style.
urlURIWhere the work can be read.
sectiontextThe section, clause or table that the record rests on.
editiontextThe edition or version of the work, as the work names it.
Links
Held by Records that embed this one, with their field that holds it.
- AlgorithmEntitystandardcitationsA published or versioned computation, such as ISO 9613-2:2024, or a model trained on data. Sealed steps and runs refer to it by id, as the method they claim to follow.
- AssumptionEntitycitationA fact that an evaluation takes as true without evidence, such as an operating state or the weather, with the reason for it.
- CalibrationPartstandardA check of an instrument against a reference, with its date, its result and its certificate.
- ComparisonPartbasisTwo results for the same thing, their difference, the tolerance that judges it and the verdict. Validation runs, monitoring against prediction and conformance tests use it.
- ControlPartcitationA check on how an evaluation is done, which a framework sets, such as "a person approves each decision" or "measurements use a Class 1 meter". A mitigation is not a control: a barrier is a Structure, and a site's own limit is a criterion of its Permit.
- CriterionPartcitationOne rule that must be checked. It compares a metric, summed up by a statistic over a period, with a limit, for the features it applies to.
- FrameworkEntitycitationA set of rules for one domain, issued by a regulator, an industry body or an organization, such as AER Directive 038. It holds its policies, controls, periods and variables.
- Geographic identifierDatatypedatasetA place stated by a name or an id, not by coordinates, such as a legal land description, a parcel id, a civic address or a feature of a named dataset. As in ISO 19112.
- PeriodPartcitationA recurring window in local time that a rule judges by, such as night-time from 22:00 to 07:00. A window whose end is not after its start runs past midnight.
- PolicyPartcitationOne risk that a framework manages, and the criteria that manage it.
- PositioningDatatypecitationHow a position was obtained and how accurate it is. It holds the method, the time, the accuracy in metres and what the position rests on. The accuracy is absolute positional accuracy, as in ISO 19157.
- StepPartcitationOne unit of work in a flow, such as a calculation, a question, a decision or a run of an algorithm. A sealed step names its inputs, its outputs and the algorithm it claims to follow, but not how it works.
- TraceEntityTraceStep.oversight.authorityJustification.citationsWhat one run of a flow or an algorithm did: what it used, each step, what it made, and the verdict. Its terms follow W3C PROV where they map: agents (prov:wasAssociatedWith), inputs (prov:used), outputs (prov:generated).
- VariablePartcitationA named Value or formula that criteria and steps refer to, such as a framework's limit or a method's parameter.
Examples
An id that another example defines opens that record.
Example 2
{
"title": "Directive 038: Noise Control",
"text": "Alberta Energy Regulator (2024). Directive 038: Noise Control.",
"url": "https://www.aer.ca/regulating-development/rules-and-directives/directives/directive-038",
"section": "Table 1",
"edition": "April 2024"
}Show 1 more exampleHide the other example
Example 1
{
"title": "Directive 038: Noise Control",
"section": "Table 1"
}Changes and file
Changes
- 0.1.0 First version.
Schema file
Show the JSON SchemaHide the JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://opendevelopmentstandards.org/schema/1.0.0-rc.2/core/Citation.json",
"title": "Citation",
"description": "A published work that a record rests on, such as a regulation, a standard, a paper or a procedure.",
"type": "object",
"properties": {
"title": {
"type": "string",
"minLength": 1,
"description": "The work's title."
},
"text": {
"type": "string",
"description": "The full citation, in any common style."
},
"url": {
"type": "string",
"format": "uri",
"description": "Where the work can be read."
},
"section": {
"type": "string",
"description": "The section, clause or table that the record rests on."
},
"edition": {
"type": "string",
"description": "The edition or version of the work, as the work names it."
}
},
"required": [
"title"
],
"patternProperties": {
"^x-": {}
},
"unevaluatedProperties": false,
"examples": [
{
"title": "Directive 038: Noise Control",
"section": "Table 1"
},
{
"title": "Directive 038: Noise Control",
"text": "Alberta Energy Regulator (2024). Directive 038: Noise Control.",
"url": "https://www.aer.ca/regulating-development/rules-and-directives/directives/directive-038",
"section": "Table 1",
"edition": "April 2024"
}
],
"x-ods-status": "draft",
"x-ods-kind": "datatype",
"x-ods-module": "core",
"x-ods-changes": {
"0.1.0": "First version."
}
}