Search
K
< Back

Manage a Subscription

You can manage FHIR subscriptions to maintain reliability, adjust delivery behavior, and keep configurations aligned with your organization’s operational needs. Management actions include viewing existing subscriptions, updating delivery parameters, and disabling or deleting inactive records.

Health Gorilla supports standard FHIR operations for retrieving, modifying, and deleting subscriptions through the /Subscription endpoint. Use these operations to confirm status, change headers or delivery endpoints, and rotate credentials without recreating the entire subscription.

View a subscription

View existing subscriptions to verify their configuration and delivery status.

  1. Send a GET request to the Subscription endpoint.
GET https://api.healthgorilla.com/fhir/Subscription/YOUR_SUBSCRIPTION_ID
Accept: application/fhir+json
  1. To retrieve multiple subscriptions, include a query parameter such as status=active.
GET https://api.healthgorilla.com/fhir/Subscription?status=active
  1. Review the returned configuration and verify details such as criteria, channel.endpoint, and status.

Update a subscription

You can update a subscription to replace headers, rotate tokens, or update the delivery endpoint.

  1. Send a PATCH request to the subscription using the application/json-patch+json format.
  2. Include only the fields that require updates.

Example: Replace authorization headers

PATCH https://api.healthgorilla.com/fhir/Subscription/YOUR_SUBSCRIPTION_ID
Content-Type: application/json-patch+json

[
  {
    "op": "replace",
    "path": "/channel/header",
    "value": [
      "Authorization: Bearer YOUR_NEW_ACCESS_TOKEN"
    ]
  }
]

Example: Update the endpoint URL

PATCH https://api.healthgorilla.com/fhir/Subscription/YOUR_SUBSCRIPTION_ID
Content-Type: application/json-patch+json

[
  {
    "op": "replace",
    "path": "/channel/endpoint",
    "value": "https://your-system.com/healthgorilla/webhook"
    }
]

Disable a subscription

You can pause notifications without deleting the subscription.

  1. Send a PATCH request and set the status to off.
PATCH https://api.healthgorilla.com/fhir/Subscription/YOUR_SUBSCRIPTION_ID
Content-Type: application/json-patch+json

[
  {
    "op": "replace",
    "path": "/status",
    "value": "off"
  }
]
  1. Verify that the subscription no longer delivers notifications.
  2. When ready to resume, change the status value back to active.

Delete a subscription

You can permanently remove a subscription and stop all related notifications.

  1. Send a DELETE request to the subscription ID.
DELETE https://api.healthgorilla.com/fhir/Subscription/YOUR_SUBSCRIPTION_ID
  1. Confirm the deletion response and ensure no further notifications are sent.

Best Practices

  • Disable subscriptions during maintenance windows rather than deleting them.
  • Rotate authentication credentials and headers regularly.
  • Review active subscriptions quarterly to confirm alignment with operational needs.
  • Remove obsolete subscriptions to avoid unnecessary callbacks.