Merge pull request #2652 from NHSDigital/develop

sanjeeven-singh · web-flow · commit 32f8484e7475 · 2025-12-08T10:22:11.000Z
Creating APIM-R 1.51-beta release
diff --git a/package-lock.json b/package-lock.json
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -35,11 +35,11 @@ openapi-core = "^0.19.5"
 
 [tool.poetry.group.dev.dependencies]
 flake8 = "^7.3.0"
-black = "^25.9"
+black = "^25.11"
 pip-licenses = "^5.5.0"
 jinja2 = "^3.1.6"
 pytest = "^8.4.2"
-pytest-asyncio = "^1.2.0"
+pytest-asyncio = "^1.3.0"
 pytest-nhsd-apim = "^4.0.1"
 
 [tool.poetry.scripts]
diff --git a/sandbox/package-lock.json b/sandbox/package-lock.json
diff --git a/sandbox/package.json b/sandbox/package.json
@@ -12,12 +12,12 @@
   "homepage": "https://github.com/NHSDigital/hello-world-api",
   "main": "app.js",
   "dependencies": {
-    "@hapi/hapi": "^21.4.3",
+    "@hapi/hapi": "^21.4.4",
     "@hapi/inert": "^7.1.0",
     "lodash": "^4.17.20"
   },
   "devDependencies": {
     "eslint": "^9.25.1",
-    "globals": "^16.4.0"
+    "globals": "^16.5.0"
   }
 }
diff --git a/sandbox/src/mocks/stu3/retrieveWorklist/responses/FilteredByClinician.json b/sandbox/src/mocks/stu3/retrieveWorklist/responses/FilteredByClinician.json
@@ -126,6 +126,10 @@
                 },
                 "display": "Excellent Cardiology Business Service 12"
               }
+            },
+            {
+              "url": "referralRequestVersion",
+              "valueInteger": 9
             }
           ],
           "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"
@@ -211,6 +215,10 @@
                   }
                 ]
               }
+            },
+            {
+              "url": "referralRequestVersion",
+              "valueInteger": 12
             }
           ],
           "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"
@@ -221,4 +229,4 @@
       }
     }
   ]
-}
+}
diff --git a/sandbox/src/mocks/stu3/retrieveWorklist/responses/FilteredByService.json b/sandbox/src/mocks/stu3/retrieveWorklist/responses/FilteredByService.json
@@ -130,6 +130,10 @@
                 },
                 "display": "Another Excellent Cardiology Business Service 13"
               }
+            },
+            {
+              "url": "referralRequestVersion",
+              "valueInteger": 12
             }
           ],
           "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"
@@ -140,4 +144,4 @@
       }
     }
   ]
-}
+}
diff --git a/sandbox/src/mocks/stu3/retrieveWorklist/responses/FilteredBySpecialty.json b/sandbox/src/mocks/stu3/retrieveWorklist/responses/FilteredBySpecialty.json
@@ -121,6 +121,10 @@
                   }
                 ]
               }
+            },
+            {
+              "url": "referralRequestVersion",
+              "valueInteger": 9
             }
           ],
           "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"
@@ -216,6 +220,10 @@
                 },
                 "display": "Excellent Cardiology Business Service 12"
               }
+            },
+            {
+              "url": "referralRequestVersion",
+              "valueInteger": 9
             }
           ],
           "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"
@@ -226,4 +234,4 @@
       }
     }
   ]
-}
+}
diff --git a/sandbox/src/mocks/stu3/retrieveWorklist/responses/ReferralsForReview.json b/sandbox/src/mocks/stu3/retrieveWorklist/responses/ReferralsForReview.json
@@ -131,6 +131,10 @@
                 },
                 "display": "Excellent Cardiology Business Service 12"
               }
+            },
+            {
+              "url": "referralRequestVersion",
+              "valueInteger": 7
             }
           ],
           "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"
@@ -230,6 +234,10 @@
                 },
                 "display": "Another Excellent Cardiology Business Service 13"
               }
+            },
+            {
+              "url": "referralRequestVersion",
+              "valueInteger": 12
             }
           ],
           "url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"
@@ -240,4 +248,4 @@
       }
     }
   ]
-}
+}
diff --git a/specification/components/stu3/schemas/eRS-FetchWorklist-List.yaml b/specification/components/stu3/schemas/eRS-FetchWorklist-List.yaml
@@ -174,6 +174,7 @@ properties:
                       | `appointmentStart`             | `0..1`      |                                            |
                       | `allocatedClinician`           | `0..1`      |                                            |
                       | `service`                      | `1..1`      |                                            |
+                      | `referralRequestVersion`       | `1..1`      |                                            |
                     items:
                       anyOf:
                         - title: priority
@@ -396,6 +397,7 @@ properties:
                                   type: string
                                   example: '#Practitioner-021600556514'
                         - $ref: './extensions/worklists/Extension-WorklistItem-Service.yaml'
+                        - $ref: './extensions/worklists/Extension-WorklistItem-ReferralRequestVersion.yaml'
               - title: Extension-eRS-AppointmentSlotIssues-WorkListItem
                 type: object
                 required:
diff --git a/specification/components/stu3/schemas/endpoints/a008-retrieve-worklist.yaml b/specification/components/stu3/schemas/endpoints/a008-retrieve-worklist.yaml
@@ -45,11 +45,9 @@ description: |
 
   ## Service Providing Organisations
   Service provider organisations can currently access the following referral related worklists:
-    - The 'Referrals for Review' worklist contains booked and RAS (triage) referrals that require review by the service provider organisation
+    - The 'Referrals for Review' worklist contains booked and RAS (triage) referrals that require review by the service provider organisation. The version of each referral in the worklist will also be returned. Note that the version can change due to admin/clinical changes as well as internal e-RS processes.
     - The 'Appointment Slot Issues' worklist contains referrals which have been 'deferred to provider' because of a lack of appointment availability (e.g. no appointment slots). 
     The referrals need to be reviewed and if appropriate booked into a service at the service provider organisation.
-  
-  There are currently no referral related worklists available for referring organisations.
 
   ## Supported security patterns
   - Healthcare worker, user-restricted access
diff --git a/specification/components/stu3/schemas/extensions/worklists/Extension-WorklistItem-ReferralRequestVersion.yaml b/specification/components/stu3/schemas/extensions/worklists/Extension-WorklistItem-ReferralRequestVersion.yaml
@@ -0,0 +1,14 @@
+title: referralRequestVersion
+type: object
+required:
+  - url
+  - valueInteger
+properties:
+  url:
+    type: string
+    enum:
+      - referralRequestVersion
+    example: referralRequestVersion
+  valueInteger:
+    type: integer
+    example: 0

Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,10 @@`
`126`	`126`	`},`
`127`	`127`	`"display": "Excellent Cardiology Business Service 12"`
`128`	`128`	`}`
	`129`	`+ },`
	`130`	`+ {`
	`131`	`+ "url": "referralRequestVersion",`
	`132`	`+ "valueInteger": 9`
`129`	`133`	`}`
`130`	`134`	`],`
`131`	`135`	`"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"`
`@@ -211,6 +215,10 @@`
`211`	`215`	`}`
`212`	`216`	`]`
`213`	`217`	`}`
	`218`	`+ },`
	`219`	`+ {`
	`220`	`+ "url": "referralRequestVersion",`
	`221`	`+ "valueInteger": 12`
`214`	`222`	`}`
`215`	`223`	`],`
`216`	`224`	`"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"`
`@@ -221,4 +229,4 @@`
`221`	`229`	`}`
`222`	`230`	`}`
`223`	`231`	`]`
`224`		`-}`
	`232`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -130,6 +130,10 @@`
`130`	`130`	`},`
`131`	`131`	`"display": "Another Excellent Cardiology Business Service 13"`
`132`	`132`	`}`
	`133`	`+ },`
	`134`	`+ {`
	`135`	`+ "url": "referralRequestVersion",`
	`136`	`+ "valueInteger": 12`
`133`	`137`	`}`
`134`	`138`	`],`
`135`	`139`	`"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"`
`@@ -140,4 +144,4 @@`
`140`	`144`	`}`
`141`	`145`	`}`
`142`	`146`	`]`
`143`		`-}`
	`147`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -121,6 +121,10 @@`
`121`	`121`	`}`
`122`	`122`	`]`
`123`	`123`	`}`
	`124`	`+ },`
	`125`	`+ {`
	`126`	`+ "url": "referralRequestVersion",`
	`127`	`+ "valueInteger": 9`
`124`	`128`	`}`
`125`	`129`	`],`
`126`	`130`	`"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"`
`@@ -216,6 +220,10 @@`
`216`	`220`	`},`
`217`	`221`	`"display": "Excellent Cardiology Business Service 12"`
`218`	`222`	`}`
	`223`	`+ },`
	`224`	`+ {`
	`225`	`+ "url": "referralRequestVersion",`
	`226`	`+ "valueInteger": 9`
`219`	`227`	`}`
`220`	`228`	`],`
`221`	`229`	`"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"`
`@@ -226,4 +234,4 @@`
`226`	`234`	`}`
`227`	`235`	`}`
`228`	`236`	`]`
`229`		`-}`
	`237`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -131,6 +131,10 @@`
`131`	`131`	`},`
`132`	`132`	`"display": "Excellent Cardiology Business Service 12"`
`133`	`133`	`}`
	`134`	`+ },`
	`135`	`+ {`
	`136`	`+ "url": "referralRequestVersion",`
	`137`	`+ "valueInteger": 7`
`134`	`138`	`}`
`135`	`139`	`],`
`136`	`140`	`"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"`
`@@ -230,6 +234,10 @@`
`230`	`234`	`},`
`231`	`235`	`"display": "Another Excellent Cardiology Business Service 13"`
`232`	`236`	`}`
	`237`	`+ },`
	`238`	`+ {`
	`239`	`+ "url": "referralRequestVersion",`
	`240`	`+ "valueInteger": 12`
`233`	`241`	`}`
`234`	`242`	`],`
`235`	`243`	`"url": "https://fhir.nhs.uk/STU3/StructureDefinition/Extension-eRS-ReferralsforReview-WorkListItem-1"`
`@@ -240,4 +248,4 @@`
`240`	`248`	`}`
`241`	`249`	`}`
`242`	`250`	`]`
`243`		`-}`
	`251`	`+}`