Schemas / Record

rig.record.consent

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

Fields

FieldTypeMeaning
subject entity required Person (or organisation) who decided
purpose string required What was granted (treatment, research, marketing)
status enumgranted · refused · withdrawn required granted / refused / withdrawn
instrument entity optional Optional. Signed file (rig.media.asset_ref kind document)

Permission a subject gave for a purpose. Format when present.

This schema is the grant, refusal, or withdrawal - not a consent-workflow, and not the classification mark (rig.record.mark).

subject, purpose, and status are required.

The window is rig.calendar.span on this entity. A second purpose is another entity.

JSON Schema

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://rig.works/schemas/rig.record.consent.schema.json",
  "title": "rig.record.consent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "subject": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    },
    "purpose": {
      "$ref": "./_defs.schema.json#/$defs/string"
    },
    "status": {
      "type": "string",
      "enum": [
        "granted",
        "refused",
        "withdrawn"
      ]
    },
    "instrument": {
      "$ref": "./_defs.schema.json#/$defs/entity"
    }
  },
  "required": [
    "subject",
    "purpose",
    "status"
  ],
  "description": "Permission a subject gave for a purpose. Window composes rig.calendar.span.",
  "x-rig-maturity": "draft"
}

Seen in

record-care.json