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 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HCPD-Snapshot-26.0.0-SPARKED-Testing-20260708/ and changes regularly. See the Directory of published versions

CapabilityStatement: Health Connect Provider Directory Requester

Official URL: http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-provider-directory-requester Version: 26.0.0
Active as of 2026-03-31 Computable Name: HealthConnectProviderDirectoryRequester

Copyright/Legal: 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 Requester Actor when conforming to this implementation guide. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Health Connect Provider Directory Requester Actor are defined in this CapabilityStatement. The requirements of the Health Connect Provider Directory Requester actor may also be impacted by the rules of local jurisdictions or other contextual requirements.

Raw OpenAPI-Swagger Definition file | Download

Health Connect Provider Directory Requester

  • Implementation Guide Version: 26.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHOULD support xml
  • Published on: 2026-03-31
  • 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 SHOULD be secured using OAuth protocols. It SHOULD support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements.

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, type, active, suppressedOrganization:partOfLocation:organization, Provenance:target
Locationhttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0yylocmailaddress, locationamenities, name, address, type, locationphysicaltype, near, status, suppressedLocation:organization, Location:endpointHealthcareService:location, Provenance:target
HealthcareServicehttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice|26.0.0yylanguages, hsbilling, allday, daysofweek, starttime, endtime, service-type, active, suppressedHealthcareService:location, HealthcareService:organization, HealthcareService:endpointPractitionerRole:service, Provenance:target
PractitionerRolehttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole|26.0.0yylanguages, allday, daysofweek, starttime, endtime, identifier, role, active, suppressedPractitionerRole:practitioner, PractitionerRole:service, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:endpointProvenance:target
Practitionerhttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner|26.0.0yyidentifier, regprof, rsg, name, identifier-r5, active, suppressedPractitionerRole:practitioner, Provenance:target
Endpointhttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0yyepurl, payloadmimetype, hcepi, name, connection-type, payload-type, status, suppressedHealthcareService:endpoint, Location:endpoint, PractitionerRole:endpoint, Provenance:target
Base System Profile
HCPD Provenanceversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    Read HCPD Provenance records to understand data lineage

    search-type

    Search for HCPD Provenance records by target resource

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDtargetreference
 
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 by a Requester Actor for the HCPD Organization profile of the Organization resource type.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDidentifiertoken
SHOULDnamestring
SHOULDtypetoken
SHOULDactivetoken
SHOULDsuppressedtoken
 
Base System Profile
HCPD Locationversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section introduces the supported interactions by a Requester Actor for the HCPD Location profile.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDlocmailaddressstring
SHOULDlocationamenitiestoken
SHOULDnamestring
SHOULDaddressstring
SHOULDtypetoken
SHOULDlocationphysicaltypetoken
SHOULDnearspecial
SHOULDstatustoken
SHOULDsuppressedtoken
 
Base System Profile
HCPD HealthcareServiceversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

This section introduces the supported interactions by a Requester Actor for the HCPD Healthcare Service profile.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDlanguagestoken
SHOULDhsbillingtoken
SHOULDalldaytoken
SHOULDdaysofweektoken
SHOULDstarttimenumber
SHOULDendtimenumber
SHOULDservice-typetoken
SHOULDactivetoken
SHOULDsuppressedtoken
 
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
SHOULDlanguagestoken
SHOULDalldaytoken
SHOULDdaysofweektoken
SHOULDstarttimenumber
SHOULDendtimenumber
SHOULDidentifiertoken
SHOULDroletoken
SHOULDactivetoken
SHOULDsuppressedtoken
 
Base System Profile
HCPD Practitionerversion: 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 profile of the Practitioner resource type.

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDidentifiertoken
SHOULDregprofstring
SHOULDrsgtoken
SHOULDnamestring
SHOULDidentifier-r5token
SHOULDactivetoken
SHOULDsuppressedtoken
 
Base System Profile
HCPD Endpointversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read, search-type.

Documentation

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

Search Parameters
ConformanceParameterTypeDocumentation
SHOULDepurluri
SHOULDpayloadmimetypetoken
SHOULDhcepitoken
SHOULDnamestring
SHOULDconnection-typetoken
SHOULDpayload-typetoken
SHOULDstatustoken
SHOULDsuppressedtoken