Health Connect Australia Provider Directory FHIR Implementation Guide
0.2.0-preview - Preview
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 0.2.0-preview built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HealthConnect/ and changes regularly. See the Directory of published versions
| Page standards status: Draft |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="health-connect-provider-directory-responder"/>
<text>
<status value="extensions"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement health-connect-provider-directory-responder</b></p><a name="health-connect-provider-directory-responder"> </a><a name="hchealth-connect-provider-directory-responder"> </a><h2 id="title">Health Connect Provider Directory Responder</h2><ul><li>Implementation Guide Version: 0.2.0-preview </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <strong>SHALL</strong> support <code>json</code>, <strong>SHALL</strong> support <code>xml</code></li><li>Published on: 2025-11-27 </li><li>Published by: Australian Digital Health Agency </li></ul><blockquote class="impl-note"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><h2 id="rest">FHIR RESTful Capabilities</h2><div class="panel panel-default"><div class="panel-heading"><h3 id="mode1" class="panel-title">Mode: <code>server</code></h3></div><div class="panel-body"><div class="lead"><em>Security</em></div><div class="row"><div class="col-lg-6">Enable CORS: no</div><div class="col-lg-6">Security services supported: <code>OAuth</code></div></div><blockquote><div><p>All interactions SHALL be secured using OAuth protocols. It SHALL support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements.</p>
</div></blockquote></div></div><h3 id="resourcesCap1">Capabilities by Resource/Profile</h3><h4 id="resourcesSummary1">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class="bg-info">R</span></b>ead, <b><span class="bg-info">S</span></b>earch, <b><span class="bg-info">U</span></b>pdate, and <b><span class="bg-info">C</span></b>reate, are always shown, while <b><span class="bg-info">VR</span></b>ead, <b><span class="bg-info">P</span></b>atch, <b><span class="bg-info">D</span></b>elete, <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">I</span></b>nstance, or <b><span class="bg-info">H</span></b>istory on <b><span class="bg-info">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class="table-responsive"><table class="table table-condensed table-hover"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class="text-center"><b title="GET a resource (read interaction)">R</b></th><th class="text-center"><b title="GET all set of resources of the type (search interaction)">S</b></th><th class="text-center"><b title="PUT a new resource version (update interaction)">U</b></th><th class="text-center"><b title="POST a new resource (create interaction)">C</b></th><th><b title="Required and recommended search parameters">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href="#Provenance1-1">Provenance</a></td><td><a href="StructureDefinition-hc-provenance.html">http://ns.electronichealth.net.au/hc/StructureDefinition/hc-provenance|0.2.0-preview</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>target</td><td><code>Provenance:target</code></td><td/><td/></tr><tr><td><a href="#Organization1-2">Organization</a></td><td><a href="StructureDefinition-hc-organization.html">http://ns.electronichealth.net.au/hc/StructureDefinition/hc-organization|0.2.0-preview</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>identifier, name, type</td><td><code>Organization:partOf</code></td><td><code>Location:organization</code>, <code>Provenance:target</code></td><td/></tr><tr><td><a href="#Location1-3">Location</a></td><td><a href="StructureDefinition-hc-location.html">http://ns.electronichealth.net.au/hc/StructureDefinition/hc-location|0.2.0-preview</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>locmailaddress, locationamenities, name, address, type, locationphysicaltype, near</td><td><code>Location:managingOrganization</code>, <code>Location:endpoint</code></td><td><code>HealthcareService:location</code>, <code>Provenance:target</code></td><td/></tr><tr><td><a href="#HealthcareService1-4">HealthcareService</a></td><td><a href="StructureDefinition-hc-healthcareservice.html">http://ns.electronichealth.net.au/hc/StructureDefinition/hc-healthcareservice|0.2.0-preview</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>languages, hsbilling, allday, daysofweek, starttime, endtime, service-type</td><td><code>HealthcareService:location</code>, <code>HealthcareService:providedBy</code>, <code>HealthcareService:endpoint</code></td><td><code>PractitionerRole:healthcareService</code>, <code>Provenance:target</code></td><td/></tr><tr><td><a href="#PractitionerRole1-5">PractitionerRole</a></td><td><a href="StructureDefinition-hc-practitionerrole.html">http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitionerrole|0.2.0-preview</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>languages, allday, daysofweek, starttime, endtime, identifier, roletype</td><td><code>PractitionerRole:practitioner</code>, <code>PractitionerRole:healthcareService</code>, <code>PractitionerRole:organization</code>, <code>PractitionerRole:location</code>, <code>PractitionerRole:endpoint</code></td><td><code>Provenance:target</code></td><td/></tr><tr><td><a href="#Practitioner1-6">Practitioner</a></td><td><a href="StructureDefinition-hc-practitioner.html">http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitioner|0.2.0-preview</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>identifier, regprof, rsg, genderIdentity, identifier-r5, name</td><td/><td><code>PractitionerRole:practitioner</code>, <code>Provenance:target</code></td><td/></tr><tr><td><a href="#Endpoint1-7">Endpoint</a></td><td><a href="StructureDefinition-hc-endpoint.html">http://ns.electronichealth.net.au/hc/StructureDefinition/hc-endpoint|0.2.0-preview</a></td><td class="text-center">y</td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td>epurl, payloadmimetype, hcepi, name, connection-type, payload-type</td><td/><td><code>HealthcareService:endpoint</code>, <code>Location:endpoint</code>, <code>PractitionerRole:endpoint</code>, <code>Provenance:target</code></td><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Provenance1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Provenance</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-hc-provenance.html">HC Provenanceversion: 0.2.0-preview)</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <br/><code>read</code><div><p>Read HC Provenance records</p>
</div><code>search-type</code><div><p>Search HC Provenance records by various parameters</p>
</div></li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>HC Provenance resources track the lineage of data retrieved, updated, or verified from external systems of record.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/provenance.html#search">target</a></td><td><code>reference</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Organization1-2" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Organization</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-hc-organization.html">HC Organizationversion: 0.2.0-preview)</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This section defines the supported interactions for the <a href="StructureDefinition-hc-organization.html">HC Organization</a> profile of the Organization resource type.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/organization.html#search">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/organization.html#search">name</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/organization.html#search">type</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Location1-3" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Location</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-hc-location.html">HC Locationversion: 0.2.0-preview)</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This section describes the supported interactions for the <a href="StructureDefinition-hc-location.html">HC Location</a> 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.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-location-locmailaddress.html">locmailaddress</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-location-amenities.html">locationamenities</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/location.html#search">name</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/location.html#search">address</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/location.html#search">type</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-location-physicaltype.html">locationphysicaltype</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/location.html#search">near</a></td><td><code>special</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="HealthcareService1-4" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>HealthcareService</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-hc-healthcareservice.html">HC HealthcareServiceversion: 0.2.0-preview)</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This section describes the supported interactions for the <a href="StructureDefinition-hc-healthcareservice.html">HC Healthcare Service</a> 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.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-languages.html">languages</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-healthcareservice-billing.html">hsbilling</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-allday.html">allday</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-daysofweek.html">daysofweek</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-starttime.html">starttime</a></td><td><code>number</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-endtime.html">endtime</a></td><td><code>number</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/healthcareservice.html#search">service-type</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="PractitionerRole1-5" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>PractitionerRole</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-hc-practitionerrole.html">HC PractitionerRoleversion: 0.2.0-preview)</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This section defines the supported interactions for the <a href="StructureDefinition-hc-practitionerrole.html">HC Practitioner Role</a> profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the <a href="StructureDefinition-hc-practitionerrole.html">HC Practitioner Role</a> profile describes a practitioner in a role at a healthcare service.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-languages.html">languages</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-allday.html">allday</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-daysofweek.html">daysofweek</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-starttime.html">starttime</a></td><td><code>number</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-endtime.html">endtime</a></td><td><code>number</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/practitionerrole.html#search">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-practitionerrole-roletype.html">roletype</a></td><td><code>string</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Practitioner1-6" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Practitioner</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-hc-practitioner.html">HC Practitionerversion: 0.2.0-preview)</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This section describes the supported interactions for the <a href="StructureDefinition-hc-practitioner.html">HC Practitioner</a> 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.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/practitioner.html#search">identifier</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-practitioner-regprof.html">regprof</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-practitioner-rsg.html">rsg</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org.au/fhir/6.0.0-ballot/SearchParameter-gender-identity.html">genderIdentity</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-practitioner-identifier-r5.html">identifier-r5</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/practitioner.html#search">name</a></td><td><code>string</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div><div class="panel panel-default"><div class="panel-heading"><h4 id="Endpoint1-7" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </span>Endpoint</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-6"><span class="lead">Base System Profile</span><br/><a href="StructureDefinition-hc-endpoint.html">HC Endpointversion: 0.2.0-preview)</a></div><div class="col-lg-3"><span class="lead">Profile Conformance</span><br/><b>SHALL</b></div><div class="col-lg-3"><span class="lead">Reference Policy</span><br/></div></div><p/><div class="row"><div class="col-lg-6"><span class="lead">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This section describes the supported interactions for the <a href="StructureDefinition-hc-endpoint.html">HC Endpoint</a> 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.</p>
</div></blockquote></div></div><div class="row"><div class="col-lg-7"><span class="lead">Search Parameters</span><table class="table table-condensed table-hover"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href="SearchParameter-endpoint-url.html">epurl</a></td><td><code>uri</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-endpoint-payloadmimetype.html">payloadmimetype</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="SearchParameter-endpoint-hcepi.html">hcepi</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/endpoint.html#search">name</a></td><td><code>string</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/endpoint.html#search">connection-type</a></td><td><code>token</code></td><td><div/></td></tr><tr><td><b>SHALL</b></td><td><a href="http://hl7.org/fhir/R4/endpoint.html#search">payload-type</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
</text>
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
<valueCode value="draft">
<extension
url="http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom">
<valueCanonical
value="http://ns.electronichealth.net.au/hc/ImplementationGuide/au.digitalhealth.r4.healthconnect"/>
</extension>
</valueCode>
</extension>
<url
value="http://ns.electronichealth.net.au/hc/CapabilityStatement/health-connect-provider-directory-responder"/>
<version value="0.2.0-preview"/>
<name value="HealthConnectProviderDirectoryResponder"/>
<title value="Health Connect Provider Directory Responder"/>
<status value="draft"/>
<date value="2025-11-27"/>
<publisher value="Australian Digital Health Agency"/>
<contact>
<name value="Australian Digital Health Agency"/>
<telecom>
<system value="url"/>
<value value="https://www.digitalhealth.gov.au/"/>
</telecom>
<telecom>
<system value="email"/>
<value value="help@digitalhealth.gov.au"/>
</telecom>
</contact>
<contact>
<name value="Australian Digital Health Agency"/>
<telecom>
<system value="email"/>
<value value="mailto:help@digitalhealth.gov.au"/>
<use value="work"/>
</telecom>
</contact>
<description
value="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."/>
<useContext>
<code>
<system
value="http://terminology.hl7.org/CodeSystem/usage-context-type"/>
<code value="jurisdiction"/>
</code>
<valueCodeableConcept>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="AU"/>
<display value="Australia"/>
</coding>
</valueCodeableConcept>
</useContext>
<copyright
value="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/)"/>
<kind value="instance"/>
<implementation>
<description
value="Health Connect Provider Directory Responder FHIR Server"/>
<url value="http://ns.electronichealth.net.au/hc"/>
</implementation>
<fhirVersion value="4.0.1"/>
<format value="json">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</format>
<format value="xml">
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</format>
<rest>
<mode value="server"/>
<security>
<service>
<coding>
<system
value="http://terminology.hl7.org/CodeSystem/restful-security-service"/>
<code value="OAuth"/>
<display value="OAuth"/>
</coding>
</service>
<description
value="All interactions SHALL be secured using OAuth protocols. It SHALL support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements."/>
</security>
<resource>
<type value="Provenance"/>
<profile
value="http://ns.electronichealth.net.au/hc/StructureDefinition/hc-provenance|0.2.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="HC Provenance resources track the lineage of data retrieved, updated, or verified from external systems of record."/>
<interaction>
<code value="read"/>
<documentation value="Read HC Provenance records"/>
</interaction>
<interaction>
<code value="search-type"/>
<documentation
value="Search HC Provenance records by various parameters"/>
</interaction>
<versioning value="versioned"/>
<readHistory value="false"/>
<updateCreate value="false"/>
<conditionalCreate value="false"/>
<conditionalRead value="not-supported"/>
<conditionalUpdate value="false"/>
<conditionalDelete value="not-supported"/>
<searchInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="target"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Provenance-target|4.0.1"/>
<type value="reference"/>
</searchParam>
</resource>
<resource>
<type value="Organization"/>
<profile
value="http://ns.electronichealth.net.au/hc/StructureDefinition/hc-organization|0.2.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="This section defines the supported interactions for the [HC Organization](StructureDefinition-hc-organization.html) profile of the Organization resource type."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<searchInclude value="Organization:partOf"/>
<searchRevInclude value="Location:organization"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-identifier|4.0.1"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-name|4.0.1"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Organization-type|4.0.1"/>
<type value="token"/>
</searchParam>
</resource>
<resource>
<type value="Location"/>
<profile
value="http://ns.electronichealth.net.au/hc/StructureDefinition/hc-location|0.2.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="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."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<searchInclude value="Location:managingOrganization"/>
<searchInclude value="Location:endpoint"/>
<searchRevInclude value="HealthcareService:location"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="locmailaddress"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/location-locmailaddress|0.2.0-preview"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="locationamenities"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/location-amenities|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-name|4.0.1"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="address"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-address|4.0.1"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-type|4.0.1"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="locationphysicaltype"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/location-physicaltype|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="near"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Location-near|4.0.1"/>
<type value="special"/>
</searchParam>
</resource>
<resource>
<type value="HealthcareService"/>
<profile
value="http://ns.electronichealth.net.au/hc/StructureDefinition/hc-healthcareservice|0.2.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="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."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<searchInclude value="HealthcareService:location"/>
<searchInclude value="HealthcareService:providedBy"/>
<searchInclude value="HealthcareService:endpoint"/>
<searchRevInclude value="PractitionerRole:healthcareService"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="languages"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/languages|0.2.0-preview"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="hsbilling"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/healthcareservice-billing|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="allday"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/allday|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="daysofweek"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/daysofweek|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="starttime"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/starttime|0.2.0-preview"/>
<type value="number"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="endtime"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/endtime|0.2.0-preview"/>
<type value="number"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="service-type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/HealthcareService-service-type|4.0.1"/>
<type value="token"/>
</searchParam>
</resource>
<resource>
<type value="PractitionerRole"/>
<profile
value="http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitionerrole|0.2.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="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."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<searchInclude value="PractitionerRole:practitioner"/>
<searchInclude value="PractitionerRole:healthcareService"/>
<searchInclude value="PractitionerRole:organization"/>
<searchInclude value="PractitionerRole:location"/>
<searchInclude value="PractitionerRole:endpoint"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="languages"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/languages|0.2.0-preview"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="allday"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/allday|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="daysofweek"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/daysofweek|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="starttime"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/starttime|0.2.0-preview"/>
<type value="number"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="endtime"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/endtime|0.2.0-preview"/>
<type value="number"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier|4.0.1"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="roletype"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/practitionerrole-roletype|0.2.0-preview"/>
<type value="string"/>
</searchParam>
</resource>
<resource>
<type value="Practitioner"/>
<profile
value="http://ns.electronichealth.net.au/hc/StructureDefinition/hc-practitioner|0.2.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="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."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<searchRevInclude value="PractitionerRole:practitioner"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Practitioner-identifier|4.0.1"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="regprof"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/practitioner-regprof|0.2.0-preview"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="rsg"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/practitioner-rsg|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="genderIdentity"/>
<definition
value="http://hl7.org.au/fhir/SearchParameter/gender-identity|6.0.0-ballot"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="identifier-r5"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/practitioner-identifier-r5|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Practitioner-name|4.0.1"/>
<type value="string"/>
</searchParam>
</resource>
<resource>
<type value="Endpoint"/>
<profile
value="http://ns.electronichealth.net.au/hc/StructureDefinition/hc-endpoint|0.2.0-preview">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</profile>
<documentation
value="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."/>
<interaction>
<code value="read"/>
</interaction>
<interaction>
<code value="search-type"/>
</interaction>
<versioning value="versioned"/>
<searchRevInclude value="HealthcareService:endpoint"/>
<searchRevInclude value="Location:endpoint"/>
<searchRevInclude value="PractitionerRole:endpoint"/>
<searchRevInclude value="Provenance:target"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="epurl"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/endpoint-url|0.2.0-preview"/>
<type value="uri"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="payloadmimetype"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/endpoint-payloadmimetype|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="hcepi"/>
<definition
value="http://ns.electronichealth.net.au/hc/SearchParameter/endpoint-hcepi|0.2.0-preview"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="name"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Endpoint-name|4.0.1"/>
<type value="string"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="connection-type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Endpoint-connection-type|4.0.1"/>
<type value="token"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="payload-type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Endpoint-payload-type|4.0.1"/>
<type value="token"/>
</searchParam>
</resource>
</rest>
</CapabilityStatement>IG © 2025+ Australian Digital Health Agency. Package au.digitalhealth.r4.healthconnect#0.2.0-preview based on FHIR 4.0.1. Generated 2026-01-16
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
