Health Connect Australia Provider Directory FHIR Implementation Guide

All interactions SHOULD be secured using OAuth protocols. It SHOULD support authentication, authorisation, and audit logging in accordance with local policy and regulatory requirements.

• Supports the search-systeminteraction described as follows:

  Definition:

  This operation is a RESTful search interaction (whole system interaction), across multiple resource types (as described in the FHIR specification).

  Behaviour:

  This operation is used by a client system operated by a Health Connect Provider Directory Requester to get resources that match the specified search parameters. .

  The following search parameters are supported:

  • _lastUpdated is used to get the resources that have been added or changed since the requesting system last synchronised their local data store with Health Connect Provider Directory Requester. This search parameter supports the gt and lt comparison prefixes.

  • _type is used to filter the resources returned by their resource type. The available types are:

    • HealthcareService (returns resources conforming to the HC Healthcare Service profile)

    • PractitionerRole (returns resources conforming to the HC Practitioner Role profile)

    • Organization (returns resources conforming to the HC Organization profile)

    • Location (returns resources conforming to the HC Location profile)

    • Practitioner (returns resources conforming to the HC Practitioner profile)

    • Provenance (returns resources conforming to the HC Provenance profile)

  All of the following query parameters are required in order to receive the complete set of resources that have been created, changed or published since [last_synchronized]:

  _lastUpdated=[last_synchronized]

  _type=HealthcareService,PractitionerRole,Practitioner,Organization,Location,Provenance

  _include=Location:organization

  _include=HealthcareService:organization

  _include=HealthcareService:location

  _include=PractitionerRole:organization

  _include=PractitionerRole:location

  _include=PractitionerRole:service

  _include=PractitionerRole:practitioner

  _include=Provenance:target

  _include:iterate=HealthcareService:organization

  _include:iterate=HealthcareService:location

  _include:iterate=PractitionerRole:organization

  _include:iterate=PractitionerRole:location

  _include:iterate=PractitionerRole:service

  _include:iterate=PractitionerRole:practitioner

  As described above the resources returned in the Bundle exclude any Identifiers (e.g. HPI-Is) that cannot be disclosed to the subscriber.

  This operation supports 'paging' (see FHIR specification). If there are too many resources to return in one Bundle, the FHIR server adds a next link to the response Bundle. The contents of the result Bundle therefore comprise all instances of the requested resource types whose lastUpdated timestamp is greater than the <lastSync> in the request query expression and less than or equal to <lastInBundle> where <lastInBundle> is the greatest lastUpdated value of all resources included in the result Bundle. The Subscriber Agent FHIR server sets the next link to the filter expression that was used in the original request except that <lastSync> is replaced with <lastInBundle>. If the next link is not present in the Bundle, then there are no more service offerings available.