NHS Notify – FHIR Letter Printing Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• XML
• JSON
• TTL

: Submit Letter - JSON Representation

Active as of 2025-09-30

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "SubmitLetterOperation",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition SubmitLetterOperation</b></p><a name=\"SubmitLetterOperation\"> </a><a name=\"hcSubmitLetterOperation\"> </a><p>URL: [base]/$submit-letter</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>bundle</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/bundle.html\">Bundle</a></td><td/><td><div><p>transaction/collection Bundle with CommunicationRequest + DocumentReference + Binary (+ context).</p>\n</div></td></tr><tr><td>OUT</td><td>return</td><td/><td>1..1</td><td><a href=\"http://hl7.org/fhir/R4/operationoutcome.html\">OperationOutcome</a></td><td/><td/></tr></table></div>"
  },
  "url" : "https://nhsdigital.github.io/nhs-notify-standards/fhir/OperationDefinition/submit-letter",
  "version" : "0.1.0",
  "name" : "SubmitLetter",
  "title" : "Submit Letter",
  "status" : "active",
  "kind" : "operation",
  "date" : "2025-09-30T11:01:53+00:00",
  "publisher" : "NHS England",
  "contact" : [
    {
      "name" : "NHS England",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.england.nhs.uk"
        }
      ]
    },
    {
      "name" : "NHS England – NHS Notify",
      "telecom" : [
        {
          "system" : "email",
          "value" : "notify@nhs.net"
        }
      ]
    }
  ],
  "description" : "Submit a bundle carrying the letter and context.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "GB",
          "display" : "United Kingdom"
        }
      ]
    }
  ],
  "code" : "submit-letter",
  "system" : true,
  "type" : false,
  "instance" : false,
  "parameter" : [
    {
      "name" : "bundle",
      "use" : "in",
      "min" : 1,
      "max" : "1",
      "documentation" : "transaction/collection Bundle with CommunicationRequest + DocumentReference + Binary (+ context).",
      "type" : "Bundle"
    },
    {
      "name" : "return",
      "use" : "out",
      "min" : 1,
      "max" : "1",
      "type" : "OperationOutcome"
    }
  ]
}