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

Official URL: http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-placer | Version: 1.0.0-ci-build
Standards status: Draft | Maturity Level: 1 | Computable Name: AUeRequestingPlacerCapabilityStatement
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 Placer actor that is responsible for creating diagnostic requests. The complete list of FHIR profiles, RESTful operations, and search parameters supported by the AU eRequesting Placer 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 Placer 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
Condition | AU Core Condition | AU Core Patient
Consent | AU eRequesting MHR Consent Withdrawal | AU Core Patient, AU Core Organization, AU eRequesting Imaging Request, AU eRequesting Pathology Request
Coverage | AU eRequesting Coverage | -
DocumentReference | AU eRequesting Clinical Context DocumentReference | AU Core Patient
Encounter | AU Core Encounter | AU Core Condition, AU Core Location, AU Core Organization, AU Core Patient, AU Core Practitioner, AU Core PractitionerRole, AU Core Procedure, AU Core RelatedPerson, Observation
Location | AU Core Location | AU Core Organization
Observation | Observation Pregnancy - Status (IPS) | Observation Pregnancy - Expected Delivery Date (IPS), Patient (IPS)
Organization | AU Core Organization | -
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, 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 Core Encounter, AU Core Patient, AU Core PractitionerRole, Observation Pregnancy - Status (IPS)
Task | AU eRequesting Task Communication Request, AU eRequesting Task Diagnostic Request, AU eRequesting Task Group | AU Core Organization, AU Core Patient, AU Core PractitionerRole, AU eRequesting CommunicationRequest CopyTo, AU eRequesting CommunicationRequest Patient, AU eRequesting CommunicationRequest Urgent Provider, AU eRequesting Imaging Request, AU eRequesting Pathology Request, AU eRequesting Task Group

Raw OpenAPI-Swagger Definition file | Download

## AU eRequesting Placer CapabilityStatement

- Implementation Guide Version: 1.0.0-ci-build
- 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-10-20 07:23:52+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: `client`

The AU eRequesting Placer actor 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.

### 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
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
CommunicationRequest | Supported Profiles AU eRequesting CommunicationRequest CopyTo AU eRequesting CommunicationRequest Patient AU eRequesting CommunicationRequest Urgent Provider | Y | Y | Y | Y | _id |  |  |
Condition | Supported Profiles AU Core Condition | Y | Y | Y | Y | _id |  |  |
Consent | Supported Profiles AU eRequesting MHR Consent Withdrawal | Y | Y | Y | Y | _id |  |  |
Coverage | Supported Profiles AU eRequesting Coverage | Y | Y | Y | Y | _id |  |  |
DocumentReference | Supported Profiles AU eRequesting Clinical Context DocumentReference | Y | Y | Y | Y | _id |  |  |
Encounter | Supported Profiles AU Core Encounter | Y | Y | Y | Y | _id |  |  |
Location | Supported Profiles AU Core Location | Y | Y | Y | Y | _id |  |  |
Observation | Supported Profiles Observation Pregnancy - Status (IPS) Observation Pregnancy - Expected Delivery Date (IPS) | Y | Y | Y | Y | _id |  |  |
Organization | Supported Profiles AU Core Organization | Y | Y | Y | Y | _id |  |  |
Patient | Supported Profiles AU Core Patient Patient (IPS) | Y | Y | Y | Y | _id |  |  |
Practitioner | Supported Profiles AU Core Practitioner | Y | Y | Y | Y | _id |  |  |
PractitionerRole | Supported Profiles AU Core PractitionerRole | 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 |  |  |
ServiceRequest | Supported Profiles AU eRequesting Pathology Request AU eRequesting Imaging Request | Y | Y | Y | Y | _id, supporting-info, requisition | `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:encounter`, `ServiceRequest:supporting-info` |  |
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:patient`, `Task:requester`, `Task:owner`, `Task:focus` |  |

#### Resource Conformance: SHALL CommunicationRequest

Core FHIR Resource
CommunicationRequest
Reference Policy
Interaction summary

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

Supported Profiles

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

Documentation

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

Search Parameters

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

#### Resource Conformance: MAY Condition

Core FHIR Resource
Condition
Reference Policy
Interaction summary

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

Supported Profiles

AU Core Condition

Documentation

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

Search Parameters

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

#### Resource Conformance: SHALL Consent

Core FHIR Resource
Consent
Reference Policy
Interaction summary

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

Supported Profiles

AU eRequesting MHR Consent Withdrawal

Documentation

> The AU eRequesting Placer actor 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
--- | --- | --- | ---
MAY | _id | `token` |

#### Resource Conformance: SHALL Coverage

Core FHIR Resource
Coverage
Reference Policy
Interaction summary

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

Supported Profiles

AU eRequesting Coverage

Documentation

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

Search Parameters

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

#### Resource Conformance: SHALL DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary

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

Supported Profiles

AU eRequesting Clinical Context DocumentReference

Documentation

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

Search Parameters

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

#### Resource Conformance: SHALL Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary

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

Supported Profiles

AU Core Encounter

Documentation

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

Search Parameters

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

#### Resource Conformance: MAY Location

Core FHIR Resource
Location
Reference Policy
Interaction summary

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

Supported Profiles

AU Core Location

Documentation

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

Search Parameters

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

#### Resource Conformance: SHALL Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary

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

Supported Profiles

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

Documentation

> The AU eRequesting Placer 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

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

#### Resource Conformance: SHALL Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary

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

Supported Profiles

AU Core Organization

Documentation

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

Search Parameters

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

#### Resource Conformance: SHALL Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary

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

Supported Profiles

AU Core Patient
Patient (IPS)

Documentation

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

Search Parameters

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

#### Resource Conformance: SHALL Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary

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

Supported Profiles

AU Core Practitioner

Documentation

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

Search Parameters

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

#### Resource Conformance: SHALL PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary

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

Supported Profiles

AU Core PractitionerRole

Documentation

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

Search Parameters

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

#### Resource Conformance: MAY Procedure

Core FHIR Resource
Procedure
Reference Policy
Interaction summary

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

Supported Profiles

AU Core Procedure

Documentation

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

Search Parameters

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

#### Resource Conformance: MAY RelatedPerson

Core FHIR Resource
RelatedPerson
Reference Policy
Interaction summary

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

Supported Profiles

AU Core RelatedPerson

Documentation

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

Search Parameters

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

#### Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary

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

Supported Profiles

AU eRequesting Pathology Request
AU eRequesting Imaging Request

Documentation

> The AU eRequesting Placer 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 Placer actor MAY support the `_include` parameter for `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:encounter` and `ServiceRequest:supporting-info`.

Search Parameters

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

#### Resource Conformance: SHALL Task

Core FHIR Resource
Task
Reference Policy
Interaction summary

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

Supported Profiles

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

Documentation

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

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

Search Parameters

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

Combined Search Parameters

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