Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Messaging Interactions

ITK3 Outpatient Letter Interactions

ITK3 Outpatient Letter Interactions Overview

This section provides ITK3 Outpatient Letter implementers with the information required to utilise the ITK3 Outpatient Letter Interactions.

Note 1: When using MESH, additional MESH acknowledgements and responses will be available. The MESH acknowledgements and responses are not defined in this specification

Note 2: Messages are structured in eXtensible Markup Language (XML) only.

The ITK3 Outpatient Letter is based on the HL7 FHIR STU3 Messaging Implementation and supports multiple interactions.


DOC-ToC-Primary-Recipient-OutpatientLetter-1 Interaction

The sending hospital system will construct an Outpatient Letter FHIR Document and send it to the primary recipient’s receiving system.

  • Sender: Hospital sending system
  • Receiver: Outpatient Letter Recipient system
  • Message: Wire Format: TOC-OutpatientLetter-1

DOC-ToC-Copy-Recipient-OutpatientLetter-1 Interaction

The sending hospital system will construct an Outpatient Letter FHIR Document and send it to the copy recipient’s receiving system.

  • Sender: Hospital sending system
  • Receiver: Outpatient Letter Recipient system
  • Message: Wire Format: TOC-OutpatientLetter-1

Acknowledgements Interactions

Dependent on system set up the following interactions may be utilised.

Outpatient Letter ITK3 FHIR Document Interactions Diagram

The diagram shows the Outpatient Letter Document Interactions: Note: The use of the ITK3 infrastructure interactions are dependent on system configuration.

Tags: fhir

All content is available under the Open Government Licence v3.0, except where otherwise stated