Generated Narrative: CapabilityStatement health-connect-provider-directory-responder 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 Conformance Operation Documentation 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. Bulk data extraction returns all resources regardless of active status or suppression; implementers SHALL respect the suppressed and deactivated-by extensions on returned resources, filtering these resources before displaying them to end consumers. 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://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-provenance|26.0.0 y y target Provenance:target Organization http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0 y y identifier, name, type, active, suppressed Organization:partOf Location:organization, Provenance:target Location http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0 y y locmailaddress, locationamenities, name, address, type, locationphysicaltype, near, status, suppressed Location:organization, Location:endpoint HealthcareService:location, Provenance:target HealthcareService http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice|26.0.0 y y languages, hsbilling, allday, daysofweek, starttime, endtime, service-type, active, suppressed HealthcareService:location, HealthcareService:organization, HealthcareService:endpoint, HealthcareService:organization PractitionerRole:service, Provenance:target PractitionerRole http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole|26.0.0 y y languages, allday, daysofweek, starttime, endtime, identifier, role, active, suppressed PractitionerRole:practitioner, PractitionerRole:service, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:endpoint Provenance:target Practitioner http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner|26.0.0 y y identifier, regprof, rsg, identifier-r5, name, active, suppressed PractitionerRole:practitioner, Provenance:target Endpoint http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0 y y epurl, payloadmimetype, hcepi, name, connection-type, payload-type, status, suppressed HealthcareService:endpoint, Location:endpoint, PractitionerRole:endpoint, Provenance:target Parameters http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0 y y Provenance:target, Organization:partOf, Location:organization, Location:endpoint, HealthcareService:location, HealthcareService:organization, HealthcareService:endpoint, PractitionerRole:practitioner, PractitionerRole:service, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:endpoint Location:organization, Provenance:target, HealthcareService:location, PractitionerRole:service, PractitionerRole:practitioner, HealthcareService:endpoint, Location:endpoint, PractitionerRole:endpoint Resource Conformance: SHALL Provenance 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 Conformance Parameter Type Documentation SHALL target reference Resource Conformance: SHALL Organization 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 Conformance Parameter Type Documentation SHALL identifier token SHALL name string SHALL type token SHALL active token SHALL suppressed token Resource Conformance: SHALL Location 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 Conformance Parameter Type Documentation SHALL locmailaddress string SHALL locationamenities token SHALL name string SHALL address string SHALL type token SHALL locationphysicaltype token SHALL near special SHALL status token SHALL suppressed token Resource Conformance: SHALL HealthcareService 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 Conformance Parameter Type Documentation SHALL languages token SHALL hsbilling token SHALL allday token SHALL daysofweek token SHALL starttime number SHALL endtime number SHALL service-type token SHALL active token SHALL suppressed token Resource Conformance: SHALL PractitionerRole 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 Conformance Parameter Type Documentation SHALL languages token SHALL allday token SHALL daysofweek token SHALL starttime number SHALL endtime number SHALL identifier token SHALL role token SHALL active token SHALL suppressed token Resource Conformance: SHALL Practitioner 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 Conformance Parameter Type Documentation SHALL identifier token SHALL regprof string SHALL rsg token SHALL identifier-r5 token SHALL name string SHALL active token SHALL suppressed token Resource Conformance: SHALL Endpoint 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 Conformance Parameter Type Documentation SHALL epurl uri SHALL payloadmimetype token SHALL hcepi token SHALL name string SHALL connection-type token SHALL payload-type token SHALL status token SHALL suppressed token Resource Conformance: SHALL Parameters 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.
Health Connect Provider Directory Responder
This CapabilityStatement resource defines the expected capabilities of the [Health Connect Provider Directory Responder Actor](ActorDefinition-responder-actor-health-connect.html) 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.
This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)
Health Connect Provider Directory Responder FHIR Server
All interactions SHALL be secured using OAuth protocols. It SHALL support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements.
HC Provenance resources track the lineage of data retrieved, updated, or verified from external systems of record.
Search HC Provenance records by various parameters
This section defines the supported interactions for the [HCPD Organization](StructureDefinition-hcpd-organization.html) profile of the Organization resource type.
This section describes the supported interactions for the [HCPD Location](StructureDefinition-hcpd-location.html) 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.
This section describes the supported interactions for the [HCPD Healthcare Service](StructureDefinition-hcpd-healthcareservice.html) 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.
This section defines the supported interactions for the [HCPD Practitioner Role](StructureDefinition-hcpd-practitionerrole.html) profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the [HCPD Practitioner Role](StructureDefinition-hcpd-practitionerrole.html) profile describes a practitioner in a role at a healthcare service.
This section describes the supported interactions for the [HCPD Practitioner](StructureDefinition-hcpd-practitioner.html) 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.
This section describes the supported interactions for the [HCPD Endpoint](StructureDefinition-hcpd-endpoint.html) 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.
This resource declares support for processing [HCPD Export Request Parameters](StructureDefinition-hcpd-export-request-parameters.html) 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.
Process HCPD Export Request Parameters as input to bulk export operations
This bulk data export operation expects request parameters conforming to the [HCPD Export Request Parameters](StructureDefinition-hcpd-export-request-parameters.html) 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. Bulk data extraction returns all resources regardless of active status or suppression; implementers SHALL respect the suppressed and deactivated-by extensions on returned resources, filtering these resources before displaying them to end consumers.