Subscription Introduction
Certain Integration points such as a laboratory request or referrals requires the performing source system to be aware of the record for it to be acted upon. Using a subscription microservice applications, a performing source system is able to be retrieve record that requires their attention in real time.
This context also applied to requesting source system expecting to retrieve an output record. Instead of having to call FHIR API manually, by subscribing to an output topic (such as laboratory report topic) it will be able to be retrieve records required once available.
Below is an example of a complete flow where HIE acts as a bridge for both system to exchange records that both the requesting and performing source system are able to retrieve records that that is required. HIE can also act both as the requester or receiver if specified by a use case which is elaborated in the Integration Overview section under Care Coordination (CC) subsection.
Subscription Topics
The subcription topics mainly divided into affiliate, internal & public category of topic pool. The topic are then further grouped into each respective use cases. It is expected that an integrating source system subscribed to each related pool to be able to identify which topic requires their attention.
Each topic will hold up to 72 hours upon created in Kafka. Record more than 72 hour will be cleared out from the pool.
These are the currently available subscription topics in HIE:
Affiliate Topic
Affiliate topics are related to exchange between 2 different facility.
- For example, between facility A and facility B that both have different source system.
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 Topic
Internal topics are related to exchange between 2 source system 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 |