nhsdigitalmait/nems_subscriber_config

RESTful NEMS Subscriber/Publisher Test Harness and Validator Configuration

This config repository uses the TKW-X repo and creates a Restful FHIR Validator instance. The TKW Test Harness responds subscriber and publish requests configurably and will respond with happy path and negative replies dependent on the request subject's NHS Number. Details of specific NHS numbers to use are detailed in the FHIR NEMS Test Harness documentation. All requests are responded to and a copy is validated producing an HTML validation report which includes a HAPI FHIR Validation and business specific rules as defined in the [] FHIR Validation is performed by HAPI FHIR Validator v3.7.0 ([] but the base profile validation can be extended by use of a locally stored NHS Care Connect defined FHIR Profiles. It listens internally on port 4434. The image when executed creates an internal user "service" (user ID 1001) in order that it can write to volumes without using root. In the following examples the local system has "user1", but this should be replaced by local user's name.

Mutual Authentication

The test harness can be executed in Mutual Authentication (TLSMA) mode or cleartext. If TLSMA is required a docker environment file is necessary e.g.:

trustStore=/home/service/certs/truststore.jks
trustStorePassword=password
keyStore=/home/service/certs/serverkeystore.jks
keyStorePassword=password

and must be defined at execution e.g.

--env-file=/home/user1/nems_subscriber_env_file

and the volume where the certs are stored must be defined at execution e.g.:

'--mount type=***d,source=/home/user1/certs,target=/home/service/certs`

Output Files and Logging

The image can write its output to local disk (in this example at /home/user1/OutputDir) . In order to do this the ACL permissions must be set to allow a user ID 1001 as follows:

setfacl -m u:1001:rwx /home/user1/OutputDir

and the volume where the output is to be written must be defined at execution e.g.:

'--mount type=bind,source=/home/user1/data,target=/home/service/data`

FHIR Profiles

Locally stored FHIR profiles must be organised in the following directory structure:

/home/user1/ITKMessageDefinition/Profiles/CodeSystem
/home/user1/ITKMessageDefinition/Profiles/StructureDefinition
/home/user1/ITKMessageDefinition/Profiles/ValueSet

and the volume where the FHIR Profiles are to be read from must be defined at execution e.g.:

'--mount type=***d,source=/home/user1/ITKMessageDefinition,target=/home/service/fhir`

n.b. If no local profiles are to be used, the directory structure is still necessary

Execution

To execute in the clear with an output directory at: /home/user1/OutputDir a locally stored FHIR Profile set at: /home/user1/ITKMessageDefinition and listening externally on port 8080:

docker run -d -p 8080:4434 --mount type=bind,source=/home/user1/OutputDir,target=/home/service/data --mount type=bind,source=/home/user1/ITKMessageDefinition,target=/home/service/fhir --mount type=bind,source=/home/user1/certs,target=/home/service/certs nhsdigitalmait/nems_subscriber_config:tagname

To execute using TLSMA with an output directory at: /home/user1/OutputDir a locally stored FHIR Profile set at: /home/user1/ITKMessageDefinition and listening externally on port 4433:

docker run -d -p 4433:4434 --env-file=/home/user1/nems_subscriber_env_file --mount type=bind,source=/home/user1/OutputDir,target=/home/service/data --mount type=bind,source=/home/user1/ITKMessageDefinition,target=/home/service/fhir --mount type=bind,source=/home/user1/certs,target=/home/service/certs nhsdigitalmait/nems_subscriber_config:tagname