Subscription Types
Health Gorilla supports a defined set of FHIR subscription configurations for monitoring new or updated data across products and workflows. Each subscription type defines the resource or event to monitor, the parameters supported in the criteria field, and the payload format used for notifications.
The supported types ensure consistent behavior across integrations and provide a reference for configuring subscriptions programmatically through the FHIR API. Some subscription types are available across all tenants, while others are tightly coupled with specific products such as Clinical Alerts and Patient360.
Platform-Wide Subscriptions
These subscription types are available to all tenants supporting the FHIR subscription framework. They deliver standard FHIR resources and system-level events that are not tied to a specific product.
| Resource or Event Type | Supported Parameters | Payload Type | Common Use Case |
|---|---|---|---|
| DiagnosticReport | patient, category, status, reportedInLastDays | application/fhir+json | Laboratory and diagnostic reports |
| Observation | patient, category, code, reportedInLastDays | application/fhir+json | Lab observations and vital signs |
| DocumentReference | patient, class, type | application/fhir+json | Imported or updated clinical documents |
| Encounter | patient, status | application/fhir+json | Admission, discharge, or transfer updates |
| FaxMessage | direction, deliveryFailed | application/hg-event+json | Failed or successfully delivered fax messages |
| DirectMessage | direction | application/hg-event+json | Secure Direct message delivery notifications |
Operational Events
| Resource or Event Type | Supported Parameters | Payload Type | Common Use Case |
|---|---|---|---|
| Patient P360 event | (system-triggered, no parameters) | application/hg-event+json | Notification when documents are imported via Patient360 |
| OperationOutcome | (system-triggered, no parameters) | application/fhir+json | Indicates completion of a Patient360 query or processing event |
Product-Scoped Subscriptions
| Resource or Event Type | Available With | Supported Parameters | Payload Type | Common Use Case |
|---|---|---|---|---|
| Bundle (HL7 v2 ADT) | Clinical Alerts | message.event, message.focus, _lastUpdated, eventType | application/fhir+json | Admission, discharge, or transfer notifications (HL7 v2 message format) |
| Condition | Patient360 | patient | application/fhir+json | New or updated problem list entries |
| AllergyIntolerance | Patient360 | patient | application/fhir+json | Documented medication or substance allergies |
| MedicationRequest | Patient360 | patient | application/fhir+json | New or updated medication orders |
| MedicationStatement | Patient360 | patient | application/fhir+json | Medication adherence or usage updates |
| Immunization | Patient360 | patient | application/fhir+json | New or updated vaccination records |
| Consent | Patient360 or IAS | patient | application/fhir+json | Updates to consent or authorization records |
| CarePlan | Patient360 | patient | application/fhir+json | Updates to active or completed care plans |
| Procedure | Patient360 | patient | application/fhir+json | New or updated procedure entries |
| Goal | Patient360 | patient | application/fhir+json | Clinical or care-management goals |
| FamilyMemberHistory | Patient360 | patient | application/fhir+json | Family medical history updates |
| DeviceUseStatement | Patient360 | patient | application/fhir+json | Use or discontinuation of a medical device |
Implementation Details
- Append supported parameters to the criteria field when defining a subscription (for example,
"criteria": "DiagnosticReport?reportedInLastDays=2"). - Unsupported parameters return a
422 Unprocessable Entityerror. - Notifications are sent to the endpoint defined in
channel.endpoint. - Standard payloads use
application/fhir+json. - Event-based notifications (for example, fax or Direct messages) use
application/hg-event+json, a simplified JSON format containing only the resource type and ID reference. - ADT notifications use a FHIR
Bundlethat carries the encapsulated HL7 v2 message structure and metadata. - Supported resource types and parameters may expand as new capabilities are released.