Health Connect Australia Provider Directory FHIR Implementation Guide

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 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 identifier.

Search for HealthcareService resources by billing information.

Search HealthcareServices or PractitionerRoles by supported languages/communication methods. Shared across HealthcareService and PractitionerRole.

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 a PractitionerRole record by their role type.

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 content for describing details of an endpoint.

This profile of HealthcareService represents a particular type of health or health related service offered by a healthcare organisation at a particular location i.e. a practice, clinic, facility, or hospital. The authoritative source for healthcare services is the healthcare provider organisation that provides the service(s).

This profile defines a healthcare location (can also be referred as 'location') reflects the place, a site of care i.e. a practice, clinic, hospital, or facility at which healthcare services are provided by the healthcare organisation. The healthcare location can be a physical, mobile, or virtual location. In certain cases, a healthcare location can also represent a site of care within the hospital or building premises such as consulting room, operating room, outpatient room, unit, ward (e.g. maternity ward), department (e.g. emergency department) etc.

This profile defines a Provider Directory entry for an organisation.

This profile defines Healthcare Provider Individual details who is delivering health related services.

This profile defines a practitioner in role for an organisation at a location providing a healthcare service.

This profile of Provenance is used to record an activity performed by the HC service (conditionally on behalf of a participating organisation when the target element references a HC Organization resource) whereby specific data elements of a HC Organization or HC Practitioner resource have been initially retrieved, updated or verified from an external system of record.

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 defines a unique identifier allocated to a healthcare endpoint, in a Health Connect Provider Directory context.

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.

Identifier for a healthcare service as allocated by PCA.

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.

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

Context of Use: HealthcareService

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

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

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

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

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.

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

Referral instructions and information for healthcare service providers that may wish to refer patients / clients to the healthcare service. Modelled after PCA but for Health Connect context.

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

Context of Use: HealthcareService

Codes from: http://ns.electronichealth.net.au/hc/CodeSystem/hc-iar-levels-of-care

The Australian Endpoint Payload Types value set enumerates well known endpoint payload types.

The Health Connect Australian Service Interfaces value set enumerates well known service interfaces that can be used for specifying a connection type.

A value set of gender identities recognised by Health Connect.

The Health Connect ValueSet referencing the HC Organization Classification CodeSystem (seed, network).

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

All codes from the IAR Levels of Care CodeSystem are for use in the context of the iar-levels-of-care extension.

The Endpoint Payload Types code system defines concepts that identify well known endpoint payload types.

The Australian Secure Message Service Interfaces code system defines concepts that identify service interfaces for secure message delivery.

Internal code system that describes whether an organisation is a 'seed' or 'network' type used by Health Connect.

The HC Service Provision Code code system 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 HC.

The Health Connect IAR Levels of care code system defines concepts for the levels of care that the service provides, as defined by the National Initial Assessment and Referral (IAR) for Mental Healthcare Guidance (IAR Guidance).

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

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

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

A mobile healthcare unit location example with wheelchair access, conforming to the HC 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 HC Location profile.

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

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

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

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

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

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

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