Health Connect Australia Provider Directory FHIR Implementation Guide
26.0.0 - Trial
Health Connect Australia Provider Directory FHIR Implementation Guide - Local Development build (v26.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2026-04-29 |
{
"resourceType" : "CapabilityStatement",
"id" : "health-connect-provider-directory-responder",
"text" : {
"status" : "extensions",
"div" : "<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: 26.0.0 </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: 2026-04-29 </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>\n</div></blockquote><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Summary of System-wide Operations</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Operation</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td><a href=\"http://hl7.org/fhir/uv/bulkdata/STU3/OperationDefinition-export.html\">$export</a></td><td><div><p>This bulk data export operation expects request parameters conforming to the <a href=\"StructureDefinition-hcpd-export-request-parameters.html\">HCPD Export Request Parameters</a> profile which defines the required parameter structure for _outputFormat, _type, _typeFilter, and optional _since parameters. The server returns URLs to ndjson files containing the requested resource types. When applicable, the server may automatically inject <a href=\"StructureDefinition-hcpd-export-response-list.html\">HCPD Export Response List</a> resources into the output to indicate resource identifiers marked for removal from downstream client systems.</p>\n</div></td></tr></tbody></table></div></div></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-hcpd-provenance.html\">http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-provenance|26.0.0</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-hcpd-organization.html\">http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0</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-hcpd-location.html\">http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0</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:organization</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-hcpd-healthcareservice.html\">http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice|26.0.0</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:organization</code>, <code>HealthcareService:endpoint</code>, <code>HealthcareService:organization</code></td><td><code>PractitionerRole:service</code>, <code>Provenance:target</code></td><td/></tr><tr><td><a href=\"#PractitionerRole1-5\">PractitionerRole</a></td><td><a href=\"StructureDefinition-hcpd-practitionerrole.html\">http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole|26.0.0</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, role</td><td><code>PractitionerRole:practitioner</code>, <code>PractitionerRole:service</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-hcpd-practitioner.html\">http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner|26.0.0</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, 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-hcpd-endpoint.html\">http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0</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><tr><td><a href=\"#List1-8\">List</a></td><td><a href=\"StructureDefinition-hcpd-export-response-list.html\">http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list|26.0.0</a></td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td class=\"text-center\"/><td/><td/><td/><td/></tr><tr><td><a href=\"#Parameters1-9\">Parameters</a></td><td><a href=\"StructureDefinition-hcpd-export-request-parameters.html\">http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"/><td class=\"text-center\"/><td/><td><code>Provenance:target</code>, <code>Organization:partOf</code>, <code>Location:organization</code>, <code>Location:endpoint</code>, <code>HealthcareService:location</code>, <code>HealthcareService:organization</code>, <code>HealthcareService:endpoint</code>, <code>PractitionerRole:practitioner</code>, <code>PractitionerRole:service</code>, <code>PractitionerRole:organization</code>, <code>PractitionerRole:location</code>, <code>PractitionerRole:endpoint</code></td><td><code>Location:organization</code>, <code>Provenance:target</code>, <code>HealthcareService:location</code>, <code>PractitionerRole:service</code>, <code>PractitionerRole:practitioner</code>, <code>HealthcareService:endpoint</code>, <code>Location:endpoint</code>, <code>PractitionerRole:endpoint</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: unspecified </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-hcpd-provenance.html\">HCPD Provenanceversion: 26.0.0)</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>\n</div><code>search-type</code><div><p>Search HC Provenance records by various parameters</p>\n</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>\n</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\">\u00a0</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: unspecified </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-hcpd-organization.html\">HCPD Organizationversion: 26.0.0)</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-hcpd-organization.html\">HCPD Organization</a> profile of the Organization resource type.</p>\n</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\">\u00a0</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: unspecified </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-hcpd-location.html\">HCPD Locationversion: 26.0.0)</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-hcpd-location.html\">HCPD 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>\n</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\">\u00a0</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: unspecified </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-hcpd-healthcareservice.html\">HCPD HealthcareServiceversion: 26.0.0)</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-hcpd-healthcareservice.html\">HCPD 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>\n</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>token</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\">\u00a0</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: unspecified </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-hcpd-practitionerrole.html\">HCPD PractitionerRoleversion: 26.0.0)</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-hcpd-practitionerrole.html\">HCPD Practitioner Role</a> profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the <a href=\"StructureDefinition-hcpd-practitionerrole.html\">HCPD Practitioner Role</a> profile describes a practitioner in a role at a healthcare service.</p>\n</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>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/practitionerrole.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/practitionerrole.html#search\">role</a></td><td><code>token</code></td><td><div/></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</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: unspecified </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-hcpd-practitioner.html\">HCPD Practitionerversion: 26.0.0)</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-hcpd-practitioner.html\">HCPD 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>\n</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=\"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\">\u00a0</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: unspecified </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-hcpd-endpoint.html\">HCPD Endpointversion: 26.0.0)</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-hcpd-endpoint.html\">HCPD 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>\n</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\">\u00a0</div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"List1-8\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>List</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-hcpd-export-response-list.html\">HCPD Export Response Listversion: 26.0.0)</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 access to HCPD Export Response List resources obtained through bulk export operations</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>This resource declares support for the <a href=\"StructureDefinition-hcpd-export-response-list.html\">HCPD Export Response List</a> profile. List resources conforming to this profile are automatically generated and included as part of bulk data export operations to communicate which resource identifiers should be removed from downstream client systems. These List resources are not directly searchable or accessible via standard FHIR REST operations, but are provided exclusively through the bulk export process.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Parameters1-9\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: unspecified </span>Parameters</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-hcpd-export-request-parameters.html\">HCPD Export Request Parametersversion: 26.0.0)</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><br/><code>search-type</code><div><p>Process HCPD Export Request Parameters as input to bulk export operations</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>This resource declares support for processing <a href=\"StructureDefinition-hcpd-export-request-parameters.html\">HCPD Export Request Parameters</a> resources as input to bulk data export operations. Parameters resources conforming to this profile are used to control the scope, format, and filtering criteria for bulk exports. These resources are processed as part of the $export operation and are not directly stored or searchable.</p>\n</div></blockquote></div></div></div></div></div></div>"
},
"url" : "http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-provider-directory-responder",
"version" : "26.0.0",
"name" : "HealthConnectProviderDirectoryResponder",
"title" : "Health Connect Provider Directory Responder",
"status" : "active",
"experimental" : false,
"date" : "2026-04-29",
"publisher" : "Australian Digital Health Agency",
"contact" : [
{
"name" : "Australian Digital Health Agency",
"telecom" : [
{
"system" : "url",
"value" : "https://www.digitalhealth.gov.au/"
},
{
"system" : "email",
"value" : "help@digitalhealth.gov.au"
}
]
},
{
"name" : "Australian Digital Health Agency",
"telecom" : [
{
"system" : "email",
"value" : "mailto:help@digitalhealth.gov.au",
"use" : "work"
}
]
}
],
"description" : "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" : "http://terminology.hl7.org/CodeSystem/usage-context-type",
"code" : "jurisdiction"
},
"valueCodeableConcept" : {
"coding" : [
{
"system" : "urn:iso:std:iso:3166",
"code" : "AU",
"display" : "Australia"
}
]
}
}
],
"copyright" : "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" : "instance",
"implementation" : {
"description" : "Health Connect Provider Directory Responder FHIR Server",
"url" : "http://digitalhealth.gov.au/fhir/hcpd"
},
"fhirVersion" : "4.0.1",
"format" : [
"json",
"xml"
],
"_format" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
}
],
"rest" : [
{
"mode" : "server",
"security" : {
"service" : [
{
"coding" : [
{
"system" : "http://terminology.hl7.org/CodeSystem/restful-security-service",
"code" : "OAuth",
"display" : "OAuth"
}
]
}
],
"description" : "All interactions SHALL be secured using OAuth protocols. It SHALL support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements."
},
"resource" : [
{
"type" : "Provenance",
"profile" : "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-provenance|26.0.0",
"_profile" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
"documentation" : "HC Provenance resources track the lineage of data retrieved, updated, or verified from external systems of record.",
"interaction" : [
{
"code" : "read",
"documentation" : "Read HC Provenance records"
},
{
"code" : "search-type",
"documentation" : "Search HC Provenance records by various parameters"
}
],
"versioning" : "versioned",
"readHistory" : false,
"searchInclude" : [
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "target",
"definition" : "http://hl7.org/fhir/SearchParameter/Provenance-target|4.0.1",
"type" : "reference"
}
]
},
{
"type" : "Organization",
"profile" : "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0",
"_profile" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
"documentation" : "This section defines the supported interactions for the [HCPD Organization](StructureDefinition-hcpd-organization.html) profile of the Organization resource type.",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"searchInclude" : [
"Organization:partOf"
],
"searchRevInclude" : [
"Location:organization",
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-identifier|4.0.1",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-name|4.0.1",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Organization-type|4.0.1",
"type" : "token"
}
]
},
{
"type" : "Location",
"profile" : "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0",
"_profile" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
"documentation" : "This section describes the supported interactions for the [HCPD Location](StructureDefinition-hcpd-location.html) profile. Each Location resource conforming to this profile identifies a physical or virtual place associated with healthcare services in the Health Connect Provider Directory, enabling clients to discover, filter, and reference service delivery sites.",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"searchInclude" : [
"Location:organization",
"Location:endpoint"
],
"searchRevInclude" : [
"HealthcareService:location",
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "locmailaddress",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-locmailaddress|26.0.0",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "locationamenities",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-amenities|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-name|4.0.1",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "address",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-address|4.0.1",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "type",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-type|4.0.1",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "locationphysicaltype",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-physicaltype|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "near",
"definition" : "http://hl7.org/fhir/SearchParameter/Location-near|4.0.1",
"type" : "special"
}
]
},
{
"type" : "HealthcareService",
"profile" : "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice|26.0.0",
"_profile" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
"documentation" : "This section describes the supported interactions for the [HCPD Healthcare Service](StructureDefinition-hcpd-healthcareservice.html) profile. Each HealthcareService resource conforming to this profile identifies a healthcare service in the Health Connect Provider Directory, enabling clients to discover, filter, and reference healthcare services that are provided.",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"searchInclude" : [
"HealthcareService:location",
"HealthcareService:organization",
"HealthcareService:endpoint",
"HealthcareService:organization"
],
"searchRevInclude" : [
"PractitionerRole:service",
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "languages",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/languages|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "hsbilling",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/healthcareservice-billing|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "allday",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/allday|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "daysofweek",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/daysofweek|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "starttime",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/starttime|26.0.0",
"type" : "number"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "endtime",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endtime|26.0.0",
"type" : "number"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "service-type",
"definition" : "http://hl7.org/fhir/SearchParameter/HealthcareService-service-type|4.0.1",
"type" : "token"
}
]
},
{
"type" : "PractitionerRole",
"profile" : "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole|26.0.0",
"_profile" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
"documentation" : "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" : "read"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"searchInclude" : [
"PractitionerRole:practitioner",
"PractitionerRole:service",
"PractitionerRole:organization",
"PractitionerRole:location",
"PractitionerRole:endpoint"
],
"searchRevInclude" : [
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "languages",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/languages|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "allday",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/allday|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "daysofweek",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/daysofweek|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "starttime",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/starttime|26.0.0",
"type" : "number"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "endtime",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endtime|26.0.0",
"type" : "number"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier|4.0.1",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "role",
"definition" : "http://hl7.org/fhir/SearchParameter/PractitionerRole-role|4.0.1",
"type" : "token"
}
]
},
{
"type" : "Practitioner",
"profile" : "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner|26.0.0",
"_profile" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
"documentation" : "This section describes the supported interactions for the [HCPD Practitioner](StructureDefinition-hcpd-practitioner.html) profile. Each Practitioner resource conforming to this profile represents an individual healthcare provider registered in the Health Connect Provider Directory, enabling clients to search, identify, and reference practitioners and their associated roles and service locations.",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"searchRevInclude" : [
"PractitionerRole:practitioner",
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-identifier|4.0.1",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "regprof",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-regprof|26.0.0",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "rsg",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-rsg|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "identifier-r5",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-identifier-r5|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Practitioner-name|4.0.1",
"type" : "string"
}
]
},
{
"type" : "Endpoint",
"profile" : "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0",
"_profile" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
"documentation" : "This section describes the supported interactions for the [HCPD Endpoint](StructureDefinition-hcpd-endpoint.html) profile. Each Endpoint resource conforming to this profile provides connection details for electronic services available through the Health Connect Provider Directory, allowing clients to discover and interact with service endpoints in a standardised way.",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type"
}
],
"versioning" : "versioned",
"searchRevInclude" : [
"HealthcareService:endpoint",
"Location:endpoint",
"PractitionerRole:endpoint",
"Provenance:target"
],
"searchParam" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "epurl",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-url|26.0.0",
"type" : "uri"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "payloadmimetype",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-payloadmimetype|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "hcepi",
"definition" : "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-hcepi|26.0.0",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "name",
"definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-name|4.0.1",
"type" : "string"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "connection-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-connection-type|4.0.1",
"type" : "token"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"name" : "payload-type",
"definition" : "http://hl7.org/fhir/SearchParameter/Endpoint-payload-type|4.0.1",
"type" : "token"
}
]
},
{
"type" : "List",
"profile" : "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list|26.0.0",
"_profile" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
"documentation" : "This resource declares support for the [HCPD Export Response List](StructureDefinition-hcpd-export-response-list.html) profile. List resources conforming to this profile are automatically generated and included as part of bulk data export operations to communicate which resource identifiers should be removed from downstream client systems. These List resources are not directly searchable or accessible via standard FHIR REST operations, but are provided exclusively through the bulk export process.",
"interaction" : [
{
"code" : "read",
"documentation" : "Read access to HCPD Export Response List resources obtained through bulk export operations"
}
],
"versioning" : "versioned",
"readHistory" : false
},
{
"type" : "Parameters",
"profile" : "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0",
"_profile" : {
🔗 "extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
]
},
"documentation" : "This resource declares support for processing [HCPD Export Request Parameters](StructureDefinition-hcpd-export-request-parameters.html) resources as input to bulk data export operations. Parameters resources conforming to this profile are used to control the scope, format, and filtering criteria for bulk exports. These resources are processed as part of the $export operation and are not directly stored or searchable.",
"interaction" : [
{
"code" : "read"
},
{
"code" : "search-type",
"documentation" : "Process HCPD Export Request Parameters as input to bulk export operations"
}
],
"versioning" : "versioned",
"readHistory" : false,
"searchInclude" : [
"Provenance:target",
"Organization:partOf",
"Location:organization",
"Location:endpoint",
"HealthcareService:location",
"HealthcareService:organization",
"HealthcareService:endpoint",
"PractitionerRole:practitioner",
"PractitionerRole:service",
"PractitionerRole:organization",
"PractitionerRole:location",
"PractitionerRole:endpoint"
],
"searchRevInclude" : [
"Location:organization",
"Provenance:target",
"HealthcareService:location",
"PractitionerRole:service",
"PractitionerRole:practitioner",
"HealthcareService:endpoint",
"Location:endpoint",
"PractitionerRole:endpoint"
]
}
],
"operation" : [
{
"name" : "export",
"definition" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export|3.0.0",
"documentation" : "This bulk data export operation expects request parameters conforming to the [HCPD Export Request Parameters](StructureDefinition-hcpd-export-request-parameters.html) profile which defines the required parameter structure for _outputFormat, _type, _typeFilter, and optional _since parameters. The server returns URLs to ndjson files containing the requested resource types. When applicable, the server may automatically inject [HCPD Export Response List](StructureDefinition-hcpd-export-response-list.html) resources into the output to indicate resource identifiers marked for removal from downstream client systems."
}
]
}
]
}IG © 2026+ Australian Digital Health Agency. Package au.gov.digitalhealth.hcpd#26.0.0 based on FHIR 4.0.1. Generated 2026-04-30
Links: Table of Contents | QA Report | Version History | Report an issue or propose a change
