Digital Letters Profile

2025-01-01 | 📑 358 words | ⏱ 4 mins | 🧾 History | ✍ NHS Notify | 🔑 NHS Notify

NHS Notify Digital Letters profile for CloudEvents 1.0 including additional governance and tracing attributes.

Known Issues / Todo

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

Digital Letters Profile

NHS Notify Digital Letters profile for CloudEvents 1.0 including additional governance and tracing attributes.

Schema Information

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

Properties

type

Type: string

No description available.

Minimum length: 1

source

Type: string

No description available.

Format: uri-reference Pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/digitalletters Minimum length: 30

plane

Type: string

No description available.

Allowed values: data

dataschemaversion

Type: string

Data Schema version (fixed to 1.0.0).

Constant value: 1.0.0 Examples: 1.0.0

datacontenttype

Type: string

Data Content type (fixed to application/json).

Constant value: application/json Examples: application/json

Inheritance

This schema extends the following schemas:

  • https://notify.nhs.uk/cloudevents/schemas/common/2026-04/nhs-notify-profile.schema.json

Type

object

Raw Schema 

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/digital-letters-profile.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: Digital Letters Profile
description: NHS Notify Digital Letters profile for CloudEvents 1.0 including additional
  governance and tracing attributes.
type: object
allOf:
- $ref: https://notify.nhs.uk/cloudevents/schemas/common/2026-04/nhs-notify-profile.schema.json
properties:
  type:
    type: string
    minLength: 1
    allOf:
    - name: NHS Notify versioned event type pattern
      type: string
      pattern: ^uk\.nhs\.notify\.digital\.letters\.[a-z0-9]+(?:\.[a-z0-9]+)*\.v[0-9]+$
  source:
    type: string
    pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/digitalletters
    minLength: 30
    format: uri-reference
  plane:
    type: string
    enum:
    - data
  dataschemaversion:
    type: string
    const: 1.0.0
    description: Data Schema version (fixed to 1.0.0).
    examples:
    - 1.0.0
  datacontenttype:
    type: string
    const: application/json
    description: Data Content type (fixed to application/json).
    examples:
    - application/json