{
  "$id": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/element/data/header.schema.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Header",
  "description": "Represents a set of standardized attributes needed for identification and attribution.",
  "type": "object",
  "properties": {
    "transaction_id": {
      "type": "string",
      "description": "A unique UUIDv7 assigned for this specific message.",
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-7[0-9a-fA-F]{3}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
    },
    "version": {
      "type": "string",
      "description": "The PIES specification version this message complies to. Value shall be a valid semantic version formatted string.",
      "pattern": "^(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$"
    },
    "kind": {
      "type": "string",
      "description": "The specific kind of PIES message data type this message represents.",
      "enum": ["Record", "RecordLinkage"]
    },
    "system_id": {
      "type": "string",
      "description": "A valid NRIDS IT Service Management code which identifies the source system, service or asset that the data originates from.",
      "pattern": "^ITSM-\\d{4,5}$"
    },
    "record_id": {
      "type": "string",
      "description": "The record or primary key representing what the data this message is directly associated to."
    },
    "record_kind": {
      "type": "string",
      "description": "The kind of record the source system stores this record as (i.e. Permit, Project, Submission or Tracking).",
      "enum": ["Permit", "Project", "Submission", "Tracking"]
    }
  },
  "required": ["transaction_id", "version", "kind", "system_id", "record_id", "record_kind"]
}