Healthdirect Australia · Authentication Profile

Healthdirect Authentication

Authentication

Healthdirect Australia secures its APIs with oauth2 and apiKey across 2 declared security schemes, as derived from its OpenAPI definitions. OAuth 2.0 is offered via the clientCredentials flow(s).

HealthcareAustraliaFHIRHL7InteroperabilityProvider DirectoryNational Health SystemHealth Services DirectoryTelehealthDigital HealthAppointments

Methods: oauth2, apiKey Schemes: 2 OAuth flows: clientCredentials API key in: header

Security Schemes

oauth2ClientCredentials oauth2

apiKey apiKey

· in: header ()

Source

Authentication Profile

generated: '2026-07-24'
method: searched
source: collections/nhsd-developers-portal.postman_collection.json + NHSD Developer Guide
docs: https://about.healthdirect.gov.au/what-we-do/portfolio/nhsd/integration-hub/documentation
summary:
  types: [oauth2, apiKey]
  api_key_in: [header]
  oauth2_flows: [clientCredentials]
  note: >-
    Dual credential model — every NHSD FHIR request carries BOTH an OAuth 2.0
    bearer access token AND a static x-api-key header. This is a system-to-system
    provider-directory API; there is no SMART-on-FHIR user/patient authorization
    (no patient/*.read or system/*.rw scopes documented).
schemes:
- name: oauth2ClientCredentials
  type: oauth2
  flow: clientCredentials
  tokenUrl: https://iam.int.nhsd.healthdirect.org.au/iam/oauth/token
  token_url_note: Integrator test environment; production IAM host mirrors this path.
  grant_params: [grant_type=client_credentials, client_id, client_secret]
  request_content_type: application/x-www-form-urlencoded
  token_response_field: accessToken
  token_use: 'Sent as Authorization: Bearer <accessToken> on FHIR requests.'
  scopes: []
  sources: [collections/nhsd-developers-portal.postman_collection.json]
- name: apiKey
  type: apiKey
  in: header
  parameter_name: x-api-key
  applies_to: [token request, all FHIR resource requests]
  sources: [collections/nhsd-developers-portal.postman_collection.json]
onboarding:
  gated: true
  note: >-
    Client credentials and API key are issued only after a formal onboarding —
    a connection request for the Integrator Test Environment, production
    registration, and an executed NHSD Agreement (~8 steps, ~3 months).
  request_url: https://healthdirect-serviceline.atlassian.net/servicedesk/customer/portal/3/group/12/create/44

Work with this as data

Every security artifact here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for security posture

4 MCP tools reach this

find_securityBrowse and filter every security artifact in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This security artifact

curl "https://apis.io/api/v1/security/healthdirect-authentication"

All security posture

curl "https://apis.io/api/v1/security?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.