Schemas / Record
rig.record.note
v1.0.0 · stable maturity: draft 3 fields 2 required
Fields
| Field | Type | Meaning | |
|---|---|---|---|
subject |
entity | required | What the note is about |
body |
string | required | The note |
author |
entity | optional | Optional. Person or organisation that wrote it |
A note about a fact. Format when present.
This schema is ordinary prose that hangs on a case, an order, an encounter, or any other entity - not a BCF comment (rig.bim.comment), not editorial copy (rig.story.flow), and not a mailbox (rig.person.contact).
subject and body are required.
The clock is rig.calendar.event on this entity. A title is rig.meta.named. A second note is another entity. Do not invent a notes array on the subject.
JSON Schema
Resolves at https://rig.works/schemas/rig.record.note.schema.json —
raw file.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://rig.works/schemas/rig.record.note.schema.json",
"title": "rig.record.note",
"type": "object",
"additionalProperties": false,
"properties": {
"subject": {
"$ref": "./_defs.schema.json#/$defs/entity"
},
"body": {
"$ref": "./_defs.schema.json#/$defs/string"
},
"author": {
"$ref": "./_defs.schema.json#/$defs/entity"
}
},
"required": [
"subject",
"body"
],
"description": "A note about a fact. Clock composes rig.calendar.event. Not a BCF comment and not story copy.",
"x-rig-maturity": "draft"
}