# 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

## Home

Official URL: http://ns.electronichealth.net.au/hc/ImplementationGuide/au.digitalhealth.r4.healthconnect | Version: 0.1.0-preview
IG Standards status: Draft | Computable Name: HealthConnectAustraliaProviderDirectoryFHIRImplementationGuide
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/

# Health Connect FHIR ImplementationGuide

> This material is under active development and content may be added or updated on a regular basis.

ADHA review feedback

We welcome your feedback on this implementation guide.

To contribute directly to this implementation guide with code changes or documentation updates, please fork the repository and submit a pull request.

For technical FHIR-related comments, implementation feedback, or suggestions for profile improvements, you can create a GitHub issue.

For feedback concerning design considerations, business requirements, or broader implementation strategy, please contact the Clininical Informatics team.

### Introduction

Health Connect Australia is a national health information exchange program designed to enable the sharing of health information between healthcare participants quickly and securely. By integrating advanced digital infrastructure, standards, privacy protections and enabling real-time data sharing, Health Connect Australia will support multidisciplinary collaboration across care settings. As a key enabler of the National Digital Health Strategy 2023–2028 and the National Healthcare Interoperability Plan 2023-2028, it ensures secure, connected digital solutions that improve access, efficiency and care quality—paving the way for a smarter, more integrated future in digital health. The program is being delivered in phases, beginning with foundational capabilities and expanding to support secure communication, record discovery, and value-added services for both providers and consumers.

The Directory and Authorisation Service Project is the first initiative under the Foundations phase. It enables healthcare providers to discover accurate, up-to-date information about other providers and the services they offer, while establishing a trust framework to support consistent and secure access to health information. By connecting provider data from multiple primary sources through a single access point and ensuring near real-time updates, the project lays the groundwork for broader interoperability and trusted information exchange across the national health ecosystem.

One of the key objectives of the Directory and Authorisation Service Project is to enable interoperability through contemporary standards—such as FHIR APIs—to ensure seamless integration across clinical and administrative systems. To support this, the project is establishing a centralised directory hosted on a FHIR repository, where provider and organisation data will be structured using HL7® FHIR® and terminology standards. To guide consistent implementation and promote national alignment, the project is developing a FHIR Implementation Guide that defines how provider information should be represented and exchanged. This guide will build on existing standards, including the HL7 Australia Provider Directory FHIR IG, and provide a clear reference for integrators and system vendors to support secure, scalable, and standards-compliant access to directory data.

### How to read this guide

This guide is divided into several pages which are listed at the top of each page in the menu bar.

- Home: This page provides the introduction and scope for the implementation guide.
- FHIR Artefacts: These pages provide detailed descriptions and formal definitions for all the FHIR artefacts defined in this guide.
  - Profiles and Extensions: This page lists the FHIR profiles and extensions that are defined in this guide.
  - Terminology: This page lists the FHIR terminology that are defined in this guide.
  - Search Parameters: This page lists the FHIR search parameters that are defined in this guide.
  - Capability Statements: This page defines the expected FHIR capabilities of Health Connect Reader.
  - Actor Definitions: This page defines the Health Connect actors, Health Connect Reader.
- Conformance: This page describes the set of rules to claim conformance to this guide including Capability Statements and Actor definitions.
- Examples: This page lists the sample instances of FHIR resources conforming to the FHIR profiles.
- Disclaimers: This page lists the licensing, copyright, and disclaimers under which this guide is issued.
- Downloads: This page provides links to downloadable artefacts including the Agency FHIR NPM package.

### Document purpose and scope

The primary aim of this implementation guide is to support implementers integrating with the Directory services using FHIR, Release 4 (v4.0.1) [HL7FHIR4]. It provides the technical specifications, FHIR profiles, and terminology definitions required for healthcare provider data exchange through Health Connect APIs.

This document describes specific system behaviours such as obligations, API HTTP response codes, and search parameters. Other system behavioural requirements such as the presentation of information and user experience are managed separately and must be met before systems can be assessed for conformance and granted access to Health Connect APIs.

Reference has been made to International and Australian Standards, and to Standards from HL7. The following standards are referred to in the text in such a way that some or all of its content constitutes requirements for the purposes of this specification:

- FHIR, Release 4 (v4.0.1) [HL7FHIR4]
- Australian Base Profiles Implementation Guide [HL7AUBIG]
- Australian Core Profiles Implementation Guide [HL7AUCIG]

Wherever possible, material in this specification is based on existing standards. All efforts have been made to minimise divergence from the HL7 Australia profiles of HL7 International standards (Australian Core Profiles Implementation Guide [HL7AUCIG] and Australian Base Profiles Implementation Guide [HL7AUBIG]) to provide for system interoperability and compatibility with other profiles. Issues of an editorial nature in the source material (such as spelling or punctuation errors) are intentionally reproduced. For a list of known issues (see below).

### Intended audience

This implementation guide is aimed at software development teams, architects, and designers that integrate with the Health Connect service.

This implementation guide and related artefacts are technical in nature and the audience is expected to be familiar with the language of health data specifications and to have some familiarity with health information standards and specifications, such as FHIR.

### Relationships with other work

This implementation guide builds on other specifications, helping ensure a consistent approach to data sharing that should ease adoption. The specific guides used, and the portions relevant from each of them are as follows:

IG | Package | FHIR | Comment
--- | --- | --- | ---
Health Connect Australia Provider Directory FHIR Implementation Guide | au.digitalhealth.r4.healthconnect#0.1.0-preview | R4 |
HL7 Terminology (THO) | hl7.terminology.r4#7.0.0 | R4 | Automatically added as a dependency - all IGs depend on HL7 Terminology
FHIR Extensions Pack | hl7.fhir.uv.extensions.r4#5.2.0 | R4 | Automatically added as a dependency - all IGs depend on the HL7 Extension Pack
AU Core Implementation Guide | hl7.fhir.au.core#2.0.0-ballot | R4 |
AU Base Implementation Guide | hl7.fhir.au.base#6.0.0-ballot | R4 |
FHIR Tooling Extensions IG | hl7.fhir.uv.tools.r4#0.8.0 | R4 | for example references

### Cross version analysis

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (au.digitalhealth.r4.healthconnect.r4) and R4B (au.digitalhealth.r4.healthconnect.r4b) are available.

### Global profiles

There are no Global profiles defined

### Data model overview

The Health Connect Australia Provider Directory uses FHIR resources to represent healthcare providers, their roles, organisational affiliations, service locations, and the healthcare services they provide. The diagram below illustrates the key relationships between these FHIR resources:

- Practitioner - Individual healthcare providers with their professional qualifications and identifiers
- Organization - Healthcare organisations and facilities that employ or affiliate with practitioners
- HealthcareService - Specific services offered by organisations at locations
- Location - Physical or virtual locations where healthcare services are delivered
- Endpoint - Technical endpoints for digital service integration and communication

This model supports complex healthcare delivery scenarios while maintaining FHIR R4 compliance and enabling efficient provider directory searches and integrations.

### Intellectual property considerations

This implementation guide and the underlying FHIR specification are licensed as public domain under the FHIR license. The license page also describes rules for the use of the FHIR name and logo.

This publication includes IP covered under the following statements.

- Copyright © 2018 Australian Digital Health Agency - All rights reserved. Except for the material identified below, this content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/.This resource includes material that is based on Australian Institute of Health and Welfare material.All copies of this resource must include this copyright statement and all information contained in this statement.
  Show Usage
  - Australian States and Territories: HCServiceCoverageArea
- 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/
  Show Usage
  - HC Amenity CodeSystem: HCAmenity, HCAmenityVs and Physical location with wheelchair access
  - HC Australian Endpoint Payload Types: AustralianEndpointPayloadTypesValueSet, HCEndpoint and Sydney General Hospital SMD Endpoint
  - HC IAR Levels of Care CodeSystem: HcIarLevelsOfCareExtension, HcIarLevelsOfCareVs and Healthcare service with Residential Aged Care service type
  - HC Organization Classification CodeSystem: Example Aged Care Facility, HCHSPOIdentifier, HcOrgClassVS and HcOrgClassification
  - HC Australian Service Interfaces: HCEndpoint and HCServiceInterfacesValueSet
- 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/.
  Show Usage
  - HC Service Provision Code: HCHealthcareService and HCServiceProvisionCodeValueSet
- HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.
  Show Usage
  - Location Type AU: HCLocation, HcServiceDeliveryLocationRoleType and Virtual Telehealth Service
  - Service Provision Conditions Australian Concepts: HCHealthcareService, HCServiceProvisionCodeValueSet and Healthcare service with Residential Aged Care service type
  - IdentifierType AU: Example Aged Care Facility, HCHPIOIdentifier... Show 4 more, Physical location with wheelchair access, Practitioner/example-healthconnect-practitioner-1, PractitionerRole/example-healthconnect-practitionerrole-1 and Virtual Telehealth Service
- ISO maintains the copyright on the country codes, and controls its use carefully. For further details see the ISO 3166 web page: https://www.iso.org/iso-3166-country-codes.html
  Show Usage
  - ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code: AustralianEndpointPayloadTypesCodeSystem, AustralianEndpointPayloadTypesValueSet... Show 57 more, HCAcceptNewPatient, HCAmenity, HCAmenityCs, HCAmenityVs, HCEndpoint, HCEndpointIdentifier, HCGenderIdentityVs, HCHPIOIdentifier, HCHSPOIdentifier, HCHealthcareService, HCLocation, HCOrganization, HCPractitioner, HCPractitionerRole, HCPreferredPostalAddress, HCProfessionalRegistrationNumber, HCProvenance, HCSMDTargetIdentifier, HCServiceCoverageArea, HCServiceEligibilityCodeSystem, HCServiceEligibilityValueSet, HCServiceInterfaceCodeSystem, HCServiceInterfacesValueSet, HCServiceProvisionCodeCodeSystem, HCServiceProvisionCodeValueSet, HcActivePeriod, HcIarLevelsOfCareCs, HcIarLevelsOfCareExtension, HcIarLevelsOfCareVs, HcOrgClassCS, HcOrgClassVS, HcOrgClassification, HcPractitionerRoleCommunication, HcPreferredName, HcReferralInformationForReferrer, HcServiceDeliveryLocationRoleType, HealthConnectAustraliaProviderDirectoryFHIRImplementationGuide, HealthConnectReader, PCAHealthcareServiceIdentifier, ReaderActorHealthConnect, SearchParameterAvailabilityAllDay, SearchParameterAvailabilityDaysOfWeek, SearchParameterAvailabilityEndTime, SearchParameterAvailabilityStartTime, SearchParameterEndpointIdentifierHC, SearchParameterEndpointPayloadMimeType, SearchParameterEndpointUrl, SearchParameterHealthcareServiceBilling, SearchParameterLanguages, SearchParameterLocationAmenities, SearchParameterLocationPostalAddress, SearchParameterPractitionerOfficialName, SearchParameterPractitionerPreferredname, SearchParameterPractitionerRSG, SearchParameterPractitionerRegProf, SearchParameterPractitionerRoleType and SearchParameterProfessionalRegistrationNumber
- This code system is a clone of the PCA Service Eligibility CodeSystem. Copyright © Australian Digital Health Agency.
  Show Usage
  - HC Service Eligibility CodeSystem: HCHealthcareService, HCServiceEligibilityValueSet and Healthcare service with Residential Aged Care service type
- This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  - SNOMED Clinical Terms&reg; (SNOMED CT&reg;): HCHealthcareService, Healthcare service with Residential Aged Care service type, Practitioner/example-healthconnect-practitioner-1, Practitioner/external-hc-practitioner-record and PractitionerRole/example-healthconnect-practitionerrole-1
- This material derives from the HL7 Terminology (THO). THO is copyright ©1989+ Health Level Seven International and is made available under the CC0 designation. For more licensing information see: https://terminology.hl7.org/license.html
  Show Usage
  - UsageContextType: AustralianEndpointPayloadTypesCodeSystem, AustralianEndpointPayloadTypesValueSet... Show 57 more, HCAcceptNewPatient, HCAmenity, HCAmenityCs, HCAmenityVs, HCEndpoint, HCEndpointIdentifier, HCGenderIdentityVs, HCHPIOIdentifier, HCHSPOIdentifier, HCHealthcareService, HCLocation, HCOrganization, HCPractitioner, HCPractitionerRole, HCPreferredPostalAddress, HCProfessionalRegistrationNumber, HCProvenance, HCSMDTargetIdentifier, HCServiceCoverageArea, HCServiceEligibilityCodeSystem, HCServiceEligibilityValueSet, HCServiceInterfaceCodeSystem, HCServiceInterfacesValueSet, HCServiceProvisionCodeCodeSystem, HCServiceProvisionCodeValueSet, HcActivePeriod, HcIarLevelsOfCareCs, HcIarLevelsOfCareExtension, HcIarLevelsOfCareVs, HcOrgClassCS, HcOrgClassVS, HcOrgClassification, HcPractitionerRoleCommunication, HcPreferredName, HcReferralInformationForReferrer, HcServiceDeliveryLocationRoleType, HealthConnectAustraliaProviderDirectoryFHIRImplementationGuide, HealthConnectReader, PCAHealthcareServiceIdentifier, ReaderActorHealthConnect, SearchParameterAvailabilityAllDay, SearchParameterAvailabilityDaysOfWeek, SearchParameterAvailabilityEndTime, SearchParameterAvailabilityStartTime, SearchParameterEndpointIdentifierHC, SearchParameterEndpointPayloadMimeType, SearchParameterEndpointUrl, SearchParameterHealthcareServiceBilling, SearchParameterLanguages, SearchParameterLocationAmenities, SearchParameterLocationPostalAddress, SearchParameterPractitionerOfficialName, SearchParameterPractitionerPreferredname, SearchParameterPractitionerRSG, SearchParameterPractitionerRegProf, SearchParameterPractitionerRoleType and SearchParameterProfessionalRegistrationNumber
  - identifierType: HCEndpointIdentifier, HCHSPOIdentifier... Show 4 more, HCProfessionalRegistrationNumber, Practitioner/example-healthconnect-practitioner-1, Practitioner/external-hc-practitioner-record and Sydney General Hospital SMD Endpoint
  - ActCode: HCProvenance
  - DataOperation: HCProvenance, Provenance/provenance-practitioner-name-update and Provenance/provenance-practitioner-phone-update
  - DocumentCompletion: HCProvenance
  - NullFlavor: HCGenderIdentityVs and HCPractitioner
  - ParticipationType: HCProvenance
  - RoleCode: HCLocation, HcServiceDeliveryLocationRoleType and Physical location with wheelchair access

### Known issues

This table lists known issues with this specification at the time of publishing. We are working on solutions to these issues and encourage comments to help us develop these solutions.

Reference | Description
--- | ---
Example system URI | An inherited example system (e.g. `http://www.acme.com/identifiers/patient`) erroneously infers patient context. Implementers must use their own namespace URIs. The affected identifier profile is Endpoint (HC-EPI) — this profile includes the erroneous example `system` in their documentation.

### References

[HL7AUBIG] | HL7 Australia, FHIR R4 standard for AU Base Implementation Guide, v6.0.0-ballot (Ballot)
| https://hl7.org.au/fhir/6.0.0-ballot/index.html

[HL7FHIR4] | Health Level Seven, Inc., 30 October 2019, FHIR R4.
| http://hl7.org/fhir/R4/

[HL7AUCIG] | HL7 Australia, FHIR R4 standard for AU Core Implementation Guide, v2.0.0-ballot - Ballot (Ballot)
| https://hl7.org.au/fhir/core/2.0.0-ballot/index.html