Print data

2025-01-01 | ๐Ÿ“‘ 261 words | โฑ 3 mins | ๐Ÿงพ History | โœ NHS Notify | ๐Ÿ”‘ NHS Notify

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

Print data

Reusable types for NHS Notify payload schemas.

Schema Information

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

Properties

status

Type: string

Number of times that PDM has been polled while waiting for document processing to complete

Allowed values: ACCEPTED, REJECTED, PRINTED, DISPATCHED, FAILED, RETURNED Minimum: 1 Examples: ACCEPTED, DISPATCHED, PRINTED

supplierId

Type: string

Identifier of the print supplier handling the print job

Examples: supplier-12345

Type

object

Raw Schema

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/print.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: Print data
description: Reusable types for NHS Notify payload schemas.
type: object
properties:
  status:
    type: string
    minimum: 1
    description: Number of times that PDM has been polled while waiting for document
      processing to complete
    enum:
    - ACCEPTED
    - REJECTED
    - PRINTED
    - DISPATCHED
    - FAILED
    - RETURNED
    examples:
    - ACCEPTED
    - DISPATCHED
    - PRINTED
  supplierId:
    type: string
    description: Identifier of the print supplier handling the print job
    examples:
    - supplier-12345