AU eRequesting Implementation Guide
0.3.0-ci-build - CI Build Australia flag

AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.3.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/mjosborne1/mjo-au-fhir-erequesting/ and changes regularly. See the Directory of published versions

Artefacts Summary

Page standards status: Informative

This page provides a list of the FHIR artifacts defined as part of this implementation guide.

Requirements: Actor Definitions

The following artifacts define the types of individuals and/or systems that will interact as part of the use cases covered by this implementation guide.

AU eRequesting Filler

The AU eRequesting Filler is a system that is responsible for finding and retrieving diagnostic request fulfilments so that service providers can fulfil them.

AU eRequesting Patient

A system that allows patients or their representatives to view diagnostic requests and fulfilment of diagnostic requests.

AU eRequesting Placer

The AU eRequesting Placer is a system that is responsible for creating diagnostic requests.

AU eRequesting Server

The eRequesting Server is a system that accepts diagnostic service requests and makes diagnostic service requests accessible.

Behavior: Capability Statements

The following artifacts define the specific capabilities that different types of systems are expected to have in order to comply with this implementation guide. Systems conforming to this implementation guide are expected to declare conformance to one or more of the following capability statements.

AU eRequesting Filler CapabilityStatement

This CapabilityStatement describes the basic rules for the AU eRequesting Filler actor that is responsible for finding and retrieving diagnostic request fulfilments so that service providers can fulfil them. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU eRequesting fillers are defined in this CapabilityStatement.

AU eRequesting Patient CapabilityStatement

This CapabilityStatement describes the basic rules for the AU eRequesting Patient actor that is the digital interface that allows patients or their representatives to view diagnostic requests and fulfilment of diagnostic requests. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU eRequesting Patient actor are defined in this CapabilityStatement.

AU eRequesting Placer CapabilityStatement

This CapabilityStatement describes the basic rules for the AU eRequesting Placer actor that is responsible for creating diagnostic requests. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU eRequesting placers are defined in this CapabilityStatement.

AU eRequesting Server CapabilityStatement

This CapabilityStatement describes the basic rules for the AU eRequesting Server actor that is is a system that accepts diagnostic service requests and makes diagnostic service requests accessible. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU eRequesting servers are defined in this CapabilityStatement.

Structures: Abstract Profiles

These are profiles on resources or data types that describe patterns used by other profiles, but cannot be instantiated directly. I.e. instances can conform to profiles based on these abstract profiles, but do not declare conformance to the abstract profiles themselves.

AU eRequesting CommunicationRequest

This profile sets the minimum expectations for derived CommunicationRequest resources that are used to record, search, and fetch information about a communication request to be performed.
It is based on the CommunicationRequest and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the CommunicationRequest when conforming to this profile.

AU eRequesting Diagnostic Request

This profile sets minimum expectations for a ServiceRequest resource that is used to record, search, and fetch information about diagnostic requests for a patient. It is based on the AU Base ServiceRequest and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile.

AU eRequesting Task

This profile sets minimum expectations for a Task resource that is used to record, search, and fetch information about a task to be performed. It is based on the Task and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the Task when conforming to this profile.

Structures: Resource Profiles

These define constraints on FHIR resources for systems conforming to this implementation guide.

AU eRequesting CommunicationRequest CopyTo

This profile sets the minimum expectations for a CommunicationRequest resource used to represent a request for a report to be copied to a clinician or patient as an additional recipient. A copy-to clinician is distinct from a request for urgent communication to a provider, as the priority may not be urgent.
It is based on the AU eRequesting CommunicationRequest and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the CommunicationRequest when conforming to this profile.

AU eRequesting CommunicationRequest Patient

This profile sets the minimum expectations for a CommunicationRequest resource used to represent a request for direct communication from a diagnostic provider (Filler) to a patient. It supports use cases where the diagnostic provider may communicate with the patient, for example, to suggest booking an appointment or to provide instructions for a diagnostic test. It also supports requests for communication not to be performed, for example, when a patient has requested that they not be contacted by SMS. Supported communication mediums include SMS and email.
It is based on the AU eRequesting CommunicationRequest and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the CommunicationRequest when conforming to this profile.

AU eRequesting CommunicationRequest Urgent Provider

This profile sets the minimum expectations for a CommunicationRequest resource used to represent a request for direct communication from a diagnostic provider (Filler) to a clinical provider for the purpose of providing urgent results. This communication is not a substitute for the formal diagnostic report, but is intended to provide timely notification of a result, usually by phone.
It is based on the AU eRequesting CommunicationRequest and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the CommunicationRequest when conforming to this profile.

AU eRequesting Coverage

This profile sets minimum expectations for a Coverage resource that is used to record, search, and fetch information about insurance or medical plan or a payment agreement for a patient. It is based on the AU Base Coverage and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the Coverage when conforming to this profile.

AU eRequesting Imaging Request

This profile sets minimum expectations for a ServiceRequest resource that is used to record, search, and fetch information about diagnostic imaging requests for a patient. It is based on the AU eRequesting Diagnostic Request and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile.

AU eRequesting MHR Consent Withdrawal

This profile sets minimum expectations for a Consent resource to record, search, and fetch a My Health Record (MHR) consent withdrawal. It is based on the Consent and identifies the additional mandatory core elements, extensions, vocabularies and value sets that SHALL be present in the Consent when conforming to this profile.

AU eRequesting Pathology Request

This profile sets minimum expectations for a ServiceRequest resource that is used to record, search, and fetch information about pathology requests for a patient. It is based on the AU eRequesting Diagnostic Request and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present in the ServiceRequest when conforming to this profile.

AU eRequesting Task Communication Request

This profile sets minimum expectations for a Task resource that is used to track the fulfilment of a communication request. For example, whether fulfilment of the communication request was attempted, successful, or failed. It is based on the AU eRequesting Task and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present when conforming to this profile.

AU eRequesting Task Diagnostic Request

This profile sets minimum expectations for a Task resource that is used to record, search, and fetch information about a diagnostic request task to be fulfilled. It is based on the AU eRequesting Task and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present when conforming to this profile.

AU eRequesting Task Group

This profile sets minimum expectations for a Task resource that is used to record, search, and fetch information about a group of tasks that are part of the same fulfilment group. It is based on the AU eRequesting Task and identifies the additional constraints, extensions, vocabularies and value sets that SHALL be present when conforming to this profile.

Structures: Extension Definitions

These define constraints on FHIR data types for systems conforming to this implementation guide.

AU eRequesting Display Sequence

This extension applies to the AU eRequesting Diagnostic Request profile and any derived ServiceRequest profiles. The display sequence is an integer assigned to an individual test or service in a ServiceRequest that matches the sequence as seen on a paper request form. The ability to sort on sequenceNumber more easily allows for reconciliation of paper and digital requesting data by the filler, especially for collection centre staff within a pathology collection centre.

AU eRequesting Fasting Precondition

This extension applies to the AU eRequesting Diagnostic Request profile and any derived ServiceRequest profiles. The fasting precondition is a code that indicates the recommendation related to the fasting status of the patient as a precondition to the diagnostic procedure or test being requested.

Terminology: Value Sets

These define sets of codes used by systems conforming to this implementation guide.

AU eRequesting CommunicationRequest Patient Category

Category values for patient communication used in the Australian eRequesting context.

AU eRequesting CommunicationRequest Patient Medium

Medium values for patient communication used in the Australian eRequesting context.

AU eRequesting CommunicationRequest Reason

Reason codes for a communication request used in the Australian eRequesting context.

AU eRequesting Coverage Type and Self-Pay Codes

Coverage type and self-pay codes typically used in the Australian eRequesting context.

AU eRequesting Fulfilment Task Tags

Task tag values for labelling and differentiating fulfilment of tasks used in an Australian eRequesting context.

AU eRequesting RequestStatus

ServiceRequest status values used in the Australian eRequesting context.

AU eRequesting Task Business Status

Task business status values used in the Australian eRequesting context.

AU eRequesting Task Status

Task status values used in the Australian eRequesting context.

RANZCR Radiology Referral

Standard codes for use in requesting radiology tests in Australia, derived from the RANZCR Radiology Referral Set (RRS).

Terminology: Code Systems

These define new code systems used by systems conforming to this implementation guide.

CommunicationRequest Reason

Reason codes for a communication request used in the Australian context.

Task Business Status

Business status codes for a Task used in the Australian context.

Task Tag

The Task Tag code system provides concepts that represent tag values for labelling tasks in an Australian context.

Example: Example Instances

These are example instances that show what data produced and consumed by systems conforming with this implementation guide might look like.

CommunicationRequest - Copy To GP

Shows an example CommunicationRequest for the AU eRequesting Communication Request CopyTo profile, requesting a GP as a report copy-to recipient. Patient: Remedios Belger.

Consent - My Health Record Consent Withdrawal

Shows an example of consent to upload X-ray results to the My Health Record withdrawn by patient for the AU eRequesting MHR Consent Withdrawal profile. Patient: Fred Roberts.

Coverage - Concession

Shows an example of coverage for the AU eRequesting Coverage profile, demonstrating a self funded beneficiary type with a concession. Beneficiary: Fred Roberts.

Coverage - DVA

Shows an example of coverage for the AU eRequesting Coverage profile, demonstrating the Department of Veterans’ Affairs coverage type. Beneficiary: Ronny Lawrence Irvine.

Encounter - Consultation

Shows an example of an encounter for the AU Core Encounter profile, representing a general practice consultation. Patient: Fred Roberts.

Encounter - OBGYN Outpatient Clinic

Shows an example for the AU Core Encounter profile, representing a hospital outpatient obstetrics clinic visit. Patient: Remedios Belger.

Location - Barney View Private Hospital

Shows an example of a location, Barney View Private Hospital, for the AU Core Location profile.

Observation - Pregnancy Status

Shows an example of the Pregnancy - Status (IPS) profile, with a result of Pregnant. Patient: Remedios Belger.

Organization - Barney View Private Hospital

Shows an example of an organisation, Barney View Private Hospital, for the AU Core Organization profile, with HPI-O and ABN, type as hospital, contact information and physical address.

Organization - Elimbah Medical Center

Shows an example of an organisation, Elimbah Medical Center, for the AU Core Organization profile, with HPI-O and contact details.

Organization - Kioma Pathology Laboratory

Shows an example of an organisation, Kioma Pathology Laboratory, for the AU Core Organization profile, with HPI-O, type as a pathology laboratory, contact information and physical address.

Organization - Mount Charlton Radiology

Shows an example of an organisation, Mount Charlton Radiology, for the AU Core Organization profile, with HPI-O, type as a radiology practice, contact information and physical address.

Patient - Fred Roberts

Shows an example of a patient, Fred Roberts, for the AU Core Patient profile, with an IHI, contact details, gender, birth date, address, and Indigenous status.

Patient - Remedios Belger

Shows an example of a patient, Remedios Belger, for the AU Core Patient profile with IHI, medicare number, contact details, gender, birth date, address, and Indigenous status.

Patient - Ronny Lawrence Irvine

Shows an example of a patient, Ronny Lawrence Irvine, for the AU Core Patient profile, with an IHI, Medicare and DVA identifiers.

Practitioner - Aimee Herbert

Shows an example of a practitioner, Aimee Herbert, for the AU Core Practitioner profile, including HPI-I and name information.

Practitioner - Dr. Jarred Guthridge

Shows an example of a practitioner, Jarred Guthridge, for the AU Core Practitioner profile, including HPI-I and name information.

Practitioner - Kimberlee McLaughlin

Shows an example of a practitioner, Kimberlee McLaughlin, for the AU Core Practitioner profile, including HPI-I and name information.

Practitioner - Sallie Losch

Shows an example of a practitioner, Sallie Losch, for the AU Core Practitioner profile, including HPI-I, name and APHRA information.

PractitionerRole - General practitioner

Shows an example of a General Practitioner role for the AU Core PractitionerRole profile, using a Medicare Provider Number as the role identifier, and references to the associated Practitioner and Organization.

PractitionerRole - Obstetrician and gynaecologist

Shows an example of an obstetrician and gynaecologist, Sallie Losch, for the AU Core PractitionerRole profile, including Medicare Provider Number, associated organisation, role, and contact details.

PractitionerRole - Pathologist

Shows an example of a Pathologist role for the AU Core PractitionerRole profile, including Medicare Provider Number, role, telecom and references to the associated Practitioner and Organization.

PractitionerRole - Radiologist

Shows an example of a Radiologist role for the AU Core PractitionerRole profile, including Medicare Provider Number, role, telecom and references to the associated Practitioner and Organization.

ServiceRequest - Blood Group and Antibodies panel

Shows an example of a request for a blood group and antibodies panel for the AU eRequesting Pathology Request profile. Patient: Remedios Belger.

ServiceRequest - Fasting Blood Glucose

Shows an example of a request for a Fasting Blood Glucose test for the AU eRequesting Pathology Request profile. Patient: Remedios Belger.

ServiceRequest - Full Blood Count

Shows an example of a request for a Full Blood Count (FBC) for the AU eRequesting Pathology Request profile. Patient: Fred Roberts.

ServiceRequest - Iron studies

Shows an example of a request for an Iron Studies group or panel of blood tests for the AU eRequesting Pathology Request profile. The request contains a context-specific sex parameter for clinical use and a status reason. Patient: Remedios Belger.

ServiceRequest - Obstetric Ultrasound (Second Trimester)

Shows an example of a request for an obstetric ultrasound in the second trimester for the AU eRequesting Imaging Request profile. Patient: Remedios Belger.

ServiceRequest - Urine Microscopy, Culture and Sensitivity

Shows an example of a request for a Urine Microscopy, Culture and Sensitivity test for the AU eRequesting Pathology Request profile. The request contains the precondition of nonfasting and pregnancy status supporting information. Patient: Remedios Belger.

ServiceRequest - X-ray

Shows an example of a request for a chest X-ray for the AU eRequesting Imaging Request profile. Patient: Fred Roberts.

Task - Imaging Fulfillment Task

Shows an example of a task for fulfilment of an Imaging Request for the AU eRequesting Task Diagnostic Request profile. Patient: Fred Roberts.

Task - Imaging Task Group

Shows an example of a group of tasks that are part of the same fulfilment group for an Imaging Request for the AU eRequesting Task Group profile. Patient: Fred Roberts.

Task - Pathology Fulfillment Task

Shows an example of a task for fulfilment of a Pathology Request for the AU eRequesting Task Diagnostic Request profile. Patient: Fred Roberts.

Task - Pathology Task Group

Shows an example of a group of tasks that are part of the same fulfilment group for a Pathology Request for the AU eRequesting Task Group profile. Patient: Fred Roberts.