/fhir-appliance

Documentation and configuration files for running Interweave Connect (aka FHIR Appliance)

Primary LanguagePowerShellMIT LicenseMIT

Interweave Connect

Web: Interweave Digital
Twitter: @YHCareRecord


What is Interweave Connect?

Interweave Connect (also known as the "FHIR Appliance") is a FHIR server which was built by, and for, the Interweave platform.

The software has been developed in accordance to a series of technical papers produced by the programme. Each design paper describes a set of "model" software components and architectures that, when realised, can enable health and social care organisations to share data using FHIR.

Interweave Connect will keep evolving in step with both the LHCRE, YHCR and other NHS regional shared care record programmes. The overall aim, however, is that the server will provide an out of the box, open source solution to health and social care organisations who require the ability to share data using FHIR.

Key Features

  • A complete implementation of a FHIR Server and FHIR Store (fully compliant with FHIR STU 3)
  • Support for sychronous queries, but also for asynchronous bulk extracts and event-driven subscriptions
  • Flexible endpoint configuration
  • Possible to configure dual endpoints for external vs internal access
  • Entirely configurable choice of listener ports
  • Options for http or https (including mutual authentication)
  • Options for message authentication (jwt, api-key, none)
  • Audit log of all activities (available as FHIR AuditEvent resources)
  • Option to automate registration of patients with a regional PIX server
  • Runs on Linux or Windows Server 2019, using either Postgres or MSSQL database
  • Dockerised deployment for ease of installation

Technical Overview

Interweave Connect has been developed using a stack of open source software and health care interoperability standards, namely:

Fast Healthcare Interoperable Resources - FHIR Fast Healthcare Interoperability Resources is a standard describing data formats and elements and an application programming interface for exchanging electronic health records. The standard was created by the Health Level Seven International health-care standards organization.

Moleculer.js A Progressive microservices framework for Node.js.

PostgreSQL PostgreSQL, also known as Postgres, is a free and open-source relational database management system emphasizing extensibility and technical standards compliance. It is designed to handle a range of workloads, from single machines to data warehouses or Web services with many concurrent users.

Microsoft SQL Servier Microsoft SQL Server, often called "sequel server", is a commercial product developed and maintained by Microsoft. The FHIR Appliance can work with Express editions.

Docker Docker is a set of coupled software-as-a-service and platform-as-a-service products that use operating-system-level virtualization to develop and deliver software in packages called containers.

A public git repository containing the sourcecode will be available soon but for now interested parties and members of the YHCR programme are encouraged to use the software via the docker and node.js components hosted here.


Getting started


Install guides

The following steps describe how to get the current version of Interweave Connect up and running within your local environment.

01 - Overview

02 - Server Preparation

03 - Quickstart Install

04 - Quickstart Demo

05 - Production Install

99 - 3rd Party Technologies

Reference guides

Configuring TLS

Database initialisation

Creating self-signed certificates

Using different image tags