AU eRequesting Implementation Guide
0.3.0-preview - Preview
AU eRequesting Implementation Guide
0.3.0-preview - Preview
This page is part of the AU eRequesting (v0.3.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-server | Version: 0.3.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.
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.
Raw OpenAPI-Swagger Definition file | Download
Generated Narrative: CapabilityStatement au-erequesting-server
json, MAY support xmlapplication/json-patch+jsonNote 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.
The AU eRequesting Server SHALL:
None defined.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| 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 | ServiceRequest:patient, ServiceRequest:requester, ServiceRequest:encounter | ||
| 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 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 Base Related Person | y | y | y | y | _id | |||
| Task | Supported Profiles AU eRequesting Task Diagnostic Request AU eRequesting Task Group | y | y | y | y | _id, group-identifier, owner, patient, requester, focus, _lastUpdated, status, patient+status, owner+status, requester+status, _lastUpdated+status+owner | Task:patient, Task:requester, Task:owner, Task:focus | ||
| CommunicationRequest | Supported Profiles AU eRequesting Communication Request CopyTo | y | y | y | y | _id | |||
| Consent | Supported Profiles AU eRequesting MHR Consent Withdrawal | y | y | y | y | _id |
read, search-type.create, update.AU eRequesting Pathology Request
AU eRequesting Imaging Request
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
_includeparameter forServiceRequest:patientandServiceRequest:requester, and SHOULD support the_includeparameter forServiceRequest:encounter.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | requisition | token |
read, search-type.create, update.Servers SHOULD support the Coverage resource, the AU Base profile, and the conformance expectations for the Coverage resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type.create, update.Servers SHOULD support the Encounter resource, the AU Core profile, and the conformance expectations for the Encounter resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type.create, update.Servers SHOULD support the Organization resource, the AU Core profile, and the conformance expectations for the Organization resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | identifier | token |
read, search-type.create, update.Servers SHALL support the Patient resource, the AU Core Patient and Patient (IPS) profiles, and the conformance expectations for the Patient resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | identifier | token |
read, search-type.create, update.Servers SHOULD support the Practitioner resource, the AU Core profile, and the conformance expectations for the Practitioner resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | identifier | token |
read, search-type.create, update.Servers SHOULD support the PractitionerRole resource, the AU Core profile, and the conformance expectations for the PractitionerRole resource.
The Server SHALL support the
_includeparameter forPractitionerRole:practitionerandPractitionerRole:organization.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | identifier | token |
read, search-type.create, update.Servers MAY support the Condition resource, the AU Core profile, and the conformance expectations for the Condition resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type.create, update.Servers MAY support the DocumentReference resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type.create, update.Servers MAY support the Location resource, the AU Core profile, and the conformance expectations for the Location resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type.create, update.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.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type.create, update.Servers MAY support the Procedure resource, the AU Core profile, and the conformance expectations for the Procedure resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type.create, update.Servers MAY support the RelatedPerson resource, the AU Base profile, and the conformance expectations for the RelatedPerson resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type.create, update.AU eRequesting Task Diagnostic Request
AU eRequesting Task Group
Servers SHALL support the Task resource, the AU eRequesting profiles, and the conformance expectations for the Task resource.
The Server SHALL support the
_includeparameter forTask:patient,Task:requester,Task:owner,Task:focus.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| 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 | focus | reference | |
| SHALL | _lastUpdated | date | |
| SHALL | status | token |
read, search-type.create, update.Servers SHALL support the CommunicationRequest resource, and the conformance expectations for the CommunicationRequest resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type.create, update.Servers SHALL support the Consent resource, the AU eRequesting MHR Consent Withdrawal profile, and the conformance expectations for the Consent resource.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
IG © 2025 HL7 Australia. Package hl7.fhir.au.ereq#0.3.0-preview based on FHIR 4.0.1. Generated 2025-03-12
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change