GenerateReport Data

2025-01-01 | 📑 189 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.

Data payload of the GenerateReport event

Known Issues / Todo

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

GenerateReport Data

Data payload of the GenerateReport event

Schema Information

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

Properties

senderId

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/senderId

reportPeriodStartTime

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/reportPeriodStartTime

reportPeriodEndTime

Type: unknown

No description available.

Reference: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/reportPeriodEndTime

Required Fields

  • senderId
  • reportPeriodStartTime
  • reportPeriodEndTime

Additional Properties

Additional properties are not allowed.

Type

object

Raw Schema 

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: GenerateReport Data
description: Data payload of the GenerateReport event
type: object
additionalProperties: false
properties:
  senderId:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json#/properties/senderId
  reportPeriodStartTime:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/reportPeriodStartTime
  reportPeriodEndTime:
    $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/mesh.schema.json#/properties/reportPeriodEndTime
required:
- senderId
- reportPeriodStartTime
- reportPeriodEndTime