nhsdigitalmait/tkw_fhir_mesh

FHIR MESH

This configuration will be typically used in conjunction with the MESH Client and helps suppliers test their systems against [***]

These documents are available on request from NHS Digital

This docker image has been generated from the FHIR_MESH git repostitory: https://github.com/nhsdigitalmait/FHIR_MESH. Examples of docker-compose files etc can be found here.

This config repository builds upon the TKW-x docker repository and reacts to structured MESH files being placed in the MESH-DATA-HOME volume. One or more MESH directories can be defined in the tkw-x external properties file which is referenced as a volume.

Docker Volumes

This image relies on Docker volumes for persistence of evidence, logging, FHIR profiles and MESH mailbox directories

Data Volume

All logs and validation reports are written to disk using the 'data' volume, separated into directories defined by the incoming MESH mailbox name. The container when executed creates an internal user "service" (user ID 1000) and writes its output to local disk (in this example at /home/host/data). If the user ID who is executing the container is not 1000 the ACL permissions must be set to allow this user:

setfacl -m u:1000:rwx /home/host/data

Additionally there are other images built for different UIDs named in the format x.x-uid e.g. 1.1-1005

The Data volume contains:

• log directory containing TKW system logs and metadata for each interaction set
• all_evidence directory containing the evidence separated into incoming MESH mailbox name directories The data volume directory structure will be automatically generated when first executed

MESH-DATA-HOME volume

This must contain directories which are named in accordance with the environment variables for the MESH mailboxes. Each of these directories must contain at least an IN, OUT and SENT sub directory. As data is also written to these files they must have the appropriate permissions - see Data volume above. These directories are typically used by the NHS Digital MESH client programme which is used here to delivery and received MESH messages to and from Spine.

FHIR Profile Assets volume

This directory must contain FHIR profiles in xml or json format to be used in the FHIR validation

General Config directory

This directory must contain an external extension of the tkw-x properties file named tkw-x.external.properties. This should have a definition of one or more MESH directories in the following format:

tks.MeshTransport.namelist  XXXOT001 XXXOT002
tks.MeshTransport.XXXOT001.class	uk.nhs.digital.mait.tkwx.meshinterceptor.MeshInterceptHandler
tks.MeshTransport.XXXOT001.in	/home/service/MESH/XXXOT001/IN
tks.MeshTransport.XXXOT001.out	/home/service/MESH/XXXOT001/OUT
tks.MeshTransport.XXXOT001.sent	/home/service/MESH/XXXOT001/SENT
tks.MeshTransport.XXXOT001.forwarder	/home/service/MESH/XXXOT001/forwarder
tks.MeshTransport.XXXOT002.class	uk.nhs.digital.mait.tkwx.meshinterceptor.MeshInterceptHandler
tks.MeshTransport.XXXOT002.in	/home/service/MESH/XXXOT002/IN
tks.MeshTransport.XXXOT002.out	/home/service/MESH/XXXOT002/OUT
tks.MeshTransport.XXXOT002.sent	/home/service/MESH/XXXOT002/SENT
tks.MeshTransport.XXXOT002.forwarder	/home/service/MESH/XXXOT002/forwarder

The "/home/service/MESH" references should be retained. An example of this can be found at the FHIR_MESH git repostitory: https://github.com/nhsdigitalmait/FHIR_MESH.

Execution

To execute the container, create a docker-compose.yml file containing the following, updating the directories as appropriate

version: '2.0'
services:
  tkw_fhir_mesh:
      volumes:
          - '${HOME}/fhir_mesh_data:/home/service/data'
          - '${HOME}/NHSD.Assets.STU3:/home/service/fhir'
          - '${HOME}/general_config:/home/service/config'
          - '${HOME}/MESH-DATA-HOME:/home/service/MESH'
      image: 'nhsdigitalmait/tkw_fhir_mesh:0.1'
      

Versions:

0.1: Initial build