Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

Resources Overview

Overview of the Resources section
guide Engage Clinical scenarios User stories Case Studies Benefits Explore Impl Guide Resource Profiles API definitions Search parameters Value sets Design & Build Client tools Build APIs Search Ex. Code examples Test Test data API Conformance Spine integration Assure Test services Tooling Deploy (Live) Server endpoints Support Capability statement

1. Resource API Structure

The Get Binary Retrieval Pattern described in this section of the Implementation Guide has been structured consistently in the following way:

  • 0. References
  • 1. Read
  • 2. Search

1.1 Resource API Structure Details

General Description
0. References Links to other parts of the Implementation Guide which might help with context and understanding the APIs described
1. Read A description of how to get the API
2. Search Parameters List of search parameters for the profile being described, including any tips for searching. This section shows examples of how to search using the provided search parameters

2. Resource APIs

This section lists the resources used in the Get Unstructured Document API that are covered within this Implementation Guide.

Entities
FHIR Binary
Tags: rest fhir api

All content is available under the Open Government Licence v3.0, except where otherwise stated