MESHInboxMessageAcknowledged.Bundle

2025-01-01 | 📑 770 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

MESHInboxMessageAcknowledged.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.mesh.inbox.message.acknowledged.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.mesh.inbox.message.acknowledged.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.mesh.inbox.message.acknowledged.v1

source

Type: string

Event source for digital letters.

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

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-mesh-inbox-message-acknowledged-data.schema.json Examples: digital-letters-mesh-inbox-message-acknowledged-data.schema.json

data

Type: object

Data payload of the MESHInboxMessageAcknowledged event

Comment: Dereferenced from: ../data/digital-letters-mesh-inbox-message-acknowledged-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.

meshMailboxId

Type: string

Id of the mailbox used to submit letter requests and receive acknowledgements

receivedMeshMessageId

Type: string

Id of the message in the MESH inbox

sentMeshMessageId

Type: string

Id of the message in the MESH inbox

statusCode

Type: integer

HTTP status code indicating the result of the acknowledgement (202 for success, 400 for failure)

Allowed values: 202, 400

failureCode

Type: string

Failure code indicating the reason for a negative acknowledgement

Inheritance

This schema extends the following schemas:

  • https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/digital-letters-mesh-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.mesh.inbox.message.acknowledged.v1.bundle.schema.json
$schema: https://json-schema.org/draft/2020-12/schema
title: MESHInboxMessageAcknowledged
type: object
allOf:
- $ref: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/digital-letters-mesh-profile.schema.json
properties:
  type:
    type: string
    const: uk.nhs.notify.digital.letters.mesh.inbox.message.acknowledged.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]+)/digitalletters/mesh
    description: Event source for digital letters.
  dataschema:
    type: string
    const: https://notify.nhs.uk/cloudevents/schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-acknowledged-data.schema.json
    description: Canonical URI of the event's data schema.
    examples:
    - digital-letters-mesh-inbox-message-acknowledged-data.schema.json
  data:
    $schema: https://json-schema.org/draft/2020-12/schema
    title: MESHInboxMessageAcknowledged Data
    description: Data payload of the MESHInboxMessageAcknowledged 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'
      meshMailboxId:
        type: string
        minLength: 1
        description: Id of the mailbox used to submit letter requests and receive
          acknowledgements
        examples:
        - MAILBOX01
        $comment: 'Dereferenced from: ../defs/mesh.schema.json#/properties/meshMailboxId'
      receivedMeshMessageId:
        type: string
        minLength: 1
        description: Id of the message in the MESH inbox
        examples:
        - 20200601122152994285_D59900
        $comment: 'Dereferenced from: ../defs/mesh.schema.json#/properties/meshMessageId'
      sentMeshMessageId:
        type: string
        minLength: 1
        description: Id of the message in the MESH inbox
        examples:
        - 20200601122152994285_D59900
        $comment: 'Dereferenced from: ../defs/mesh.schema.json#/properties/meshMessageId'
      statusCode:
        type: integer
        description: HTTP status code indicating the result of the acknowledgement
          (202 for success, 400 for failure)
        enum:
        - 202
        - 400
      failureCode:
        type: string
        description: Failure code indicating the reason for a negative acknowledgement
    required:
    - senderId
    - meshMailboxId
    - receivedMeshMessageId
    - sentMeshMessageId
    - statusCode
    $comment: 'Dereferenced from: ../data/digital-letters-mesh-inbox-message-acknowledged-data.schema.json'
$comment: Bundled (allOf preserved, property $refs dereferenced).