PDM data

2025-01-01 | ๐Ÿ“‘ 209 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

PDM data

Reusable types for NHS Notify payload schemas.

Schema Information

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

Properties

resourceId

Type: string

Identifier returned by PDM to the uploaded FHIR resource

Format: uuid Examples: f5524783-e5d7-473e-b2a0-29582ff231da

retryCount

Type: integer

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

Minimum: 1 Examples: 2

Type

object

Raw Schema

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/defs/pdm.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: PDM data
description: Reusable types for NHS Notify payload schemas.
type: object
properties:
  resourceId:
    type: string
    format: uuid
    description: Identifier returned by PDM to the uploaded FHIR resource
    examples:
    - f5524783-e5d7-473e-b2a0-29582ff231da
  retryCount:
    type: integer
    minimum: 1
    description: Number of times that PDM has been polled while waiting for document
      processing to complete
    examples:
    - 2