AU eRequesting Implementation Guide
0.1.0-ballot - Ballot Australia flag

This page is part of the AU eRequesting (v0.1.0-ballot: AU eRequesting R1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

Home

Official URL: http://hl7.org.au/fhir/ereq/ImplementationGuide/hl7.fhir.au.ereq Version: 0.1.0-ballot
IG Standards status: Draft Maturity Level: 0 Computable Name: AUeRequestingImplementationGuide

Copyright/Legal: Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.

AU eRequesting 0.1.0 Ballot for Comment August 2024

This ballot is opened during this cycle to solicit feedback and approval from the wider community. Feedback provided during the balloting process will be reconciled by the AU eRequesting Technical Design Group.

The ballot period is 12 August 2024 to 8 September 2024.

Information on how to provide feedback for balloters is available on this Confluence page: Guidance: Ballot Voting.

Introduction

AU eRequesting is provided to support the use of HL7® FHIR®© for clinical requesting and ordering in an Australian context. It sets the minimum expectations on FHIR resources to support conformance and implementation in systems.

AU eRequesting defines the Data model and RESTful API interactions that set minimum expectations for placing and accessing electronic requests for patients.

The focus AU eRequesting Release 1 (R1) is support of pathology and medical imaging requests in community-based care provision, and developing a foundational request model that can be applied beyond diagnostic requesting.

Project background

This implementation guide is under development through the AU eRequesting project as part of the Sparked AU FHIR Accelerator. The Sparked AU FHIR Accelerator is a community comprising government, technology vendors, provider organisations, peak bodies, practitioners, and domain experts, to accelerate the creation and use of national FHIR standards in health care information exchange.

The AU eRequesting project includes:

  • AU eRequesting Data for Interoperability
  • AU eRequesting FHIR Implementation Guide

The Australian eRequesting Data for Interoperability (AUeReqDI) is focused on an agreement of the minimum data required to support standardised eRequesting within the Australian health context, and forms a common language foundation that allows systems to exchange semantically accurate data for eRequests. AUeReqDI outputs form a set of data requirements to be considered and referred to as part of the development and definition of AU eRequesting.

Dependencies

Package hl7.fhir.uv.extensions.r4#5.1.0

This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00)

Package hl7.fhir.au.base#4.2.2-ballot

This implementation guide is provided to support the use of FHIR®© in an Australian context. (built Sun, Aug 4, 2024 06:52+0000+00:00)

Package hl7.fhir.uv.ipa#1.0.0

This IG describes how an application acting on behalf of a patient can access information about the patient from an clinical records system using a FHIR based API. The clinical records system may be supporting a clinical care provider (e.g. a hospital, or a general practitioner), or a health data exchange, including a national health record system. (built Sun, Mar 26, 2023 20:50+0000+00:00)

Package hl7.fhir.au.core#1.0.0-ballot

This implementation guide is provided to support the use of FHIR®© in an Australian context, and defines the minimum set of constraints on the FHIR resources to create the AU Core profiles. This implementation guide forms the foundation to build future AU Realm FHIR implementation guides and its content will continue to grow to meet the needs of AU implementers. (built Mon, Aug 5, 2024 04:25+0000+00:00)

AU eRequesting Actors

The following actors are part of AU eRequesting:

AU eRequesting Placer

A system that is responsible for initiating and creating diagnostic service requests. This system connects to enable requesters to provide the necessary information to create a request, ensuring that required data is accurately collected and provided to service providers with sufficient information for them to fulfil the request.

AU eRequesting Filler

A system that is responsible for finding and retrieving diagnostic service requests so that service providers can fulfil them. It ensures that service providers have the necessary information to fulfil the requests and manages the requests through the fulfilment process.

AU eRequesting Patient Access

A system that is the digital interface that allows patients or their representatives to view and manage requests for diagnostic services. It provides access to request information, enabling patients to choose service providers and track the status of requests.

AU eRequesting Server

A system that accepts diagnostic service requests and makes diagnostic service requests accessible.

AU eRequesting FHIR RESTful interactions

The RESTful interaction requirements for AU eRequesting actors, such as read and search operations, are outlined in the AU eRequesting CapabilityStatements.

The diagram below illustrates the interactions between the various actors:

FHIR RESTful read interactions

Figure 1: FHIR RESTful interactions

AU eRequesting typical sequence

The AU eRequesting Placer actor can create and update ServiceRequest details by calling the AU eRequesting Server actor.

The AU eRequesting Patient Access actor can search for ServiceRequest details by calling the AU eRequesting Server actor.

The AU eRequesting Filler actor can retrieve ServiceRequest details by calling the AU eRequesting Server actor.

Actors operate in a typical sequence where placers initiate a request by creating (and updating) service requests, patients may access details of their requests and fillers retrieve service request details to enable fulfillment of the requests.

This sequence is shown in the diagram below:

Actors Typical Sequence

Figure 2: Actors Typical Sequence


How to read this guide

This guide is divided into several pages which are listed at the top of each page in the menu bar.

  • Home: This page provides the introduction and scope for this guide.
  • Conformance: This page describes the set of rules to claim conformance to this guide
  • Guidance: These pages list the guidance for this guide.
  • Use Cases: This page describes the use cases in scope of eRequesting R1.
  • FHIR Artefacts: These pages provide detailed descriptions and formal definitions for all the FHIR artefacts defined in this guide.
    • Profiles and Extensions: This page describes the profiles and extensions that are defined in this guide to support electronic requesting. Each profile page includes a narrative description and guidance, formal definition and a “Notes” section which summarises the supported search transactions for each profile. Although the guidance typically focuses on the profiled elements, it may also may focus on un-profiled elements to aid with implementation.
    • Terminology: This page lists the value sets and code systems supported in this guide.
    • Capability Statements: This page defines the expected FHIR capabilities of AU eRequesting Server and AU eRequesting Placer.
    • Actor Definitions: This page defines the AU aRequesting actors, AU eRequesting Placer, AU eRequesting Filler and AU eRequesting Patient Access.
  • Examples: This page lists all the examples used in this guide.
  • Support: These pages provide supporting material for implementation of AU eRequesting.
    • Downloads: This page provides links to downloadable artefacts.
    • License and Legal: This page outlines the license and legal requirements for material in AU eRequesting.

Collaboration

This guide is the product of collaborative work undertaken with participants from:

Primary Editors: Brett Esler, Danielle Tavares-Rixon, Dusica Bojicic.