DisclosureOS documentation · v2 Beta
Records overview
Choose the structures you need for an observation and its supporting material.
The Records area covers the observation itself, its setting, witness accounts, documents and physical samples. Use this overview to choose a guide for the material you have. Each guide has a field reference beneath it in the menu.
Start with an observation
An observation holds source references, reported time and position, measured values and processing history. It can begin as a small draft with explicit gaps. You can add the supporting documents your application needs as the material becomes available.
The Observation guide uses the fictional example case's station log. Attach it to a record, save validated JSON and diagnose a broken source reference.
New to the packages? Begin with your first record.
Choose the supporting material
These topics extend what you can describe. You do not need to implement every topic before saving a useful observation.
Event and setting
Describe reported objects, places, platforms, conditions and time. Keep competing descriptions and their sources separate, and link measured quantities to the observation.
Witnesses and accounts
Distinguish a witness from each account they give. Retain recording context, sourced qualifications and the details of interviews or other collection procedures.
Documents and custody
Track document editions, pages, releases and digital custody. Preserve which edition supplied a statement or extract so later changes remain traceable.
Materials and laboratory
Describe collected specimens, their preparation, custody and laboratory results. Keep each result connected to the tested portion and the files that support it.
How the documents connect
Your application keeps the source files and the JSON documents that describe them. An observation inventories its sources and data products. Supporting documents, such as context or witness records, link to the observation through the references defined by their schemas. References to exact document snapshots preserve which version was used.
A source description can remain incomplete or disputed. Keep a reviewer's assessment in a claim history, with the subject, supporting inputs and attribution. For recordings, Instruments supplies equipment and capture context that can be connected to the observation's products and measurements.
Use a guide to assemble and check a document. Use its field reference to look up required fields, alternatives and constraints. The Observation fields cover the core record; each supporting topic has its own reference.
Check supplied source files
The shared source and custody examples cover documents, testimony and physical samples. Run the workflow that matches your material to inspect declared relationships and check supplied files against their recorded digests. These checks do not authenticate a speaker, document release or physical handoff.
Package availability
The observation, context, witness, document, material and laboratory APIs are published in Beta 4. Each guide identifies the document versions and checks it uses. See installation and release details.
For an interactive explanation, visit the Records standard page. To inspect a connected implementation, explore the fictional example case.