Search loading...


Explore and Make use of Nationally Defined Messaging APIs


Messaging Architecture Overview

Overview of the Messaging Architecture section

Using the message pages

Within this message section of the implementation guide, the audience are presented with each business entity that form part of a National Pathology diagnostic test. The business entities are:

  • Test Request Summary - This business entity is used to capture details from the requestor and uses the ProcedureRequest FHIR resource.
  • Test Report - This business entity is used to capture details regarding all the tests performed by the performing organisation and uses the DiagnosticReport FHIR resource.
  • Specimen - This business entity is used to capture specimen (sample) details and uses the Specimen FHIR resource.
  • Test Group - This business entity is used to capture groups of test results. These can be a battery of tests or a single test, or a combination of all of these entities. It uses the Observation FHIR resource.
  • Test Result - This business entity is used to capture details for a single test result and uses the Observation.

Within each business entity message, the audience is presented with a tabular view that provides low level details on how each FHIR element is used to construct a data record to support the requirements for that business entity. The table is made up of 5 columns:


The FHIR data element name used by HL7 FHIR


The cardinality assigned to this FHIR data element. This may differ to the FHIR base value if the resource uses a CareConnect version.

Business Conformance

This indicates what the business has requested the value be set to. Consists of Mandatory, Required and Optional (MRO). This may conflict with the FHIR cardinality e.g 0..1 in FHIR MAY be Mandatory within the business.


FHIR data type used with this element. This MAY include a reference to FHIR profiles.

Description, Constraints and Mapping for Implementation

Supporting information for the data item which is made up of FHIR default description, which always remains in place and unchanged, and additional narrative added to support the business requirement. Any additional supporting information is highlighted in Red font to distinguish it from the default FHIR descriptions.

The table provides a clear guidance to allow implementers to rapidly build a structured National Pathology diagnostic test message.

Bundle Diagram

The following diagram provides a visual indication to assist implementers with understanding which resources are included within a National Pathology ITK bundle, and how these resources are related. The diagram is interactive and upon click on each resource, this will redirect the user to the specific National Pathology page which provides data item level implementation guidance.

Page-1 Click for how to map to Bundle Bundle Bundle Sheet.2 MessageHeader MessageHeader 1..1 Resource 1..1 Resource 1..1 Resource Sheet.4 Patient Patient Sheet.5 Organization Organization Sheet.6 Specimen Specimen Sheet.7 DiagnosticReport DiagnosticReport Sheet.8 Observation (Test Group) Observation (Test Group) Sheet.9 Observation (Test Result) Observation (Test Result) Sheet.10 ProcedureRequest ProcedureRequest Sheet.11 Practitioner Practitioner 1..1 Responsible 1..1 Responsible 1..1 Responsible 1..1 Focus 1..1 Focus 1..1 Focus 0..1 Organization 0..1 Organization 0..1 Organization 0..1 Performer 0..1 Performer 0..1 Performer Sheet.16 0..1 Performer 0..1 Performer 0..* Result 0..* Result 0..* Result 1..1 Patient 1..1 Patient 1..1 Patient Sheet.19 1..1 Patient 1..1 Patient Sheet.20 1..1 Patient 1..1 Patient 0..* Specimen 0..* Specimen 0..* Specimen 0..* Related 0..* Related 0..* Related Sheet.23 0..* Related 0..* Related Sheet.24 0..* Specimen 0..* Specimen 0..* basedOn 0..* basedOn 0..* basedOn 1..1 requester 1..1 requester 1..1 requester Sheet.27 0..* Specimen 0..* Specimen Sheet.28 0..1 Performer 0..1 Performer Sheet.29 0..1 Performer 0..1 Performer Sheet.30 0..1 Performer 0..1 Performer Sheet.31 0..1 Performer 0..1 Performer Sheet.32 1..1 Patient 1..1 Patient Sheet.33 1..1 Patient 1..1 Patient
Tags: fhir

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