Spec / open-values-register-entity-map
Open Values Register Entity Map
For one public register, which catalogue options have been matched to which company or record in that register, and which could not be matched. Maintainers write and review it by hand, and the evidence builder uses only the matched rows.
- Files people or tools write
- Status: draft
- Version: 1.0.0
- Format name in the file:
open-values-register-entity-map
Draft. It may still change before it is called stable. A file someone writes by hand or with a tool, and keeps.
Who writes it and who reads it
Written by pipeline/registers/scaffold_entity_map.py. Read by register evidence generation, mapping review.
Fields
| Field | What it means | Type |
|---|---|---|
format required | Names the file format. Always open-values-register-entity-map. | always "open-values-register-entity-map" |
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 these mappings point into, from content/registers.json. The file is named after it. | string |
updated required | The date the mappings were last changed, as YYYY-MM-DD. No review date in the file may be later than this. | string |
note required | A short paragraph on what this set of mappings covers and any limits on how its matches should be read. | string |
mappings required | One row per catalogue option that has been looked up, or is waiting to be looked up, in this register. | 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-entity-map-v1.schema.json. Validators can fetch it there; the file is also in the repository at app/data/standard/schemas/register-entity-map.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.