Configuration
Configuring a subscription defines the criteria for monitoring new or updated data and how event notifications are delivered to your system. Proper configuration ensures that subscriptions are precise, reliable, and aligned with your security and compliance policies.
Why Configure Subscriptions
Configuring subscriptions allows your organization to:
- Monitor only relevant patients, populations, or resource types
- Limit notifications to meaningful events such as lab results or encounter updates
- Ensure secure delivery to authorized endpoints
- Maintain control over reliability, performance, and compliance
Configuration Elements
Each subscription defines monitoring criteria and delivery settings that determine when notifications are triggered and where they are sent.
| Element | Description | Examples or Notes |
|---|---|---|
| Resource or Event Type | Identifies the FHIR resource or event category to monitor. | DocumentReference, Observation, or Encounter |
| Filters | Defines the event criteria using parameters such as patient ID, code, category, or time window. | DiagnosticReport?reportedInLastDays=2 |
| Patient Roster | Specifies which patients are monitored, usually managed through an enrollment or roster API. | Restricts notifications to enrolled individuals |
| Delivery Method | Determines how notifications are sent. FHIR subscription delivery is preferred; HL7 v2 and polling are supported only in specialized or legacy use. | HTTPS endpoint for event notifications |
| Endpoint and Credentials | Specifies the delivery URL and authentication details. | Authorization header, API key, or mutual TLS certificate |
How Configuration is Applied
Subscriptions are created through the FHIR subscription resource using Health Gorilla APIs.
- Configuration parameters—including filters, rosters, and delivery settings—are defined in the Subscription resource.
- The subscription is activated once validated by Health Gorilla.
- Notifications are automatically sent when incoming or updated data matches the configured criteria.
- Configuration values can be updated or replaced at any time without recreating the entire subscription.
Example Configurations
- Lab Results: Subscribe to
Observationresources with a category of “laboratory,” tied to a defined patient roster. - Encounter Updates: Subscribe to
Encounterresources for active inpatients, with notifications sent to a secure HTTPS endpoint. - Bulk Job Completion: Subscribe to asynchronous export jobs to receive notifications when processing completes and batch files are ready to download.
Operational Considerations
- Scalability: Limit the scope to reduce noise and avoid unnecessary notifications.
- Security: Verify endpoints that require authentication and are restricted to trusted IP ranges.
- Reliability: Maintain endpoint uptime and prompt acknowledgment to prevent delivery retries.
- Maintenance: Review filters, rosters, and credentials regularly to align with policy and workflow changes.
- Auditability: All configuration changes and deliveries are logged for compliance and traceability.