My Health Record FHIR Gateway - API Specification v5.0

This document provides an overview of the API specifications required by developers to connect applications (apps) to the My Health Record system. This document describes API requests, API responses, OperationOutcome details, and error conditions that apply to application transactions.

Intended audience

This document is intended for use by Fast Healthcare Interoperability Resources (FHIR®) API consumers to understand the API signature exposed by the My Health Record system. This includes information about request messages, response messages, error handling and request processing logic. This document will serve as an input to the National Infrastructure Operator (NIO) Build team for the development and implementation of the solution. This document is also intended as an input to the NIO Test team for the purpose of defining test scripts.