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
Copy file name to clipboardExpand all lines: README.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,15 +46,15 @@ sequenceDiagram
46
46
**Key NHS services used:**
47
47
48
48
| Service | Purpose |
49
-
|---|---|
49
+
|---|---|
50
50
|[PDS FHIR API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir)| Looks up the patient's registered GP practice code |
@@ -126,7 +126,7 @@ This project depends on the [clinical-data-common](https://github.com/NHSDigital
126
126
The project uses `make` targets to build, deploy, and manage the application. Run these from the repository root:
127
127
128
128
| Command | Description |
129
-
|---|---|
129
+
|---|---|
130
130
|`make dependencies`| Install all project dependencies via Poetry |
131
131
|`make build`| Type-check, package, and build the Docker image |
132
132
|`make deploy`| Build and start the Gateway API container at `localhost:5000`|
@@ -138,7 +138,7 @@ The project uses `make` targets to build, deploy, and manage the application. Ru
138
138
Once deployed, the API exposes:
139
139
140
140
| Method | Path | Description |
141
-
|---|---|---|
141
+
|---|---|---|
142
142
|`POST`|`/patient/$gpc.getstructuredrecord`| Retrieve a patient's structured clinical record |
143
143
|`GET`|`/health`| Health check endpoint |
144
144
@@ -147,14 +147,15 @@ The full API schema is defined in [gateway-api/openapi.yaml](gateway-api/openapi
147
147
### Environment Variables
148
148
149
149
| Variable | Description |
150
-
|---|---|
150
+
|---|---|
151
151
|`BASE_URL`| Protocol, hostname and port for the running API (e.g. `http://localhost:5000`, or `http://gateway-api:8080` from within the devcontainer) |
152
152
|`HOST`| hostname portion of `BASE_URL`|
153
153
|`FLASK_HOST`| Host the Flask app binds to |
154
154
|`FLASK_PORT`| Port the Flask app listens on |
155
155
|`STUB_PDS`|`true`, use the stubs/stubs/pds/stub.py to return stubbed responses for PDS FHIR API; otherwise, not. |
156
156
|`STUB_SDS`|`true`, use the stubs/stubs/sds/stub.py to return stubbed responses for SDS FHIR API; otherwise, not. |
157
157
|`STUB_PROVIDER`|`true`, use the stubs/stubs/provider/stub.py to return stubbed responses for the provider system; otherwise, not. |
158
+
|`CDG_DEBUG`|`true`, Return additional debug information when the call to the GP provider returns an error. Note if set true causes the unit tests to fail, because expected return values are changed. |
158
159
159
160
Environment variables also control whether stubs are used in place of the real PDS, SDS, and Provider services during local development.
160
161
@@ -163,7 +164,7 @@ Environment variables also control whether stubs are used in place of the real P
163
164
The project has five test suites, each targeting a different layer of confidence. The API container must be running for all suites except unit tests.
164
165
165
166
| Command | Suite | Framework | Description |
166
-
|---|---|---|---|
167
+
|---|---|---|---|
167
168
|`make test-unit`| Unit | pytest | Tests individual modules in isolation |
0 commit comments