Generated Narrative: CapabilityStatement health-connect-bulk-export-requester

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 return URLs to ndjson files containing the requested resource types. When applicable, the response may include HCPD Export Response List resources that the client MUST process to remove those resource identifiers from local systems.

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.0yyProvenance: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
Listhttp://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list|26.0.0y
Binary y

Resource Conformance: unspecified Parameters

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.

Resource Conformance: unspecified List

Base System Profile
HCPD Export Response Listversion: 26.0.0)
Profile Conformance
SHALL
Reference Policy

Interaction summary
  • Supports
    read

    Read HCPD Export Response List resources received through bulk export operations to identify resources for local removal

Documentation

This section defines the required capabilities for processing HCPD Export Response List 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.

Resource Conformance: unspecified Binary

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.

 <status value="active"/> <experimental value="false"/> <date value="2026-04-29"/> <publisher value="Australian Digital Health Agency"/> <contact> <name value="Australian Digital Health Agency"/> <telecom> <system value="url"/> <value value="https://www.digitalhealth.gov.au/"/> </telecom> <telecom> <system value="email"/> <value value="help@digitalhealth.gov.au"/> </telecom> </contact> <contact> <name value="Australian Digital Health Agency"/> <telecom> <system value="email"/> <value value="mailto:help@digitalhealth.gov.au"/> <use value="work"/> </telecom> </contact> <description value="This CapabilityStatement resource defines the expected capabilities of the [Health Connect Provider Directory 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."/> <useContext> <code> <system value="http://terminology.hl7.org/CodeSystem/usage-context-type"/> <code value="jurisdiction"/> </code> <valueCodeableConcept> <coding> <system value="urn:iso:std:iso:3166"/> <code value="AU"/> <display value="Australia"/> </coding> </valueCodeableConcept> </useContext> <copyright value="Copyright © 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 value="requirements"/> <fhirVersion value="4.0.1"/> <format value="json"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> </format> <format value="xml"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> </format> <rest> <mode value="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> <type value="Parameters"/> <profile value="http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> </profile> <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"/> </resource> <resource> <type value="List"/> <profile value="http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list|26.0.0"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> </profile> <documentation value="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."/> <interaction> <code value="read"/> <documentation value="Read HCPD Export Response List resources received through bulk export operations to identify resources for local removal"/> </interaction> <versioning value="versioned"/> <readHistory value="false"/> </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 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."/> </operation> </rest> </CapabilityStatement>