Search
K
< Back

Initial Configuration

Before you begin API development, ensure your tenant is provisioned and configured to support your licensed solutions. This includes enabling key capabilities, verifying tenant metadata, and setting up delivery channels for alerts and notifications. Completing these steps early helps ensure that your integration functions correctly in both sandbox and production environments.

Licensed Solutions

Health Gorilla Support enables only the features your organization has licensed. These may include:

  • Patient360 record retrieval
  • Clinical Alerts
  • Lab Ordering
  • HL7 ADT Notifications

If you are unsure which solutions have been provisioned, refer to your onboarding documentation or contact your Client Success Manager.

Tenant Configuration

Support configures your tenant with the required metadata and group structure. You are responsible for confirming that:

  • Your organization’s NPI, taxonomy, and contact information have been added
  • Provider groups and user roles are correctly configured
  • Groups are structured to support alert routing and data access

You can use the FHIR API to verify this setup:

  • GET /Group to list groups
  • GET /Group/{id} to view group details and assigned members
  • POST /Group/{id}/$members to add patients to a group, or submit a list to Support for bulk enrollment

Delivery Setup

To receive alerts and HL7 messages, set up at least one delivery method:

  • Webhook delivery
    • Register a publicly accessible https:// endpoint that accepts POST requests
    • Confirm that your system responds with HTTP 200
  • HL7 ADT delivery
    • Coordinate with Support to configure Mirth routing
    • Verify SSH access and review message delivery in test logs

Validation in the Sandbox

After configuration is complete, use the sandbox environment to validate:

  • Webhook delivery using synthetic patient alerts
  • HL7 delivery using Mirth log inspection
  • Group enrollment and membership via the API
  • Access to clinical records through test queries

For instructions on using sandbox data, go to Test Data in the Sandbox.

What Happens Next

Initial configuration prepares your tenant and delivery channels, but your team must complete the development and integration work required to connect your system to Health Gorilla APIs. This includes implementing authentication, building workflows to send and receive FHIR or HL7 messages, processing and storing retrieved data, and configuring error handling, retries, and logging. For assistance with this, see the Developer Quickstart.

After completing this work, return to the Sandbox Testing procedure to validate your workflows before moving on to network testing.