health-connect-provider-directory-requester
type: CapabilityStatement
node role: treeRoot
id:
  v: health-connect-provider-directory-requester
text:
  status:
    v: extensions
  div:
    v: 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) P…
url:
  v: http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-provider-directory-requester
version:
  v: 26.0.0
name:
  v: HealthConnectProviderDirectoryRequester
title:
  v: Health Connect Provider Directory Requester
status:
  v: active
experimental:
  v: false
date:
  v: 2026-03-31
publisher:
  v: Australian Digital Health Agency
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: url
    value:
      v: https://www.digitalhealth.gov.au/
  telecom:
    system:
      v: email
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: email
    use:
      v: work
description:
  v: 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.
use context:
  code:
    system:
      v: http://terminology.hl7.org/CodeSystem/usage-context-type
    code:
      v: jurisdiction
  value: CodeableConcept
    coding:
      system:
        v: urn:iso:std:iso:3166
      code:
        v: AU
      display:
        v: Australia
copyright:
  v: 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/)
kind:
  v: requirements
fhir version:
  v: 4.0.1
format:
  v: json
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
format:
  v: xml
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
rest:
  mode:
    v: client
  security:
    description:
      v: All interactions SHOULD be secured using OAuth protocols. It SHOULD support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements.
  resource:
    type:
      v: Provenance
    profile:
      v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-provenance|26.0.0
      link: 26.0
      link: .0
      extension:
        value: code
    documentation:
      v: This resource is used to track the provenance of data retrieved, updated, or verified from external systems of record for HC resources.
    interaction:
      code:
        v: read
      documentation:
        v: Read HCPD Provenance records to understand data lineage
    interaction:
      code:
        v: search-type
      documentation:
        v: Search for HCPD Provenance records by target resource
    versioning:
      v: versioned
    read history:
      v: false
    search include:
      v: Provenance:target
    search param:
      extension:
        value: code
      name:
        v: target
      definition:
        v: http://hl7.org/fhir/SearchParameter/Provenance-target|4.0.1
        link: 4.0
        link: .1
      type:
        v: reference
  resource:
    type:
      v: Organization
    profile:
      v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0
      link: 26.0
      link: .0
      extension:
        value: code
    documentation:
      v: This section defines the supported interactions by a Requester Actor for the HCPD Organization profile of the Organization resource type.
    interaction:
      code:
        v: read
    interaction:
      code:
        v: search-type
    versioning:
      v: versioned
    search include:
      v: Organization:partOf
    search rev include:
      v: Location:organization
    search rev include:
      v: Provenance:target
    search param:
      extension:
        value: code
      name:
        v: identifier
      definition:
        v: http://hl7.org/fhir/SearchParameter/Organization-identifier|4.0.1
        link: 4.0
        link: .1
      type:
        v: token
    search param:
      extension:
        value: code
      name:
        v: name
      definition:
        v: http://hl7.org/fhir/SearchParameter/Organization-name|4.0.1
        link: 4.0
        link: .1
      type:
        v: string
    search param:
      extension:
        value: code
      name:
        v: type
      definition:
        v: http://hl7.org/fhir/SearchParameter/Organization-type|4.0.1
        link: 4.0
        link: .1
      type:
        v: token
  resource:
    type:
      v: Location
    profile:
      v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0
      link: 26.0
      link: .0
      extension:
        value: code
    documentation:
      v: This section introduces the supported interactions by a Requester Actor for the HCPD Location profile.
    interaction:
      code:
        v: read
    interaction:
      code:
        v: search-type
    versioning:
      v: versioned
    search include:
      v: Location:organization

v: OAuth

v: OAuth

code
v: SHOULD

code
v: SHOULD

code
v: SHALL

code
v: SHOULD

code
v: SHOULD

code
v: SHOULD

code
v: SHOULD

v: Location:endpoint

v: HealthcareService:location

v: Provenance:target

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: locmailaddress
definition:
  v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-locmailaddress|26.0.0
  link: 26.0
  link: .0
type:
  v: string

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: locationamenities
definition:
  v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-amenities|26.0.0
  link: 26.0
  link: .0
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: name
definition:
  v: http://hl7.org/fhir/SearchParameter/Location-name|4.0.1
  link: 4.0
  link: .1
type:
  v: string

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: address
definition:
  v: http://hl7.org/fhir/SearchParameter/Location-address|4.0.1
  link: 4.0
  link: .1
type:
  v: string

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: type
definition:
  v: http://hl7.org/fhir/SearchParameter/Location-type|4.0.1
  link: 4.0
  link: .1
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: locationphysicaltype
definition:
  v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-physicaltype|26.0.0
  link: 26.0
  link: .0
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: near
definition:
  v: http://hl7.org/fhir/SearchParameter/Location-near|4.0.1
  link: 4.0
  link: .1
type:
  v: special

type:
  v: HealthcareService
profile:
  v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice|26.0.0
  link: 26.0
  link: .0
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
documentation:
  v: This section introduces the supported interactions by a Requester Actor for the [HCPD Healthcare Service](StructureDefinition-hcpd-healthcareservice.html) profile.
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
search include:
  v: HealthcareService:location
search include:
  v: HealthcareService:organization
search include:
  v: HealthcareService:endpoint
search rev include:
  v: PractitionerRole:service
search rev include:
  v: Provenance:target
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: languages
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/languages|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: hsbilling
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/healthcareservice-billing|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: allday
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/allday|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: daysofweek
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/daysofweek|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: starttime
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/starttime|26.0.0
    link: 26.0
    link: .0
  type:
    v: number
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: endtime
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endtime|26.0.0
    link: 26.0
    link: .0
  type:
    v: number
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: service-type
  definition:
    v: http://hl7.org/fhir/SearchParameter/HealthcareService-service-type|4.0.1
    link: 4.0
    link: .1
  type:
    v: token

type:
  v: PractitionerRole
profile:
  v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole|26.0.0
  link: 26.0
  link: .0
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
documentation:
  v: 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.
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
search include:
  v: PractitionerRole:practitioner
search include:
  v: PractitionerRole:service
search include:
  v: PractitionerRole:organization
search include:
  v: PractitionerRole:location
search include:
  v: PractitionerRole:endpoint
search rev include:
  v: Provenance:target
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: languages
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/languages|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: allday
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/allday|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: daysofweek
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/daysofweek|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: starttime
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/starttime|26.0.0
    link: 26.0
    link: .0
  type:
    v: number
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: endtime
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endtime|26.0.0
    link: 26.0
    link: .0
  type:
    v: number
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier|4.0.1
    link: 4.0
    link: .1
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: role
  definition:
    v: http://hl7.org/fhir/SearchParameter/PractitionerRole-role|4.0.1
    link: 4.0
    link: .1
  type:
    v: token

type:
  v: Practitioner
profile:
  v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner|26.0.0
  link: 26.0
  link: .0
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHALL
documentation:
  v: This section defines the supported interactions for the [HCPD Practitioner](StructureDefinition-hcpd-practitioner.html) profile of the Practitioner resource type.
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
search rev include:
  v: PractitionerRole:practitioner
search rev include:
  v: Provenance:target
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: identifier
  definition:
    v: http://hl7.org/fhir/SearchParameter/Practitioner-identifier|4.0.1
    link: 4.0
    link: .1
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: regprof
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-regprof|26.0.0
    link: 26.0
    link: .0
  type:
    v: string
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: rsg
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-rsg|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: name
  definition:
    v: http://hl7.org/fhir/SearchParameter/Practitioner-name|4.0.1
    link: 4.0
    link: .1
  type:
    v: string
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: identifier-r5
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-identifier-r5|26.0.0
    link: 26.0
    link: .0
  type:
    v: token

type:
  v: Endpoint
profile:
  v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0
  link: 26.0
  link: .0
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
documentation:
  v: 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.
interaction:
  code:
    v: read
interaction:
  code:
    v: search-type
versioning:
  v: versioned
search rev include:
  v: HealthcareService:endpoint
search rev include:
  v: Location:endpoint
search rev include:
  v: PractitionerRole:endpoint
search rev include:
  v: Provenance:target
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: epurl
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-url|26.0.0
    link: 26.0
    link: .0
  type:
    v: uri
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: payloadmimetype
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-payloadmimetype|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: hcepi
  definition:
    v: http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-hcepi|26.0.0
    link: 26.0
    link: .0
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: name
  definition:
    v: http://hl7.org/fhir/SearchParameter/Endpoint-name|4.0.1
    link: 4.0
    link: .1
  type:
    v: string
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: connection-type
  definition:
    v: http://hl7.org/fhir/SearchParameter/Endpoint-connection-type|4.0.1
    link: 4.0
    link: .1
  type:
    v: token
search param:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    value: code
      v: SHOULD
  name:
    v: payload-type
  definition:
    v: http://hl7.org/fhir/SearchParameter/Endpoint-payload-type|4.0.1
    link: 4.0
    link: .1
  type:
    v: token

code:
  v: search-system
documentation:
  v: **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 `…

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: _lastUpdated
definition:
  v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated|4.0.1
  link: 4.0
  link: .1
type:
  v: date

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: _type
type:
  v: token

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: _include
type:
  v: special

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
  value: code
    v: SHOULD
name:
  v: _resultId
type:
  v: special