Generated Narrative: CapabilityStatement au-erequesting-patient AU eRequesting Patient CapabilityStatement Implementation Guide Version: 1.0.0-ci-build FHIR Version: 4.0.1 Supported Formats: SHOULD support json, MAY support xml Supported Patch Formats: MAY support application/json-patch+json Published on: 2025-12-19 05:08:24+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 Patient actor SHALL: Support at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource. 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 _id Condition Supported Profiles AU Core Condition Y Y _id Consent Supported Profiles AU eRequesting MHR Consent Withdrawal Y Y _id Coverage Supported Profiles AU eRequesting Coverage Y Y _id DocumentReference Supported Profiles AU eRequesting Clinical Context DocumentReference Y Y _id Encounter Supported Profiles AU eRequesting Encounter Y Y _id Location Supported Profiles AU Core Location Y Y _id Observation Supported Profiles Observation Pregnancy - Status (IPS) Observation Pregnancy - Expected Delivery Date (IPS) Y Y _id Organization Supported Profiles AU eRequesting Organization Y Y _id, identifier Patient Supported Profiles AU eRequesting Patient Patient (IPS) Y Y _id, identifier Practitioner Supported Profiles AU eRequesting Practitioner Y Y _id, identifier PractitionerRole Supported Profiles AU eRequesting PractitionerRole Y Y _id, identifier PractitionerRole:practitioner, PractitionerRole:organization Procedure Supported Profiles AU Core Procedure Y Y _id RelatedPerson Supported Profiles AU Core RelatedPerson Y Y _id ServiceRequest Supported Profiles AU eRequesting Pathology Request AU eRequesting Imaging Request Y Y _id, requisition, supporting-info 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 _id, _lastUpdated, _tag, focus, group-identifier, owner, part-of, patient, requester, status, _lastUpdated+status+owner, owner+status, patient+status, requester+status Task:patient, Task:requester, Task:owner, Task:focus Task:part-of 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. Where a CommunicationRequest profile is defined for a specific purpose that profile SHALL be used: Communication requests about providing a copy of the report to a patient or clinician SHALL use the AU eRequesting CommunicationRequest CopyTo profile Communication requests about communication with a patient from a filler SHALL use the AU eRequesting CommunicationRequest Patient profile Communication requests about communication from a filler to a clinical provider to notify them of urgent results SHALL use the AU eRequesting CommunicationRequest Urgent Provider profile 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. 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 Conformance Parameter Type Documentation MAY _id token 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 Conformance Parameter Type Documentation MAY _id token 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. When using one of the below Coverage types, at least one of the corresponding identifiers SHOULD be populated: Coverage Type Code Identifier Medicare PUBLICPOL AU Medicare Card Number Department of Veterans Affairs (DVA) VET AU DVA Number Concession payconc AU Pensioner Concession Card Number, AU Commonwealth Seniors Health Card Number , AU Health Care Card Number Private health insurance HIP AU Insurance Member Number Private (self funded) pay N/A Search Parameters Conformance Parameter Type Documentation MAY _id token 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 Conformance Parameter Type Documentation MAY _id token Resource Conformance: SHOULD Encounter Core FHIR Resource Encounter Reference Policy Interaction summary SHOULD support read, search-type. Supported Profiles AU eRequesting Encounter Documentation If the AU eRequesting Patient actor supports the Encounter resource, the AU eRequesting Patient actor SHALL support the AU eRequesting Encounter 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. 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 Conformance Parameter Type Documentation MAY _id token Resource Conformance: SHOULD Observation Core FHIR Resource Observation Reference Policy Interaction summary SHOULD support read, search-type. Supported Profiles Observation Pregnancy - Status (IPS) Observation Pregnancy - Expected Delivery Date (IPS) 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 Conformance Parameter Type Documentation MAY _id token Resource Conformance: SHOULD Organization Core FHIR Resource Organization Reference Policy Interaction summary SHOULD support read, search-type. Supported Profiles AU eRequesting Organization Documentation If the AU eRequesting Patient actor supports the Organization resource, the AU eRequesting Patient actor SHALL support the AU eRequesting Organization profile, and the conformance expectations for the Organization resource. Search Parameters Conformance Parameter Type Documentation MAY _id token MAY identifier token Resource Conformance: SHOULD Patient Core FHIR Resource Patient Reference Policy Interaction summary SHOULD support read, search-type. Supported Profiles AU eRequesting Patient Patient (IPS) Documentation If the AU eRequesting Patient actor supports the Patient resource, the AU eRequesting Patient profile, the Patient (IPS) profile, and the conformance expectations for the Patient resource SHALL be supported. Search Parameters Conformance Parameter Type Documentation MAY _id token MAY identifier token Resource Conformance: SHOULD Practitioner Core FHIR Resource Practitioner Reference Policy Interaction summary SHOULD support read, search-type. Supported Profiles AU eRequesting Practitioner Documentation If the AU eRequesting Patient actor supports the Practitioner resource, AU eRequesting Patient actor SHALL support the AU eRequesting Practitioner profile, and the conformance expectations for the Practitioner resource. Search Parameters Conformance Parameter Type Documentation MAY _id token MAY identifier token Resource Conformance: SHOULD PractitionerRole Core FHIR Resource PractitionerRole Reference Policy Interaction summary SHOULD support read, search-type. Supported Profiles AU eRequesting PractitionerRole Documentation If the AU eRequesting Patient actor supports the PractitionerRole resource, the AU eRequesting Patient actor SHALL support the AU eRequesting 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 Conformance Parameter Type Documentation MAY _id token MAY identifier token 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 Conformance Parameter Type Documentation MAY _id token 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 Conformance Parameter Type Documentation MAY _id token 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 Diagnostic Request 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. Where a profile is defined for a specific domain that profile SHALL be used: Pathology requests SHALL use AU eRequesting Pathology Request profile; Imaging requests SHALL use AU eRequesting Imaging Request profile. Information recorded in ServiceRequest.note SHALL NOT duplicate or overlap with clinical context captured in ServiceRequest.supportingInfo:clinicalContext, or with any other information recorded in the ServiceRequest. AU eRequesting Imaging Request: Placer systems SHALL populate ServiceRequest.code.text so that fillers can at least display the service requested, even if they do not recognise the code supplied.​ Placer systems SHALL adhere to the following order of preference when populating the ServiceRequest.code: A code selected from the RANZCR Radiology Referral value set is the preferred option A code selected from the SNOMED CT Imaging Procedure value set is the second most preferred option A local code is preferred over free text, preferably from a published and accessible FHIR code system​ Free text is the least preferred option which should not be used if a local code is known AU eRequesting Pathology Request: Placer systems SHALL populate ServiceRequest.code.text so that fillers can at least display the service requested, even if they do not recognise the code supplied. Placer systems SHALL adhere to the following order of preference when populating the ServiceRequest.code: A code selected from the RCPA - SPIA Requesting Pathology Terminology Reference Set value set is the preferred option A code selected from the SNOMED CT Pathology Procedure value set is the second most preferred option A local code is preferred over free text, preferably from a published and accessible FHIR code system​ Free text is the least preferred option which should not be used if a local code is known Search Parameters Conformance Parameter Type Documentation MAY _id token MAY requisition token MAY supporting-info reference 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. The AU eRequesting Patient actor MAY support the _revinclude parameter for Task:part-of. Where a task profile is defined for a specific purpose that profile SHALL be used: Group tasks SHALL use AU eRequesting Task Group profile Diagnostic request tasks SHALL use AU eRequesting Task Diagnostic Request profile Communication request tasks SHALL use AU eRequesting Task Communication Request profile Search Parameters Conformance Parameter Type Documentation MAY _id token MAY _lastUpdated date The AU eRequesting Patient actor MAY support multipleAnd. The AU eRequesting Patient 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 Patient actor MAY support chained search owner.identifier using HPI-O and ABN identifiers as defined in the AU Core Organization profile. MAY part-of reference MAY patient reference 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. MAY requester reference The AU eRequesting Patient 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 Patient 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
AU eRequesting Patient CapabilityStatement
This CapabilityStatement describes the basic rules for the [AU eRequesting Patient actor](ActorDefinition-au-erequesting-actor-patient.html) 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.
Used by permission of HL7 International, all rights reserved Creative Commons License. HL7 Australia© 2024+; Licensed Under Creative Commons No Rights Reserved.
The AU eRequesting Patient actor **SHALL**: 1. Support at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource. 1. Implement the RESTful behavior according to the FHIR specification.
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. Where a CommunicationRequest profile is defined for a specific purpose that profile **SHALL** be used: * Communication requests about providing a copy of the report to a patient or clinician **SHALL** use the AU eRequesting CommunicationRequest CopyTo profile * Communication requests about communication with a patient from a filler **SHALL** use the AU eRequesting CommunicationRequest Patient profile * Communication requests about communication from a filler to a clinical provider to notify them of urgent results **SHALL** use the AU eRequesting CommunicationRequest Urgent Provider profile
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.
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.
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. When using one of the below Coverage types, at least one of the corresponding identifiers **SHOULD** be populated: | Coverage Type | Code | Identifier | | ----------- | ----------- | ----------- | | Medicare | PUBLICPOL | [AU Medicare Card Number](https://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-medicarecardnumber.html)| | Department of Veterans Affairs (DVA) | VET | [AU DVA Number](https://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-dvanumber.html) | | Concession | payconc | [AU Pensioner Concession Card Number](https://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-pensionerconcessioncardnumber.html), [AU Commonwealth Seniors Health Card Number](https://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-cwlthseniorshealthcardnumber.html) , [AU Health Care Card Number](https://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-healthcarecardnumber.html)| | Private health insurance | HIP | [AU Insurance Member Number](https://build.fhir.org/ig/hl7au/au-fhir-base/StructureDefinition-au-insurancemembernumber.html) | | Private (self funded) | pay | N/A |
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.
If the AU eRequesting Patient actor supports the Encounter resource, the AU eRequesting Patient actor **SHALL** support the AU eRequesting Encounter profile, and the conformance expectations for the Encounter resource.
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.
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.
If the AU eRequesting Patient actor supports the Organization resource, the AU eRequesting Patient actor **SHALL** support the AU eRequesting Organization profile, and the conformance expectations for the Organization resource.
If the AU eRequesting Patient actor supports the Patient resource, the AU eRequesting Patient profile, the Patient (IPS) profile, and the conformance expectations for the Patient resource **SHALL** be supported.
If the AU eRequesting Patient actor supports the Practitioner resource, AU eRequesting Patient actor **SHALL** support the AU eRequesting Practitioner profile, and the conformance expectations for the Practitioner resource.
If the AU eRequesting Patient actor supports the PractitionerRole resource, the AU eRequesting Patient actor **SHALL** support the AU eRequesting 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`
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.
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.
The AU eRequesting Patient 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 Patient actor **MAY** support the `_include` parameter for `ServiceRequest:patient`, `ServiceRequest:requester`, `ServiceRequest:encounter` and `ServiceRequest:supporting-info`. Where a profile is defined for a specific domain that profile **SHALL** be used: Pathology requests **SHALL** use AU eRequesting Pathology Request profile; Imaging requests **SHALL** use AU eRequesting Imaging Request profile. Information recorded in `ServiceRequest.note` **SHALL NOT** duplicate or overlap with clinical context captured in `ServiceRequest.supportingInfo:clinicalContext`, or with any other information recorded in the ServiceRequest. [AU eRequesting Imaging Request](StructureDefinition-au-erequesting-servicerequest-imag.html): Placer systems **SHALL** populate `ServiceRequest.code.text` so that fillers can at least display the service requested, even if they do not recognise the code supplied.​ Placer systems **SHALL** adhere to the following order of preference when populating the `ServiceRequest.code`: * A code selected from the [RANZCR Radiology Referral](https://www.healthterminologies.gov.au/integration/R4/fhir/ValueSet/ranzcr-radiology-referral-1) value set is the preferred option * A code selected from the SNOMED CT [Imaging Procedure](https://www.healthterminologies.gov.au/integration/R4/fhir/ValueSet/imaging-procedure-1) value set is the second most preferred option * A local code is preferred over free text, preferably from a published and accessible FHIR code system​ * Free text is the least preferred option which should not be used if a local code is known [AU eRequesting Pathology Request](StructureDefinition-au-erequesting-servicerequest-path.html): Placer systems **SHALL** populate `ServiceRequest.code.text` so that fillers can at least display the service requested, even if they do not recognise the code supplied. Placer systems **SHALL** adhere to the following order of preference when populating the `ServiceRequest.code`: * A code selected from the [RCPA - SPIA Requesting Pathology Terminology Reference Set](https://www.healthterminologies.gov.au/integration/R4/fhir/ValueSet/spia-requesting-refset-3) value set is the preferred option * A code selected from the SNOMED CT [Pathology Procedure](https://www.healthterminologies.gov.au/integration/R4/fhir/ValueSet/pathology-procedure-1) value set is the second most preferred option * A local code is preferred over free text, preferably from a published and accessible FHIR code system​ * Free text is the least preferred option which should not be used if a local code is known
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`. The AU eRequesting Patient actor **MAY** support the `_revinclude` parameter for `Task:part-of`. Where a task profile is defined for a specific purpose that profile **SHALL** be used: * Group tasks **SHALL** use AU eRequesting Task Group profile * Diagnostic request tasks **SHALL** use AU eRequesting Task Diagnostic Request profile * Communication request tasks **SHALL** use AU eRequesting Task Communication Request profile
The AU eRequesting Patient actor **MAY** support `multipleAnd`. The AU eRequesting Patient actor **MAY** support search comparators `gt`, `lt`, `ge`, `le`.
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.
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.
The AU eRequesting Patient actor **MAY** support chained search requester.identifier using Medicare Provider Number identifier as defined in the AU Core PractitionerRole profile.
The AU eRequesting Patient actor **MAY** support `multipleOr`.