Health Connect Australia Provider Directory FHIR Implementation Guide - Local Development build (v26.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

CapabilityStatement: Health Connect Provider Directory Responder

Official URL: http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-provider-directory-responder Version: 26.0.0
Active as of 2026-04-29 Computable Name: HealthConnectProviderDirectoryResponder

Usage:Jurisdiction: Australia

Copyright/Legal: Copyright © 2026 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 Provider Directory Responder Actor when conforming to this implementation guide. The listed FHIR profiles, RESTful operations, and search parameters describe only those capabilities exposed for responding to Requester Actor requests. The Health Connect Provider Directory Responder supports additional internal and publishing operations that are not shown here; these are out of scope for this IG and are documented separately for publishing systems. The requirements of the Health Connect Provider Directory Responder may also be impacted by the rules of local jurisdictions or other contextual requirements.

Raw OpenAPI-Swagger Definition file | Download

Health Connect Provider Directory Responder

  • Implementation Guide Version: 26.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHALL support xml
  • Published on: 2026-04-29
  • 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: server

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 Operations
ConformanceOperationDocumentation
SHALL$export

This bulk data export operation expects request parameters conforming to the HCPD Export Request Parameters profile which defines the required parameter structure for _outputFormat, _type, _typeFilter, and optional _since parameters. The server returns URLs to ndjson files containing the requested resource types. When applicable, the server may automatically inject HCPD Export Response List resources into the output to indicate resource identifiers marked for removal from downstream client systems.

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://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-provenance|26.0.0yytargetProvenance:target
Organizationhttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0yyidentifier, name, typeOrganization:partOfLocation:organization, Provenance:target
Locationhttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0yylocmailaddress, locationamenities, name, address, type, locationphysicaltype, nearLocation:organization, Location:endpointHealthcareService:location, Provenance:target
HealthcareServicehttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice|26.0.0yylanguages, hsbilling, allday, daysofweek, starttime, endtime, service-typeHealthcareService:location, HealthcareService:organization, HealthcareService:endpoint, HealthcareService:organizationPractitionerRole:service, Provenance:target
PractitionerRolehttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole|26.0.0yylanguages, allday, daysofweek, starttime, endtime, identifier, rolePractitionerRole:practitioner, PractitionerRole:service, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:endpointProvenance:target
Practitionerhttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner|26.0.0yyidentifier, regprof, rsg, identifier-r5, namePractitionerRole:practitioner, Provenance:target
Endpointhttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0yyepurl, payloadmimetype, hcepi, name, connection-type, payload-typeHealthcareService:endpoint, Location:endpoint, PractitionerRole:endpoint, Provenance:target
Listhttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list|26.0.0y
Parametershttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0yyProvenance:target, Organization:partOf, Location:organization, Location:endpoint, HealthcareService:location, HealthcareService:organization, HealthcareService:endpoint, PractitionerRole:practitioner, PractitionerRole:service, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:endpointLocation:organization, Provenance:target, HealthcareService:location, PractitionerRole:service, PractitionerRole:practitioner, HealthcareService:endpoint, Location:endpoint, PractitionerRole:endpoint
Base System Profile
HCPD Provenanceversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    Read HC Provenance records

    search-type

    Search HC Provenance records by various parameters

Documentation

HC Provenance resources track the lineage of data retrieved, updated, or verified from external systems of record.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLtargetreference
 
Base System Profile
HCPD Organizationversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLnamestring
SHALLtypetoken
 
Base System Profile
HCPD Locationversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section describes the supported interactions for the HCPD Location profile. Each Location resource conforming to this profile identifies a physical or virtual place associated with healthcare services in the Health Connect Provider Directory, enabling clients to discover, filter, and reference service delivery sites.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLlocmailaddressstring
SHALLlocationamenitiestoken
SHALLnamestring
SHALLaddressstring
SHALLtypetoken
SHALLlocationphysicaltypetoken
SHALLnearspecial
 
Base System Profile
HCPD HealthcareServiceversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section describes the supported interactions for the HCPD Healthcare Service profile. Each HealthcareService resource conforming to this profile identifies a healthcare service in the Health Connect Provider Directory, enabling clients to discover, filter, and reference healthcare services that are provided.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLlanguagestoken
SHALLhsbillingtoken
SHALLalldaytoken
SHALLdaysofweektoken
SHALLstarttimenumber
SHALLendtimenumber
SHALLservice-typetoken
 
Base System Profile
HCPD PractitionerRoleversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHALLlanguagestoken
SHALLalldaytoken
SHALLdaysofweektoken
SHALLstarttimenumber
SHALLendtimenumber
SHALLidentifiertoken
SHALLroletoken
 
Base System Profile
HCPD Practitionerversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section describes the supported interactions for the HCPD Practitioner profile. Each Practitioner resource conforming to this profile represents an individual healthcare provider registered in the Health Connect Provider Directory, enabling clients to search, identify, and reference practitioners and their associated roles and service locations.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALLregprofstring
SHALLrsgtoken
SHALLidentifier-r5token
SHALLnamestring
 
Base System Profile
HCPD Endpointversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section describes the supported interactions for the HCPD Endpoint profile. Each Endpoint resource conforming to this profile provides connection details for electronic services available through the Health Connect Provider Directory, allowing clients to discover and interact with service endpoints in a standardised way.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLepurluri
SHALLpayloadmimetypetoken
SHALLhcepitoken
SHALLnamestring
SHALLconnection-typetoken
SHALLpayload-typetoken
 
Base System Profile
HCPD Export Response Listversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    Read access to HCPD Export Response List resources obtained through bulk export operations

Documentation

This resource declares support for the HCPD Export Response List profile. List resources conforming to this profile are automatically generated and included as part of bulk data export operations to communicate which resource identifiers should be removed from downstream client systems. These List resources are not directly searchable or accessible via standard FHIR REST operations, but are provided exclusively through the bulk export process.

Base System Profile
HCPD Export Request Parametersversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read
    search-type

    Process HCPD Export Request Parameters as input to bulk export operations

Documentation

This resource declares support for processing HCPD Export Request Parameters resources as input to bulk data export operations. Parameters resources conforming to this profile are used to control the scope, format, and filtering criteria for bulk exports. These resources are processed as part of the $export operation and are not directly stored or searchable.