myHealth Record

A practical guide to myHealth Record APIs

The myHealth Record B2B gateway exposes document upload, retrieval, search, and consent services. Understanding which service to call, how authentication works, and what payloads are expected is the foundation of any integration.

Common challenges

What teams struggle with

Sparse public documentation

Official specs exist but are spread across conformance profiles, implementation guides, and vendor portals — hard to piece together without prior experience.

Multiple service endpoints

Document services, individual healthcare identifier services, and provider directories each have distinct contracts and error models.

Sandbox vs production differences

Test environments behave differently from production. Teams often discover edge cases only after conformance testing.

Versioning and profile changes

CDA and FHIR document profiles evolve. Keeping parsers and generators up to date requires ongoing attention.

How we help

Practical solutions that ship

Integration blueprints

Reference architectures for common flows: upload a prescription, retrieve a shared health summary, search for patient documents.

API client development

Typed, tested API clients with retry logic, error mapping, and logging suitable for healthcare audit requirements.

Sandbox test harnesses

Automated test suites that run against ADHA sandbox environments before conformance submissions.

Developer onboarding docs

Internal documentation so your team can maintain and extend the integration after handover.

Frequently asked

Questions about myhealth record api guide

Which myHealth Record services do most apps need?

Most integrations use document upload/retrieval, patient search, and consent services. The exact set depends on whether you're a prescriber, dispenser, pathology provider, or general practice.

Is REST or SOAP used?

The B2B gateway primarily uses SOAP web services with XML payloads for clinical documents. FHIR-based approaches are increasingly supported for certain document types.

Related guides

You might also need