DSARM-8814 DPS CORE REQUEST - To Update of public facing Immunisation…

… History API based on feedback from Point of Care system providers.
NHSDigital · Oct 3, 2023 · 7208eaa · 7208eaa
1 parent 5bbffba
commit 7208eaa
Show file tree

Hide file tree

Showing 12 changed files with 1,115 additions and 1,608 deletions.
diff --git a/Makefile b/Makefile
@@ -68,4 +68,4 @@ smoketest: pytest-guards
 	poetry run pytest -v --junitxml=smoketest-report.xml -s -m smoketest
 
 e2etest: pytest-guards
-	poetry run pytest -v --junitxml=e2e-report.xml -s -m e2e
+	poetry run pytest -v --junitxml=e2e-report.xml -s -m e2e --api-name=$$API_NAME --proxy-name=$$PROXY_NAME
diff --git a/azure/components/run-e2e-tests.yml b/azure/components/run-e2e-tests.yml
@@ -1,4 +1,4 @@
-steps: 
+steps:
   - bash: |
       export RELEASE_RELEASEID=$(Build.BuildId)
       export SOURCE_COMMIT_ID=$(Build.SourceVersion)
@@ -11,6 +11,9 @@ steps:
       export JWT_PRIVATE_KEY_ABSOLUTE_PATH="$(Pipeline.Workspace)/secrets/$(JWT_TESTING_PRIVATE_KEY)"
       export ID_TOKEN_NHS_LOGIN_PRIVATE_KEY_ABSOLUTE_PATH="$(Pipeline.Workspace)/secrets/$(ID_TOKEN_NHS_LOGIN_PRIVATE_KEY)"
       export APIGEE_API_TOKEN="$(secret.AccessToken)"
+      export PROXY_NAME="$(FULLY_QUALIFIED_SERVICE_NAME)"
+      export API_NAME="$(SERVICE_NAME)"
+      export APIGEE_ACCESS_TOKEN="$(secret.AccessToken)"
       make e2etest
     workingDirectory: $(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)
     displayName: run e2e tests
@@ -20,4 +23,4 @@ steps:
     condition: always()
     inputs:
       testResultsFiles: '$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/e2e-report.xml'
-      failTaskOnFailedTests: true
+      failTaskOnFailedTests: true
diff --git a/azure/components/run-smoke-tests.yml b/azure/components/run-smoke-tests.yml
@@ -1,20 +1,20 @@
 steps:
-  - bash: |
-      export RELEASE_RELEASEID=$(Build.BuildId)
-      export SOURCE_COMMIT_ID=$(Build.SourceVersion)
-      export APIGEE_ENVIRONMENT="$(ENVIRONMENT)"
-      export SERVICE_BASE_PATH="$(SERVICE_BASE_PATH)"
-      export STATUS_ENDPOINT_API_KEY="$(status-endpoint-api-key)"
-      export APIGEE_PRODUCT="$(FULLY_QUALIFIED_SERVICE_NAME)"
-      export OAUTH_PROXY="oauth2"
-      export OAUTH_BASE_URI="https://$(ENVIRONMENT).api.service.nhs.uk"
-      make smoketest
-    workingDirectory: $(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)
-    displayName: run smoketests
+    -   bash: |
+            export RELEASE_RELEASEID=$(Build.BuildId)
+            export SOURCE_COMMIT_ID=$(Build.SourceVersion)
+            export APIGEE_ENVIRONMENT="$(ENVIRONMENT)"
+            export SERVICE_BASE_PATH="$(SERVICE_BASE_PATH)"
+            export STATUS_ENDPOINT_API_KEY="$(status-endpoint-api-key)"
+            export APIGEE_PRODUCT="$(FULLY_QUALIFIED_SERVICE_NAME)"
+            export OAUTH_PROXY="oauth2-mock"
+            export OAUTH_BASE_URI="https://$(ENVIRONMENT).api.service.nhs.uk"
+            make smoketest
+        workingDirectory: $(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)
+        displayName: run smoketests
 
-  - task: PublishTestResults@2
-    displayName: 'Publish smoketest results'
-    condition: always()
-    inputs:
-      testResultsFiles: '$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/smoketest-report.xml'
-      failTaskOnFailedTests: true
+    -   task: PublishTestResults@2
+        displayName: 'Publish smoketest results'
+        condition: always()
+        inputs:
+            testResultsFiles: '$(Pipeline.Workspace)/s/$(SERVICE_NAME)/$(SERVICE_ARTIFACT_NAME)/smoketest-report.xml'
+            failTaskOnFailedTests: true
diff --git a/manifest_template.yml b/manifest_template.yml
@@ -4,6 +4,7 @@ DESCRIPTION: Immunisation history API
 APIGEE_ENVIRONMENTS:
   - name: internal-dev
     display_name: Internal Development
+    has_mock_auth: true
   - name: internal-dev-sandbox
     display_name: Internal Development Sandbox
   - name: internal-qa
@@ -71,6 +72,9 @@ apigee:
         proxies:
           - immunisation-history-{{ ENV.name }}
           - identity-service-{{ ENV.name }}
+{% if ENV.has_mock_auth | default(false) %}
+          - identity-service-mock-{{ ENV.name }}
+{% endif %}
         scopes: {{ MODE.scopes }}
         quota: {{ ENV.quota | default('300') }}
         quotaInterval: '1'
@@ -89,4 +93,4 @@ apigee:
         visibility: true
         specId: immunisation-history-{{ ENV.name }}
 {% endfor %}
-{% endfor %}
+{% endfor %}
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -18,11 +18,10 @@ python = "^3.8"
 
 
 [tool.poetry.dev-dependencies]
-pytest = "^6.1.2"
+pytest = "^6.2.5"
 coverage = "^5.5"
 aiohttp = "^3.7.3"
 pytest-asyncio = "^0.14.0"
-api-test-utils = {url = "https://github.com/NHSDigital/apim-test-utils/releases/download/v1.1.35-alpha/api_test_utils-1.1.35a0-py3-none-any.whl"}
 flake8 = "^3.7.9"
 pip-licenses = "^3.3.1"
 jinja2 = "^2.11.1"
@@ -31,10 +30,10 @@ docopt = "^0.6.2"
 jsonpath-rw = "^1.4.0"
 semver = "^2.9.0"
 gitpython = "^3.1.30"
-requests = "^2.27.1"
+requests = "^2.31.0"
 sh = "^1.14.3"
 fire = "^0.4.0"
-pytest-nhsd-apim = "^2.0.6"
+pytest-nhsd-apim = "^3.3.9"
 behave = "^1.2.6"
 
 [tool.poetry.scripts]
diff --git a/specification/components/examples/Immunization.json b/specification/components/examples/Immunization.json
@@ -6,6 +6,7 @@
     {
       "fullUrl": "urn:uuid:d11c69d8-7a50-4a54-a848-7648121e995f",
       "resource": {
+        "id": "90640007.747583-127",
         "resourceType": "Immunization",
         "extension": [
           {
@@ -29,15 +30,6 @@
           }
         ],
         "status": "completed",
-        "statusReason": [
-          {
-            "coding": [
-              {
-                "system": "http://snomed.info/sct"
-              }
-            ]
-          }
-        ],
         "vaccineCode": {
           "coding": [
             {
@@ -55,8 +47,8 @@
             "value": "9000000009"
           }
         },
-        "occurrenceDateTime": "2020-12-10T13:00:08.476+00:00",
-        "recorded": "2020-12-10",
+        "occurrenceDateTime": "2020-12-10T13:00:08.476Z",
+        "recorded": "2020-12-10T00:00:00.000Z",
         "primarySource": true,
         "manufacturer": {
           "display": "AstraZeneca Ltd"
@@ -87,7 +79,6 @@
           "unit": "pre-filled disposable injection",
           "code": "3318611000001103"
         },
-        "reportOrigin": {},
         "performer": [
           {
             "actor": {
@@ -115,7 +106,13 @@
           {
             "doseNumberPositiveInt": 1
           }
-        ]
+        ],
+        "location": {
+          "identifier": {
+            "system": "urn:iso:std:iso:3166",
+            "value": "GB"
+          }
+        }
       },
       "search": {
         "mode": "match"
@@ -124,6 +121,7 @@
     {
       "fullUrl": "urn:uuid:8da02505-db94-40b6-a8ed-d5af5628e28c",
       "resource": {
+        "id": "90640007.747583-128",
         "resourceType": "Immunization",
         "extension": [
           {
@@ -147,15 +145,6 @@
           }
         ],
         "status": "completed",
-        "statusReason": [
-          {
-            "coding": [
-              {
-                "system": "http://snomed.info/sct"
-              }
-            ]
-          }
-        ],
         "vaccineCode": {
           "coding": [
             {
@@ -173,8 +162,8 @@
             "value": "9000000009"
           }
         },
-        "occurrenceDateTime": "2020-12-31T13:00:08.476+00:00",
-        "recorded": "2020-12-31",
+        "occurrenceDateTime": "2020-12-31T13:00:08.476Z",
+        "recorded": "2020-12-31T00:00:00.000Z",
         "primarySource": true,
         "manufacturer": {
           "display": "AstraZeneca Ltd"
@@ -205,7 +194,6 @@
           "unit": "pre-filled disposable injection",
           "code": "3318611000001103"
         },
-        "reportOrigin": {},
         "performer": [
           {
             "actor": {
@@ -233,7 +221,13 @@
           {
             "doseNumberPositiveInt": 1
           }
-        ]
+        ],
+        "location": {
+          "identifier": {
+            "system": "urn:iso:std:iso:3166",
+            "value": "GB"
+          }
+        }
       },
       "search": {
         "mode": "match"
@@ -242,6 +236,7 @@
     {
       "fullUrl": "urn:uuid:124fcb63-669c-4a3c-af2b-caf55de167ec",
       "resource": {
+        "id": "9000000009",
         "resourceType": "Patient",
         "identifier": [
           {

diff --git a/specification/components/schemas/Immunization.yaml b/specification/components/schemas/Immunization.yaml
@@ -228,14 +228,13 @@ properties:
     description: The quantity of vaccine product that was administered.
     type: object
     required:
-      - value
       - unit
       - system
       - code
     properties:
       value:
         description: Number of units administered.
-        type: integer
+        type: number
         example: 1
       unit:
         description: Description of unit.

diff --git a/specification/immunisation-history.yaml b/specification/immunisation-history.yaml
@@ -294,7 +294,7 @@ paths:
             Optional header to select the version of the api. Version number will follow semver.
           schema:
             type: string
-            example: version=1.0
+            example: version=1.0, version=2.0
       responses:
         '200':
           description: |