Schemas / Record

rig.record.case

v1.0.0 · stable maturity: draft 6 fields 3 required

Fields

FieldTypeMeaning
subject entity required Person or organisation the file is about
kind enumfraud · aml · service · benefits · other required fraud / aml / service / benefits / other
status enumopen · pending · closed required open / pending / closed
assignee entity optional Optional. Person or organisation working the file
openedDate string optional Optional. Day opened, YYYY-MM-DD
identifier string optional Optional. Case number as issued

A file about a subject. Format when present.

One shape for an AML investigation and a citizen service request. This schema is the file - not a workflow, and not the payments or encounters that belong to it.

subject, kind, and status are required.

The title is rig.meta.named. Members point at this file with rig.record.concerns. Do not put a members array here.

JSON Schema

Resolves at https://rig.works/schemas/rig.record.case.schema.json — raw file.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.record.case.schema.json",
  "title": "rig.record.case",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "subject": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "kind": {
      "type": "string",
      "enum": [
        "fraud",
        "aml",
        "service",
        "benefits",
        "other"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "open",
        "pending",
        "closed"
      ]
    },
    "assignee": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "openedDate": {
      "type": "string",
      "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
      "description": "ISO 8601 calendar date."
    },
    "identifier": {
      "$ref": "./_defs.schema.json#/$defs/string"
    }
  },
  "required": [
    "subject",
    "kind",
    "status"
  ],
  "description": "A file about a subject. Members point at it with rig.record.concerns. Title is rig.meta.named.",
  "x-rig-maturity": "draft"
}

Seen in

record-bank.json · record-civic.json