Health Connect Australia Provider Directory FHIR Implementation Guide, published by Australian Digital Health Agency. This guide is not an authorized publication; it is the continuous build for version 0.1.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HealthConnect/ and changes regularly. See the Directory of published versions

CapabilityStatement: Health Connect Reader

Official URL: http://ns.electronichealth.net.au/hc/CapabilityStatement/health-connect-reader Version: 0.1.0-preview
Standards status: Draft Computable Name: HealthConnectReader

Usage:Jurisdiction: Australia

Copyright/Legal: Copyright © 2025 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/

This CapabilityStatement resource defines the expected capabilities of the Health Connect Reader actor when conforming to this implementation guide. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Health Connect Reader actor are defined in this CapabilityStatement. The requirements of the HealthConnect Reader actor may also be impacted by the rules of local jurisdictions or other contextual requirements.

Raw OpenAPI-Swagger Definition file | Download

Health Connect Reader

  • Implementation Guide Version: 0.1.0-preview
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHALL support xml
  • Published on: 2025-08-12
  • Published by: Australian Digital Health Agency

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.

FHIR RESTful Capabilities

Mode: client

Security
Enable CORS: no
Security services supported: OAuth

All interactions SHALL be secured using OAuth protocols. It SHALL support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements.

Summary of System-wide Interactions
  • Supports the search-systeminteraction described as follows:

    Definition:

    This operation is a RESTful search interaction (whole system interaction), across multiple resource types (as described in the FHIR specification).

    Behaviour:

    This operation is used by a client system operated by a Health Connect reader to get resources that match the specified search parameters. .

    The following search parameters are supported:

    • _lastUpdated is used to get the resources that have been added or changed since the requesting system last synchronised their local data store with Health Connect Reader. This search parameter supports the gt and lt comparison prefixes.

    • _type is used to filter the resources returned by their resource type. The available types are:

    All of the following query parameters are required in order to receive the complete set of resources that have been created, changed or published to all the subscriber organisation's partner services since [last_synchronized]:

    _lastUpdated=[last_synchronized]

    _type=HealthcareService,PractitionerRole,Practitioner,Organization,Location,Provenance

    _include=Location:organization

    _include=HealthcareService:organization

    _include=HealthcareService:location

    _include=PractitionerRole:organization

    _include=PractitionerRole:location

    _include=PractitionerRole:service

    _include=PractitionerRole:practitioner

    _include=Provenance:target

    _include:iterate=HealthcareService:organization

    _include:iterate=HealthcareService:location

    _include:iterate=PractitionerRole:organization

    _include:iterate=PractitionerRole:location

    _include:iterate=PractitionerRole:service

    _include:iterate=PractitionerRole:practitioner

    As described above the resources returned in the Bundle exclude any Identifiers (e.g. HPI-Is) that cannot be disclosed to the subscriber.

    This operation supports 'paging' (see FHIR specification). If there are too many resources to return in one Bundle, the FHIR server adds a next link to the response Bundle. The contents of the result Bundle therefore comprise all instances of the requested resource types whose lastUpdated timestamp is greater than the <lastSync> in the request query expression and less than or equal to <lastInBundle> where <lastInBundle> is the greatest lastUpdated value of all resources included in the result Bundle. The Subscriber Agent FHIR server sets the next link to the filter expression that was used in the original request except that <lastSync> is replaced with <lastInBundle>. If the next link is not present in the Bundle, then there are no more service offerings available.

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
Provenancehttp://ns.electronichealth.net.au/hc/StructureDefinition/hc-provenanceyy
Organizationhttp://ns.electronichealth.net.au/hc/StructureDefinition/hc-organizationyyidentifier, name, typeOrganization:partOfLocation:organization, Provenance:target
Locationhttp://ns.electronichealth.net.au/hc/StructureDefinition/hc-locationyypostaladdress, locationamenities, name, address, typeLocation:endpointHealthcareService:location, Provenance:target
HealthcareServicehttp://ns.electronichealth.net.au/hc/StructureDefinition/hc-healthcareserviceyylanguages, hsbilling, availability-allday, availability-daysofweek, availability-starttime, availability-endtime, service-typeHealthcareService:location, HealthcareService:providedBy, HealthcareService:endpointPractitionerRole:healthcareService, Provenance:target
PractitionerRolehttp://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitionerroleyylanguages, availability-allday, availability-daysofweek, availability-starttime, availability-endtime, identifier, roletype, prnPractitionerRole:practitioner, PractitionerRole:healthcareService, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:endpointProvenance:target
Practitionerhttp://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitioneryidentifier, regprof, rsg, gender-identity, practitionername, practitionerpreferredname, prnPractitionerRole:practitioner, Provenance:target
Endpointhttp://ns.electronichealth.net.au/hc/StructureDefinition/hc-endpointyyepurl, payloadmimetype, hcepi, name, connection-type, payload-typeHealthcareService:endpoint, Location:endpoint, PractitionerRole:endpoint, Provenance:target

Resource Conformance: supported Provenance

Base System Profile
HC Provenance
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    Read HC Provenance records to understand data lineage

    search-type

    Search for HC Provenance records by target resource or activity

Documentation

This resource is used to track the provenance of data retrieved, updated, or verified from external systems of record for HC resources.

Resource Conformance: supported Organization

Base System Profile
HC Organization
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section defines the supported interactions for the HC Organization profile of the Organization resource type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLnamestring
SHALLtypetoken
 

Resource Conformance: supported Location

Base System Profile
HC Location
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section defines the supported interactions for the HC Location profile of the Location resource type. A Location resource conforming to the HC Location profile represents a location at which healthcare services are offered by a Health Connect Reader.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpostaladdressstring
SHALLlocationamenitiestoken
SHALLnamestring
SHALLaddressstring
SHALLtypetoken
 

Resource Conformance: supported HealthcareService

Base System Profile
HC HealthcareService
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section defines the supported interactions for the HC Healthcare Service profile. A HealthcareService resource conforming to the HC Healthcare Service profile describes a healthcare service offered at a location by a Health Connect Reader.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLlanguagesstring
SHALLhsbillingtoken
SHALLavailability-alldaytoken
SHALLavailability-daysofweektoken
SHALLavailability-starttimestring
SHALLavailability-endtimestring
SHALLservice-typetoken
 

Resource Conformance: supported PractitionerRole

Base System Profile
HC PractitionerRole
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section defines the supported interactions for the HC Practitioner Role profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the HC Practitioner Role profile describes a practitioner in a role at a healthcare service.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLlanguagesstring
SHALLavailability-alldaytoken
SHALLavailability-daysofweektoken
SHALLavailability-starttimestring
SHALLavailability-endtimestring
SHALLidentifiertoken
SHALLroletypestring
SHALLprntoken
 

Resource Conformance: supported Practitioner

Base System Profile
HC Practitioner
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports search-type.

Documentation

This section defines the supported interactions for the HC Practitioner profile of the Practitioner resource type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLregprofstring
SHALLrsgtoken
SHALLgender-identitytoken
SHALLpractitionernamestring
SHALLpractitionerpreferrednamestring
SHALLprntoken
 

Resource Conformance: supported Endpoint

Base System Profile
HC Endpoint
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section defines the supported interactions for the HC Endpoint profile of the Endpoint resource type. Each Endpoint resource conforming the HC Endpoint profile is a read-only proxy for a corresponding Endpoint resource managed by the HC portal.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLepurluri
SHALLpayloadmimetypetoken
SHALLhcepistring
SHALLnamestring
SHALLconnection-typetoken
SHALLpayload-typetoken