Subscription Introduction

Certain integration points such as a laboratory request or a referral require the performing source system to be aware of the record for it to be acted upon. Using a subscription microservice application, a performing source system is able to be retrieve records that require their attention in real time.

This context also applies when a requesting source system is expecting to retrieve an output record. Instead of having to call a FHIR API manually, by subscribing to an output topic (such as a laboratory report topic) it will be able to retrieve the relevant records once available.

Below is an example of a complete flow where the HIE acts as a bridge for both systems to exchange records. In this scenario, both the requesting and performing source systems are able to retrieve records that are required. The HIE can also act both as the requester or receiver if specified by a use case which is elaborated in the Integration Overview page under the Care Coordination (CC) section.

Subscription Topics

The subcription topics are mainly divided into affiliate, internal & public categories. The topics are then further grouped into respective use cases. It is expected that an integrating source system subscribed to each related pool will be able to identify which topic requires their attention.

Each topic will be stored up to 72 hours upon creation in Kafka. Records more than 72 hours old will be cleared from the pool.

These are the currently available subscription topics in HIE:

Affiliate Topics

Affiliate topics are related to data exchange between two affiliated facilities.

• For example, data that is shared between facility A and facility B, with both having different source systems.

Use Case	Topic Title	Main Resource	Include Resource	Criteria
Laboratory	Lab Requesting Affiliate	ServiceRequest	Patient Encounter	1. category=108252007 2. performer-type=affiliate 3. status=active, revoked
	Lab Reporting	DiagnosticReport	Observation Patient Encounter	1. category=108252007 2. status=final
Imaging	Imaging Requesting Affiliate	ServiceRequest	ImagingStudy Patient Encounter	1. category=363679005 2. performer-type=affiliate 3. status=active, reject
	Imaging Reporting	DiagnosticReport	ImagingStudy Patient Encounter	1. category=363679005 2. status=preliminary, final
Referral	Referral Acknowledge Affiliate	ServiceRequest	Patient Encounter	1. category=3457005 2. performer-type=affiliate 3. status=active
	Referral Outcome Affiliate	ServiceRequest	Patient Encounter	1. category=3457005 2. performer-type=affiliate 3. status=completed, revoked
Appointment	Appointment Booking Affiliate	Appointment	Patient	1. appointment-type=affiliate 2. status=booked
	Appointment Fulfilled Affiliate	Appointment	Patient	1. appointment-type=affiliate 2. status=fulfilled
Virtual Consultation	VC Encounter Arrived	Encounter	Patient	1. class=VR 2. status=arrived

Internal Topics

Internal topics are related to the exchange between two source systems but within the same facility.

• For example, between HIE and a pharmacy/laboratory system in facility A.

Use Case	Topic Title	Main Resource	Include Resource	Criteria
Laboratory	Lab Requesting Internal	ServiceRequest	Patient Encounter	1. category=108252007 2. performer-type=internal 3. status=active, revoked
	Lab Reporting	DiagnosticReport	Observation Patient Encounter	1. category=108252007 2. status=final
Imaging	Imaging Requesting Internal	ServiceRequest	ImagingStudy Patient Encounter	1. category=363679005 2. performer-type=internal 3. status=active, reject
	Imaging Reporting	DiagnosticReport	ImagingStudy Patient Encounter	1. category=363679005 2. status=preliminary, final
Referral	Referral Acknowledge Internal	ServiceRequest	Patient Encounter	1. category=3457005 2. performer-type=internal 3. status=active
	Referral Outcome Internal	ServiceRequest	Patient Encounter	1. category=3457005 2. performer-type=internal 3. status=completed, revoked
Appointment	Appointment Booking Internal	Appointment	Patient	1. appointment-type=internal 2. status=booked
	Appointment Fulfilled Internal	Appointment	Patient	1. appointment-type=internal 2. status=fulfilled
Virtual Consultation	VC Encounter Arrived	Encounter	Patient	1. class=VR 2. status=arrived