Developer Quickstart

The quickstart provides a path to test connectivity, validate authentication, and submit initial API requests, helping you confirm configuration and create a working baseline for development.

Prerequisites

Gather the required credentials, protocols, and environment details before beginning development.

Implementation Paths

Identify whether you are building as an EHR vendor, payer, HIE, or public health organization, and learn how your model affects scopes, workflows, and API usage.

Set Up Your Environment

Apply the correct base URL and configure sandbox or production endpoints.

Get a Token

Obtain an OAuth 2.0 bearer token and use it to authorize API requests.

Send a Test Call

Submit a simple FHIR request to verify authentication and data access.

Verify Access

Check assigned OAuth scopes to ensure expected permissions are granted.

Test in Postman

Use the Health Gorilla Postman collection to run interactive sandbox tests.

Test with curl

Run command-line requests using curl to validate token handling and connectivity.

Best Practices

Follow recommended patterns for authentication, retries, rate limits, and monitoring.

FAQs

Find answers to common setup, request, and environment-related questions.