# 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

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

Active as of 2026-04-29

Raw ttl | Download

    @prefix fhir: <http://hl7.org/fhir/> .
    @prefix owl: <http://www.w3.org/2002/07/owl#> .
    @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .
    @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
    @prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

    # - resource -------------------------------------------------------------------

     a fhir:CapabilityStatement ;
      fhir:nodeRole fhir:treeRoot ;
      fhir:id [ fhir:v "health-connect-bulk-export-requester"] ; #
      fhir:text [
    fhir:status [ fhir:v "extensions" ] ;
    fhir:div [ fhir:v "<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>, <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>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>\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 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 return URLs to ndjson files containing the requested resource types. When applicable, the response may include <a href=\"StructureDefinition-hcpd-export-response-list.html\">HCPD Export Response List</a> resources that the client MUST process to remove those resource identifiers from local 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=\"#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/><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=\"#List1-2\">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=\"#Binary1-3\">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: 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>Submit HCPD Export Request Parameters as search instructions for bulk data 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 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>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"List1-2\" 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 HCPD Export Response List resources received through bulk export operations to identify resources for local removal</p>\n</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 required capabilities for processing <a href=\"StructureDefinition-hcpd-export-response-list.html\">HCPD Export Response List</a> resources received as part of bulk data export operations. The client SHALL be able to read and parse these List resources to identify resource identifiers that must be removed from local systems in compliance with suppression requirements.</p>\n</div></blockquote></div></div></div></div></div><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Binary1-3\" 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>\n</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>\n</div></blockquote></div></div></div></div></div></div>"^^rdf:XMLLiteral ]
      ] ; #
      fhir:url [
    fhir:v "http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-bulk-export-requester"^^xsd:anyURI ;
    fhir:l <http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-bulk-export-requester>
      ] ; #
      fhir:version [ fhir:v "26.0.0"] ; #
      fhir:name [ fhir:v "HealthConnectProviderDirectoryBulkExportRequester"] ; #
      fhir:title [ fhir:v "Health Connect Provider Directory Bulk Export Requester"] ; #
      fhir:status [ fhir:v "active"] ; #
      fhir:experimental [ fhir:v false] ; #
      fhir:date [ fhir:v "2026-04-29"^^xsd:date] ; #
      fhir:publisher [ fhir:v "Australian Digital Health Agency"] ; #
      fhir:contact ( [
    fhir:name [ fhir:v "Australian Digital Health Agency" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "url" ] ;
    fhir:value [ fhir:v "https://www.digitalhealth.gov.au/" ]     ] [
    fhir:system [ fhir:v "email" ] ;
    fhir:value [ fhir:v "help@digitalhealth.gov.au" ]     ] )
      ] [
    fhir:name [ fhir:v "Australian Digital Health Agency" ] ;
        ( fhir:telecom [
    fhir:system [ fhir:v "email" ] ;
    fhir:value [ fhir:v "mailto:help@digitalhealth.gov.au" ] ;
    fhir:use [ fhir:v "work" ]     ] )
      ] ) ; #
      fhir:description [ fhir:v "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, including handling resource removal lists."] ; #
      fhir:useContext ( [
    fhir:code [
    fhir:system [
    fhir:v "http://terminology.hl7.org/CodeSystem/usage-context-type"^^xsd:anyURI ;
    fhir:l <http://terminology.hl7.org/CodeSystem/usage-context-type>       ] ;
    fhir:code [ fhir:v "jurisdiction" ]     ] ;
    fhir:value [
    a fhir:CodeableConcept ;
          ( fhir:coding [
    fhir:system [
    fhir:v "urn:iso:std:iso:3166"^^xsd:anyURI ;
    fhir:l <urn:iso:std:iso:3166>         ] ;
    fhir:code [ fhir:v "AU" ] ;
    fhir:display [ fhir:v "Australia" ]       ] )     ]
      ] ) ; #
      fhir:copyright [ fhir:v "Copyright © 2026 Australian Digital Health Agency - All rights reserved. This content is licensed under a Creative Commons Attribution 4.0 International License. See [https://creativecommons.org/licenses/by/4.0/](https://creativecommons.org/licenses/by/4.0/)"] ; #
      fhir:kind [ fhir:v "requirements"] ; #
      fhir:fhirVersion [ fhir:v "4.0.1"] ; #
      fhir:format ( [
    fhir:v "json" ;
        ( fhir:extension [
    fhir:url [
    fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation>       ] ;
    fhir:value [
    a fhir:Code ;
    fhir:v "SHALL"       ]     ] )
      ] [
    fhir:v "xml" ;
        ( fhir:extension [
    fhir:url [
    fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation>       ] ;
    fhir:value [
    a fhir:Code ;
    fhir:v "SHALL"       ]     ] )
      ] ) ; #
      fhir:rest ( [
    fhir:mode [ fhir:v "client" ] ;
    fhir:security [
          ( fhir:service [
            ( fhir:coding [
    fhir:system [
    fhir:v "http://terminology.hl7.org/CodeSystem/restful-security-service"^^xsd:anyURI ;
    fhir:l <http://terminology.hl7.org/CodeSystem/restful-security-service>           ] ;
    fhir:code [ fhir:v "OAuth" ] ;
    fhir:display [ fhir:v "OAuth" ]         ] )       ] ) ;
    fhir:description [ fhir:v "All interactions SHALL be secured using OAuth protocols. It SHALL support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements." ]     ] ;
        ( fhir:resource [
    fhir:type [ fhir:v "Parameters" ] ;
    fhir:profile [
    fhir:v "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0"^^xsd:anyURI ;
    fhir:l <http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters?version=26.0.0> ;
            ( fhir:extension [
    fhir:url [
    fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation>           ] ;
    fhir:value [
    a fhir:Code ;
    fhir:v "SHALL"           ]         ] )       ] ;
    fhir:documentation [ fhir:v "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." ] ;
          ( fhir:interaction [
    fhir:code [ fhir:v "read" ]       ] [
    fhir:code [ fhir:v "search-type" ] ;
    fhir:documentation [ fhir:v "Submit HCPD Export Request Parameters as search instructions for bulk data export operations" ]       ] ) ;
    fhir:versioning [ fhir:v "versioned" ] ;
    fhir:readHistory [ fhir:v false ] ;
          ( fhir:searchInclude [ fhir:v "Provenance:target" ] [ fhir:v "Organization:partOf" ] [ fhir:v "Location:organization" ] [ fhir:v "Location:endpoint" ] [ fhir:v "HealthcareService:location" ] [ fhir:v "HealthcareService:organization" ] [ fhir:v "HealthcareService:endpoint" ] [ fhir:v "PractitionerRole:practitioner" ] [ fhir:v "PractitionerRole:service" ] [ fhir:v "PractitionerRole:organization" ] [ fhir:v "PractitionerRole:location" ] [ fhir:v "PractitionerRole:endpoint" ] ) ;
          ( fhir:searchRevInclude [ fhir:v "Location:organization" ] [ fhir:v "Provenance:target" ] [ fhir:v "HealthcareService:location" ] [ fhir:v "PractitionerRole:service" ] [ fhir:v "PractitionerRole:practitioner" ] [ fhir:v "HealthcareService:endpoint" ] [ fhir:v "Location:endpoint" ] [ fhir:v "PractitionerRole:endpoint" ] )     ] [
    fhir:type [ fhir:v "List" ] ;
    fhir:profile [
    fhir:v "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list|26.0.0"^^xsd:anyURI ;
    fhir:l <http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list?version=26.0.0> ;
            ( fhir:extension [
    fhir:url [
    fhir:v "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation>           ] ;
    fhir:value [
    a fhir:Code ;
    fhir:v "SHALL"           ]         ] )       ] ;
    fhir:documentation [ fhir:v "This section defines the required capabilities for processing [HCPD Export Response List](StructureDefinition-hcpd-export-response-list.html) resources received as part of bulk data export operations. The client SHALL be able to read and parse these List resources to identify resource identifiers that must be removed from local systems in compliance with suppression requirements." ] ;
          ( fhir:interaction [
    fhir:code [ fhir:v "read" ] ;
    fhir:documentation [ fhir:v "Read HCPD Export Response List resources received through bulk export operations to identify resources for local removal" ]       ] ) ;
    fhir:versioning [ fhir:v "versioned" ] ;
    fhir:readHistory [ fhir:v false ]     ] [
    fhir:type [ fhir:v "Binary" ] ;
    fhir:documentation [ fhir:v "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." ] ;
          ( fhir:interaction [
    fhir:code [ fhir:v "read" ] ;
    fhir:documentation [ fhir:v "Read Binary resources containing bulk exported data files" ]       ] ) ;
    fhir:versioning [ fhir:v "versioned" ] ;
    fhir:readHistory [ fhir:v false ]     ] ) ;
        ( fhir:operation [
    fhir:name [ fhir:v "export" ] ;
    fhir:definition [
    fhir:v "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export|3.0.0"^^xsd:anyURI ;
    fhir:l <http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export?version=3.0.0>       ] ;
    fhir:documentation [ fhir:v "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 return URLs to ndjson files containing the requested resource types. When applicable, the response may include [HCPD Export Response List](StructureDefinition-hcpd-export-response-list.html) resources that the client MUST process to remove those resource identifiers from local systems." ]     ] )
      ] ) . #