PDFAnalysed.Bundle

2025-01-01 | 📑 754 words | ⏱ 8 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

PDFAnalysed.Bundle

No description available.

Schema Information

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

Properties

type

Type: string

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

Constant value: uk.nhs.notify.digital.letters.print.pdf.analysed.v1

source

Type: string

Event source for digital letters.

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

dataschema

Type: string

Canonical URI of the event’s data schema.

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

data

Type: object

Data payload of the PDFAnalysed event

Comment: Dereferenced from: ../data/digital-letters-print-pdf-analysed-data.schema.json

Properties of data

messageReference

Type: string

Globally unique reference for each message, provided by the sender

senderId

Type: string

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

letterUri

Type: string

Uri to the S3 storage location of the PDF letter relating to this message request

Format: uri

pageCount

Type: integer

The number of pages in the analysed letter PDF.

sha256Hash

Type: string

The SHA256 hash of the analysed letter PDF.

Pattern: ^[A-Fa-f0-9]{64}$

createdAt

Type: string

Timestamp when the letter was created (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))$

Inheritance

This schema extends the following schemas:

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

Type

object

Raw Schema 

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.print.pdf.analysed.v1.bundle.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: PDFAnalysed
type: object
allOf:
- $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/digital-letters-print-profile.schema.json
properties:
  type:
    type: string
    const: uk.nhs.notify.digital.letters.print.pdf.analysed.v1
    description: Concrete versioned event type string for this event (.vN suffix).
  source:
    type: string
    pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/print
    description: Event source for digital letters.
  dataschema:
    type: string
    const: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-print-pdf-analysed-data.schema.json
    description: Canonical URI of the event's data schema.
    examples:
    - digital-letters-pdf-analysed-data.schema.json
  data:
    $schema: https://json-schema.org/draft/2020-12/schema
    title: PDFAnalysed Data
    description: Data payload of the PDFAnalysed event
    type: object
    additionalProperties: false
    properties:
      messageReference:
        type: string
        description: Globally unique reference for each message, provided by the sender
        examples:
        - 19cd1d01-98c3-4ab8-a7b8-c1adabda7641
        $comment: 'Dereferenced from: ../defs/requests.schema.json#/properties/messageReference'
      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
        $comment: 'Dereferenced from: ../defs/requests.schema.json#/properties/senderId'
      letterUri:
        type: string
        format: uri
        description: Uri to the S3 storage location of the PDF letter relating to
          this message request
        examples:
        - s3://my-bucket/path/to/my-object
        $comment: 'Dereferenced from: ../defs/print.schema.json#/properties/letterUri'
      pageCount:
        type: integer
        description: The number of pages in the analysed letter PDF.
        examples:
        - 1
        - 3
        $comment: 'Dereferenced from: ../defs/print.schema.json#/properties/pageCount'
      sha256Hash:
        type: string
        description: The SHA256 hash of the analysed letter PDF.
        pattern: ^[A-Fa-f0-9]{64}$
        examples:
        - 3a7bd3e2360a3d80c4d4e8b1e3e5e6e7e8e9e0e1e2e3e4e5e6e7e8e9e0e1e2e3 abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890
        $comment: 'Dereferenced from: ../defs/print.schema.json#/properties/sha256Hash'
      createdAt:
        title: Created At DateTime
        description: Timestamp when the letter was created (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))$
        $comment: 'Dereferenced from: ../defs/print.schema.json#/properties/createdAt'
    required:
    - messageReference
    - senderId
    - letterUri
    - pageCount
    - sha256Hash
    - createdAt
    $comment: 'Dereferenced from: ../data/digital-letters-print-pdf-analysed-data.schema.json'
$comment: Bundled (allOf preserved, property $refs dereferenced).