GenerateReport.Bundle

2025-01-01 | 📑 528 words | ⏱ 6 mins | 🧾 History | ✍ NHS Notify | 🔑 NHS Notify

No description available.

Known Issues / Todo

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

GenerateReport.Bundle

No description available.

Schema Information

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

Properties

type

Type: string

Concrete versioned event type string for this event (.vN suffix).

Constant value: uk.nhs.notify.digital.letters.reporting.generate.report.v1

source

Type: string

Event source for digital letters.

Pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/reporting

dataschema

Type: string

Canonical URI of the event’s data schema.

Constant value: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.json Examples: digital-letters-reporting-generate-report-data.schema.json

data

Type: object

Data payload of the GenerateReport event

Comment: Dereferenced from: ../data/digital-letters-reporting-generate-report-data.schema.json

Properties of data

senderId

Type: string

Identifier that the sender provided during onboarding. Provided in the body of each FHIR resource submitted by the sender.

reportPeriodStartTime

Type: string

Start time of the reporting period

Format: date-time

reportPeriodEndTime

Type: string

End time of the reporting period

Format: date-time

Inheritance

This schema extends the following schemas:

  • https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/digital-letters-reporting-profile.schema.json

Type

object

Raw Schema 

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.bundle.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: GenerateReport
type: object
allOf:
- $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/digital-letters-reporting-profile.schema.json
properties:
  type:
    type: string
    const: uk.nhs.notify.digital.letters.reporting.generate.report.v1
    description: Concrete versioned event type string for this event (.vN suffix).
  source:
    type: string
    pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/reporting
    description: Event source for digital letters.
  dataschema:
    type: string
    const: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.json
    description: Canonical URI of the event's data schema.
    examples:
    - digital-letters-reporting-generate-report-data.schema.json
  data:
    $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:
        type: string
        description: Identifier that the sender provided during onboarding. Provided
          in the body of each FHIR resource submitted by the sender.
        examples:
        - Trust-12345
        $comment: 'Dereferenced from: ../defs/requests.schema.json#/properties/senderId'
      reportPeriodStartTime:
        type: string
        format: date-time
        description: Start time of the reporting period
        examples:
        - '2025-12-03T00:00:00Z'
        $comment: 'Dereferenced from: ../defs/mesh.schema.json#/properties/reportPeriodStartTime'
      reportPeriodEndTime:
        type: string
        format: date-time
        description: End time of the reporting period
        examples:
        - '2025-12-04T23:59:59Z'
        $comment: 'Dereferenced from: ../defs/mesh.schema.json#/properties/reportPeriodEndTime'
    required:
    - senderId
    - reportPeriodStartTime
    - reportPeriodEndTime
    $comment: 'Dereferenced from: ../data/digital-letters-reporting-generate-report-data.schema.json'
$comment: Bundled (allOf preserved, property $refs dereferenced).