AU eRequesting Implementation Guide
0.4.0-preview - Preview

Publication Build: This will be filled in by the publication tooling

## CapabilityStatement: AU eRequesting Server CapabilityStatement

Official URL: http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-server | Version: 0.4.0-preview
Standards status: Draft | Maturity Level: 0 | 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 AU eRequesting servers 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 a server 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 Server CapabilityStatement

- Implementation Guide Version: 0.4.0-preview
- 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-06-17 05:04: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

- http://hl7.org.au/fhir/ImplementationGuide/hl7.fhir.au.base
- http://hl7.org.au/fhir/core/ImplementationGuide/hl7.fhir.au.core

## FHIR RESTful Capabilities

### Mode: `server`

The AU eRequesting Server SHALL:

1. Support at least one AU eRequesting Diagnostic Request 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 Type | Profile | R | S | U | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
ServiceRequest | Supported Profiles AU eRequesting Pathology Request AU eRequesting Imaging Request | y | y | y | y | _id, requisition, supporting-info | `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:encounter`, `ServiceRequest:supporting-info` |  |
Coverage | Supported Profiles AU eRequesting Coverage | y | y | y | y | _id |  |  |
Encounter | Supported Profiles AU Core Encounter | y | y | y | y | _id |  |  |
Organization | Supported Profiles AU Core Organization | y | y | y | y | _id, identifier |  |  |
Patient | Supported Profiles AU Core Patient Patient (IPS) | y | y | y | y | _id, identifier |  |  |
Practitioner | Supported Profiles AU Core Practitioner | y | y | y | y | _id, identifier |  |  |
PractitionerRole | Supported Profiles AU Core PractitionerRole | y | y | y | y | _id, identifier | `PractitionerRole:practitioner`, `PractitionerRole:organization` |  |
Condition | Supported Profiles AU Core Condition | y | y | y | y | _id |  |  |
DocumentReference | Supported Profiles AU eRequesting Clinical Context DocumentReference | y | y | y | y | _id |  |  |
Location | Supported Profiles AU Core Location | y | y | y | y | _id |  |  |
Observation | Supported Profiles Observation - Pregnancy: status Observation - Pregnancy: EDD | y | y | y | y | _id |  |  |
Procedure | Supported Profiles AU Core Procedure | y | y | y | y | _id |  |  |
RelatedPerson | Supported Profiles AU Core RelatedPerson | y | y | y | y | _id |  |  |
Task | Supported Profiles AU eRequesting Task Group AU eRequesting Task Diagnostic Request AU eRequesting Task Communication Request | y | y | y | y | _id, _lastUpdated, _tag, focus, group-identifier, owner, patient, requester, status, _lastUpdated+status+owner, owner+status, patient+status, requester+status | `Task:focus`, `Task:owner`, `Task:patient`, `Task:requester` |  |
CommunicationRequest | Supported Profiles AU eRequesting CommunicationRequest CopyTo AU eRequesting CommunicationRequest Patient AU eRequesting CommunicationRequest Urgent Provider | y | y | y | y | _id |  |  |
Consent | Supported Profiles AU eRequesting MHR Consent Withdrawal | y | y | y | y | _id |  |  |

#### Resource Conformance: SHALL ServiceRequest

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

> Servers SHALL support the ServiceRequest resource, at least one AU eRequesting Diagnostic Request profile, and the conformance expectations for the ServiceRequest resource.

> The Server SHALL support the `_include` parameter for `ServiceRequest:patient` and `ServiceRequest:requester`, and SHOULD support the `_include` parameter for `ServiceRequest:encounter` and `ServiceRequest:supporting-info`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |
SHALL | requisition | `token` |
SHOULD | supporting-info | `reference` |

#### Resource Conformance: SHALL Coverage

Core FHIR Resource
Coverage
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

AU eRequesting Coverage

Documentation

> Servers SHOULD support the Coverage resource, the AU Base profile, and the conformance expectations for the Coverage resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |

#### Resource Conformance: SHALL Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

AU Core Encounter

Documentation

> Servers SHOULD support the Encounter resource, the AU Core profile, and the conformance expectations for the Encounter resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |

#### Resource Conformance: SHALL Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

AU Core Organization

Documentation

> Servers SHOULD support the Organization resource, the AU Core profile, and the conformance expectations for the Organization resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |
SHALL | identifier | `token` |

#### Resource Conformance: SHALL Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

AU Core Patient
Patient (IPS)

Documentation

> Servers SHALL support the Patient resource, the AU Core Patient and Patient (IPS) profiles, and the conformance expectations for the Patient resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |
SHALL | identifier | `token` |

#### Resource Conformance: SHALL Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

AU Core Practitioner

Documentation

> Servers SHOULD support the Practitioner resource, the AU Core profile, and the conformance expectations for the Practitioner resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |
SHALL | identifier | `token` |

#### Resource Conformance: SHALL PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

AU Core PractitionerRole

Documentation

> Servers SHOULD support the PractitionerRole resource, the AU Core profile, and the conformance expectations for the PractitionerRole resource.

> The Server SHALL support the `_include` parameter for `PractitionerRole:practitioner` and `PractitionerRole:organization`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |
SHALL | identifier | `token` |

#### Resource Conformance: MAY Condition

Core FHIR Resource
Condition
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

AU Core Condition

Documentation

> Servers MAY support the Condition resource, the AU Core profile, and the conformance expectations for the Condition resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |

#### Resource Conformance: SHALL DocumentReference

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

> Servers SHALL support the DocumentReference resource, the AU eRequesting profile, and the conformance expectations for the DocumentReference resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |

#### Resource Conformance: MAY Location

Core FHIR Resource
Location
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

AU Core Location

Documentation

> Servers MAY support the Location resource, the AU Core profile, and the conformance expectations for the Location resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |

#### Resource Conformance: SHALL Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

Observation - Pregnancy: status
Observation - Pregnancy: EDD

Documentation

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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |

#### Resource Conformance: MAY Procedure

Core FHIR Resource
Procedure
Reference Policy
Interaction summary

- SHALL support `read`, `search-type`.
- SHOULD support `create`, `update`.

Supported Profiles

AU Core Procedure

Documentation

> Servers MAY support the Procedure resource, the AU Core profile, and the conformance expectations for the Procedure resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |

#### Resource Conformance: MAY RelatedPerson

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 Server supports the RelatedPerson resource, Server SHALL support the AU Core profile, and the conformance expectations for the RelatedPerson resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |

#### Resource Conformance: SHALL Task

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

> Servers SHALL support the Task resource, the AU eRequesting profiles, and the conformance expectations for the Task resource.

> The Server SHALL support the `_include` parameter for `Task:patient`, `Task:requester`, `Task:owner`, `Task:focus`.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |
SHALL | _lastUpdated | `date` | The Server SHALL support `multipleAnd`. The Server SHALL support search comparators `gt`, `lt`, `ge`, `le`.
SHALL | _tag | `token` |
SHALL | focus | `reference` |
SHALL | group-identifier | `token` |
SHALL | owner | `reference` | The Server SHALL support chained search owner.identifier using HPI-O and ABN identifiers as defined in the AU Core Organization profile.
SHALL | patient | `reference` | The Server SHALL support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.
SHALL | requester | `reference` | The Server SHALL support chained search requester.identifier using Medicare Provider Number identifier as defined in the AU Core PractitionerRole profile.
SHALL | status | `token` | The Server SHALL support `multipleOr`.

Combined Search Parameters

Conformance | Parameters | Types
--- | --- | ---
SHALL | _lastUpdated+status+owner | `date`+`token`+`reference`
SHALL | owner+status | `reference`+`token`
SHALL | patient+status | `reference`+`token`
SHALL | requester+status | `reference`+`token`

#### Resource Conformance: SHALL CommunicationRequest

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

> Servers SHALL support the CommunicationRequest resource, the AU eRequesting profiles, and the conformance expectations for the CommunicationRequest resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |

#### Resource Conformance: SHALL Consent

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

> Servers SHALL support the Consent resource, the AU eRequesting MHR Consent Withdrawal profile, and the conformance expectations for the Consent resource.

Search Parameters

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | _id | `token` |