Reporting data

2025-01-01 | 📑 140 words | ⏱ 2 mins | 🧾 History | ✍ NHS Notify | 🔑 NHS Notify

🚧 This page has less that 200 words. So it looks like this page is still under construction.

Reusable types for NHS Notify payload schemas.

Known Issues / Todo

  • ⛅ This page is draft and is subject to rapid change, and may not be fully accurate or complete

Reporting data

Reusable types for NHS Notify payload schemas.

Schema Information

  • Schema ID: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/reporting.schema.json
  • Schema Version: https://json-schema.org/draft/2020-12/schema
  • Source File: digital-letters/2025-10-draft/defs/reporting.schema.yaml

Properties

reportUri

Type: string

Uri to the storage location of the generated status report

Format: uri Examples: s3://my-bucket/path/to/my-report

Type

object

Raw Schema 

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/reporting.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: Reporting data
description: Reusable types for NHS Notify payload schemas.
type: object
properties:
  reportUri:
    type: string
    format: uri
    description: Uri to the storage location of the generated status report
    examples:
    - s3://my-bucket/path/to/my-report