ZusHook Syncing

ZusHooks are an efficient method for your organization to automatically sync Zus sourced FHIR resources and other raw data types to your own back end. Upon availability of new data like Conditions, Medications, and ADT events, Zus can automatically push this data to a customers endpoint to ensure they stay informed with the most up to date information on their patients. Additionally, customers will benefit from the normalization, enrichment, and de-duplication of these FHIR resources to promote effective care delivery.

Patient data from external sources encompasses

  • Medical history retrieved from Electronic Health Record (EHR) systems
  • Medication history obtained from pharmacies
  • Historical records and alerts from laboratory results
  • Alerts pertaining to admissions, discharges, and transfers (ADT).

In addition to the standard enriched FHIR resources, ZusHooks also encompass Lens resources, which are Zus created resources that are semantically normalized, de-duplicated, summarized, and tagged. Lens resources allow you to extract the relevant clinical information for a particular finding without the messiness typically associated with clinical data. More information regarding Lens resources can be found on our Docs page here.

This guide is intended to get you started with syncing FHIR resources from Zus’s sandbox environment to your own sandbox or development environment. Although the data fields will only include test data, the structure of the JSON FHIR resources will be the same as production data.

Authentication Setup

ZusHooks allow you to receive inbound HTTPS requests from Zus when new resources are created or updated in the Zus FHIR store. Zus supports both Basic and OAuth authentication methods, as detailed below:

OAuth: When secured with OAuth, Zus will send the entire FHIR resource in the response body. The following values are required:

  • webhookUrl
  • clientId
  • clientSecret
  • tokenUrl

Basic: For basic authentication, Zus will send the FHIR resource ID and associated Universal Patient Identifier. You will then need to query the Zus FHIR store to retrieve the full details of the resource. Here is an example of how you could query the Zus FHIR store for the full resource, a condition in this example:

Postman Collection

The following Postman collection (linked here) will include all of the steps needed to begin sending Zus FHIR resources from your Zus sandbox environment to your established endpoint. To get started, please ensure that you have forked both the Zus Public Postman collection and environment into your own Postman workspace.

To initiate a ZusHook to your development endpoint, we must simulate the creation of a resource within Zus on behalf of one of your Sandbox patients. Each folder within the Postman collection contains a couple example JSON FHIR resources that can be posted to your patient to trigger a corresponding Zushook. The "ZusPID'' variable in each request body will indicate the FHIR resource ID for the associated patient for whom we will be posting this resource. To ensure you have the correct patient in context, perform the Patient GET call within the “Patient ID” folder.

Before starting, be sure to fork the Zus Postman Collection! Follow along in the video below.

Resource Types

Below are the resources and data types available for testing within the ZusHooks Testing postman collecting

A Condition Summary Lens resource is a Zus constructed FHIR resource that has been semantically normalized and de-duplicated to SNOMED CT. The Chronic Condition Lens is a subset of the Summary Lens, and will enrich the resource with a CCI indicator where applicable.

Similar to the Condition Lens, the Medication Summary Lens resource is a Zus constructed FHIR resource that has been semantically normalized and de-duplicated to RxNorm. For Medications that have had activity within the last 180 days or 365 days into the future, Zus will also enrich the resource with an “ActiveMedications” tag. The Active Medications Lens is a subset of the Medications Summary Lens.

The Transition of Care Lens aggregates and summarizes Encounter resources for each patient into EpisodeofCare resources. The Transitions of Care lens allows you to track Encounters with matching visit IDs or within 36 hours of each other to help provide a better picture of the patients healthcare journey. More information regarding the grouping logic of the TOC lens as well as an example resource are located within our TOC documentation.

ADT ZusHooks are a subset of Zus’s Encounter resources which are created in real time from our ADT network sources. ADT notifications can help enable timely updates on clinical events to help facilitate practice management and optimized continuity of care for your patients.## Labs

Zus receives lab data from Quest and our EHR data sources and parses them into DiagnosticReport FHIR resources.


Procedures will include activity that is performed on, with, or for a patient as part of the provision of care.


Vital signs are a subset of the Observation FHIR resource tagged with the code “vital-signs”.