You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Improvements to the main README.md documentation (#274)
* Move developer information out of main README
This should help clarify what instructions are useful for NMEs
vs what instructions should be followed by the internal team.
* Replace references to NHS Digital with NHS England
* Link to example JSON/XML mapping files from README
These should be useful context for a user trying to understand what
data the adaptor will generate.
Copy file name to clipboardExpand all lines: README.md
+12-32Lines changed: 12 additions & 32 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,7 +11,8 @@ You can receive and route a “post event message” to their GP when NHS 111 re
11
11
The NHS 111 Report adaptor can receive messages from the NHS 111 service and post them to the mailbox of the relevant GP practice.
12
12
13
13
## Adaptor Scope
14
-
The main objective of the 111 Adaptor is to hide complex legacy standards and instead present a simple and consistent interface aligned to current NHSD national standards. The adaptor receives ITK 2.2 wrapped Clinical Document Architecture (CDA) XML documents over web services, and converts them into structured FHIR messages before posting them onto the GP system's inbound event queue.
14
+
The main objective of the 111 Adaptor is to hide complex legacy standards and instead present a simple and consistent interface aligned to current NHS England national standards.
15
+
The adaptor receives ITK 2.2 wrapped Clinical Document Architecture (CDA) XML documents over web services, and converts them into structured FHIR messages before posting them onto the GP system's inbound event queue.
15
16
16
17
The 111 adaptor consists of two docker images:[proxy](https://hub.docker.com/r/nhsdev/nia-111-nginx-adaptor) and [adaptor](https://hub.docker.com/r/nhsdev/nia-111-adaptor), you must deploy it within your own environment.
17
18
@@ -110,40 +111,19 @@ Nginx proxy is used to handle TLS MA. In order to configure it you need to set t
110
111
* NGINX_CRL - Certificate revocation list
111
112
* NGINX_CRL_URL - CRL URL - Nginx can download CRL on startup
112
113
113
-
## ITK to FHIR Mapping
114
-
Even though the adaptor removes this complexity, the [FHIR field mappings have been documented for information](doc/ITK_FHIR_mapping.md).
114
+
## Mapping documentation
115
+
To help understand what fields are populated by the adaptor we provide [ITK to FHIR field mappings](doc/ITK_FHIR_mapping.md).
115
116
116
-
## Running the Adaptor
117
-
118
-
### Pre requisites for running the Adaptor:
119
-
1. JDK 17
120
-
2. Docker
121
-
122
-
### How to run service:
123
-
* Navigate to `docker`
124
-
* Run script: `./start-local-environment.sh`
125
-
126
-
The above script builds the necessary docker images and starts the SpringBoot service and ActiveMQ
127
-
* REST service `localhost:10001`
128
-
* ActiveMQ: `localhost:5672`
129
-
130
-
### How to run unit tests:
131
-
* Navigate to `service`
132
-
* Run: `./gradlew test`
133
-
134
-
### How to run integration tests:
135
-
* Navigate to `service`
136
-
* Run: `./gradlew integrationTest`
137
-
138
-
### Example bundle message
139
-
* An example bundle message can be found [here](doc/example_FHIR_bundle_message.json) of [ITK_Report](./service/src/integration-test/resources/xml/ITK_Report_request.xml) converted to FHIR.
140
-
141
-
### AMQP Variables
142
-
* Queue name: `encounter-report`
143
-
* Broker: `amqp://activemq:5672`
117
+
We also provide [example JSON payloads](doc/json) of what the adaptor generates from an [incoming XML payload](doc/xml).
144
118
145
119
## ITK Testbench
146
-
The [ITK Testbench](https://digital.nhs.uk/services/interoperability-toolkit/developer-resources/itk-test-centre/itk-testbench) provided by NHS Digital has an essential tool for ITK interface development and conformance. This tool provides resources that will allow you to adequately test the 111 adaptor within your own environment.
120
+
The [ITK Testbench] provided by NHS England has an essential tool for ITK interface development and conformance.
121
+
This tool provides resources that will allow you to adequately test the 111 adaptor within your own environment.
Our testing pack as well our test harness can be found inside the test-suite directory [Test-Suite](./test-suite)
127
+
128
+
## NIA Support (NHS England) guidance
129
+
If you are looking to make changes to the adaptor you should first read the [guidance for developing the adaptor](nhs-england-developer-information.md).
> The audience of this documentation is designed for NHS England developers.
5
+
6
+
## Pre requisites for running the Adaptor:
7
+
1. JDK 17
8
+
2. Docker
9
+
10
+
## How to run service:
11
+
* Navigate to `docker`
12
+
* Run script: `./start-local-environment.sh`
13
+
14
+
The above script builds the necessary docker images and starts the SpringBoot service and ActiveMQ
15
+
* REST service `localhost:10001`
16
+
* ActiveMQ: `localhost:5672`
17
+
18
+
## How to run unit tests:
19
+
* Navigate to `service`
20
+
* Run: `./gradlew test`
21
+
22
+
## How to run integration tests:
23
+
* Navigate to `service`
24
+
* Run: `./gradlew integrationTest`
25
+
26
+
## Example bundle message
27
+
* An example bundle message can be found [here](doc/example_FHIR_bundle_message.json) of [ITK_Report](./service/src/integration-test/resources/xml/ITK_Report_request.xml) converted to FHIR.
0 commit comments