ips-subscriptions

Implementation of IPS FHIR IG on Aidbox FHIR platform

This repository contains pre-configured Aidbox instance and implementation of $summary operation defined by IPS:

• FHIRSchema
• FHIR 4.3.0, ca.infoway.io.psca
• Topic-based subscriptions
• $summary operation

Prerequisites

• Docker

STEP 1: Environment and Aidbox license

Copy .env.tpl file into .env file:

cp .env.tpl .env

If you are hosting Aidbox on your local computer, obtain the self-hosted license as described in the documentation.

Add the license (AIDBOX_LICENSE) int the .env file.

STEP 2: Run aidbox and node-app in Docker

docker compose up --build

On start, the node-app will create App resource, upload a sample FHIR Bundle with patient data.

Step 3: Open and log in into Aidbox instance

Open in browser http://localhost:8888

And log in witn username: admin and password: password

Step 4: Request $summary using REST Console

In the Aidbox admin window, navigate to the APIs section and choose REST Console.

The $summary operation requires either the logical ID (Patient.id) or a business identifier (Patient.identifier) of the patient. To request the IPS "document" Bundle for a specific patient using the REST Console, you can use the following request:

GET /fhir/Patient/[id]/$summary

Or you can use request with identifier search parameter:

GET /fhir/Patient/$summary?identifier=<patient-identifier>

Step 5: Check if topic-based-subscriptions works

Here is configured one SubscriptionTopic (triggers if new resource Observation has valueQuantity > 10). Table "observation_topic" will be used.

Let's check if it works. Create observation:

POST /fhir/Observation

status: final
code:
  text: text
valueQuantity:
  value: 11

Check Subscription Topics tab or check observation_topic table in Db Console:

select * from observation_topic

Read more about Topic-Based Subscriptions: https://docs.aidbox.app/modules-1/topic-based-subscriptions