Request 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

Request data

Reusable types for NHS Notify payload schemas.

Schema Information

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

Properties

`messageReference`

Type: string

Globally unique reference for each message, provided by the sender

Examples: 19cd1d01-98c3-4ab8-a7b8-c1adabda7641

`senderId`

Type: string

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

Examples: Trust-12345

`messageUri`

Type: string

Uri to the storage location of the FHIR resource relating to this message request

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

`nhsNumber`

Type: string

Unique identifier of the intended recipient of the digital letter

Pattern: ^\d{10}$ Minimum length: 10 Maximum length: 10 Examples: 4857773456

`odsCode`

Type: string

The ODS Code of the sending organisation. Used to identify the sender in NHS App

Examples: ``

Type

object

Raw Schema

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/requests.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: Request data
description: Reusable types for NHS Notify payload schemas.
type: object
properties:
  messageReference:
    type: string
    description: Globally unique reference for each message, provided by the sender
    examples:
    - 19cd1d01-98c3-4ab8-a7b8-c1adabda7641
  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
  messageUri:
    type: string
    format: uri
    description: Uri to the storage location of the FHIR resource relating to this
      message request
    examples:
    - s3://my-bucket/path/to/my-object
  nhsNumber:
    type: string
    description: Unique identifier of the intended recipient of the digital letter
    pattern: ^\d{10}$
    minLength: 10
    maxLength: 10
    examples:
    - '4857773456'
  odsCode:
    type: string
    description: The ODS Code of the sending organisation. Used to identify the sender
      in NHS App
    examples:
    - ''