# Health Connect Australia Provider Directory FHIR Implementation Guide

26.0.0 - Snapshot HL7 AU Connectathon Aug 25 & 26, 2026

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 26.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/AuDigitalHealth/HCPD-Snapshot-26.0.0-HL7AU-Connectathon-Aug-25-26/ and changes regularly. See the Directory of published versions

## : Health Connect Provider Directory Bulk Export Requester - XML Representation

Active as of 2026-08-07

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="health-connect-bulk-export-requester"/>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement health-connect-bulk-export-requester</b></p><a name="health-connect-bulk-export-requester"> </a><a name="hchealth-connect-bulk-export-requester"> </a><h2 id="title">Health Connect Provider Directory Bulk Export Requester</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></li><li>Published on: 2026-08-07 </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>client</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 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 operation enables the client to initiate bulk data export requests by submitting <a href="StructureDefinition-hcpd-export-request-parameters.html">HCPD Export Request Parameters</a> resources to the Health Connect Provider Directory Responder. The operation SHALL accept parameters including _outputFormat, _type, _typeFilter, and optionally _since to control bulk data export scope and format. The operation SHALL return URLs to ndjson files containing the requested resource types. Bulk data extraction returns all resources regardless of active status or suppression; implementers SHALL respect the suppressed and deactivated-by extensions on returned resources, filtering these resources before displaying them to end consumers.</p>
    </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="#Parameters1-1">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>_outputFormat, _type, _typeFilter, _since</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><tr><td><a href="#Binary1-2">Binary</a></td><td> </td><td class="text-center">y</td><td class="text-center"/><td class="text-center"/><td class="text-center"/><td/><td/><td/><td/></tr></tbody></table></div><hr/><div class="panel panel-default"><div class="panel-heading"><h4 id="Parameters1-1" class="panel-title"><span style="float: right;">Resource Conformance: SHALL </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>Submit HCPD Export Request Parameters as search instructions for bulk data export operations</p>
    </div></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 submitting <a href="StructureDefinition-hcpd-export-request-parameters.html">HCPD Export Request Parameters</a> resources as search instructions for bulk data export operations. The client SHALL be able to form properly structured Parameters resources containing _outputFormat, _type, _typeFilter, and optionally _since parameters to control bulk data export scope and format. The server validates these parameters before executing the bulk export.</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>_outputFormat</td><td><code>string</code></td><td><div><p>Specifies the output format for bulk export. Fixed to application/fhir+ndjson.</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>_type</td><td><code>string</code></td><td><div><p>Comma-separated list of resource types to include in the bulk export (e.g. Organization,Location,HealthcareService,Practitioner,PractitionerRole,Endpoint,Provenance).</p>
    </div></td></tr><tr><td><b>SHALL</b></td><td>_typeFilter</td><td><code>string</code></td><td><div><p>FHIR search expression applied to a specific resource type to filter which resources are included in the export. One _typeFilter SHALL be provided for each resource type specified in _type. Supported filter expressions include: Location?address-state, Location?address-postalcode, Location?address-city, Location?near, Organization?identifier, Organization?name, HealthcareService?service-type, PractitionerRole?location.address-city, PractitionerRole?location.address-postalcode.</p>
    </div></td></tr><tr><td><b>SHOULD</b></td><td>_since</td><td><code>date</code></td><td><div><p>Only resources updated since the specified instant (ISO 8601) will be included in the export. Used for delta/incremental extracts.</p>
    </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="Binary1-2" class="panel-title"><span style="float: right;">Resource Conformance: unspecified </span>Binary</h4></div><div class="panel-body"><div class="container"><div class="row"><div class="col-lg-4"><span class="lead">Core FHIR Resource</span><br/><a href="http://hl7.org/fhir/R4/binary.html">Binary</a></div><div class="col-lg-4"><span class="lead">Reference Policy</span><br/></div><div class="col-lg-4"><span class="lead">Interaction summary</span><br/><ul><li>Supports <br/><code>read</code><div><p>Read Binary resources containing bulk exported data files</p>
    </div></li></ul></div></div><p/><p/><div class="row"><div class="col-12"><span class="lead">Documentation</span><blockquote><div><p>This section defines the required capabilities for retrieving Binary resources containing bulk exported data files. After submitting export parameters and receiving export completion notification, the client SHALL be able to retrieve the Binary resources containing the exported data in ndjson format.</p>
    </div></blockquote></div></div></div></div></div></div>
      </text>
      <url
           value="http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-bulk-export-requester"/>
      <version value="26.0.0"/>
      <name value="HealthConnectProviderDirectoryBulkExportRequester"/>
      <title value="Health Connect Provider Directory Bulk Export Requester"/>
      <status value="active"/>
      <experimental value="false"/>
      <date value="2026-08-07"/>
      <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="url"/>
          <value value="https://www.digitalhealth.gov.au"/>
          <use value="work"/>
        </telecom>
        <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 Bulk Export Requester Actor](ActorDefinition-bulk-export-requester-actor-health-connect.html) when conforming to this implementation guide. This actor is specifically designed for bulk data export operations and does not support standard FHIR REST search interactions. The listed FHIR profiles and operations describe the capabilities required for initiating bulk exports and processing the returned data."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="AU"/>
          <display value="Australia"/>
        </coding>
      </jurisdiction>
      <copyright
                 value="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="requirements"/>
      <fhirVersion value="4.0.1"/>
      <format value="json">
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
      </format>
      <rest>
        <mode value="client"/>
        <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>
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
            <valueCode value="SHALL"/>
          </extension>
          <type value="Parameters"/>
          <profile
                   value="http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0"/>
          <documentation
                         value="This section defines the supported interactions for submitting [HCPD Export Request Parameters](StructureDefinition-hcpd-export-request-parameters.html) resources as search instructions for bulk data export operations. The client SHALL be able to form properly structured Parameters resources containing _outputFormat, _type, _typeFilter, and optionally _since parameters to control bulk data export scope and format. The server validates these parameters before executing the bulk export."/>
          <interaction>
            <code value="read"/>
          </interaction>
          <interaction>
            <code value="search-type"/>
            <documentation
                           value="Submit HCPD Export Request Parameters as search instructions for bulk data export operations"/>
          </interaction>
          <versioning value="versioned"/>
          <readHistory value="false"/>
          <searchInclude value="Provenance:target"/>
          <searchInclude value="Organization:partOf"/>
          <searchInclude value="Location:organization"/>
          <searchInclude value="Location:endpoint"/>
          <searchInclude value="HealthcareService:location"/>
          <searchInclude value="HealthcareService:organization"/>
          <searchInclude value="HealthcareService:endpoint"/>
          <searchInclude value="PractitionerRole:practitioner"/>
          <searchInclude value="PractitionerRole:service"/>
          <searchInclude value="PractitionerRole:organization"/>
          <searchInclude value="PractitionerRole:location"/>
          <searchInclude value="PractitionerRole:endpoint"/>
          <searchRevInclude value="Location:organization"/>
          <searchRevInclude value="Provenance:target"/>
          <searchRevInclude value="HealthcareService:location"/>
          <searchRevInclude value="PractitionerRole:service"/>
          <searchRevInclude value="PractitionerRole:practitioner"/>
          <searchRevInclude value="HealthcareService:endpoint"/>
          <searchRevInclude value="Location:endpoint"/>
          <searchRevInclude value="PractitionerRole:endpoint"/>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="_outputFormat"/>
            <type value="string"/>
            <documentation
                           value="Specifies the output format for bulk export. Fixed to application/fhir+ndjson."/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="_type"/>
            <type value="string"/>
            <documentation
                           value="Comma-separated list of resource types to include in the bulk export (e.g. Organization,Location,HealthcareService,Practitioner,PractitionerRole,Endpoint,Provenance)."/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="_typeFilter"/>
            <type value="string"/>
            <documentation
                           value="FHIR search expression applied to a specific resource type to filter which resources are included in the export. One _typeFilter SHALL be provided for each resource type specified in _type. Supported filter expressions include: Location?address-state, Location?address-postalcode, Location?address-city, Location?near, Organization?identifier, Organization?name, HealthcareService?service-type, PractitionerRole?location.address-city, PractitionerRole?location.address-postalcode."/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHOULD"/>
            </extension>
            <name value="_since"/>
            <type value="date"/>
            <documentation
                           value="Only resources updated since the specified instant (ISO 8601) will be included in the export. Used for delta/incremental extracts."/>
          </searchParam>
        </resource>
        <resource>
          <type value="Binary"/>
          <documentation
                         value="This section defines the required capabilities for retrieving Binary resources containing bulk exported data files. After submitting export parameters and receiving export completion notification, the client SHALL be able to retrieve the Binary resources containing the exported data in ndjson format."/>
          <interaction>
            <code value="read"/>
            <documentation
                           value="Read Binary resources containing bulk exported data files"/>
          </interaction>
          <versioning value="versioned"/>
          <readHistory value="false"/>
        </resource>
        <operation>
          <name value="export"/>
          <definition
                      value="http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export|3.0.0"/>
          <documentation
                         value="This operation enables the client to initiate bulk data export requests by submitting [HCPD Export Request Parameters](StructureDefinition-hcpd-export-request-parameters.html) resources to the Health Connect Provider Directory Responder. The operation SHALL accept parameters including _outputFormat, _type, _typeFilter, and optionally _since to control bulk data export scope and format. The operation SHALL return URLs to ndjson files containing the requested resource types. Bulk data extraction returns all resources regardless of active status or suppression; implementers SHALL respect the suppressed and deactivated-by extensions on returned resources, filtering these resources before displaying them to end consumers."/>
        </operation>
      </rest>
    </CapabilityStatement>