Core data

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

Full Screen

Core data

Reusable types for NHS Notify payload schemas.

Schema Information

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

Properties

`notifyId`

Type: string

KSUID assigned by Notify to uniquely identify the message request

Pattern: ^[0-9a-zA-Z]{27}$ Minimum length: 27 Maximum length: 27 Examples: 35bVTLgU9sVCukH6Cgri39g5xPF

`failureCode`

Type: string

A code representing the reason for failure

Examples: CFR_SUPE_0001

`failureReason`

Type: string

A human readable desription of the reason for failure

Examples: Failed reason: Not registered with NHS App

`supplierStatus`

Type: string

Status returned by the supplier for this channel

Examples: paper_letter_opted_out

`time`

Type: string

Timestamp when the event occurred (RFC 3339).

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ Examples: 2025-10-01T10:15:30.000Z

Type

object

Raw Schema

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/core.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: Core data
description: Reusable types for NHS Notify payload schemas.
type: object
properties:
  notifyId:
    type: string
    description: KSUID assigned by Notify to uniquely identify the message request
    minLength: 27
    maxLength: 27
    pattern: ^[0-9a-zA-Z]{27}$
    examples:
    - 35bVTLgU9sVCukH6Cgri39g5xPF
  failureCode:
    type: string
    description: A code representing the reason for failure
    examples:
    - CFR_SUPE_0001
  failureReason:
    type: string
    description: A human readable desription of the reason for failure
    examples:
    - 'Failed reason: Not registered with NHS App'
  supplierStatus:
    type: string
    description: Status returned by the supplier for this channel
    examples:
    - paper_letter_opted_out
  time:
    title: Event Time
    description: Timestamp when the event occurred (RFC 3339).
    examples:
    - '2025-10-01T10:15:30.000Z'
    type: string
    pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$