Record Linkage 🚧

Represents an assertion for specific records to be related or linked together.

Scope

This message type is intended to allow systems to assert that two records are related and should be linked However, this message only serves as an assertion; validation of the relationship between the records is left to the consuming system.

Structure

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

Name	Cardinality	Type	Description & Constraints
linked_system_id	1..*	string	A valid URI that identifies the source system, service or asset that the linked data comes from. This URI should point to an authoritative asset tracking system or equivalent. However, the URI does not need to be machine readable.
linked_record_id	1..1	string	The record or primary key representing what record should be linked with the primary header record.
linked_record_kind	1..1	string	The kind of record the source system stores this linked record as (i.e. Permit, Project, Submission or Tracking).

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": "Record Linkage",
  "description": "Represents an assertion for a specific record to be related or linked together.",
  "type": "object",
  "properties": {
    "linked_system_id": {
      "type": "string",
      "description": "A valid URI that identifies the source system, service or asset that the linked data comes from. This URI should point to an authoritative asset tracking system or equivalent. However, the URI does not need to be machine readable.",
      "format": "uri"
    },
    "linked_record_id": {
      "type": "string",
      "description": "The record or primary key representing what record should be linked with the primary header record."
    },
    "linked_record_kind": {
      "type": "string",
      "description": "The kind of record the source system stores this linked record as (i.e. Permit, Project, Submission or Tracking).",
      "enum": [
        "Permit",
        "Project",
        "Submission",
        "Tracking"
      ]
    }
  },
  "allOf": [
    {
      "$ref": "https://raw.githubusercontent.com/bcgov/nr-pies/refs/heads/main/docs/spec/data/header.schema.json"
    }
  ],
  "required": [
    "linked_record_id",
    "linked_record_kind",
    "linked_system_id"
  ]
}

Example

{
  "tx_id": "01950719-b154-72f5-8437-5572df032a69",
  "version": "0.1.0",
  "kind": "RecordLinkage",
  "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",
  "linked_system_id": "https://apps.nrs.gov.bc.ca/int/jira/secure/insight/assets/ITSM-5314",
  "linked_record_id": "5d884469-d016-4b87-8d65-4a1520ae788b",
  "linked_record_kind": "Tracking"
}

Implementation Notes

The sole purpose of the Record Linkage message type is to define a specific link between two different records. This message may be used by the consuming system to either bind the different records together, or to use it as a way to remove a specific link between two specific records.

This message type should only specify one system_id; while the specification permits defining an unordered array of system ids, this is not recommended as it introduces ambiguity. If multiple links must be expressed, each link should have their own message.

References

• Header