AU eRequesting Implementation Guide
0.2.0-ci-build - CI Build
AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org.au/fhir/ereq/ImplementationGuide/hl7.fhir.au.ereq | Version: 0.2.0-ci-build | |||
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 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.
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:
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.
AU eRequesting R1 is in currently in development. We are working towards a Ballot for Comment August 2024.
See How to Register - Participant Information for information on how to participate in the AU Core Technical Design Group and Clinical Design Group as part of Sparked, the Australian FHIR Accelerator.
Visit the HL7 Australia - AU eRequesting Technical Design Group Home
If you have a question, feature request, or proposed change, the best place to start is Zulip e.g. the Australia stream https://chat.fhir.org/#narrow/stream/179173-australia.
To identify future work or raise discussion points, you can post in the Australia stream https://chat.fhir.org/#narrow/stream/179173-australia or raise specification feedback through a Jira issue tracker.
Once the issue is logged, you should discuss with the team on chat.fhir.org in the australia > AU Request topic before attempting to make changes yourself. It's important to coordinate with the other people working on the project. When everyone has agreed on a course of action, IG changes should be submitted as a pull request for review in the AU eRequesting repository.
IG | Package | FHIR | Comment |
---|---|---|---|
AU eRequesting Implementation Guide | hl7.fhir.au.ereq#0.2.0-ci-build | R4 | |
HL7 Terminology (THO) | hl7.terminology.r4#6.0.2 | R4 | Automatically added as a dependency - all IGs depend on HL7 Terminology |
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#5.1.0 | R4 | Automatically added as a dependency - all IGs depend on the HL7 Extension Pack |
AU Base Implementation Guide | hl7.fhir.au.base#4.2.2-ci-build | R4 | |
AU Core Implementation Guide | hl7.fhir.au.core#1.0.0-ci-build | R4 | |
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.1.0 | R4 | |
HL7 Terminology (THO) | hl7.terminology.r4#5.0.0 | R4 | |
International Patient Access | hl7.fhir.uv.ipa#current | R4 | |
SMART App Launch | hl7.fhir.uv.smart-app-launch#2.0.0 | R4 |
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-ci-build This implementation guide is provided to support the use of FHIR®© in an Australian context. (built Fri, Oct 25, 2024 06:43+0000+00:00) |
Package hl7.fhir.uv.ipa#current 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 Thu, Oct 3, 2024 12:52+0000+00:00) |
Package hl7.fhir.au.core#1.0.0-ci-build 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 Sat, Oct 26, 2024 12:21+0000+00:00) |
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.
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:
Figure 1: FHIR RESTful interactions
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:
Figure 2: Actors Typical Sequence
This guide is divided into several pages which are listed at the top of each page in the menu bar.
This guide is the product of collaborative work undertaken with participants from:
Primary Editors: Brett Esler, Danielle Tavares-Rixon, Dusica Bojicic.