health-connect-bulk-export-requester
type: CapabilityStatement
node role: treeRoot
id:
  v: health-connect-bulk-export-requester
text:
  status:
    v: extensions
  div:
    v: 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 Conformance Operation Documentation 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 Type Profil…
url:
  v: http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-bulk-export-requester
  l: health-connect-bulk-export-requester
version:
  v: 26.0.0
name:
  v: HealthConnectProviderDirectoryBulkExportRequester
title:
  v: Health Connect Provider Directory Bulk Export Requester
status:
  v: active
experimental:
  v: false
date:
  v: 2026-04-29
publisher:
  v: Australian Digital Health Agency
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: url
    value:
      v: https://www.digitalhealth.gov.au/
  telecom:
    system:
      v: email
contact:
  name:
    v: Australian Digital Health Agency
  telecom:
    system:
      v: email
    use:
      v: work
description:
  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.
use context:
  code:
    system:
      v: http://terminology.hl7.org/CodeSystem/usage-context-type
      l: usage-context-type
    code:
      v: jurisdiction
  value: CodeableConcept
    coding:
      system:
        v: urn:iso:std:iso:3166
        l: 3166
      code:
        v: AU
      display:
        v: Australia
copyright:
  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/)
kind:
  v: requirements
fhir version:
  v: 4.0.1
format:
  v: json
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
format:
  v: xml
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
rest:
  mode:
    v: client
  security:
    description:
      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.
  resource:
    type:
      v: Parameters
    profile:
      v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0
      l: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters
      extension:
        value: Code
    documentation:
      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.
    interaction:
      code:
        v: read
    interaction:
      code:
        v: search-type
      documentation:
        v: Submit HCPD Export Request Parameters as search instructions for bulk data export operations
    versioning:
      v: versioned
    read history:
      v: false
    search include:
      v: Provenance:target
    search include:
      v: Organization:partOf
    search include:
      v: Location:organization
    search include:
      v: Location:endpoint
    search include:
      v: HealthcareService:location
    search include:
      v: HealthcareService:organization
    search include:
      v: HealthcareService:endpoint
    search include:
      v: PractitionerRole:practitioner
    search include:
      v: PractitionerRole:service
    search include:
      v: PractitionerRole:organization
    search include:
      v: PractitionerRole:location
    search include:
      v: PractitionerRole:endpoint
    search rev include:
      v: Location:organization
    search rev include:
      v: Provenance:target
    search rev include:
      v: HealthcareService:location
    search rev include:
      v: PractitionerRole:service
    search rev include:
      v: PractitionerRole:practitioner
    search rev include:
      v: HealthcareService:endpoint
    search rev include:
      v: Location:endpoint
    search rev include:
      v: PractitionerRole:endpoint
  resource:
    type:
      v: List
    profile:
      v: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list|26.0.0
      l: http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-response-list
      extension:
        value: Code
    documentation:
      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.
    interaction:
      code:
        v: read
      documentation:
        v: Read HCPD Export Response List resources received through bulk export operations to identify resources for local removal
    versioning:
      v: versioned
    read history:
      v: false
  resource:
    type:
      v: Binary
    documentation:
      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.
    interaction:
      code:
        v: read
      documentation:
        v: Read Binary resources containing bulk exported data files
    versioning:
      v: versioned
    read history:
      v: false
  operation:
    name:
      v: export
    definition:
      v: http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export|3.0.0
      l: http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export
    documentation:
      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.

v: OAuth

v: OAuth

Code
v: SHALL

Code
v: SHALL