AEA-3808 Add Prescription Status message schema to API Specification (#…

…11) ## Summary 🎫 [AEA-3808](https://nhsd-jira.digital.nhs.uk/browse/AEA-3808) Add Prescription Status message schema to API Specification - Routine Change ### Details The changes to the Prescription Status Update API specification
NHSDigital · Feb 23, 2024 · 2cac2c8 · 2cac2c8
1 parent 7b40495
commit 2cac2c8
Show file tree

Hide file tree

Showing 8 changed files with 76 additions and 23 deletions.
diff --git a/packages/specification/eps-prescription-status-update-api.yaml b/packages/specification/eps-prescription-status-update-api.yaml
@@ -107,28 +107,33 @@ paths:
             schema:
               $ref: "#/components/schemas/PostPrescriptionStatusBundle"
             examples:
-              request-ready-to-collect:
-                summary: request-ready-to-collect
-                description: A request message contains tracking status ready to collect.
+              ready-to-collect:
+                summary: ready-to-collect
+                description: A request message contains tracking status `Ready to collect`.
                 value:
                   $ref: examples/request-ready-to-collect.json
-              request-ready-to-collect-note:
-                summary: request-ready-to-collect-note
-                description: A request message contains tracking status ready to collect with note.
+              ready-to-deliver:
+                summary: ready-to-deliver
+                description: A request message contains tracking status `Ready to deliver`.
                 value:
-                  $ref: examples/request-ready-to-collect-note.json
+                  $ref: examples/request-ready-to-deliver.json
+              in-collection-locker:
+                summary: in-collection-locker
+                description: A request message contains tracking status `In Collection Locker` and a note that describes the collection process.
+                value:
+                  $ref: examples/request-in-collection-locker.json
               collected:
                 summary: collected
-                description: A request message contains tracking status collected.
+                description: A request message contains tracking status `Collected`.
                 value:
                   $ref: examples/request-collected.json
               dispatched:
                 summary: dispatched
                 description: A request message contains tracking status dispatched.
                 value:
                   $ref: examples/request-dispatched.json
-              multiple-tasks:
-                summary: multiple-tasks
+              multiple-items:
+                summary: multiple-items
                 description: A request message contains multiple items.
                 value:
                   $ref: examples/request-multiple-items.json
@@ -140,11 +145,11 @@ paths:
               schema:
                 $ref: "#/components/schemas/bundle-response"
               examples:
-                single-task:
+                single-item:
                   description: A successful response to a UpdatePrescriptionStatus request, contains a single item.
                   value:
-                    $ref: "examples/response-single-task.json"
-                multiple-tasks:
+                    $ref: "examples/response-single-item.json"
+                multiple-items:
                   description: A successful response to a UpdatePrescriptionStatus request, contains multiple items.
                   value:
                     $ref: "examples/response-multiple-items.json"

diff --git a/packages/specification/examples/request-collected.json b/packages/specification/examples/request-collected.json
@@ -18,7 +18,7 @@
         "coding": [
           {
             "system": "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt",
-            "code": "9004",
+            "code": "4",
             "display": "Collected"
           }
         ]

diff --git a/packages/specification/examples/request-dispatched.json b/packages/specification/examples/request-dispatched.json
@@ -18,7 +18,7 @@
         "coding": [
           {
             "system": "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt",
-            "code": "9005",
+            "code": "5",
             "display": "Dispatched"
           }
         ]

diff --git a/...amples/request-ready-to-collect-note.json → ...xamples/request-in-collection-locker.json b/...amples/request-ready-to-collect-note.json → ...xamples/request-in-collection-locker.json
@@ -18,8 +18,8 @@
         "coding": [
           {
             "system": "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt",
-            "code": "9001",
-            "display": "Ready to Collect"
+            "code": "3",
+            "display": "In Collection Locker"
           }
         ]
       },

diff --git a/packages/specification/examples/request-multiple-items.json b/packages/specification/examples/request-multiple-items.json
@@ -20,8 +20,8 @@
           "coding": [
             {
               "system": "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt",
-              "code": "9001",
-              "display": "Ready to Collect"
+              "code": "3",
+              "display": "In Collection Locker"
             }
           ]
         },
@@ -74,8 +74,8 @@
           "coding": [
             {
               "system": "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt",
-              "code": "9001",
-              "display": "Ready to Collect"
+              "code": "3",
+              "display": "In Collection Locker"
             }
           ]
         },

diff --git a/packages/specification/examples/request-ready-to-collect.json b/packages/specification/examples/request-ready-to-collect.json
@@ -18,8 +18,8 @@
         "coding": [
           {
             "system": "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt",
-            "code": "9001",
-            "display": "Ready to Collect"
+            "code": "1",
+            "display": "Ready to collect"
           }
         ]
       },

diff --git a/packages/specification/examples/request-ready-to-deliver.json b/packages/specification/examples/request-ready-to-deliver.json
@@ -0,0 +1,48 @@
+{
+  "resourceType": "Bundle",
+  "type": "transaction",
+  "entry": [
+    {
+      "fullUrl": "http://example.org/fhir/Task/4d70678c-81e4-4ff4-8c67-17596fd0aa46",
+      "resourceType": "Task",
+      "basedOn": [
+        {
+          "identifier": {
+            "system": "https://fhir.nhs.uk/Id/prescription-order-number",
+            "value": "24F5DA-A83008-7EFE6Z"
+          }
+        }
+      ],
+      "status": "in-progress",
+      "businessStatus": {
+        "coding": [
+          {
+            "system": "https://fhir.nhs.uk/CodeSystem/task-businessStatus-nppt",
+            "code": "2",
+            "display": "Ready to deliver"
+          }
+        ]
+      },
+      "intent": "order",
+      "focus": {
+        "identifier": {
+          "system": "https://fhir.nhs.uk/Id/prescription-order-item-number",
+          "value": "6989b7bd-8db6-428c-a593-4022e3044c00"
+        }
+      },
+      "for": {
+        "identifier": {
+          "system": "https://fhir.nhs.uk/Id/nhs-number",
+          "value": "9449304130"
+        }
+      },
+      "lastModified": "2024-01-30T12:01:24Z",
+      "owner": {
+        "identifier": {
+          "system": "https://fhir.nhs.uk/Id/ods-organization-code",
+          "value": "C9Z1O"
+        }
+      }
+    }
+  ]
+}
diff --git a/...cation/examples/response-single-task.json → ...cation/examples/response-single-item.json b/...cation/examples/response-single-task.json → ...cation/examples/response-single-item.json