Merge pull request #49 from NHSDigital/release/2023-03-14

Release 2023-03-14
NHSDigital · Mar 16, 2023 · 821ab40 · 821ab40
2 parents adbf4fd + 3b9dc67
commit 821ab40
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 12 deletions.
diff --git a/proxies/live/apiproxy/proxies/default.xml b/proxies/live/apiproxy/proxies/default.xml
@@ -35,9 +35,10 @@
           <Message>Missing Header: NHSD-End-User-Organisation-ODS</Message>
         </Step>
       </Request>
-      <Condition>request.header.NHSD-End-User-Organisation-ODS = null or request.header.NHSD-End-User-Organisation-ODS = ""</Condition>
+      <Condition>request.verb != "OPTIONS" and (request.header.NHSD-End-User-Organisation-ODS = null or request.header.NHSD-End-User-Organisation-ODS = "")</Condition>
     </Flow>
-    <Flow name="OptionsPreFlight">
+    <Flow name="CorsHeaders">
+      <!-- This must be the last item in the flow -->
       <Request/>
       <Response>
         <Step>

diff --git a/proxies/sandbox/apiproxy/proxies/default.xml b/proxies/sandbox/apiproxy/proxies/default.xml
@@ -36,9 +36,10 @@
           <Message>Missing Header: NHSD-End-User-Organisation-ODS</Message>
         </Step>
       </Request>
-      <Condition>request.header.NHSD-End-User-Organisation-ODS = null or request.header.NHSD-End-User-Organisation-ODS = ""</Condition>
+      <Condition>request.verb != "OPTIONS" and (request.header.NHSD-End-User-Organisation-ODS = null or request.header.NHSD-End-User-Organisation-ODS = "")</Condition>
     </Flow>
-    <Flow name="OptionsPreFlight">
+    <Flow name="CorsHeaders">
+      <!-- This must be the last item in the flow -->
       <Request/>
       <Response>
         <Step>

diff --git a/specification/nrl-consumer-api.yaml b/specification/nrl-consumer-api.yaml
@@ -155,11 +155,11 @@ info:
     url: "https://digital.nhs.uk/developer/help-and-support"
     email: [email protected]
 servers:
-  - url: "https://sandbox.api.service.nhs.uk/nrl-consumer-api/FHIR/R4"
+  - url: https://sandbox.api.service.nhs.uk/nrl-consumer-api/FHIR/R4
     description: Sandbox environment.
-  - url: "https://int.api.service.nhs.uk/nrl-consumer-api/FHIR/R4"
+  - url: https://int.api.service.nhs.uk/nrl-consumer-api/FHIR/R4
     description: Integration test environment.
-  - url: "https://api.service.nhs.uk/nrl-consumer-api/FHIR/R4"
+  - url: https://api.service.nhs.uk/nrl-consumer-api/FHIR/R4
     description: Production environment.
 paths:
   /DocumentReference:
@@ -170,6 +170,7 @@ paths:
         - $ref: "#/components/parameters/subject"
         - $ref: "#/components/parameters/custodian"
         - $ref: "#/components/parameters/type"
+        - $ref: "#/components/parameters/nextPageToken"
         - $ref: "#/components/parameters/odsCode"
         - $ref: "#/components/parameters/requestId"
         - $ref: "#/components/parameters/correlationId"
@@ -490,7 +491,7 @@ components:
   requestBodies:
     DocumentReference:
       content:
-        application/fhir+json:
+        application/fhir+json;version=1:
           schema:
             $ref: "#/components/schemas/DocumentReference"
       required: true
@@ -1192,6 +1193,8 @@ components:
           $ref: "#/components/schemas/RequestQueryCustodian"
         type.identifier:
           $ref: "#/components/schemas/RequestQueryType"
+        next-page-token:
+          $ref: "#/components/schemas/NextPageToken"
       required:
         - subject.identifier
     RequestQuerySubject:
@@ -1206,6 +1209,8 @@ components:
       type: string
       pattern: ^http\:\/\/snomed\.info\/sct\|(\d+)$
       example: "http://snomed.info/sct|736253002"
+    NextPageToken:
+      type: string
     RequestHeaderOdsCode:
       type: string
     RequestHeaderRequestId:
@@ -1238,6 +1243,9 @@ components:
         $ref: "#/components/schemas/RequestQuerySubject"
       required: true
       examples:
+        none:
+          summary: None
+          value: ""
         valid_1:
           summary: "Valid #1"
           value: https://fhir.nhs.uk/Id/nhs-number|4409815415
@@ -1253,6 +1261,9 @@ components:
       schema:
         $ref: "#/components/schemas/RequestQueryCustodian"
       examples:
+        none:
+          summary: None
+          value: ""
         valid:
           summary: Valid
           value: https://fhir.nhs.uk/Id/ods-organization-code|Y05868
@@ -1265,6 +1276,9 @@ components:
       schema:
         $ref: "#/components/schemas/RequestQueryType"
       examples:
+        none:
+          summary: None
+          value: ""
         SNOMED_CODES_MENTAL_HEALTH_CRISIS_PLAN:
           summary: Mental Health Crisis Plan
           value: http://snomed.info/sct|736253002
@@ -1280,6 +1294,15 @@ components:
         invalid:
           summary: Unknown
           value: http://snomed.info/sct|410970009
+    nextPageToken:
+      name: next-page-token
+      description: |
+        A token that can be sent as either a query parameter or in the post body parameter to retrieve the next set of 20 records.
+
+        This token is returned in the meta.tag field.
+      in: query
+      schema:
+        $ref: "#/components/schemas/NextPageToken"
     odsCode:
       name: NHSD-End-User-Organisation-ODS
       description: ODS Code for Organisation
@@ -1290,10 +1313,10 @@ components:
       examples:
         valid:
           summary: Valid
-          value: https://fhir.nhs.uk/Id/ods-organization-code|Y05868
+          value: Y05868
         invalid:
           summary: Unknown
-          value: https://fhir.nhs.uk/Id/ods-organization-code|XYZ
+          value: XYZ
     requestId:
       name: X-Request-ID
       description: |
@@ -1322,13 +1345,13 @@ components:
     Success:
       description: Success Response
       content:
-        application/fhir+json:
+        application/fhir+json;version=1:
           schema:
             $ref: "#/components/schemas/OperationOutcome"
     Error:
       description: Error Response
       content:
-        application/fhir+json:
+        application/fhir+json;version=1:
           schema:
             $ref: "#/components/schemas/OperationOutcome"
   headers: