FHIR Profile

FHIR profile for digital letters

Known Issues / Todo

⛅ This page is draft and is subject to rapid change, and may not be fully accurate or complete

Full Screen

FHIR Profile

FHIR profile for digital letters

Schema Information

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

Properties

`type`

Type: string

No description available.

Minimum length: 1

`source`

Type: string

No description available.

Inheritance

This schema extends the following schemas:

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

Type

object

Raw Schema

$id: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/digital-letters-fhir-profile.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: FHIR Profile
description: FHIR profile for digital letters
type: object
allOf:
- $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/digital-letters-profile.schema.json
properties:
  type:
    type: string
    minLength: 1
    allOf:
    - name: NHS Notify versioned event type pattern
      type: string
      pattern: ^uk\.nhs\.notify\.digital\.letters\.fhir\.[a-z0-9]+(?:\.[a-z0-9]+)*\.v[0-9]+$
  source:
    type: string
    pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/(data-plane|control-plane)/digitalletters/fhir
    minLength: 40
    format: uri-reference