AU eRequesting Implementation Guide
0.3.0-preview - Preview

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

## CapabilityStatement: AU eRequesting Filler CapabilityStatement

Official URL: http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-filler | Version: 0.3.0-preview
Standards status: Draft | Maturity Level: 0 | Computable Name: AUeRequestingFillerCapabilityStatement
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 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.

### 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 filler supports a particular resource.

Resource Type | Profile | Supported Target Reference
--- | --- | ---
CommunicationRequest | AU eRequesting Communication Request CopyTo | AU Core Organization, AU Core Patient, AU Core PractitionerRole, AU eRequesting Imaging Request, AU eRequesting Pathology Request
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 | DocumentReference | -
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 Base Related Person
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 Base Related Person | -
ServiceRequest | AU eRequesting Imaging Request, AU eRequesting Pathology Request | AU eRequesting Coverage, AU Core Encounter, AU Core Patient, AU Core PractitionerRole, Observation Pregnancy - Status (IPS)
Task | AU eRequesting Task Diagnostic Request, AU eRequesting Task Group | AU Core Organization, AU Core Patient, AU Core PractitionerRole, AU eRequesting Imaging Request, AU eRequesting Pathology Request

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement au-erequesting-filler

## AU eRequesting Filler CapabilityStatement

- Implementation Guide Version: 0.3.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-03-12 04:23:30+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 Filler 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 |  |  |  |  | `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:encounter` |  |
Coverage | Supported Profiles AU eRequesting Coverage |  |  |  |  |  |  |  |
Encounter | Supported Profiles AU Core Encounter |  |  |  |  |  |  |  |
Organization | Supported Profiles AU Core Organization |  |  |  |  |  |  |  |
Patient | Supported Profiles AU Core Patient Patient (IPS) | y | y |  |  | _id |  |  |
Practitioner | Supported Profiles AU Core Practitioner |  |  |  |  |  |  |  |
PractitionerRole | Supported Profiles AU Core PractitionerRole |  |  |  |  |  |  |  |
Condition | Supported Profiles AU Core Condition |  |  |  |  |  |  |  |
DocumentReference | Supported Profiles DocumentReference |  |  |  |  |  |  |  |
Location | Supported Profiles AU Core Location |  |  |  |  |  |  |  |
Observation | Supported Profiles Observation - Pregnancy: status Observation - Pregnancy: EDD | y | y |  |  | _id |  |  |
Procedure | Supported Profiles AU Core Procedure |  |  |  |  |  |  |  |
RelatedPerson | Supported Profiles AU Base Related Person |  |  |  |  |  |  |  |
CommunicationRequest | Supported Profiles AU eRequesting Communication Request CopyTo | y | y |  |  | _id |  |  |
Consent | Supported Profiles AU eRequesting MHR Consent Withdrawal | y | y |  |  | _id |  |  |

#### Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary

- SHALL support `read`.

Supported Profiles

AU eRequesting Pathology Request
AU eRequesting Imaging Request

Documentation

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

> The Filler SHOULD support the `_include` parameter for `ServiceRequest:patient`, `ServiceRequest:requester` and `ServiceRequest:encounter`.

#### Resource Conformance: SHOULD Coverage

Core FHIR Resource
Coverage
Reference Policy
Interaction summary

Supported Profiles

AU eRequesting Coverage

Documentation

> Fillers SHOULD support the Coverage resource, the AU eRequesting profile, and the conformance expectations for the Coverage resource.

#### Resource Conformance: SHOULD Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary

Supported Profiles

AU Core Encounter

Documentation

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

#### Resource Conformance: SHOULD Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary

Supported Profiles

AU Core Organization

Documentation

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

#### Resource Conformance: SHALL Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary

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

Supported Profiles

AU Core Patient
Patient (IPS)

Documentation

> Fillers 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: SHOULD Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary

Supported Profiles

AU Core Practitioner

Documentation

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

#### Resource Conformance: SHOULD PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary

Supported Profiles

AU Core PractitionerRole

Documentation

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

#### Resource Conformance: MAY Condition

Core FHIR Resource
Condition
Reference Policy
Interaction summary

Supported Profiles

AU Core Condition

Documentation

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

#### Resource Conformance: MAY DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary

Supported Profiles

DocumentReference

Documentation

> Fillers MAY support the DocumentReference resource.

#### Resource Conformance: MAY Location

Core FHIR Resource
Location
Reference Policy
Interaction summary

Supported Profiles

AU Core Location

Documentation

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

#### Resource Conformance: SHALL Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary

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

Supported Profiles

Observation - Pregnancy: status
Observation - Pregnancy: EDD

Documentation

> Fillers SHALL support the Observation resource, the Observation Pregnancy - Status (IPS), 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: MAY Procedure

Core FHIR Resource
Procedure
Reference Policy
Interaction summary

Supported Profiles

AU Core Procedure

Documentation

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

#### Resource Conformance: MAY RelatedPerson

Core FHIR Resource
RelatedPerson
Reference Policy
Interaction summary

Supported Profiles

AU Base Related Person

Documentation

> Fillers MAY support the RelatedPerson resource, the AU Base profile, and the conformance expectations for the RelatedPerson resource.

#### Resource Conformance: SHALL CommunicationRequest

Core FHIR Resource
CommunicationRequest
Reference Policy
Interaction summary

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

Supported Profiles

AU eRequesting Communication Request CopyTo

Documentation

> Fillers SHALL support the CommunicationRequest resource, the AU eRequesting profile, and the conformance expectations for the CommunicationRequest 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`.

Supported Profiles

AU eRequesting MHR Consent Withdrawal

Documentation

> Fillers 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` |