AU eRequesting Implementation Guide
1.0.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 1.0.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

CapabilityStatement: AU eRequesting Server CapabilityStatement

Official URL: http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-server Version: 1.0.0-ci-build
Standards status: Draft Maturity Level: 1 Computable Name: AUeRequestingServerCapabilityStatement

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

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 the AU eRequesting Server actor are defined in this CapabilityStatement.

Summary of Must Support and References Between Profiles

The table below identifies where a Profile has a Must Support reference to other profiles or resources (i.e., Target Profiles). This list is provided to clarify where additional profiles or resources may need to be supported if the AU eRequesting Server actor supports a particular resource.

Resource Type Profile Supported Target Reference
CommunicationRequest AU eRequesting CommunicationRequest CopyTo, AU eRequesting CommunicationRequest Patient, AU eRequesting CommunicationRequest Urgent Provider AU eRequesting Imaging Request, AU eRequesting Pathology Request, AU eRequesting Organization, AU eRequesting Patient, AU eRequesting PractitionerRole, AU eRequesting Task Group
Condition AU Core Condition AU Core Patient
Consent AU eRequesting MHR Consent Withdrawal AU eRequesting Imaging Request, AU eRequesting Pathology Request, AU eRequesting Organization, AU eRequesting Patient
Coverage AU eRequesting Coverage -
DocumentReference AU eRequesting Clinical Context DocumentReference AU eRequesting Patient
Encounter AU eRequesting Encounter AU Core Condition, AU Core Location, AU Core Procedure, AU Core RelatedPerson, AU eRequesting Organization, AU eRequesting Patient, AU eRequesting Practitioner, AU eRequesting PractitionerRole, Observation
Location AU Core Location AU Core Organization
Observation Observation Pregnancy - Status (IPS) Observation Pregnancy - Expected Delivery Date (IPS), Patient (IPS)
Organization AU eRequesting Organization -
Patient AU eRequesting Patient -
Practitioner AU eRequesting Practitioner -
PractitionerRole AU eRequesting PractitionerRole AU eRequesting Organization, AU eRequesting Practitioner
Procedure AU Core Procedure AU Core Condition, AU Core Encounter, AU Core Patient, AU Core Procedure, DocumentReference, Observation
RelatedPerson AU Core RelatedPerson AU Core Patient
ServiceRequest AU eRequesting Imaging Request, AU eRequesting Pathology Request AU eRequesting Clinical Context DocumentReference, AU eRequesting Coverage, AU eRequesting Encounter, AU eRequesting Patient, AU eRequesting PractitionerRole, Observation Pregnancy - Status (IPS)
Task AU eRequesting Task Communication Request, AU eRequesting Task Diagnostic Request, AU eRequesting Task Group AU eRequesting CommunicationRequest CopyTo, AU eRequesting CommunicationRequest Patient, AU eRequesting CommunicationRequest Urgent Provider, AU eRequesting Imaging Request, AU eRequesting Organization, AU eRequesting Pathology Request, AU eRequesting Patient, AU eRequesting PractitionerRole, AU eRequesting Task Group

Raw OpenAPI-Swagger Definition file | Download

AU eRequesting Server CapabilityStatement

  • Implementation Guide Version: 1.0.0-ci-build
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHOULD support xml
  • Supported Patch Formats: MAY support application/json-patch+json
  • Published on: 2025-12-19 05:08:24+0000
  • Published by: HL7 Australia

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

The AU eRequesting Server actor SHALL:

  1. Support all resource profiles required for the exchange of diagnostic requests, as defined in this CapabilityStatement.
  2. Implement the RESTful behavior according to the FHIR specification.
Security

None defined.

Summary of System-wide Interactions
  • SHOULD support the transactioninteraction.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
CommunicationRequestSupported Profiles
  AU eRequesting CommunicationRequest CopyTo
  AU eRequesting CommunicationRequest Patient
  AU eRequesting CommunicationRequest Urgent Provider		YYYY_id
ConditionSupported Profiles
  AU Core Condition		YYYY_id
ConsentSupported Profiles
  AU eRequesting MHR Consent Withdrawal		YYYY_id
CoverageSupported Profiles
  AU eRequesting Coverage		YYYY_id
DocumentReferenceSupported Profiles
  AU eRequesting Clinical Context DocumentReference		YYYY_id
EncounterSupported Profiles
  AU eRequesting Encounter		YYYY_id
LocationSupported Profiles
  AU Core Location		YYYY_id
ObservationSupported Profiles
  Observation Pregnancy - Status (IPS)
  Observation Pregnancy - Expected Delivery Date (IPS)		YYYY_id
OrganizationSupported Profiles
  AU eRequesting Organization		YYYY_id, identifier
PatientSupported Profiles
  AU eRequesting Patient
  Patient (IPS)		YYYY_id, identifier
PractitionerSupported Profiles
  AU eRequesting Practitioner		YYYY_id, identifier
PractitionerRoleSupported Profiles
  AU eRequesting PractitionerRole		YYYY_id, identifierPractitionerRole:practitioner, PractitionerRole:organization
ProcedureSupported Profiles
  AU Core Procedure		YYYY_id
RelatedPersonSupported Profiles
  AU Core RelatedPerson		YYYY_id
ServiceRequestSupported Profiles
  AU eRequesting Pathology Request
  AU eRequesting Imaging Request		YYYY_id, requisition, supporting-infoServiceRequest:patient, ServiceRequest:requester, ServiceRequest:encounter, ServiceRequest:supporting-info
TaskSupported Profiles
  AU eRequesting Task Group
  AU eRequesting Task Diagnostic Request
  AU eRequesting Task Communication Request		YYYY_id, _lastUpdated, _tag, focus, group-identifier, owner, part-of, patient, requester, status, _lastUpdated+status+owner, owner+status, patient+status, requester+statusTask:focus, Task:owner, Task:patient, Task:requesterTask:part-of
Core FHIR Resource
CommunicationRequest
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting CommunicationRequest CopyTo
AU eRequesting CommunicationRequest Patient
AU eRequesting CommunicationRequest Urgent Provider

Documentation

The AU eRequesting Server actor SHALL support the CommunicationRequest resource, the AU eRequesting profiles, and the conformance expectations for the CommunicationRequest resource.

Where a CommunicationRequest profile is defined for a specific purpose that profile SHALL be used:

  • Communication requests about providing a copy of the report to a patient or clinician SHALL use the AU eRequesting CommunicationRequest CopyTo profile
  • Communication requests about communication with a patient from a filler SHALL use the AU eRequesting CommunicationRequest Patient profile
  • Communication requests about communication from a filler to a clinical provider to notify them of urgent results SHALL use the AU eRequesting CommunicationRequest Urgent Provider profile
Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
Condition
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Condition

Documentation

The AU eRequesting Server actor MAY support the Condition resource, the AU Core profile, and the conformance expectations for the Condition resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
Consent
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting MHR Consent Withdrawal

Documentation

The AU eRequesting Server actor SHALL support the Consent resource, the AU eRequesting MHR Consent Withdrawal profile, and the conformance expectations for the Consent resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
Coverage
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Coverage

Documentation

The AU eRequesting Server actor SHALL support the Coverage resource, the AU eRequesting profile, and the conformance expectations for the Coverage resource.

When using one of the below Coverage types, at least one of the corresponding identifiers SHOULD be populated:

Coverage Type Code Identifier
Medicare PUBLICPOL AU Medicare Card Number
Department of Veterans Affairs (DVA) VET AU DVA Number
Concession payconc AU Pensioner Concession Card Number, AU Commonwealth Seniors Health Card Number , AU Health Care Card Number
Private health insurance HIP AU Insurance Member Number
Private (self funded) pay N/A
Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Clinical Context DocumentReference

Documentation

The AU eRequesting Server actor SHALL support the DocumentReference resource, the AU eRequesting profile, and the conformance expectations for the DocumentReference resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Encounter

Documentation

The AU eRequesting Server actor SHALL support the Encounter resource, the AU eRequesting profile, and the conformance expectations for the Encounter resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
Location
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Location

Documentation

The AU eRequesting Server actor MAY support the Location resource, the AU Core profile, and the conformance expectations for the Location resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

Observation Pregnancy - Status (IPS)
Observation Pregnancy - Expected Delivery Date (IPS)

Documentation

The AU eRequesting Server actor SHALL support the Observation resource, the Observation Pregnancy - Status (IPS) and the Observation Pregnancy - Expected Delivery Date (IPS) profiles, and the conformance expectations for the Observation resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Organization

Documentation

The AU eRequesting Server actor SHALL support the Organization resource, the AU eRequesting profile, and the conformance expectations for the Organization resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLidentifiertoken
 
Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Patient
Patient (IPS)

Documentation

The AU eRequesting Server actor SHALL support the Patient resource, the AU eRequesting profile, the Patient (IPS) profile, and the conformance expectations for the Patient resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLidentifiertoken
 
Core FHIR Resource
Practitioner
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Practitioner

Documentation

The AU eRequesting Server actor SHALL support the Practitioner resource, the AU eRequesting profile, and the conformance expectations for the Practitioner resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLidentifiertoken
 
Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting PractitionerRole

Documentation

The AU eRequesting Server actor SHALL support the PractitionerRole resource, the AU eRequesting profile, and the conformance expectations for the PractitionerRole resource.

The AU eRequesting Server actor SHALL support the _include parameter for PractitionerRole:practitioner and PractitionerRole:organization.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLidentifiertoken
 
Core FHIR Resource
Procedure
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Procedure

Documentation

The AU eRequesting Server actor MAY support the Procedure resource, the AU Core profile, and the conformance expectations for the Procedure resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
RelatedPerson
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core RelatedPerson

Documentation

If the AU eRequesting Server actor supports the RelatedPerson resource, the AU eRequesting Server actor SHALL support the AU Core profile, and the conformance expectations for the RelatedPerson resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 
Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Pathology Request
AU eRequesting Imaging Request

Documentation

The AU eRequesting Server actor SHALL support the ServiceRequest resource, at least one AU eRequesting Diagnostic Request profile, and the conformance expectations for the ServiceRequest resource.

The AU eRequesting Server actor SHALL support the _include parameter for ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:encounter and ServiceRequest:supporting-info.

Where a profile is defined for a specific domain that profile SHALL be used: Pathology requests SHALL use AU eRequesting Pathology Request profile; Imaging requests SHALL use AU eRequesting Imaging Request profile.

Information recorded in ServiceRequest.note SHALL NOT duplicate or overlap with clinical context captured in ServiceRequest.supportingInfo:clinicalContext, or with any other information recorded in the ServiceRequest.

AU eRequesting Imaging Request:

Placer systems SHALL populate ServiceRequest.code.text so that fillers can at least display the service requested, even if they do not recognise the code supplied.

Placer systems SHALL adhere to the following order of preference when populating the ServiceRequest.code:

  • A code selected from the RANZCR Radiology Referral value set is the preferred option
  • A code selected from the SNOMED CT Imaging Procedure value set is the second most preferred option
  • A local code is preferred over free text, preferably from a published and accessible FHIR code system​
  • Free text is the least preferred option which should not be used if a local code is known

AU eRequesting Pathology Request:

Placer systems SHALL populate ServiceRequest.code.text so that fillers can at least display the service requested, even if they do not recognise the code supplied.

Placer systems SHALL adhere to the following order of preference when populating the ServiceRequest.code:

  • A code selected from the RCPA - SPIA Requesting Pathology Terminology Reference Set value set is the preferred option

  • A code selected from the SNOMED CT Pathology Procedure value set is the second most preferred option

  • A local code is preferred over free text, preferably from a published and accessible FHIR code system​

  • Free text is the least preferred option which should not be used if a local code is known

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLrequisitiontoken
SHALLsupporting-inforeference
 
Core FHIR Resource
Task
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Task Group
AU eRequesting Task Diagnostic Request
AU eRequesting Task Communication Request

Documentation

The AU eRequesting Server actor SHALL support the Task resource, the AU eRequesting profiles, and the conformance expectations for the Task resource.

The AU eRequesting Server actor SHALL support the _include parameter for Task:patient, Task:requester, Task:owner, Task:focus.

The AU eRequesting Server actor SHALL support the _revinclude parameter for Task:part-of.

Where a task profile is defined for a specific purpose that profile SHALL be used:

  • Group tasks SHALL use AU eRequesting Task Group profile

  • Diagnostic request tasks SHALL use AU eRequesting Task Diagnostic Request profile

  • Communication request tasks SHALL use AU eRequesting Task Communication Request profile

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_lastUpdateddate

The AU eRequesting Server actor SHALL support multipleAnd. The AU eRequesting Server actor SHALL support search comparators gt, lt, ge, le.

SHALL_tagtoken
SHALLfocusreference
SHALLgroup-identifiertoken
SHALLownerreference

The AU eRequesting Server actor SHALL support chained search owner.identifier using HPI-O and ABN identifiers as defined in the AU Core Organization profile.

SHALLpart-ofreference
SHALLpatientreference

The AU eRequesting Server actor SHALL support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.

SHALLrequesterreference

The AU eRequesting Server actor SHALL support chained search requester.identifier using Medicare Provider Number identifier as defined in the AU Core PractitionerRole profile.

SHALLstatustoken

The AU eRequesting Server actor SHALL support multipleOr.

Combined Search Parameters
ConformanceParametersTypes
SHALL_lastUpdated+status+ownerdate+token+reference
SHALLowner+statusreference+token
SHALLpatient+statusreference+token
SHALLrequester+statusreference+token