Generated Narrative: CapabilityStatement health-connect-provider-directory-requester 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. Summary of System-wide Interactions Supports the search-systeminteraction described as follows: Definition: This operation is a RESTful search interaction (whole system interaction), across multiple resource types (as described in the FHIR specification). Behaviour: This operation is used by a client system operated by a Health Connect Provider Directory Requester to get resources that match the specified search parameters. . The following search parameters are supported: _lastUpdated is used to get the resources that have been added or changed since the requesting system last synchronised their local data store with Health Connect Provider Directory Requester. This search parameter supports the gt and lt comparison prefixes. _type is used to filter the resources returned by their resource type. The available types are: HealthcareService (returns resources conforming to the HCPD Healthcare Service profile) PractitionerRole (returns resources conforming to the HCPD Practitioner Role profile) Organization (returns resources conforming to the HCPD Organization profile) Location (returns resources conforming to the HCPD Location profile) Practitioner (returns resources conforming to the HCPD Practitioner profile) Provenance (returns resources conforming to the HCPD Provenance profile) All of the following query parameters are required in order to receive the complete set of resources that have been created, changed or published since [last_synchronized]: _lastUpdated=[last_synchronized] _type=HealthcareService,PractitionerRole,Practitioner,Organization,Location,Provenance _include=Location:organization _include=HealthcareService:organization _include=HealthcareService:location _include=PractitionerRole:organization _include=PractitionerRole:location _include=PractitionerRole:service _include=PractitionerRole:practitioner _include=Provenance:target _include:iterate=HealthcareService:organization _include:iterate=HealthcareService:location _include:iterate=PractitionerRole:organization _include:iterate=PractitionerRole:location _include:iterate=PractitionerRole:service _include:iterate=PractitionerRole:practitioner As described above the resources returned in the Bundle exclude any Identifiers (e.g. HPI-Is) that cannot be disclosed to the subscriber. This operation supports 'paging' (see FHIR specification). If there are too many resources to return in one Bundle, the FHIR server adds a next link to the response Bundle. The contents of the result Bundle therefore comprise all instances of the requested resource types whose lastUpdated timestamp is greater than the <lastSync> in the request query expression and less than or equal to <lastInBundle> where <lastInBundle> is the greatest lastUpdated value of all resources included in the result Bundle. The Subscriber Agent FHIR server sets the next link to the filter expression that was used in the original request except that <lastSync> is replaced with <lastInBundle>. If the next link is not present in the Bundle, then there are no more service offerings available. 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 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 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 HealthcareService:location, HealthcareService:organization, HealthcareService:endpoint 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 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, name, identifier-r5 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 HealthcareService:endpoint, Location:endpoint, PractitionerRole:endpoint, Provenance:target Resource Conformance: unspecified Provenance Base System Profile HCPD Provenanceversion: 26.0.0) Profile Conformance SHOULD 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 Conformance Parameter Type Documentation SHOULD target reference Resource Conformance: unspecified 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 by a Requester Actor for the HCPD Organization profile of the Organization resource type. Search Parameters Conformance Parameter Type Documentation SHOULD identifier token SHOULD name string SHOULD type token Resource Conformance: unspecified Location Base System Profile HCPD Locationversion: 26.0.0) Profile Conformance SHOULD 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 Conformance Parameter Type Documentation SHOULD locmailaddress string SHOULD locationamenities token SHOULD name string SHOULD address string SHOULD type token SHOULD locationphysicaltype token SHOULD near special Resource Conformance: unspecified HealthcareService Base System Profile HCPD HealthcareServiceversion: 26.0.0) Profile Conformance SHOULD 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 Conformance Parameter Type Documentation SHOULD languages token SHOULD hsbilling token SHOULD allday token SHOULD daysofweek token SHOULD starttime number SHOULD endtime number SHOULD service-type token Resource Conformance: unspecified PractitionerRole Base System Profile HCPD PractitionerRoleversion: 26.0.0) Profile Conformance SHOULD 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 SHOULD languages token SHOULD allday token SHOULD daysofweek token SHOULD starttime number SHOULD endtime number SHOULD identifier token SHOULD role token Resource Conformance: unspecified Practitioner 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 Conformance Parameter Type Documentation SHOULD identifier token SHOULD regprof string SHOULD rsg token SHOULD name string SHOULD identifier-r5 token Resource Conformance: unspecified Endpoint Base System Profile HCPD Endpointversion: 26.0.0) Profile Conformance SHOULD 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 Conformance Parameter Type Documentation SHOULD epurl uri SHOULD payloadmimetype token SHOULD hcepi token SHOULD name string SHOULD connection-type token SHOULD payload-type token
Health Connect Provider Directory Requester
This [CapabilityStatement](https://hl7.org/fhir/R4/capabilitystatement.html) resource defines the expected capabilities of the [Health Connect Provider Directory Requester Actor](ActorDefinition-requester-actor-health-connect.html) 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.
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/](https://creativecommons.org/licenses/by/4.0/)
All interactions SHOULD be secured using OAuth protocols. It SHOULD support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements.
This resource is used to track the provenance of data retrieved, updated, or verified from external systems of record for HC resources.
Read HCPD Provenance records to understand data lineage
Search for HCPD Provenance records by target resource
This section defines the supported interactions by a Requester Actor for the HCPD Organization profile of the Organization resource type.
This section introduces the supported interactions by a Requester Actor for the HCPD Location profile.
This section introduces the supported interactions by a Requester Actor for the [HCPD Healthcare Service](StructureDefinition-hcpd-healthcareservice.html) profile.
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 defines the supported interactions for the [HCPD Practitioner](StructureDefinition-hcpd-practitioner.html) profile of the Practitioner resource type.
This section defines the supported interactions for the [HCPD Endpoint](StructureDefinition-hcpd-endpoint.html) profile of the Endpoint resource type. Each Endpoint resource conforming to the [HCPD Endpoint](StructureDefinition-hcpd-endpoint.html) profile is a read-only proxy for a corresponding Endpoint resource published by the HCPD portal.
**Definition**: This operation is a RESTful *search* interaction (whole system interaction), across multiple resource types (as described in the [FHIR specification](https://www.hl7.org/fhir/http.html#search)). **Behaviour**: This operation is used by a client system operated by a Health Connect Provider Directory Requester to get resources that match the specified search parameters. . The following search parameters are supported: * *_lastUpdated* is used to get the resources that have been added or changed since the requesting system last synchronised their local data store with Health Connect Provider Directory Requester. This search parameter supports the ```gt``` and ```lt``` comparison prefixes. * *_type* is used to filter the resources returned by their resource type. The available types are: * ```HealthcareService``` (returns resources conforming to the [HCPD Healthcare Service](StructureDefinition-hcpd-healthcareservice.html) profile) * ```PractitionerRole``` (returns resources conforming to the [HCPD Practitioner Role](StructureDefinition-hcpd-practitionerrole.html) profile) * ```Organization``` (returns resources conforming to the [HCPD Organization](StructureDefinition-hcpd-organization.html) profile) * ```Location``` (returns resources conforming to the [HCPD Location](StructureDefinition-hcpd-location.html) profile) * ```Practitioner``` (returns resources conforming to the [HCPD Practitioner](StructureDefinition-hcpd-practitioner.html) profile) * ```Provenance``` (returns resources conforming to the [HCPD Provenance](StructureDefinition-hcpd-provenance.html) profile) All of the following query parameters are required in order to receive the complete set of resources that have been created, changed or published since *[last_synchronized]*: ``` _lastUpdated=[last_synchronized] ``` ```_type=HealthcareService,PractitionerRole,Practitioner,Organization,Location,Provenance ``` ```_include=Location:organization ``` ```_include=HealthcareService:organization ``` ```_include=HealthcareService:location ``` ```_include=PractitionerRole:organization ``` ```_include=PractitionerRole:location ``` ```_include=PractitionerRole:service ``` ```_include=PractitionerRole:practitioner ``` ```_include=Provenance:target ``` ```_include:iterate=HealthcareService:organization ``` ```_include:iterate=HealthcareService:location ``` ```_include:iterate=PractitionerRole:organization ``` ```_include:iterate=PractitionerRole:location ``` ```_include:iterate=PractitionerRole:service ``` ```_include:iterate=PractitionerRole:practitioner ``` As described above the resources returned in the Bundle exclude any *Identifiers* (e.g. HPI-Is) that cannot be disclosed to the subscriber. This operation supports 'paging' ([see FHIR specification](https://www.hl7.org/fhir/search.html#Paging)). If there are too many resources to return in one ```Bundle```, the FHIR server adds a *next* link to the response ```Bundle```. The contents of the result ```Bundle``` therefore comprise all instances of the requested resource types whose *lastUpdated* timestamp is greater than the \<lastSync\> in the request query expression and less than or equal to \<lastInBundle\> where \<lastInBundle\> is the greatest *lastUpdated* value of all resources included in the result ```Bundle```. The Subscriber Agent FHIR server sets the *next* link to the filter expression that was used in the original request except that \<lastSync\> is replaced with \<lastInBundle\>. If the *next* link is not present in the Bundle, then there are no more service offerings available.