Health Connect Australia Provider Directory FHIR Implementation Guide

The Health Connect Provider Directory Bulk Export Requester actor represents a system that initiates bulk data export requests from the Health Connect Provider Directory system. This actor is responsible for submitting properly formatted export parameters and processing the returned bulk data files, including handling HCPD Export Response Lists for resource removal operations.

The Health Connect Provider Directory Requester actor represents a system that is requesting Health Connect Provider Directory details for a particular provider or resource from the Health Connect Provider Directory system.

The Health Connect Provider Directory Responder actor represents the system that provides Health Connect Provider Directory details. It accepts requests for Directory information about practitioners or services and returns the requested information, or an error message if the request cannot be fulfilled.

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, including handling resource removal lists.

This CapabilityStatement resource defines the expected capabilities of the Health Connect Provider Directory Requester Actor when conforming to this implementation guide. The complete list of FHIR profiles, RESTful operations, and search parameters supported by Health Connect Provider Directory Requester Actor are defined in this CapabilityStatement. The requirements of the Health Connect Provider Directory Requester actor may also be impacted by the rules of local jurisdictions or other contextual requirements.

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

Search HealthcareServices or PractitionerRoles by whether they are available all day.

Search HealthcareServices or PractitionerRoles by days of week availability. Supports multiple days using OR logic.

Search HealthcareServices or PractitionerRoles by end time. Query values must use a four-digit numeric 24 hr time format (HHMM, e.g., 0830 for 8:30am). The end time is converted to an integer to enable prefix-based time searches (e.g., gt, lt, ge, le).

Search for Endpoint resources by payloadMimeType.

Search for Endpoint resources by address (URL).

Search an Endpoint record by its HC Local Identifier.

Search for HealthcareService resources by billing information.

Search HealthcareServices or PractitionerRoles by supported languages/communication methods. Shared across HealthcareService and PractitionerRole. Supports token based searching, i.e. system|code or just code

Search for Location resources by amenities.

Search for Location resources by physicalType field.

Search for Location resources by postal address components.

Enables R5-style identifier searching across both Practitioner.identifier and Practitioner.qualification.identifier paths. This allows searching for practitioners by any identifier type including HPI-I, Ahpra and other peak body registration numbers. Works with system|value OR system OR value.

Search a Practitioner record by their recorded sex or gender. This search parameter operates on the 'value' element of the individual-recordedSexOrGender extension (typically an administrative gender code). However, to fully understand the meaning and context of the recorded sex or gender, the complete extension structure returned in results should be examined, including metadata elements such as 'type' (category of what's recorded), 'source', 'sourceDocument', 'effectivePeriod', and other contextual information.

Search a Practitioner record by their registered profession using string values.

Search HealthcareServices or PractitionerRoles by start time. Query values must use a four-digit numeric 24 hr time format (HHMM, e.g., 0830 for 8:30am). The start time is converted to an integer to enable prefix-based time searches (e.g., gt, lt, ge, le).

This profile defines a Health Connect Provider Directory entry for a technical endpoint.

Defines a profile of a Parameters resource used to make bulk data export requests. It contains the standard FHIR bulk export parameters including _type, _typeFilter, _outputFormat, and _since for controlling the export scope and format.

This profile defines a List resource used in context of the Bulk Data Extraction capability. This communicates which resources should be removed from downstream systems. It MAY contain identifiers from ALL HCPD resource types.

This profile defines a Health Connect Provider Directory entry for a healthcare service offered by an organisation.

This profile defines a Health Connect Provider Directory entry for a healthcare location where services are provided.

This profile defines a Health Connect Provider Directory entry for an organisation.

This profile defines a Health Connect Provider Directory entry for a healthcare practitioner.

This profile defines a Health Connect Provider Directory entry for a practitioner role within an organisation.

This profile of Provenance is used to track activities related to provider directory data, recording when specific data elements of a HCPD Organization or HCPD Practitioner resource have been retrieved, updated or verified.

This profile of Location represents an Australian geographic coverage area i.e. postcodes where this service is provided. For a healthcare service, that is provided through a physical location but have eligibility restrictions applicable in terms of only residents for certain postcodes/suburbs can receive this service, then the details of coverage area and eligibility should be provided here.

This identifier profile extends the AU HPI-O profile to include an organization classification extension to indicate whether the organization is a 'seed' or 'network' type.

This identifier profile defines a Healthcare Support Service Provider Organisation in an Australian context. An HSP-O is assigned under the HI Service to a service (in-home care support and personal care services) where healthcare is provided. A HSP-O can only be of 'seed' type. An Organization cannot be assigned both an HPI-O and an HSP-O; only one identifier is assigned by the HI Service.

This profile of Identifier defines a HCPD Local Identifier (HCPD-LI) used for system reference and internal business logic.

This identifier profile defines a professional registration number allocated to a healthcare practitioner, in a Health Connect Provider Directory context.

This identifier profile defines a SMD target identifier allocated to a healthcare practitioner, in a Health Connect Provider Directory context.

The period during which the HealthcareService is considered active in the Health Connect Provider Directory Responder. Patterned after PCA Active Period.

This extension applies to PractitionerRole, and represents a name by which a practitioner chooses to be known in the context of the delivery of a specific healthcare service.

Physical features or amenities available within, or in close proximity of, a location. Uses the NCTS Facility Amenity ValueSet.

Alternate postal/mailing address for correspondence (PO Box or mailing address) that is distinct from the registered physical address.

Extension to record whether an organisation's HPIO is a 'seed' or 'network' type in the HI service.

Indicates the IAR (Initial Assessment and Referral) Levels of Care for a healthcare service.

Context of Use: HealthcareService

Codes from: http://digitalhealth.gov.au/fhir/hcpd/CodeSystem/hcpd-iar-levels-of-care

Indicates whether the healthcare service is accepting new patients. Patterned after PCA New Patient Availability extension.

Context of Use: HealthcareService

Practitioner Role Communication. This extension captures communication preferences and capabilities for a practitioner in a given role.

Referral instructions and information for healthcare service providers that may wish to refer patients / clients to the healthcare service.

All codes in the HI Service Organization Classification CodeSystem code system.

The Service Provision Code ValueSet includes values that may be used to identify the service provision condition of a healthcare service.

Internal code system that describes whether an organisation is a 'seed' or 'network' type in the HI Service.

The Service Provision CodeSystem defines a concept (in addition to those defined in Service Provision Conditions Australian Concepts that may be used to identify the service provision condition of a healthcare service in HCPD.

An example Endpoint with an SMD target identifier for secure messaging conforming to the HCPD Endpoint profile.

An example Parameters resource conforming to the HCPD Export Request Parameters profile, requesting export of all cardiology services in Balmain including organizations, locations, services, roles and practitioners.

An example Parameters resource showing a delta export request with _since parameter for retrieving changes since a previous export.

An example List resource conforming to the HCPD Export Response List profile, containing identifiers of resources flagged for removal from downstream systems.

A Residential Aged Care HealthcareService example conforming to the HCPD HealthcareService profile.

A physical medical centre location example with wheelchair access, conforming to the HCPD Location profile.

A mobile healthcare unit location example with wheelchair access, conforming to the HCPD Location profile.

A virtual coverage area defining the geographical service boundary for the mobile healthcare unit.

A virtual telehealth service location example without physical address, conforming to the HCPD Location profile.

An Aged Care Facility example conforming to the HCPD Organization profile.

A Home Care Support Service example conforming to the HCPD Organization profile with HSP-O identifier.

An example Practitioner (Alex Smith) conforming to the HCPD Practitioner profile.

Practitioner serving Balmain examples.

An external practitioner record example (PRN identifier) conforming to the HCPD Practitioner profile.

An example PractitionerRole (Medicare) that conforms to the HCPD PractitionerRole profile.

Demonstrates provenance tracking for a practitioner's name amendment, conforming to the HCPD Provenance profile.

Demonstrates provenance tracking for a practitioner's phone number amendment, conforming to the HCPD Provenance profile.