HL7 Network Updated (v2.0.0)

When a Hl7 network config has change

Details

This event is triggered after user has made a change to HL7 config in CCA

schema.json
{
"$schema": "https://json-schema.org/draft-07/schema#",
"$id": "https://cloud.sonifi.cca.software/schemas/hl7-network-updated-v2.json",
"title": "HL7 Network Updated EventBridge Event",
"description": "Schema for HL7 network update events from Sonifi CCA software platform published to AWS EventBridge",
"type": "object",
"required": [
"version",
"id",
"detail-type",
"source",
"account",
"time",
"region",
"detail"
],
"properties": {
"version": {
"type": "string",
"const": "0",
"description": "By default, this is set to 0 (zero) in all events"
},
"id": {
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
"description": "A unique identifier for the event, formatted as a UUID",
"examples": ["12345678-1234-1234-1234-123456789012"]
},
"detail-type": {
"type": "string",
"const": "hl7-network.updated.v2",
"description": "The type of event, specifically for HL7 network updates version 2"
},
"source": {
"type": "string",
"const": "cloud.sonifi.cca.software",
"description": "The source system generating this event"
},
"account": {
"type": "string",
"pattern": "^[0-9]{12}$",
"description": "The 12-digit number identifying an AWS account",
"examples": ["123456789012"]
},
"time": {
"type": "string",
"format": "date-time",
"description": "The event timestamp in ISO 8601 format",
"examples": ["2025-07-16T14:30:00Z"]
},
"region": {
"type": "string",
"pattern": "^[a-z]{2}-[a-z]+-[0-9]{1}$",
"description": "The AWS region where the event originated",
"examples": ["us-east-1", "eu-west-1", "ap-southeast-2"]
},
"resources": {
"type": "array",
"description": "Optional array of resource ARNs related to the event",
"items": {
"type": "string",
"pattern": "^arn:aws:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_/:.]+$",
"description": "AWS Resource ARN"
},
"examples": [
["arn:aws:rds:us-east-1:123456789012:db:hl7-network-db"],
["arn:aws:lambda:us-east-1:123456789012:function:hl7-processor"]
]
},
"detail": {
"type": "object",
"description": "Contains the event payload with data and metadata",
"required": [
"data",
"metadata"
],
"properties": {
"data": {
"type": "object",
"description": "The main event data payload",
"required": [
"site_id"
],
"properties": {
"site_id": {
"type": "string",
"pattern": "^[0-9]{7}$",
"description": "Unique identifier for the site, formatted as 7-digit numeric string",
"examples": ["0000001", "1234567"]
}
},
"additionalProperties": true
},
"metadata": {
"type": "object",
"description": "Additional metadata about the event context",
"required": [
"platform"
],
"properties": {
"platform": {
"type": "string",
"enum": ["Ocean"],
"description": "The platform where the event originated"
}
},
"additionalProperties": true
}
},
"additionalProperties": false
}
},
"additionalProperties": false,
"examples": [
{
"version": "0",
"id": "12345678-1234-1234-1234-123456789012",
"detail-type": "hl7-network.updated.v2",
"source": "cloud.sonifi.cca.software",
"account": "123456789012",
"time": "2025-07-16T14:30:00Z",
"region": "us-east-1",
"resources": [
"arn:aws:rds:us-east-1:123456789012:db:hl7-network-db"
],
"detail": {
"data": {
"site_id": "0000001"
},
"metadata": {
"platform": "Ocean"
}
}
}
]
}