AU eRequesting Server CapabilityStatement

AU eRequesting Implementation Guide
0.2.0-ci-build - CI Build Australia flag

AU eRequesting Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 0.2.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-erequesting/ and changes regularly. 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-ci-build
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

Resource Type

Profile

Supported Target Reference

Coverage

AU eRequesting Coverage

-

Condition

AU Core Condition

AU Core Patient

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

-

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

Implementation Guide Version: 0.2.0-ci-build
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-09 00:06:01+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:

Support at least one AU eRequesting Diagnostic Request profile, and the conformance expectations for the ServiceRequest resource.
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`
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	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	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	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`

Resource Conformance: SHALL ServiceRequest

Core FHIR Resource
ServiceRequest

Reference Policy

Interaction summary

SHALL support read, search-type.
SHOULD support create, update.

Supported Profiles

AU eRequesting Pathology Request
AU eRequesting Imaging Request

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`
SHALL	requisition	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`
SHALL	identifier	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`
SHALL	identifier	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`
SHALL	identifier	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`
SHALL	identifier	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`

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

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`

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

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`

Combined Search Parameters

Conformance	Parameters	Types
SHALL	patient+status	`reference`+`token`
SHALL	owner+status	`reference`+`token`
SHALL	requester+status	`reference`+`token`
SHALL	_lastUpdated+status+owner	`date`+`token`+`reference`

IG © 2024 HL7 Australia. Package hl7.fhir.au.ereq#0.2.0-ci-build based on FHIR 4.0.1. Generated 2024-12-09
Links: Table of Contents | QA Report | Version History | | Propose a change

CapabilityStatement: AU eRequesting Server CapabilityStatement

Summary of Must Support and References Between Profiles