TEMP EXTERNAL SupplierAPIPrintStatusUpdated.Bundle

2025-01-01 | 📑 396 words | ⏱ 4 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

TEMP EXTERNAL SupplierAPIPrintStatusUpdated.Bundle

No description available.

Schema Information

  • Schema ID: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.supplierapi.letter.printed.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.supplierapi.letter.printed.v1.bundle.schema.yaml

Properties

type

Type: string

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

Constant value: uk.nhs.notify.supplierapi.letter.printed.v1

source

Type: string

Event source for digital letters examples.

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

dataschema

Type: string

Canonical URI of the example event’s data schema.

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

data

Type: object

Base data for digital letters - a placeholder until all data schemas are defined

Comment: Dereferenced from: ../data/digital-letter-base-data.schema.json

Properties of data

something

Type: string

Example reusable property definition

Inheritance

This schema extends the following schemas:

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

Type

object

Raw Schema 

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.supplierapi.letter.printed.v1.bundle.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: TEMP EXTERNAL SupplierAPIPrintStatusUpdated
type: object
allOf:
- $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/supplierapi-profile.schema.json
properties:
  type:
    type: string
    const: uk.nhs.notify.supplierapi.letter.printed.v1
    description: Concrete versioned event type string for this example event (.vN
      suffix).
  source:
    type: string
    pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/supplierapi
    description: Event source for digital letters  examples.
  dataschema:
    type: string
    const: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json
    description: Canonical URI of the example event's data schema.
    examples:
    - digital-letter-base-data.schema.json
  data:
    $schema: https://json-schema.org/draft/2020-12/schema
    title: Placeholder Data
    description: Base data for digital letters - a placeholder until all data schemas
      are defined
    type: object
    additionalProperties: false
    properties:
      something:
        type: string
        description: Example reusable property definition
        examples:
        - example value
        $comment: 'Dereferenced from: ../defs/some.object.schema.json#/properties/something'
    required:
    - something
    $comment: 'Dereferenced from: ../data/digital-letter-base-data.schema.json'
$comment: Bundled (allOf preserved, property $refs dereferenced).