Process Event Set 📝

Represents a set of process events associated to a specific record.

Scope

This message type is intended to represent a set of temporal events within a defined process. This will commonly be used for situations where acquiring a record's process history is required, such as for auditing, reporting or compliance purposes.

Note that this message type does not guarantee nor expect all known or related ProcessEvents to be present. It is possible for this message to only contain a subset of all known ProcessEvents.

Structure

A Process Event Set shall contain every standard message Header property, in addition to the following properties:

Name	Cardinality	Type	Description & Constraints
process_event	1..1	ProcessEvent	A set of ProcessEvents. Represents a set of process concepts at a specific event in time.

Specification

Schema

Loading ....

Source

{
  "$id": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/message/process_event_set.schema.json",
  "$schema": "https://json-schema.org/draft-07/schema",
  "title": "Process Event Set",
  "description": "Represents a process concept at a specific event in time.",
  "type": "object",
  "properties": {
    "process_event": {
      "type": "array",
      "items": {
        "$ref": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/resource/process_event.schema.json"
      },
      "minItems": 1,
      "uniqueItems": true
    }
  },
  "allOf": [
    {
      "$ref": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/data/header.schema.json"
    }
  ],
  "required": [
    "process_event"
  ]
}

Example

{
  "tx_id": "01950719-b154-72f5-8437-5572df032a69",
  "version": "0.1.0",
  "kind": "ProcessEventSet",
  "system_id": "https://apps.nrs.gov.bc.ca/int/jira/secure/insight/assets/ITSM-5917",
  "record_id": "06bc53dc-3e4f-420b-801c-bd9cc0ea01b2",
  "record_kind": "Permit",
  "process_event": [
    {
      "event": {
        "start_date": "2024-12-01",
        "end_date": "2024-12-31"
      },
      "process": {
        "class": [
          "Application",
          "Review",
          "Assessment",
          "UnderReview"
        ],
        "concept": "https://bcgov.github.io/nr-pies/docs/spec/concept/process_tracking",
        "description": "The authorization request is under review by subject matter expert.",
        "status": "Auditing",
        "status_code": "AU"
      }
    },
    {
      "event": {
        "start_date": "2025-01-01"
      },
      "process": {
        "class": [
          "Application",
          "Decision",
          "Declined"
        ],
        "concept": "https://bcgov.github.io/nr-pies/docs/spec/concept/process_tracking",
        "description": "The authorization request has been declined due to a conflict of interest.",
        "status": "DeclinedConflict"
      }
    }
  ]
}

Implementation Notes

The Process Event Set message type is designed to act as an aggregation of ProcessEvents. Systems creating this message type should provide all known ProcessEvents associated to a record where possible. Recipient systems should not assume that the message will provide the full data horizon of all ProcessEvents. If he full data horizon is required, recipient systems must ensure that they request for any other relevant ProcessEventSets that may come from associated records.

References

• Header
• ProcessEvent