AU eRequesting Implementation Guide
1.0.0-ballot - Ballot 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-ballot 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 Patient CapabilityStatement

Official URL: http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-patient Version: 1.0.0-ballot
Standards status: Draft Maturity Level: 1 Computable Name: AUeRequestingPatientCapabilityStatement

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 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.

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 Patient 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 Core Organization, AU Core Patient, AU Core PractitionerRole, AU eRequesting Imaging Request, AU eRequesting Pathology Request, AU eRequesting Task Group
Consent AU eRequesting MHR Consent Withdrawal AU Core Patient, AU Core Organization, AU eRequesting Imaging Request, AU eRequesting Pathology Request
Coverage AU eRequesting Coverage -
Condition AU Core Condition AU Core Patient
DocumentReference AU eRequesting Clinical Context DocumentReference AU Core Patient
Encounter AU Core Encounter AU Core Condition, AU Core Location, Observation, AU Core Organization, AU Core Patient, AU Core Practitioner, AU Core PractitionerRole, AU Core Procedure, AU Core RelatedPerson
Location AU Core Location AU Core Organization
Organization AU Core Organization -
Observation Observation Pregnancy - Status (IPS) Observation Pregnancy - Expected Delivery Date (IPS), Patient (IPS)
Patient AU Core Patient -
Practitioner AU Core Practitioner -
PractitionerRole AU Core PractitionerRole AU Core Organization, AU Core Practitioner
Procedure AU Core Procedure AU Core Condition, DocumentReference, AU Core Encounter, Observation, AU Core Patient, AU Core Procedure
RelatedPerson AU Core RelatedPerson AU Core Patient
ServiceRequest AU eRequesting Imaging Request, AU eRequesting Pathology Request AU eRequesting Coverage, AU eRequesting Clinical Context DocumentReference, AU Core Encounter, AU Core Patient, AU Core PractitionerRole, Observation Pregnancy - Status (IPS)
Task AU eRequesting Task Diagnostic Request, AU eRequesting Task Group, AU eRequesting Task Communication Request AU Core Organization, AU eRequesting Task Group, AU eRequesting CommunicationRequest CopyTo, AU eRequesting CommunicationRequest Patient, AU eRequesting CommunicationRequest Urgent Provider, AU Core Patient, AU Core PractitionerRole, AU eRequesting Imaging Request, AU eRequesting Pathology Request

Raw OpenAPI-Swagger Definition file | Download

AU eRequesting Patient CapabilityStatement

  • Implementation Guide Version: 1.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: MAY support json, MAY support xml
  • Supported Patch Formats: MAY support application/json-patch+json
  • Published on: 2025-08-04 13:30:39+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: client

The AU eRequesting Patient actor SHALL:

  1. Support at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource.
  2. Implement the RESTful behavior according to the FHIR specification.
Security

None defined.

Summary of System-wide Interactions

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		yy_id
ConditionSupported Profiles
  AU Core Condition		yy_id
ConsentSupported Profiles
  AU eRequesting MHR Consent Withdrawal		yy_id
CoverageSupported Profiles
  AU eRequesting Coverage		yy_id
DocumentReferenceSupported Profiles
  AU eRequesting Clinical Context DocumentReference		yy_id
EncounterSupported Profiles
  AU Core Encounter		yy_id
LocationSupported Profiles
  AU Core Location		yy_id
ObservationSupported Profiles
  Observation - Pregnancy: status
  Observation - Pregnancy: EDD		yy_id
OrganizationSupported Profiles
  AU Core Organization		yy_id, identifier
PatientSupported Profiles
  AU Core Patient
  Patient (IPS)		yy_id, identifier
PractitionerSupported Profiles
  AU Core Practitioner		yy_id, identifier
PractitionerRoleSupported Profiles
  AU Core PractitionerRole		yy_id, identifierPractitionerRole:practitioner, PractitionerRole:organization
ProcedureSupported Profiles
  AU Core Procedure		yy_id
RelatedPersonSupported Profiles
  AU Core RelatedPerson		yy_id
ServiceRequestSupported Profiles
  AU eRequesting Pathology Request
  AU eRequesting Imaging Request		yy_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		yy_id, _lastUpdated, _tag, focus, group-identifier, owner, patient, requester, status, _lastUpdated+status+owner, owner+status, patient+status, requester+statusTask:patient, Task:requester, Task:owner, Task:focus

Resource Conformance: SHOULD CommunicationRequest

Core FHIR Resource
CommunicationRequest
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

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

Documentation

If the AU eRequesting Patient actor supports the CommunicationRequest resource, the AU eRequesting Patient actor SHALL support the AU eRequesting profiles and the conformance expectations for the CommunicationRequest resource.

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: MAY Condition

Core FHIR Resource
Condition
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU Core Condition

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: SHOULD Consent

Core FHIR Resource
Consent
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU eRequesting MHR Consent Withdrawal

Documentation

If the AU eRequesting Patient actor supports the Consent resource, the AU eRequesting Patient actor SHALL support the AU eRequesting MHR Consent Withdrawal profile and the conformance expectations for the Consent resource.

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: SHOULD Coverage

Core FHIR Resource
Coverage
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU eRequesting Coverage

Documentation

If the AU eRequesting Patient actor supports the Coverage resource, the AU eRequesting Patient actor SHALL support the AU eRequesting Coverage profile, and the conformance expectations for the Coverage resource.

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: SHOULD DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU eRequesting Clinical Context DocumentReference

Documentation

If the AU eRequesting Patient actor supports the DocumentReference resource, the AU eRequesting Patient actor SHALL support the AU eRequesting profile, and the conformance expectations for the DocumentReference resource.

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: SHOULD Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU Core Encounter

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: MAY Location

Core FHIR Resource
Location
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU Core Location

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: SHOULD Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

Observation - Pregnancy: status
Observation - Pregnancy: EDD

Documentation

If the AU eRequesting Patient actor supports the Observation resource, the Observation Pregnancy - Status (IPS), the Observation Pregnancy - Expected Delivery Date (IPS) profiles and the conformance expectations for the Observation resource SHALL be supported.

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: SHOULD Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU Core Organization

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
MAYidentifiertoken
 

Resource Conformance: SHOULD Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU Core Patient
Patient (IPS)

Documentation

If the AU eRequesting Patient actor supports the Patient resource, the AU Core Patient and Patient (IPS) profiles and the conformance expectations for the Patient resource SHALL be supported.

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
MAYidentifiertoken
 

Resource Conformance: SHOULD Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU Core Practitioner

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
MAYidentifiertoken
 

Resource Conformance: SHOULD PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU Core PractitionerRole

Documentation

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

The AU eRequesting Patient actor MAY support the _include parameter for PractitionerRole:practitioner and PractitionerRole:organization

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
MAYidentifiertoken
 

Resource Conformance: MAY Procedure

Core FHIR Resource
Procedure
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU Core Procedure

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: MAY RelatedPerson

Core FHIR Resource
RelatedPerson
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

AU Core RelatedPerson

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
 

Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • SHOULD support search-type, read.

Supported Profiles

AU eRequesting Pathology Request
AU eRequesting Imaging Request

Documentation

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

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

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
MAYrequisitiontoken
MAYsupporting-inforeference
 

Resource Conformance: SHOULD Task

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • SHOULD support read, search-type.

Supported Profiles

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

Documentation

If the AU eRequesting Patient actor supports the Task resource, the AU eRequesting Patient actor SHALL support the AU eRequesting profiles, and the conformance expectations for the Task resource.

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

Search Parameters
ConformanceParameterTypeDocumentation
MAY_idtoken
MAY_lastUpdateddate

The AU eRequesting Patient actor MAY support multipleAnd. The AU eRequesting Patient actor MAY support search comparators gt, lt, ge, le.

MAY_tagtoken
MAYfocusreference
MAYgroup-identifiertoken
MAYownerreference

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

MAYpatientreference

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

MAYrequesterreference

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

MAYstatustoken

The AU eRequesting Patient actor MAY support multipleOr.

Combined Search Parameters
ConformanceParametersTypes
MAY_lastUpdated+status+ownerdate+token+reference
MAYowner+statusreference+token
MAYpatient+statusreference+token
MAYrequester+statusreference+token