AU eRequesting Implementation Guide
0.1.0-ballot - Ballot Australia flag

This page is part of the AU eRequesting (v0.1.0-ballot: AU eRequesting R1 Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

CapabilityStatement: AU eRequesting Patient Access CapabilityStatement

Official URL: http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-patientaccess Version: 0.1.0-ballot
Standards status: Draft Maturity Level: 0 Computable Name: AUeRequestingPatientAccessCapabilityStatement

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 Patient Access actor that is the digital interface that allows patients or their representatives to view and manage requests for diagnostic services. The complete list of FHIR profiles, RESTful operations, and search parameters supported by AU eRequesting patient access clients 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 patient access client supports a particular resource.

Resource Type Profile Supported Target Reference
Coverage AU Base 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 -
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 ServiceRequest, AU eRequesting Imaging Request, AU eRequesting Pathology Request AU Base Coverage, AU Core Encounter, AU Core Patient, AU Core PractitionerRole

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement au-erequesting-patientaccess

AU eRequesting Patient Access CapabilityStatement

  • Implementation Guide Version: 0.1.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: MAY support json, MAY support xml
  • Supported Patch Formats: MAYsupport application/json-patch+json
  • Published on: 2024-08-05 11:22:46+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

FHIR RESTful Capabilities

Mode: client

The AU eRequesting Patient Access SHALL:

  1. Support at least one AU eRequesting ServiceRequest 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 TypeProfileRSUCSearches_include_revincludeOperations
ServiceRequestSupported Profiles
  AU eRequesting ServiceRequest
  AU eRequesting Pathology Request
  AU eRequesting Imaging Request		y_id, requisition
CoverageSupported Profiles
  AU Base Coverage
EncounterSupported Profiles
  AU Core Encounter
OrganizationSupported Profiles
  AU Core Organization
PatientSupported Profiles
  AU Core Patient
PractitionerSupported Profiles
  AU Core Practitioner
PractitionerRoleSupported Profiles
  AU Core PractitionerRole
ConditionSupported Profiles
  AU Core Condition
DocumentReferenceSupported Profiles
  DocumentReference
LocationSupported Profiles
  AU Core Location
ObservationSupported Profiles
  Observation
ProcedureSupported Profiles
  AU Core Procedure
RelatedPersonSupported Profiles
  AU Base Related Person

Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • SHALLsupport search-type.

Supported Profiles

http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest
http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-path
http://hl7.org.au/fhir/ereq/StructureDefinition/au-erequesting-servicerequest-imag

Documentation

Patient Accesss SHALL support the ServiceRequest resource, at least one AU eRequesting ServiceRequest profile, and the conformance expectations for the ServiceRequest resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLrequisitiontoken
 

Resource Conformance: SHOULD Coverage

Core FHIR Resource
Coverage
Reference Policy
Interaction summary

    Supported Profiles

    http://hl7.org.au/fhir/StructureDefinition/au-coverage

    Documentation

    Patient Accesss clients SHOULD support the Coverage resource, the AU Base profile, and the conformance expectations for the Coverage resource.

    Resource Conformance: SHOULD Encounter

    Core FHIR Resource
    Encounter
    Reference Policy
    Interaction summary

      Supported Profiles

      http://hl7.org.au/fhir/core/StructureDefinition/au-core-encounter

      Documentation

      Patient Accesss clients 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

        http://hl7.org.au/fhir/core/StructureDefinition/au-core-organization

        Documentation

        Patient Accesss clients SHOULD support the Organization resource, the AU Core profile, and the conformance expectations for the Organization resource.

        Resource Conformance: SHOULD Patient

        Core FHIR Resource
        Patient
        Reference Policy
        Interaction summary

          Supported Profiles

          http://hl7.org.au/fhir/core/StructureDefinition/au-core-patient

          Documentation

          Patient Accesss clients SHOULD support the Patient resource, the AU Core profile, and the conformance expectations for the Patient resource.

          Resource Conformance: SHOULD Practitioner

          Core FHIR Resource
          Practitioner
          Reference Policy
          Interaction summary

            Supported Profiles

            http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitioner

            Documentation

            Patient Accesss clients 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

              http://hl7.org.au/fhir/core/StructureDefinition/au-core-practitionerrole

              Documentation

              Patient Accesss clients 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

                http://hl7.org.au/fhir/core/StructureDefinition/au-core-condition

                Documentation

                Patient Accesss 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

                  http://hl7.org/fhir/StructureDefinition/DocumentReference

                  Documentation

                  Patient Accesss MAY support the DocumentReference resource.

                  Resource Conformance: MAY Location

                  Core FHIR Resource
                  Location
                  Reference Policy
                  Interaction summary

                    Supported Profiles

                    http://hl7.org.au/fhir/core/StructureDefinition/au-core-location

                    Documentation

                    Patient Accesss MAY support the Location resource, the AU Core profile, and the conformance expectations for the Location resource.

                    Resource Conformance: MAY Observation

                    Core FHIR Resource
                    Observation
                    Reference Policy
                    Interaction summary

                      Supported Profiles

                      http://hl7.org/fhir/StructureDefinition/Observation

                      Documentation

                      Patient Accesss MAY support the Observation resource.

                      Resource Conformance: MAY Procedure

                      Core FHIR Resource
                      Procedure
                      Reference Policy
                      Interaction summary

                        Supported Profiles

                        http://hl7.org.au/fhir/core/StructureDefinition/au-core-procedure

                        Documentation

                        Patient Accesss 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

                          http://hl7.org.au/fhir/StructureDefinition/au-relatedperson

                          Documentation

                          Patient Accesss MAY support the RelatedPerson resource, the AU Base profile, and the conformance expectations for the RelatedPerson resource.