Spec / open-values-register-observations
Open Values Register Observations
The facts a parser read out of one saved register download, as short labelled values that each point back to the raw record they came from. A register's parser writes it, and the evidence builder turns it into citations; it holds no scores and no finished sentences.
- Files built from other files
- Status: draft
- Version: 1.0.0
- Format name in the file:
open-values-register-observations
Draft. It may still change before it is called stable. A file a build step makes from other files. Change the sources, not this file.
Who writes it and who reads it
Written by future register-specific parsers. Read by deterministic register evidence generator, register review workflow.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names the file format. Always open-values-register-observations. | always "open-values-register-observations" |
version required | The version of this format the file follows. Always 1.0.0. | always "1.0.0" |
registerId required | The id of the register the observations were read from. It must match the snapshot and the entity map. | string |
snapshot required | The one verified snapshot these observations were parsed from. | object |
parser required | The parser that wrote this file. It must be the same id and version the snapshot manifest names. | object |
targets required | The catalogue options this snapshot covers, each written as cid/entityCode. Each must have a matched row in the register's entity map, and each needs exactly one observation. Listing targets lets several snapshots each cover part of one map. | list of string |
observations required | One observation per target option, keyed by that option's register identifier. | list |
This format allows no fields beyond the list above. A writer MUST NOT add any.
The schema
Its address is https://openvaluesstandard.org/schema/register-observations-v1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/register-observations.schema.json.
The key words MUST, MUST NOT, SHOULD, SHOULD NOT and MAY are used as described in RFC 2119 and RFC 8174 when, and only when, they appear in capitals.
Whether this format fits your app is your call. The spec says what a file MUST hold. Which formats you read and write, and what your app does with them, is yours to decide.