Send a Test Call

Sending a simple Fast Healthcare Interoperability Resources (FHIR) request verifies that authentication is working and that your system can successfully communicate with the Health Gorilla FHIR API. A basic read request provides a lightweight way to confirm connectivity and confirm request formatting before moving on to deeper workflows.

Choose a Test Resource

A Patient read request is commonly used to validate access because it relies on standard FHIR behavior and minimal parameters. The request requires a valid access token and appropriate read scopes.

Send a FHIR Request

Send an HTTPS GET request to the FHIR R4 endpoint for the selected environment. Include the OAuth 2.0 access token in the Authorization header and request a FHIR JSON response.

Example: Patient Read Request

curl -X GET "https://sandbox.healthgorilla.com/fhir/R4/Patient/YOUR_PATIENT_ID" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Accept: application/fhir+json"

Replace YOUR_PATIENT_ID with a valid patient identifier available in the target environment. If you don't have one yet, obtain a patient identifier from a patient search in the target environment first.

Review the Response

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

Common elements in the response include:

resourceType: Patient
id: Patient identifier
name: One or more patient names
gender: Administrative gender value
birthDate: Date of birth in ISO 8601 format

Returned content depends on available data and the scopes associated with the access token.

Example: Patient Resource Response

{
  "resourceType": "Patient",
  "id": "YOUR_PATIENT_ID",
  "name": [
    {
      "family": "Doe",
      "given": ["John"]
    }
  ],
  "gender": "male",
  "birthDate": "1980-01-01"
}

Troubleshooting Common Issues

If the request does not succeed:

Verify that the access token is valid and unexpired.
Confirm that the request is sent to the correct environment base URL.
Check that the assigned OAuth 2.0 scopes permit read access to the requested resource.

Once a test call succeeds, authenticated access to the Health Gorilla FHIR API is confirmed. Your system is ready to verify scopes, explore additional requests, or proceed to tool-based testing.