Subscription Types

Each subscription is created by setting the criteria field on a FHIR R4 Subscription resource, for example "criteria": "DiagnosticReport?status=final".

Platform-Wide Subscriptions

These deliver standard FHIR resources and are created by the client via the FHIR API.

Resource Type	Supported Parameters	Payload Type	Common Use Case
`Patient`	`gender`, `birthDate` (`eq`/`gt`/`lt`), `postalCode`	`application/fhir+json`	Patient demographic add or update
`DiagnosticReport`	`patient`, `category`, `status`, `reportedInLastDays`	`application/fhir+json`	Laboratory and diagnostic reports
`Observation`	`patient`, `category`	`application/fhir+json`	Lab observations and vital signs
`DocumentReference`	`patient`, `class`, `type`	`application/fhir+json`	Imported or updated clinical documents
`Encounter`	`patient`	`application/fhir+json`	New or updated encounters
`FaxMessage`	`direction`, `deliveryFailed`	`application/hg-event+json`	Failed or delivered fax messages
`DirectMessage`	`direction`	`application/hg-event+json`	Secure Direct message delivery notifications
`InstantMessage`	`direction`	`application/fhir+json`	Secure message notifications
`RequestGroup`	`patient`, `status`, `_tag`	`application/fhir+json`	New or updated lab orders
`ServiceRequest`	`patient`, `status`	`application/fhir+json`	New or updated referrals and orders

System-Initiated Notifications

You create each of these subscriptions, and Health Gorilla sends a notification when the related event completes. For the Patient360 event, set the criteria field to Patient.P360. For the OperationOutcome notification, set the criteria field to OperationOutcome?async=true.

Resource Type	Supported Parameters	Payload Type	Common Use Case
Patient360 event	system-initiated, no parameters	application/hg-event+json	Notification when documents are imported via Patient360
`OperationOutcome`	`async` (for example `OperationOutcome?async=true`)	application/fhir+json	Completion of an asynchronous Patient360 query or processing event

ADT Notifications

You create each ADT subscription with the required message.event filter set to admin-notify, for example "criteria": "Bundle?message.event=admin-notify". The payload type is application/fhir+json.

Resource or Event Type	Supported Parameters	Common Use Case
`Bundle` (HL7 v2 ADT)	`message.event`, `diagnosis`, `eventType`, `patientClass`	Admission, discharge, and transfer notifications, delivered as a FHIR Bundle encapsulating the HL7 v2 message. Also available over SFTP.

ADT delivery is independent of Clinical Alerts and of the Patient360 query workflow: network-sourced ADT messages arrive regardless of those products.

Product-Scoped Subscriptions

These subscriptions are available with Patient360. You create each one with a patient filter, and the payload type is application/fhir+json.

Resource Type	Common Use Case
`Condition`	New or updated problem list entries
`AllergyIntolerance`	Documented medication or substance allergies
`MedicationRequest`	New or updated medication orders
`MedicationStatement`	Medication adherence or usage updates
`MedicationDispense`	Medications dispensed to the patient
`NutritionOrder`	New or updated nutrition orders
`Immunization`	New or updated vaccination records
`Consent`	Updates to consent or authorization records
`CarePlan`	Updates to active or completed care plans
`Coverage`	New or updated insurance coverage
`Procedure`	New or updated procedure entries
`Goal`	Clinical or care-management goals
`FamilyMemberHistory`	Family medical history updates
`DeviceUseStatement`	Use or discontinuation of a medical device

Implementation Details

Append supported parameters to the criteria field, for example "criteria": "DiagnosticReport?reportedInLastDays=2".
An unsupported parameter returns 422 Unprocessable Entity.
Delivery channels: Health Gorilla supports the rest-hook (webhook), websocket, and message channel types; email returns 422. The channel.endpoint must be HTTPS. A rest-hook subscription that uses OAuth 2.0 must use the client_credentials grant.
Standard payloads use application/fhir+json. Event-based notifications, for example fax or Direct messages, use application/hg-event+json, a simplified format containing only the resource type and an ID reference.
Supported resource types and parameters may expand as new capabilities are released.