Generated Narrative: CapabilityStatement health-connect-provider-directory-responder Health Connect Provider Directory Responder Implementation Guide Version: 0.2.0-preview FHIR Version: 4.0.1 Supported Formats: SHALL support json, SHALL support xml Published on: 2025-11-27 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. 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|0.2.0-preview y y target Provenance:target Organization http://ns.electronichealth.net.au/hc/StructureDefinition/hc-organization|0.2.0-preview y y identifier, name, type Organization:partOf Location:organization, Provenance:target Location http://ns.electronichealth.net.au/hc/StructureDefinition/hc-location|0.2.0-preview y y locmailaddress, locationamenities, name, address, type, locationphysicaltype, near Location:managingOrganization, Location:endpoint HealthcareService:location, Provenance:target HealthcareService http://ns.electronichealth.net.au/hc/StructureDefinition/hc-healthcareservice|0.2.0-preview y y languages, hsbilling, allday, daysofweek, starttime, endtime, service-type HealthcareService:location, HealthcareService:providedBy, HealthcareService:endpoint PractitionerRole:healthcareService, Provenance:target PractitionerRole http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitionerrole|0.2.0-preview y y languages, allday, daysofweek, starttime, endtime, identifier, roletype PractitionerRole:practitioner, PractitionerRole:healthcareService, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:endpoint Provenance:target Practitioner http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitioner|0.2.0-preview y y identifier, regprof, rsg, genderIdentity, identifier-r5, name PractitionerRole:practitioner, Provenance:target Endpoint http://ns.electronichealth.net.au/hc/StructureDefinition/hc-endpoint|0.2.0-preview y y epurl, payloadmimetype, hcepi, name, connection-type, payload-type HealthcareService:endpoint, Location:endpoint, PractitionerRole:endpoint, Provenance:target Resource Conformance: SHALL Provenance Base System Profile HC Provenanceversion: 0.2.0-preview) 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 HC Organizationversion: 0.2.0-preview) 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: SHALL Location Base System Profile HC Locationversion: 0.2.0-preview) Profile Conformance SHALL Reference Policy Interaction summary Supports read, search-type. Documentation This section describes the supported interactions for the HC 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 Resource Conformance: SHALL HealthcareService Base System Profile HC HealthcareServiceversion: 0.2.0-preview) Profile Conformance SHALL Reference Policy Interaction summary Supports read, search-type. Documentation This section describes the supported interactions for the HC 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 string SHALL hsbilling token SHALL allday token SHALL daysofweek token SHALL starttime number SHALL endtime number SHALL service-type token Resource Conformance: SHALL PractitionerRole Base System Profile HC PractitionerRoleversion: 0.2.0-preview) 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 allday token SHALL daysofweek token SHALL starttime number SHALL endtime number SHALL identifier token SHALL roletype string Resource Conformance: SHALL Practitioner Base System Profile HC Practitionerversion: 0.2.0-preview) Profile Conformance SHALL Reference Policy Interaction summary Supports read, search-type. Documentation This section describes the supported interactions for the HC 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 genderIdentity token SHALL identifier-r5 token SHALL name string Resource Conformance: SHALL Endpoint Base System Profile HC Endpointversion: 0.2.0-preview) Profile Conformance SHALL Reference Policy Interaction summary Supports read, search-type. Documentation This section describes the supported interactions for the HC 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
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.
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/](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 [HC Organization](StructureDefinition-hc-organization.html) profile of the Organization resource type.
This section describes the supported interactions for the [HC Location](StructureDefinition-hc-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 [HC Healthcare Service](StructureDefinition-hc-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 [HC Practitioner Role](StructureDefinition-hc-practitionerrole.html) profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the [HC Practitioner Role](StructureDefinition-hc-practitionerrole.html) profile describes a practitioner in a role at a healthcare service.
This section describes the supported interactions for the [HC Practitioner](StructureDefinition-hc-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 [HC Endpoint](StructureDefinition-hc-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.