# Health Connect Australia Provider Directory FHIR Implementation Guide

0.1.0-preview - Preview

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/steveswinsburg/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-system`interaction 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:

    - `HealthcareService` (returns resources conforming to the HC Healthcare Service profile)

    - `PractitionerRole` (returns resources conforming to the HC Practitioner Role profile)

    - `Organization` (returns resources conforming to the HC Organization profile)

    - `Location` (returns resources conforming to the HC Location profile)

    - `Practitioner` (returns resources conforming to the HC Practitioner profile)

    - `Provenance` (returns resources conforming to the HC Provenance profile)

  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 Type | Profile | R | S | U | C | Searches | `_include` | `_revinclude` | Operations
--- | --- | --- | --- | --- | --- | --- | --- | --- | ---
Provenance | http://ns.electronichealth.net.au/hc/StructureDefinition/hc-provenance | y | y |  |  |  |  |  |
Organization | http://ns.electronichealth.net.au/hc/StructureDefinition/hc-organization | y | y |  |  | identifier, name, type | `Organization:partOf` | `Location:organization`, `Provenance:target` |
Location | http://ns.electronichealth.net.au/hc/StructureDefinition/hc-location | y | y |  |  | postaladdress, locationamenities, name, address, type | `Location:endpoint` | `HealthcareService:location`, `Provenance:target` |
HealthcareService | http://ns.electronichealth.net.au/hc/StructureDefinition/hc-healthcareservice | y | y |  |  | languages, hsbilling, availability-allday, availability-daysofweek, availability-starttime, availability-endtime, service-type | `HealthcareService:location`, `HealthcareService:providedBy`, `HealthcareService:endpoint` | `PractitionerRole:healthcareService`, `Provenance:target` |
PractitionerRole | http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitionerrole | y | y |  |  | languages, availability-allday, availability-daysofweek, availability-starttime, availability-endtime, identifier, roletype, prn | `PractitionerRole:practitioner`, `PractitionerRole:healthcareService`, `PractitionerRole:organization`, `PractitionerRole:location`, `PractitionerRole:endpoint` | `Provenance:target` |
Practitioner | http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitioner |  | y |  |  | identifier, regprof, rsg, gender-identity, practitionername, practitionerpreferredname, prn |  | `PractitionerRole:practitioner`, `Provenance:target` |
Endpoint | http://ns.electronichealth.net.au/hc/StructureDefinition/hc-endpoint | y | y |  |  | epurl, payloadmimetype, hcepi, name, connection-type, payload-type |  | `HealthcareService: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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | identifier | `token` |
SHALL | name | `string` |
SHALL | type | `token` |

#### 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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | postaladdress | `string` |
SHALL | locationamenities | `token` |
SHALL | name | `string` |
SHALL | address | `string` |
SHALL | type | `token` |

#### 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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | languages | `string` |
SHALL | hsbilling | `token` |
SHALL | availability-allday | `token` |
SHALL | availability-daysofweek | `token` |
SHALL | availability-starttime | `string` |
SHALL | availability-endtime | `string` |
SHALL | service-type | `token` |

#### 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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | languages | `string` |
SHALL | availability-allday | `token` |
SHALL | availability-daysofweek | `token` |
SHALL | availability-starttime | `string` |
SHALL | availability-endtime | `string` |
SHALL | identifier | `token` |
SHALL | roletype | `string` |
SHALL | prn | `token` |

#### 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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | identifier | `token` |
SHALL | regprof | `string` |
SHALL | rsg | `token` |
SHALL | gender-identity | `token` |
SHALL | practitionername | `string` |
SHALL | practitionerpreferredname | `string` |
SHALL | prn | `token` |

#### 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

Conformance | Parameter | Type | Documentation
--- | --- | --- | ---
SHALL | epurl | `uri` |
SHALL | payloadmimetype | `token` |
SHALL | hcepi | `string` |
SHALL | name | `string` |
SHALL | connection-type | `token` |
SHALL | payload-type | `token` |