AU Provider Directory Implementation Guide
2.1.0 - Draft
AU Provider Directory Implementation Guide, published by HL7 Australia. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7au/au-fhir-pd/ and changes regularly. See the Directory of published versions
Page standards status: Informative |
Multiple directory service sources (operating FHIR services under this implementation guide) may be combined to offer a federated service capability by suppliers. This allows searches by client systems to be supported across multiple directory service sources. This allows directory entries to be provided to client systems that can be used to generate secure messages that can be exchanged via a preferred secure messaging provider to another secure messaging provider preferred by the receiving client system.
From the client system perspective there is no functional impact on search or usage of directory entries for the generation of secure messages. The supplying directory and secure messaging service provider acts as an intermediary for 3rd party directory and secure message service providers and provides suitable directory entries to support forwarding of secure messages to other secure message intermediaries.
Arrangements for federated directories and secure message exchange between suppliers are on a case by case basis and completely under control of the participating federating parties.
FED01 Directory service source providers SHALL supply adequate core registration information to federating directory service providers
Property | Description |
---|---|
Name | A user-friendly description of the registered server e.g. Argus Directory |
Contact Details | Details of who to contact for support issues |
Endpoint URL | The URL of the server to send federated requests to (base URL of the FHIR server) (this should also be used as the issuer in the identity JWT) |
Authentication Details | Any details required to authenticate to the server e.g. API key (simple fixed value), authorization header (fixed/long living bearer token), client ID/secret (OAuth details) |
Vendor Thumbprint | The thumbprint of the certificate to use to connect to the vendor |
Id Prefix | Suitable prefix that may be prepended to all id fields to make unique |
Identifier Namespace | The namespace that will be used for messaging vendor-created identifiers |
FED02 Directory service results content is defined by the federated service supplier
FED03 Federating directory services SHALL supply a CapabilityStatement conformant with this Implementation Guide
FED04 Paging of directory service results MUST be supported by client and server systems
FED05 Resource referencing in federated results MUST be adequate for client use on subsequent interactions with the federated service
FED06 Tracking HTTP headers SHOULD be implemented to allow support investigation