Merge pull request #1786 from NHSDigital/develop

adamtallentire-nhsd · web-flow · commit dd7019f4a21a · 2024-09-18T15:10:30.000+01:00
APIM-R 1.37 Cut
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
   "license": "MIT",
   "homepage": "https://github.com/NHSDigital/e-referrals-service-api",
   "dependencies": {
-    "@redocly/cli": "^1.19.0"
+    "@redocly/cli": "^1.23.1"
   },
   "devDependencies": {
     "apigeetool": "^0.16.4",
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -28,7 +28,7 @@ semver = "^3.0.2"
 gitpython = "^3.1.43"
 lxml = "^4.9.4"
 xmlformatter = "^0.2.6"
-pytest-check = "^2.3.1"
+pytest-check = "^2.4.1"
 requests = "^2.32.3"
 openapi-core = "^0.19.3"
 
@@ -39,8 +39,8 @@ black = "^24.8"
 pip-licenses = "^4.5.1"
 jinja2 = "^3.1.4"
 pytest = "^8.3.2"
-pytest-asyncio = "^0.23.8"
-pytest-nhsd-apim = "^3.4.2"
+pytest-asyncio = "^0.24.0"
+pytest-nhsd-apim = "^3.4.3"
 
 [tool.poetry.scripts]
 
diff --git a/sandbox/package-lock.json b/sandbox/package-lock.json
diff --git a/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralIntendPrivateWithoutComment.json b/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralIntendPrivateWithoutComment.json
@@ -59,7 +59,7 @@
                                 "valueCoding": {
                                     "system": "_baseUrl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",
                                     "code": "INTEND_PRIVATE",
-                                    "display": "Intend to go private"
+                                    "display": "Patient will go to a private clinic"
                                 }
                             }
                         ]
diff --git a/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralPatientOther.json b/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralPatientOther.json
@@ -59,7 +59,7 @@
                                 "valueCoding": {
                                     "system": "_baseUrl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",
                                     "code": "PATIENT_REQUEST_CANCELLATION_OTHER",
-                                    "display": "Other reason"
+                                    "display": "Other"
                                 }
                             },
                             {
diff --git a/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralRaisedInError.json b/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralRaisedInError.json
@@ -59,7 +59,7 @@
                                 "valueCoding": {
                                     "system": "_baseUrl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",
                                     "code": "RAISED_IN_ERROR",
-                                    "display": "Referral raised in error"
+                                    "display": "Referral created by mistake"
                                 }
                             },
                             {
diff --git a/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralResolvedDeferralIntendPrivateWithComment.json b/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralResolvedDeferralIntendPrivateWithComment.json
@@ -61,7 +61,7 @@
                                 "valueCoding": {
                                     "system": "_baseUrl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",
                                     "code": "INTEND_PRIVATE",
-                                    "display": "Patient intends to go private"
+                                    "display": "Patient will go to a private clinic"
                                 }
                             },
                             {
diff --git a/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralWithCancelledBookingNoLongerRequired.json b/sandbox/src/mocks/stu3/cancelReferral/responses/CancelledReferralWithCancelledBookingNoLongerRequired.json
@@ -63,7 +63,7 @@
                                 "valueCoding": {
                                     "code": "TREATMENT_NO_LONGER_REQUIRED",
                                     "system": "_baseurl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",
-                                    "display": "Referral no longer required"
+                                    "display": "Referral no longer needed"
                                 }
                             },
                             {
diff --git a/sandbox/src/mocks/stu3/getCodeSystem/responses/AppointmentCancellationReasonCodeSystem.json b/sandbox/src/mocks/stu3/getCodeSystem/responses/AppointmentCancellationReasonCodeSystem.json
@@ -482,7 +482,7 @@
     },
     {
       "code": "PATIENT_APPOINTMENT_CANCELLATION_OTHER",
-      "display": "Other reason",
+      "display": "Other",
       "property": [
         {
           "code": "effectiveFrom",
diff --git a/sandbox/src/mocks/stu3/getCodeSystem/responses/ReferralCancellationReasonCodeSystem.json b/sandbox/src/mocks/stu3/getCodeSystem/responses/ReferralCancellationReasonCodeSystem.json
@@ -124,7 +124,7 @@
     },
     {
       "code": "INTEND_PRIVATE",
-      "display": "Patient intends to go private",
+      "display": "Patient will go to a private clinic",
       "property": [
         {
           "code": "effectiveFrom",
@@ -274,7 +274,7 @@
     },
     {
       "code": "PATIENT_REQUEST_CANCELLATION_OTHER",
-      "display": "Other reason",
+      "display": "Other",
       "property": [
         {
           "code": "effectiveFrom",
@@ -313,7 +313,7 @@
     },
     {
       "code": "RAISED_IN_ERROR",
-      "display": "Referral raised in error",
+      "display": "Referral created by mistake",
       "property": [
         {
           "code": "effectiveFrom",
@@ -409,7 +409,7 @@
     },
     {
       "code": "TREATMENT_NO_LONGER_REQUIRED",
-      "display": "Referral no longer required",
+      "display": "Referral no longer needed",
       "property": [
         {
           "code": "effectiveFrom",
@@ -466,7 +466,7 @@
     },
     {
       "code": "PATIENT_APPOINTMENT_CANCELLATION_OTHER",
-      "display": "Other reason",
+      "display": "Other",
       "property": [
         {
           "code": "effectiveFrom",
diff --git a/sandbox/src/mocks/stu3/retrieveWorklist/responses/AssessmentReturnedCancelledDna.json b/sandbox/src/mocks/stu3/retrieveWorklist/responses/AssessmentReturnedCancelledDna.json
@@ -72,7 +72,7 @@
                     {
                       "system": "_baseurl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",
                       "code": "INTEND_PRIVATE",
-                      "display": "Patient intends to go private"
+                      "display": "Patient will go to a private clinic"
                     }
                   ]
                 }
diff --git a/specification/components/stu3/schemas/CodeSystemConcept.yaml b/specification/components/stu3/schemas/CodeSystemConcept.yaml
@@ -30,14 +30,14 @@ properties:
     title: Display value of the code system
     description: |
       
-      | Code System                           | Example Display Value         |
-      | ------------------------------------- | ----------------------------- |
-      | Specialty                             | Urology                       |
-      | Clinic Type                           | General Urology               |
-      | Appointment Cancellation Reason       | Inappropriate service         |
-      | Referral Cancellation Reason          | Intend to go private          |
-      | Appointment Non-attendance Reason     | Patient ill                   |
-      | Priority                              | Routine                       |
+      | Code System                           | Example Display Value               |
+      | ------------------------------------- | ----------------------------------- |
+      | Specialty                             | Urology                             |
+      | Clinic Type                           | General Urology                     |
+      | Appointment Cancellation Reason       | Inappropriate service               |
+      | Referral Cancellation Reason          | Patient will go to a private clinic |
+      | Appointment Non-attendance Reason     | Patient ill                         |
+      | Priority                              | Routine                             |
       
     type: string
   property:
diff --git a/specification/components/stu3/schemas/eRS-CancelReferral-Request-Parameters.yaml b/specification/components/stu3/schemas/eRS-CancelReferral-Request-Parameters.yaml
@@ -73,5 +73,5 @@ properties:
               example: 'cancellationComments'
             valueString:
               type: string
-              example: 'Patient intend to go private'
+              example: 'Patient will go to a private clinic'
 
diff --git a/specification/components/stu3/schemas/eRS-FetchWorklist-List.yaml b/specification/components/stu3/schemas/eRS-FetchWorklist-List.yaml
@@ -828,7 +828,7 @@ properties:
                                           example: INTEND_PRIVATE
                                         display:
                                           type: string
-                                          example: Patient intends to go private
+                                          example: Patient will go to a private clinic
               - title: 'Extension-eRS-AwaitingBooking-WorklistItem'
                 type: object
                 required:
diff --git a/specification/components/stu3/schemas/responses/cancelReferral/200Response.yaml b/specification/components/stu3/schemas/responses/cancelReferral/200Response.yaml
@@ -12,26 +12,26 @@ content:
       $ref: '../../eRS-CancelReferral-Response-Parameters.yaml'
     examples:
       cancelled-referral-intend-private-without-comment:
-        summary: Cancelled Referral without Booking with Reason 'Intend to go private' without Comment (Comment Not Mandatory)
+        summary: Cancelled Referral without Booking with Reason 'Patient will go to a private clinic' without Comment (Comment Not Mandatory)
         value:
           $ref: '../../../examples/cancelReferral/responses/CancelledReferralIntendPrivateWithoutComment.json'
       cancelled-referral-patient-other-reason:
-        summary: Cancelled Referral without Booking with Reason 'Other reason' with Comment (Comment Mandatory)
+        summary: Cancelled Referral without Booking with Reason 'Other' with Comment (Comment Mandatory)
         value:
           $ref: '../../../examples/cancelReferral/responses/CancelledReferralPatientOther.json'
       cancelled-referral-raised-in-error:
-        summary: Cancelled Referral without Booking with Reason 'Referral raised in error'
+        summary: Cancelled Referral without Booking with Reason 'Referral created by mistake'
         value:
           $ref: '../../../examples/cancelReferral/responses/CancelledReferralRaisedInError.json'
       cancelled-referral-with-booking-referrer-cancellation:
         summary: Cancelled Referral with Booking with Reason 'Other - Referrer request cancellation'
         value:
           $ref: '../../../examples/cancelReferral/responses/CancelledBookedReferralReferrerCancellation.json'
       cancelled-referral-with-cancelled-booking-no-longer-required:
-        summary: Cancelled Referral with Cancelled Booking with Reason 'Referral no longer required'
+        summary: Cancelled Referral with Cancelled Booking with Reason 'Referral no longer needed'
         value:
           $ref: '../../../examples/cancelReferral/responses/CancelledReferralWithCancelledBookingNoLongerRequired.json'
       cancelled-referral-with-deferral-intend-private-with-comment:
-        summary: Cancelled Referral with Existing Review Outcome with Reason 'Intend to go private'
+        summary: Cancelled Referral with Existing Review Outcome with Reason 'Patient will go to a private clinic'
         value:
           $ref: '../../../examples/cancelReferral/responses/CancelledReferralResolvedDeferralIntendPrivateWithComment.json'

Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@`
`59`	`59`	`"valueCoding": {`
`60`	`60`	`"system": "_baseUrl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",`
`61`	`61`	`"code": "INTEND_PRIVATE",`
`62`		`- "display": "Intend to go private"`
	`62`	`+ "display": "Patient will go to a private clinic"`
`63`	`63`	`}`
`64`	`64`	`}`
`65`	`65`	`]`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@`
`61`	`61`	`"valueCoding": {`
`62`	`62`	`"system": "_baseUrl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",`
`63`	`63`	`"code": "INTEND_PRIVATE",`
`64`		`- "display": "Patient intends to go private"`
	`64`	`+ "display": "Patient will go to a private clinic"`
`65`	`65`	`}`
`66`	`66`	`},`
`67`	`67`	`{`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@`
`63`	`63`	`"valueCoding": {`
`64`	`64`	`"code": "TREATMENT_NO_LONGER_REQUIRED",`
`65`	`65`	`"system": "_baseurl_/STU3/CodeSystem/REFERRAL-CANCELLATION-REASON",`
`66`		`- "display": "Referral no longer required"`
	`66`	`+ "display": "Referral no longer needed"`
`67`	`67`	`}`
`68`	`68`	`},`
`69`	`69`	`{`