Search
K
< Back

FAQs

Get answers to common questions that arise during the early stages of working with the Health Gorilla API.

1. How do I obtain API credentials?

Contact your Client Success Manager (CSM) or email support@healthgorilla.com to request credentials for both the Sandbox and Production environments. Credentials are environment-specific and must be stored securely.

2. Can I test the API without using live data?

Yes. The Sandbox environment includes synthetic patients and simulated clinical documents that support testing Patient360, Clinical Alerts, and document retrieval workflows.

3. How do I know if I am using FHIR R4 or STU3?

Check your base URL:

  • FHIR R4: /fhir/R4/
  • FHIR STU3: /fhir/3.0.1/

You can also verify your version by inspecting resource paths or contacting your CSM.

4. What is the difference between Sandbox and Production?

  • Sandbox: Contains synthetic data and is intended for testing and validation.
  • Production: Contains live clinical data and is used for authorized, real-world workflows.

Credentials, scopes, and tokens are not shared between environments.

5. How do I trigger Clinical Alerts or ADT messages in Sandbox?

Health Gorilla can simulate alert delivery using synthetic patients. Coordinate with your CSM to enable alerts and verify webhook behavior.

6. Can I filter data by patient ID or date range?

Yes. Most search endpoints support query parameters such as patient, date, and _lastUpdated.

7. What if I only need access to lab data?

You can request specific scopes such as observation.read and diagnosticreport.read to limit access to lab results only. Scope-based access allows you to tailor access to your needs.

8. Do you support asynchronous queries?

Yes. The FHIR STU3 API supports asynchronous queries for operations such as $everything. However, the FHIR R4 API is recommended and it uses synchronous queries by default.

9. How long do access tokens last?

Access tokens are valid for approximately one hour. When the token expires, request a new one using the same credentials. The client credentials flow does not support refresh tokens.

10. Can I receive support while working with the API?

Yes. Contact your CSM for onboarding and integration support or email support@healthgorilla.com with questions about configuration, access, or troubleshooting.