Australian Provider Directory Implementation Guide (PD 2)

This page is part of the Australian Provider Directory IG (v2.0.1: PD 2 on FHIR R4) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Capability Statements Defined

Scope of Resource Profiles

A subset of FHIR resource types are used in this specification. These are profiled to ensure minimal elements needed for secure messaging are supported by the directory service.

  • Location is physical location, where service delivery occurs.
  • Organization is an entity providing practitioner roles and/or healthcare service.
  • PractitionerRole (provider) is a practitioner acting roles at one location for one organisation.
  • Practitioner details of an individual that maybe acting in a practitioner role.
  • HealthcareService describes the services delivered at one location for one organisation.

Service Interactions Overview

A subset of FHIR possible interactions are required for this specification. This applies to core directory services offered by a directory provider and also federated services combining results from multiple directory service sources.

Instance Level Interactions

  • read PractitionerRole, Practitioner, HealthcareService, Location, Organization, Endpoint
  • vread Not Required
  • update Not Required
  • patch Not Required
  • delete Not Required
  • history Not Required

Type Level Interactions

  • create Not Required
  • search PractitionerRole, Practitioner, HealthcareService, Location, Organization, Endpoint
  • history Not Required

Whole System Interactions

  • capabilities Required
  • batch/transaction Not Required
  • history Not Required
  • search Not required

Expected scope of search/include support:

Resource Type Profile Search Parameters Includes
Organization Australian Organisation Directory Entry active, identifier, name  
Practitioner Australian Practitioner Directory Entry active, identifier, family, given, name  
PractitionerRole Australian PractitionerRole Directory Entry active, identifier, location.address-city, location.address-postalcode, location.address-state, location.near, location.near-distance, organization.identifier, practitioner.name, practitioner.family, practitioner.given location, organization, endpoint, practitioner
HealthcareService Australian HealthcareService Directory Entry active, identifier, name, location.address-city, location.address-postalcode, location.address-state, location.near, location.near-distance, organization.identifier location, organization, endpoint
Location Australian Location Directory Entry status, address-city, address-postalcode, address-state, near, near-distance  
Endpoint Australian Endpoint Directory Entry status, identifier, connection-type, payload-type, au-receivingfacility-namespace-id, au-receivingfacility-universal-id, au-receivingfacility-universal-id-type  

Expected adherence to search parameters:

  • FHIR search _include parameter SHALL be supported to the extent described in above table.
  • FHIR search _count parameter SHALL be honoured by directory service provider to limit the result count as requested by client consumers.

Expected Bundle result support and behaviour:

  • Bundle.link (paging) MAY be supplied by directory service provider, this is most useful as _count limit on result count suggests paging is desirable.
  • Bundle.link (paging) with IANA link relation ‘next’[1] MUST be supported by client consuming system to allow next page retrieval when available.