semantic errors

Author: JamesW1-NHS

specification/immunisation-fhir-api.json

@@ -857,13 +857,13 @@
               "description": "Create Immunization operation successful",
               "headers": {
                 "Location": {
-                  "$ref": "#/components/parameters/Location"
+                  "$ref": "#/components/headers/Location"
                 },
                 "CorrelationID": {
-                  "$ref": "#/components/parameters/CorrelationID"
+                  "$ref": "#/components/headers/CorrelationID"
                 },
                 "RequestID": {
-                  "$ref": "#/components/parameters/RequestID"
+                  "$ref": "#/components/headers/RequestID"
                 }
               }
             },
@@ -1808,13 +1808,13 @@
               "description": "Read Immunization operation successful",
               "headers": {
                 "CorrelationID": {
-                  "$ref": "#/components/parameters/CorrelationID"
+                  "$ref": "#/components/headers/CorrelationID"
                 },
                 "RequestID": {
-                  "$ref": "#/components/parameters/RequestID"
+                  "$ref": "#/components/headers/RequestID"
                 },
                 "E-Tag": {
-                  "$ref": "#/components/parameters/E-Tag"
+                  "$ref": "#/components/headers/E-Tag"
                 }
               },
               "content": {
@@ -3554,10 +3554,10 @@
               "description": "Update Immunization operation successful",
               "headers": {
                 "CorrelationID": {
-                  "$ref": "#/components/parameters/CorrelationID"
+                  "$ref": "#/components/headers/CorrelationID"
                 },
                 "RequestID": {
-                  "$ref": "#/components/parameters/RequestID"
+                  "$ref": "#/components/headers/RequestID"
                 }
               }
             },
@@ -3682,6 +3682,43 @@
           }
         }
       },
+      "headers": {
+        "CorrelationID": {
+          "required": false,
+          "description": "An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters.\n\nMirrored back in a response header.\n",
+          "schema": {
+            "type": "string",
+            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+            "example": "60E0B220-8136-4CA5-AE46-1D97EF59D068"
+          }
+        },
+        "RequestID": {
+          "required": false,
+          "description": "A globally unique identifier (GUID) for the request, which we use to de-duplicate repeated requests and to trace the request if you contact our helpdesk.\n\nMust be a universally unique identifier (UUID) (ideally version 4).\n\nMirrored back in a response header.\n\nIf you re-send a failed request, use the same value in this header.\n",
+          "schema": {
+            "type": "string",
+            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+            "example": "60E0B220-8136-4CA5-AE46-1D97EF59D068"
+          }
+        },
+        "Location": {
+          "required": true,
+          "description": "The location of the newly created Immunization record. It contains the resource ID at the end.",
+          "schema": {
+            "type": "string",
+            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
+            "example": "60E0B220-8136-4CA5-AE46-1D97EF59D068"
+          }
+        },
+        "E-Tag": {
+          "required": true,
+          "description": "Indicates the current version of an Immunization resource",
+          "schema": {
+            "type": "integer",
+            "example": 1
+          }
+        }
+      },
       "parameters": {
         "Id": {
           "in": "path",
@@ -3773,22 +3810,11 @@
             "default": "Immunization:patient"
           }
         },
-        "Location": {
-          "in": "header",
-          "name": "location",
-          "required": true,
-          "description": "The location of newly created Immunization record. It contains resouce ID at the end.",
-          "schema": {
-            "type": "string",
-            "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
-            "example": "60E0B220-8136-4CA5-AE46-1D97EF59D068"
-          }
-        },
         "E-Tag": {
           "in": "header",
           "name": "E-Tag",
           "required": true,
-          "description": "Indicaes the current version of Immunization resource",
+          "description": "Indicates the current version of an Immunization resource",
           "schema": {
             "type": "integer",
             "example": 1