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-SPARKED-Testing-20260708/ and changes regularly. See the Directory of published versions

CapabilityStatement: Health Connect Provider Directory Bulk Export Requester

Official URL: http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-bulk-export-requester Version: 26.0.0
Active as of 2026-04-29 Computable Name: HealthConnectProviderDirectoryBulkExportRequester

Copyright/Legal: This content is licensed under a Creative Commons Attribution 4.0 International License. See https://creativecommons.org/licenses/by/4.0/

This CapabilityStatement resource defines the expected capabilities of the Health Connect Provider Directory Bulk Export Requester Actor 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.

Raw OpenAPI-Swagger Definition file | Download

Health Connect Provider Directory Bulk Export Requester

  • Implementation Guide Version: 26.0.0
  • FHIR Version: 4.0.1
  • Supported Formats: SHALL support json, SHALL support xml
  • Published on: 2026-04-29
  • Published by: Australian Digital Health Agency

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: client

Security
Enable CORS: no
Security services supported: OAuth

All interactions SHALL be secured using OAuth protocols. It SHALL support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements.

Summary of System-wide Operations
ConformanceOperationDocumentation
SHALL$export

This operation enables the client to initiate bulk data export requests by submitting HCPD Export Request Parameters 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.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Parametershttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0yy_outputFormat, _type, _typeFilter, _sinceProvenance:target, Organization:partOf, Location:organization, Location:endpoint, HealthcareService:location, HealthcareService:organization, HealthcareService:endpoint, PractitionerRole:practitioner, PractitionerRole:service, PractitionerRole:organization, PractitionerRole:location, PractitionerRole:endpointLocation:organization, Provenance:target, HealthcareService:location, PractitionerRole:service, PractitionerRole:practitioner, HealthcareService:endpoint, Location:endpoint, PractitionerRole:endpoint
Binary y
Base System Profile
HCPD Export Request Parametersversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports read
    search-type

    Submit HCPD Export Request Parameters as search instructions for bulk data export operations

Documentation

This section defines the supported interactions for submitting HCPD Export Request Parameters 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.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_outputFormatstring

Specifies the output format for bulk export. Fixed to application/fhir+ndjson.

SHALL_typestring

Comma-separated list of resource types to include in the bulk export (e.g. Organization,Location,HealthcareService,Practitioner,PractitionerRole,Endpoint,Provenance).

SHALL_typeFilterstring

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.

SHOULD_sincedate

Only resources updated since the specified instant (ISO 8601) will be included in the export. Used for delta/incremental extracts.

 
Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • Supports
    read

    Read Binary resources containing bulk exported data files

Documentation

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.