FHIRsmith: CapabilityStatement/CapabilityStatement-health-connect-provider-directory-responder.json

FHIR IG analytics

Package	au.gov.digitalhealth.hcpd
Resource Type	CapabilityStatement
Id	CapabilityStatement-health-connect-provider-directory-responder.json
FHIR Version	R4
Source	https://build.fhir.org/ig/AuDigitalHealth/HCPD-Snapshot-26.0.0-SPARKED-Testing-20260708/CapabilityStatement-health-connect-provider-directory-responder.html
URL	http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-provider-directory-responder
Version	26.0.0
Status	active
Date	2026-04-29
Name	HealthConnectProviderDirectoryResponder
Title	Health Connect Provider Directory Responder
Realm	au
Description	This CapabilityStatement resource defines the expected capabilities of the [Health Connect Provider Directory Responder Actor](ActorDefinition-responder-actor-health-connect.html) when conforming to this implementation guide. The listed FHIR profiles, RESTful operations, and search parameters describe only those capabilities exposed for responding to Requester Actor requests. The Health Connect Provider Directory Responder supports additional internal and publishing operations that are not shown here; these are out of scope for this IG and are documented separately for publishing systems. The requirements of the Health Connect Provider Directory Responder may also be impacted by the rules of local jurisdictions or other contextual requirements.
Copyright	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	instance

Resources that use this resource

No resources found

Resources that this resource uses

OperationDefinition
hl7.fhir.uv.bulkdata#current	export	FHIR Bulk Data System Level Export

SearchParameter
au.gov.digitalhealth.hcpd#current	allday	SearchParameterAllDay
au.gov.digitalhealth.hcpd#current	daysofweek	SearchParameterDaysOfWeek
au.gov.digitalhealth.hcpd#current	endpoint-hcepi	SearchParameterEndpointIdentifierHC
au.gov.digitalhealth.hcpd#current	endpoint-payloadmimetype	SearchParameterEndpointPayloadMimeType
au.gov.digitalhealth.hcpd#current	endpoint-url	SearchParameterEndpointUrl
au.gov.digitalhealth.hcpd#current	endtime	SearchParameterEndTime
au.gov.digitalhealth.hcpd#current	healthcareservice-billing	SearchParameterHealthcareServiceBilling
au.gov.digitalhealth.hcpd#current	languages	SearchParameterLanguages
au.gov.digitalhealth.hcpd#current	location-amenities	SearchParameterLocationAmenities
au.gov.digitalhealth.hcpd#current	location-locmailaddress	SearchParameterAlternatePostalAddress
au.gov.digitalhealth.hcpd#current	location-physicaltype	SearchParameterLocationPhysicalType
au.gov.digitalhealth.hcpd#current	practitioner-identifier-r5	SearchParameterPractitionerIdentifierR5
au.gov.digitalhealth.hcpd#current	practitioner-regprof	SearchParameterPractitionerRegProf
au.gov.digitalhealth.hcpd#current	practitioner-rsg	SearchParameterPractitionerRSG
au.gov.digitalhealth.hcpd#current	starttime	SearchParameterStartTime
au.gov.digitalhealth.hcpd#current	suppressed	SearchParameterSuppressedBy

StructureDefinition
au.gov.digitalhealth.hcpd#current	hcpd-endpoint	HCPD Endpoint
au.gov.digitalhealth.hcpd#current	hcpd-export-request-parameters	HCPD Export Request Parameters
au.gov.digitalhealth.hcpd#current	hcpd-healthcareservice	HCPD HealthcareService
au.gov.digitalhealth.hcpd#current	hcpd-location	HCPD Location
au.gov.digitalhealth.hcpd#current	hcpd-organization	HCPD Organization
au.gov.digitalhealth.hcpd#current	hcpd-practitioner	HCPD Practitioner
au.gov.digitalhealth.hcpd#current	hcpd-practitionerrole	HCPD PractitionerRole
au.gov.digitalhealth.hcpd#current	hcpd-provenance	HCPD Provenance

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement health-connect-provider-directory-responder

Health Connect Provider Directory Responder

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: `server`

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 bulk data export operation expects request parameters conforming to the HCPD Export Request Parameters profile which defines the required parameter structure for _outputFormat, _type, _typeFilter, and optional _since parameters. The server returns 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 Type	Profile	R	S	Searches	`_include`	`_revinclude`
Provenance	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-provenance\|26.0.0	y	y	target	`Provenance:target`
Organization	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization\|26.0.0	y	y	identifier, name, type, active, suppressed	`Organization:partOf`	`Location:organization`, `Provenance:target`
Location	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location\|26.0.0	y	y	locmailaddress, locationamenities, name, address, type, locationphysicaltype, near, status, suppressed	`Location:organization`, `Location:endpoint`	`HealthcareService:location`, `Provenance:target`
HealthcareService	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice\|26.0.0	y	y	languages, hsbilling, allday, daysofweek, starttime, endtime, service-type, active, suppressed	`HealthcareService:location`, `HealthcareService:organization`, `HealthcareService:endpoint`, `HealthcareService:organization`	`PractitionerRole:service`, `Provenance:target`
PractitionerRole	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole\|26.0.0	y	y	languages, allday, daysofweek, starttime, endtime, identifier, role, active, suppressed	`PractitionerRole:practitioner`, `PractitionerRole:service`, `PractitionerRole:organization`, `PractitionerRole:location`, `PractitionerRole:endpoint`	`Provenance:target`
Practitioner	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner\|26.0.0	y	y	identifier, regprof, rsg, identifier-r5, name, active, suppressed		`PractitionerRole:practitioner`, `Provenance:target`
Endpoint	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint\|26.0.0	y	y	epurl, payloadmimetype, hcepi, name, connection-type, payload-type, status, suppressed		`HealthcareService:endpoint`, `Location:endpoint`, `PractitionerRole:endpoint`, `Provenance:target`
Parameters	http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters\|26.0.0	y	y		`Provenance:target`, `Organization:partOf`, `Location:organization`, `Location:endpoint`, `HealthcareService:location`, `HealthcareService:organization`, `HealthcareService:endpoint`, `PractitionerRole:practitioner`, `PractitionerRole:service`, `PractitionerRole:organization`, `PractitionerRole:location`, `PractitionerRole:endpoint`	`Location:organization`, `Provenance:target`, `HealthcareService:location`, `PractitionerRole:service`, `PractitionerRole:practitioner`, `HealthcareService:endpoint`, `Location:endpoint`, `PractitionerRole:endpoint`

Resource Conformance: SHALL Provenance

Base System Profile
HCPD Provenanceversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports
read
Read HC Provenance records

search-type
Search HC Provenance records by various parameters

Documentation

HC Provenance resources track the lineage of data retrieved, updated, or verified from external systems of record.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	target	`reference`

Resource Conformance: SHALL Organization

Base System Profile
HCPD Organizationversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section defines the supported interactions for the HCPD Organization profile of the Organization resource type.

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	name	`string`
SHALL	type	`token`
SHALL	active	`token`
SHALL	suppressed	`token`

Resource Conformance: SHALL Location

Base System Profile
HCPD Locationversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section describes the supported interactions for the HCPD Location profile. Each Location resource conforming to this profile identifies a physical or virtual place associated with healthcare services in the Health Connect Provider Directory, enabling clients to discover, filter, and reference service delivery sites.

Search Parameters

Conformance	Parameter	Type
SHALL	locmailaddress	`string`
SHALL	locationamenities	`token`
SHALL	name	`string`
SHALL	address	`string`
SHALL	type	`token`
SHALL	locationphysicaltype	`token`
SHALL	near	`special`
SHALL	status	`token`
SHALL	suppressed	`token`

Resource Conformance: SHALL HealthcareService

Base System Profile
HCPD HealthcareServiceversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section describes the supported interactions for the HCPD Healthcare Service profile. Each HealthcareService resource conforming to this profile identifies a healthcare service in the Health Connect Provider Directory, enabling clients to discover, filter, and reference healthcare services that are provided.

Search Parameters

Conformance	Parameter	Type
SHALL	languages	`token`
SHALL	hsbilling	`token`
SHALL	allday	`token`
SHALL	daysofweek	`token`
SHALL	starttime	`number`
SHALL	endtime	`number`
SHALL	service-type	`token`
SHALL	active	`token`
SHALL	suppressed	`token`

Resource Conformance: SHALL PractitionerRole

Base System Profile
HCPD PractitionerRoleversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section defines the supported interactions for the HCPD Practitioner Role profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the HCPD Practitioner Role profile describes a practitioner in a role at a healthcare service.

Search Parameters

Conformance	Parameter	Type
SHALL	languages	`token`
SHALL	allday	`token`
SHALL	daysofweek	`token`
SHALL	starttime	`number`
SHALL	endtime	`number`
SHALL	identifier	`token`
SHALL	role	`token`
SHALL	active	`token`
SHALL	suppressed	`token`

Resource Conformance: SHALL Practitioner

Base System Profile
HCPD Practitionerversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section describes the supported interactions for the HCPD Practitioner profile. Each Practitioner resource conforming to this profile represents an individual healthcare provider registered in the Health Connect Provider Directory, enabling clients to search, identify, and reference practitioners and their associated roles and service locations.

Search Parameters

Conformance	Parameter	Type
SHALL	identifier	`token`
SHALL	regprof	`string`
SHALL	rsg	`token`
SHALL	identifier-r5	`token`
SHALL	name	`string`
SHALL	active	`token`
SHALL	suppressed	`token`

Resource Conformance: SHALL Endpoint

Base System Profile
HCPD Endpointversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read, search-type.

Documentation

This section describes the supported interactions for the HCPD Endpoint profile. Each Endpoint resource conforming to this profile provides connection details for electronic services available through the Health Connect Provider Directory, allowing clients to discover and interact with service endpoints in a standardised way.

Search Parameters

Conformance	Parameter	Type
SHALL	epurl	`uri`
SHALL	payloadmimetype	`token`
SHALL	hcepi	`token`
SHALL	name	`string`
SHALL	connection-type	`token`
SHALL	payload-type	`token`
SHALL	status	`token`
SHALL	suppressed	`token`

Resource Conformance: SHALL Parameters

Base System Profile
HCPD Export Request Parametersversion: 26.0.0)

Profile Conformance
SHALL

Reference Policy

Interaction summary

Supports read
search-type
Process HCPD Export Request Parameters as input to bulk export operations

Documentation

This resource declares support for processing HCPD Export Request Parameters resources as input to bulk data export operations. Parameters resources conforming to this profile are used to control the scope, format, and filtering criteria for bulk exports. These resources are processed as part of the $export operation and are not directly stored or searchable.

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "health-connect-provider-directory-responder",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://digitalhealth.gov.au/fhir/hcpd/CapabilityStatement/health-connect-provider-directory-responder",
  "version": "26.0.0",
  "name": "HealthConnectProviderDirectoryResponder",
  "title": "Health Connect Provider Directory Responder",
  "status": "active",
  "experimental": false,
  "date": "2026-04-29",
  "publisher": "Australian Digital Health Agency",
  "contact": [
    {
      "name": "Australian Digital Health Agency",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.digitalhealth.gov.au/"
        },
        {
          "system": "email",
          "value": "help@digitalhealth.gov.au"
        }
      ]
    },
    {
      "name": "Australian Digital Health Agency",
      "telecom": [
        {
          "system": "url",
          "value": "https://www.digitalhealth.gov.au",
          "use": "work"
        },
        {
          "system": "email",
          "value": "mailto:help@digitalhealth.gov.au",
          "use": "work"
        }
      ]
    }
  ],
  "description": "This CapabilityStatement resource defines the expected capabilities of the [Health Connect Provider Directory Responder Actor](ActorDefinition-responder-actor-health-connect.html) when conforming to this implementation guide. The listed FHIR profiles, RESTful operations, and search parameters describe only those capabilities exposed for responding to Requester Actor requests. The Health Connect Provider Directory Responder supports additional internal and publishing operations that are not shown here; these are out of scope for this IG and are documented separately for publishing systems. The requirements of the Health Connect Provider Directory Responder may also be impacted by the rules of local jurisdictions or other contextual requirements.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "AU",
          "display": "Australia"
        }
      ]
    }
  ],
  "copyright": "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": "instance",
  "implementation": {
    "description": "Health Connect Provider Directory Responder FHIR Server",
    "url": "http://digitalhealth.gov.au/fhir/hcpd"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "_format": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        }
      ]
    },
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        }
      ]
    }
  ],
  "rest": [
    {
      "mode": "server",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/restful-security-service",
                "code": "OAuth",
                "display": "OAuth"
              }
            ]
          }
        ],
        "description": "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": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Provenance",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-provenance|26.0.0",
          "documentation": "HC Provenance resources track the lineage of data retrieved, updated, or verified from external systems of record.",
          "interaction": [
            {
              "code": "read",
              "documentation": "Read HC Provenance records"
            },
            {
              "code": "search-type",
              "documentation": "Search HC Provenance records by various parameters"
            }
          ],
          "versioning": "versioned",
          "readHistory": false,
          "searchInclude": [
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "target",
              "definition": "http://hl7.org/fhir/SearchParameter/Provenance-target|4.0.1",
              "type": "reference"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Organization",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-organization|26.0.0",
          "documentation": "This section defines the supported interactions for the [HCPD Organization](StructureDefinition-hcpd-organization.html) profile of the Organization resource type.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "searchInclude": [
            "Organization:partOf"
          ],
          "searchRevInclude": [
            "Location:organization",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Organization-identifier|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Organization-name|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/Organization-type|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/Organization-active|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Location",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-location|26.0.0",
          "documentation": "This section describes the supported interactions for the [HCPD Location](StructureDefinition-hcpd-location.html) profile. Each Location resource conforming to this profile identifies a physical or virtual place associated with healthcare services in the Health Connect Provider Directory, enabling clients to discover, filter, and reference service delivery sites.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "searchInclude": [
            "Location:organization",
            "Location:endpoint"
          ],
          "searchRevInclude": [
            "HealthcareService:location",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "locmailaddress",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-locmailaddress|26.0.0",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "locationamenities",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-amenities|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-name|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "address",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-address|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-type|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "locationphysicaltype",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/location-physicaltype|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "near",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-near|4.0.1",
              "type": "special"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Location-status|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "HealthcareService",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-healthcareservice|26.0.0",
          "documentation": "This section describes the supported interactions for the [HCPD Healthcare Service](StructureDefinition-hcpd-healthcareservice.html) profile. Each HealthcareService resource conforming to this profile identifies a healthcare service in the Health Connect Provider Directory, enabling clients to discover, filter, and reference healthcare services that are provided.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "searchInclude": [
            "HealthcareService:location",
            "HealthcareService:organization",
            "HealthcareService:endpoint",
            "HealthcareService:organization"
          ],
          "searchRevInclude": [
            "PractitionerRole:service",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "languages",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/languages|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "hsbilling",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/healthcareservice-billing|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "allday",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/allday|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "daysofweek",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/daysofweek|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "starttime",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/starttime|26.0.0",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "endtime",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endtime|26.0.0",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "service-type",
              "definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-service-type|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/HealthcareService-active|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "PractitionerRole",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitionerrole|26.0.0",
          "documentation": "This section defines the supported interactions for the [HCPD Practitioner Role](StructureDefinition-hcpd-practitionerrole.html) profile of the PractitionerRole resource type. Each PractitionerRole resource conforming to the [HCPD Practitioner Role](StructureDefinition-hcpd-practitionerrole.html) profile describes a practitioner in a role at a healthcare service.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "searchInclude": [
            "PractitionerRole:practitioner",
            "PractitionerRole:service",
            "PractitionerRole:organization",
            "PractitionerRole:location",
            "PractitionerRole:endpoint"
          ],
          "searchRevInclude": [
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "languages",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/languages|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "allday",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/allday|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "daysofweek",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/daysofweek|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "starttime",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/starttime|26.0.0",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "endtime",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endtime|26.0.0",
              "type": "number"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-identifier|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "role",
              "definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-role|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/PractitionerRole-active|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Practitioner",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-practitioner|26.0.0",
          "documentation": "This section describes the supported interactions for the [HCPD Practitioner](StructureDefinition-hcpd-practitioner.html) profile. Each Practitioner resource conforming to this profile represents an individual healthcare provider registered in the Health Connect Provider Directory, enabling clients to search, identify, and reference practitioners and their associated roles and service locations.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "searchRevInclude": [
            "PractitionerRole:practitioner",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-identifier|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "regprof",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-regprof|26.0.0",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "rsg",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-rsg|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier-r5",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/practitioner-identifier-r5|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-name|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/Practitioner-active|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Endpoint",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-endpoint|26.0.0",
          "documentation": "This section describes the supported interactions for the [HCPD Endpoint](StructureDefinition-hcpd-endpoint.html) profile. Each Endpoint resource conforming to this profile provides connection details for electronic services available through the Health Connect Provider Directory, allowing clients to discover and interact with service endpoints in a standardised way.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "versioning": "versioned",
          "searchRevInclude": [
            "HealthcareService:endpoint",
            "Location:endpoint",
            "PractitionerRole:endpoint",
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "epurl",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-url|26.0.0",
              "type": "uri"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "payloadmimetype",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-payloadmimetype|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "hcepi",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/endpoint-hcepi|26.0.0",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "name",
              "definition": "http://hl7.org/fhir/SearchParameter/Endpoint-name|4.0.1",
              "type": "string"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "connection-type",
              "definition": "http://hl7.org/fhir/SearchParameter/Endpoint-connection-type|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "payload-type",
              "definition": "http://hl7.org/fhir/SearchParameter/Endpoint-payload-type|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/Endpoint-status|4.0.1",
              "type": "token"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "suppressed",
              "definition": "http://digitalhealth.gov.au/fhir/hcpd/SearchParameter/suppressed|26.0.0",
              "type": "token"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Parameters",
          "profile": "http://digitalhealth.gov.au/fhir/hcpd/StructureDefinition/hcpd-export-request-parameters|26.0.0",
          "documentation": "This resource declares support for processing [HCPD Export Request Parameters](StructureDefinition-hcpd-export-request-parameters.html) resources as input to bulk data export operations. Parameters resources conforming to this profile are used to control the scope, format, and filtering criteria for bulk exports. These resources are processed as part of the $export operation and are not directly stored or searchable.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type",
              "documentation": "Process HCPD Export Request Parameters as input to bulk export operations"
            }
          ],
          "versioning": "versioned",
          "readHistory": false,
          "searchInclude": [
            "Provenance:target",
            "Organization:partOf",
            "Location:organization",
            "Location:endpoint",
            "HealthcareService:location",
            "HealthcareService:organization",
            "HealthcareService:endpoint",
            "PractitionerRole:practitioner",
            "PractitionerRole:service",
            "PractitionerRole:organization",
            "PractitionerRole:location",
            "PractitionerRole:endpoint"
          ],
          "searchRevInclude": [
            "Location:organization",
            "Provenance:target",
            "HealthcareService:location",
            "PractitionerRole:service",
            "PractitionerRole:practitioner",
            "HealthcareService:endpoint",
            "Location:endpoint",
            "PractitionerRole:endpoint"
          ]
        }
      ],
      "operation": [
        {
          "name": "export",
          "definition": "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/export|3.0.0",
          "documentation": "This bulk data export operation expects request parameters conforming to the [HCPD Export Request Parameters](StructureDefinition-hcpd-export-request-parameters.html) profile which defines the required parameter structure for _outputFormat, _type, _typeFilter, and optional _since parameters. The server returns 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."
        }
      ]
    }
  ]
}

FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

Health Connect Provider Directory Responder

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL Provenance

Resource Conformance: SHALL Organization

Resource Conformance: SHALL Location

Resource Conformance: SHALL HealthcareService

Resource Conformance: SHALL PractitionerRole

Resource Conformance: SHALL Practitioner

Resource Conformance: SHALL Endpoint

Resource Conformance: SHALL Parameters

Source1

Mode: `server`