AU eRequesting Implementation Guide
0.2.0-preview - Preview Australia flag

This page is part of the AU eRequesting (v0.2.0-preview: QA Preview) based on FHIR (HL7® FHIR® Standard) R4. . For a full list of available versions, see the Directory of published versions

CapabilityStatement: AU eRequesting Server CapabilityStatement

Official URL: http://hl7.org.au/fhir/ereq/CapabilityStatement/au-erequesting-server Version: 0.2.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.

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

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

Raw OpenAPI-Swagger Definition file | Download

Generated Narrative: CapabilityStatement au-erequesting-server

AU eRequesting Server CapabilityStatement

  • Implementation Guide Version: 0.2.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: 2024-12-05 09:17:10+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: server

The AU eRequesting Server 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 TypeProfileRSUCSearches_include_revincludeOperations
ServiceRequestSupported Profiles
  AU eRequesting Pathology Request
  AU eRequesting Imaging Request
yyyy_id, requisitionServiceRequest:patient, ServiceRequest:requester, ServiceRequest:encounter
CoverageSupported Profiles
  AU eRequesting Coverage
yyyy_id
EncounterSupported Profiles
  AU Core Encounter
yyyy_id
OrganizationSupported Profiles
  AU Core Organization
yyyy_id, identifier
PatientSupported Profiles
  AU Core Patient
yyyy_id, identifier
PractitionerSupported Profiles
  AU Core Practitioner
yyyy_id, identifier
PractitionerRoleSupported Profiles
  AU Core PractitionerRole
yyyy_id, identifierPractitionerRole:practitioner, PractitionerRole:organization
ConditionSupported Profiles
  AU Core Condition
yyyy_id
DocumentReferenceSupported Profiles
  DocumentReference
yyyy_id
LocationSupported Profiles
  AU Core Location
yyyy_id
ObservationSupported Profiles
  Observation
yyyy_id
ProcedureSupported Profiles
  AU Core Procedure
yyyy_id
RelatedPersonSupported Profiles
  AU Base Related Person
yyyy_id
TaskSupported Profiles
  AU eRequesting Task
yyyy_id, group-identifier, owner, patient, requester, focus, _lastUpdated, status, patient+status, owner+status, requester+status, _lastUpdated+status+ownerTask:patient, Task:requester, Task:owner, Task:focus

Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Documentation

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 _include parameter for ServiceRequest:patient and ServiceRequest:requester, and SHOULD support the _include parameter for ServiceRequest:encounter.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLrequisitiontoken
 

Resource Conformance: SHOULD Coverage

Core FHIR Resource
Coverage
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Coverage

Documentation

Servers SHOULD support the Coverage resource, the AU Base profile, and the conformance expectations for the Coverage resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: SHOULD Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Encounter

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: SHOULD Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Organization

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLidentifiertoken
 

Resource Conformance: SHOULD Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Patient

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLidentifiertoken
 

Resource Conformance: SHOULD Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Practitioner

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLidentifiertoken
 

Resource Conformance: SHOULD PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core PractitionerRole

Documentation

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

The Server SHALL support the _include parameter for PractitionerRole:practitioner and PractitionerRole:organization.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLidentifiertoken
 

Resource Conformance: MAY Condition

Core FHIR Resource
Condition
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Condition

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: MAY DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

DocumentReference

Documentation

Servers MAY support the DocumentReference resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: MAY Location

Core FHIR Resource
Location
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Location

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: MAY Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

Observation

Documentation

Servers MAY support the Observation resource.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: MAY Procedure

Core FHIR Resource
Procedure
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Core Procedure

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: MAY RelatedPerson

Core FHIR Resource
RelatedPerson
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU Base Related Person

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: SHALL Task

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • SHALL support read, search-type.
  • SHOULD support create, update.

Supported Profiles

AU eRequesting Task

Documentation

Servers SHALL support the Task resource, the AU eRequesting profile, and the conformance expectations for the Task resource.

The Server SHALL support the _include parameter for Task:patient, Task:requester, Task:owner, Task:focus.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLgroup-identifiertoken
SHALLownerreference

The Server SHALL support chained search owner.identifier using HPI-O and ABN identifiers as defined in the AU Core Organization profile.

SHALLpatientreference

The Server SHALL support chained search patient.identifier using IHI, Medicare Number, and DVA Number identifiers as defined in the AU Core Patient profile.

SHALLrequesterreference

The Server SHALL support chained search requester.identifier using Medicare Provider Number identifier as defined in the AU Core PractitionerRole profile.

SHALLfocusreference
SHALL_lastUpdateddate
SHALLstatustoken
Combined Search Parameters
ConformanceParametersTypes
SHALLpatient+statusreference+token
SHALLowner+statusreference+token
SHALLrequester+statusreference+token
SHALL_lastUpdated+status+ownerdate+token+reference