Test in Postman

Postman provides an interactive way to validate authentication, explore request structure, and exercise supported workflows against the Health Gorilla API. Using Postman helps confirm request formatting and response behavior before integrating requests into application code.

Import the Postman Collection

The Health Gorilla Fast Healthcare Interoperability Resources (FHIR) R4 Postman collection includes preconfigured requests for common API workflows. Your implementation contact provides the collection during onboarding. Import it into Postman to begin testing.

After importing the collection, review the environment and variables to ensure they match the selected Health Gorilla environment.

Configure Environment Variables

Configure the following variables in Postman to match the target environment:

  • FHIR base URL for the selected environment
  • OAuth 2.0 access token
  • Any required identifiers or parameters used by the collection

Ensure the access token is current and unexpired before sending requests.

Send a Test Request

Select a request from the collection that aligns with your intended workflow, such as a basic FHIR read request. Send the request and review the response.

A successful request returns an HTTP 200 OK response and a valid FHIR resource in JSON format.

Review Responses and Errors

Review the response body and headers to confirm:

  • Authentication succeeded.
  • The expected FHIR resource is returned.
  • Response structure matches FHIR R4 conventions.

If a request fails, common causes include:

  • An expired or missing access token
  • Incorrect environment configuration
  • Missing OAuth 2.0 scopes or unprovisioned features

Iterate and Explore

Once a request succeeds, additional requests in the collection can be used to explore other supported workflows. Postman is well suited for iterating on request parameters and validating responses during development.

After you validate requests in Postman, you can implement similar calls in application code or test them using command-line tools.


What’s Next