{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://docs.demiton.io/registers/document_transmittal/v1.json",
  "title": "document_transmittal contract v1",
  "type": "object",
  "required": [
    "external_id",
    "number",
    "project",
    "sent_at",
    "status",
    "subject"
  ],
  "properties": {
    "number": {
      "type": "string",
      "description": "the transmittal number",
      "x-demiton-requiredness": "required"
    },
    "status": {
      "type": "string",
      "description": "whether it is outstanding, responded or closed",
      "x-demiton-requiredness": "required"
    },
    "thread": {
      "type": "string",
      "description": "the correspondence thread it belongs to",
      "x-demiton-requiredness": "optional"
    },
    "project": {
      "type": "string",
      "description": "the project the transmittal is on",
      "x-demiton-requiredness": "required",
      "x-demiton-reference": true
    },
    "sent_at": {
      "type": "string",
      "description": "when the transmittal was issued",
      "x-demiton-requiredness": "required",
      "format": "date-time",
      "x-demiton-type": "datetime"
    },
    "subject": {
      "type": "string",
      "description": "what the transmittal is",
      "x-demiton-requiredness": "required"
    },
    "revision": {
      "type": "integer",
      "description": "the submittal revision",
      "x-demiton-requiredness": "optional"
    },
    "documents": {
      "type": "array",
      "description": "the documents transmitted, each with number and revision",
      "x-demiton-requiredness": "optional"
    },
    "from_party": {
      "type": "string",
      "description": "who sent the transmittal",
      "x-demiton-requiredness": "optional",
      "x-demiton-reference": true
    },
    "to_parties": {
      "type": "array",
      "description": "who received it, with the distribution type",
      "x-demiton-requiredness": "optional"
    },
    "external_id": {
      "type": "string",
      "description": "the source system's own id for the transmittal",
      "x-demiton-requiredness": "required"
    },
    "in_reply_to": {
      "type": "string",
      "description": "the transmittal this one answers",
      "x-demiton-requiredness": "optional",
      "x-demiton-reference": true
    },
    "confidential": {
      "type": "boolean",
      "description": "whether the transmittal is confidential",
      "x-demiton-requiredness": "optional"
    },
    "response_due": {
      "type": "string",
      "description": "when a response is due",
      "x-demiton-requiredness": "optional",
      "x-demiton-unit": "day",
      "format": "date",
      "x-demiton-type": "date"
    },
    "approval_status": {
      "type": "string",
      "description": "the approval state of the transmittal",
      "x-demiton-requiredness": "optional"
    },
    "reason_for_issue": {
      "type": "string",
      "description": "why the documents were issued",
      "x-demiton-requiredness": "optional"
    },
    "response_required": {
      "type": "boolean",
      "description": "whether a response is owed",
      "x-demiton-requiredness": "optional"
    },
    "correspondence_type": {
      "type": "string",
      "description": "the kind of correspondence, e.g. transmittal or submittal",
      "x-demiton-requiredness": "optional"
    },
    "specification_section": {
      "type": "string",
      "description": "the specification section the documents address",
      "x-demiton-requiredness": "optional"
    },
    "responsible_contractor": {
      "type": "string",
      "description": "the contractor responsible for the submission",
      "x-demiton-requiredness": "optional",
      "x-demiton-reference": true
    }
  },
  "x-demiton-register-type": "document_transmittal",
  "x-demiton-contract-version": "1.0.3",
  "x-demiton-store": "tenant",
  "x-demiton-axes": [
    {
      "axis": "project",
      "requirement": "required",
      "role": "subject"
    }
  ],
  "x-demiton-measures": [],
  "x-demiton-provenance": {
    "standards": [
      {
        "code": "AS ISO 19650.1:2019 / AS ISO 19650.2:2019",
        "title": "Organization and digitization of information about buildings and civil engineering works, including BIM - Information management using BIM - Part 1: Concepts and principles",
        "access": "public_summary",
        "region": "Australia",
        "edition": "2019",
        "checked_on": "2026-09-14"
      },
      {
        "code": "AS ISO 19650.2:2019",
        "title": "Information management using BIM - Part 2: Delivery phase of the assets",
        "access": "public_summary",
        "region": "Australia",
        "edition": "2019",
        "checked_on": "2026-09-14"
      },
      {
        "code": "Privacy Act 1988 (Cth)",
        "title": "Privacy Act 1988 - Australian Privacy Principles",
        "access": "public_summary",
        "clause": "APPs 1-13",
        "region": "Australia",
        "edition": "compilation current at 2026-09",
        "checked_on": "2026-09-14"
      },
      {
        "code": "EN ISO 19650-1:2018 / EN ISO 19650-2:2018",
        "title": "European adoptions of ISO 19650-1/-2 (CEN)",
        "access": "public_summary",
        "region": "European Union",
        "edition": "2018",
        "checked_on": "2026-09-14"
      },
      {
        "code": "Regulation (EU) 2016/679 (GDPR)",
        "title": "General Data Protection Regulation",
        "access": "public_summary",
        "region": "European Union",
        "edition": "2016/679",
        "checked_on": "2026-09-14"
      },
      {
        "code": "ISO 19650-1:2018 / ISO 19650-2:2018",
        "title": "Information management using building information modelling - Part 1: Concepts and principles",
        "access": "public_summary",
        "region": "International",
        "edition": "2018",
        "checked_on": "2026-09-14"
      },
      {
        "code": "ISO 19650-2:2018",
        "title": "Information management using building information modelling - Part 2: Delivery phase of the assets",
        "access": "public_summary",
        "region": "International",
        "edition": "2018",
        "checked_on": "2026-09-14"
      },
      {
        "code": "Privacy Act 2020 (NZ)",
        "title": "Privacy Act 2020 - Information Privacy Principles",
        "access": "public_summary",
        "clause": "IPPs 1-13",
        "region": "New Zealand",
        "edition": "2020 No 31",
        "checked_on": "2026-09-14"
      },
      {
        "code": "BS EN ISO 19650-1:2018 / BS EN ISO 19650-2:2018",
        "title": "UK adoptions of ISO 19650-1/-2 (UK BIM Framework, now IMI Framework)",
        "access": "public_summary",
        "region": "United Kingdom",
        "edition": "2018",
        "checked_on": "2026-09-14"
      },
      {
        "code": "BS EN ISO 19650-2 UK National Annex",
        "title": "UK National Annex to BS EN ISO 19650-2 (status and revision codes)",
        "access": "paywalled_secondary",
        "clause": "NA.4.2 / Table NA.2; NA.4.3 (reported by third party)",
        "region": "United Kingdom",
        "edition": "2021",
        "checked_on": "2026-09-14"
      },
      {
        "code": "UK GDPR and Data Protection Act 2018",
        "title": "UK General Data Protection Regulation with Data Protection Act 2018",
        "access": "public_summary",
        "region": "United Kingdom",
        "edition": "UK GDPR (retained) + DPA 2018",
        "checked_on": "2026-09-14"
      }
    ]
  },
  "description": "Transmittals recording which documents went to whom, and when.",
  "x-demiton-contract-url": "https://docs.demiton.io/registers/document_transmittal/",
  "x-demiton-register-catalog": "https://docs.demiton.io/concepts/register-catalog"
}