Merge pull request #186 from NHSDigital/feature/axkr1-NRL-1554-ContentRetrievalMechanismExtension

NRL-1554 Add content retrieval mechanism to documentation

Author: axelkrastek1-nhs

specification/record-locator/consumer.yaml

@@ -39,7 +39,7 @@ info:
     | Care Plan         ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000))               | Advance care plan                                                         ([736366004](https://termbrowser.nhs.uk/?perspective=full&conceptId1=736366004))               | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
     | Care Plan         ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000))               | Treatment escalation plan                                                 ([735324008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=735324008))               | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
     | Care Plan         ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000))               | Personalised Care and Support Plan                                        ([2181441000000107](https://termbrowser.nhs.uk/?perspective=full&conceptId1=2181441000000107)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
-    | Care Plan         ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000))               | Lloyd George record folder                                                ([16521000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=16521000000101))     | unstructured PDF - NDR retrieval proxy                                                                                                                                                 |
+    | Care Plan         ([734163000](https://termbrowser.nhs.uk/?perspective=full&conceptId1=734163000))               | Lloyd George record folder                                                ([16521000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=16521000000101))     | unstructured PDF - LDR retrieval proxy                                                                                                                                                 |
     | Observation       ([1102421000000108](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1102421000000108)) | Royal College of Physicians NEWS2 (National Early Warning Score 2) chart  ([1363501000000100](https://termbrowser.nhs.uk/?perspective=full&conceptId1=1363501000000100)) | [contact details](https://developer.nhs.uk/apis/nrl/retrieval_contact_details.html) & [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html) |
     | Clinical note     ([823651000000106](https://termbrowser.nhs.uk/?perspective=full&conceptId1=823651000000106))   | Summary record                                                            ([824321000000109](https://termbrowser.nhs.uk/?perspective=full&conceptId1=824321000000109))   | [unstructured PDF - SSP](https://developer.nhs.uk/apis/nrl/retrieval_unstructured_document.html)                                                                                       |
     | Record artifact   ([419891008](https://termbrowser.nhs.uk/?perspective=full&conceptId1=419891008))               | Appointment                                                               ([749001000000101](https://termbrowser.nhs.uk/?perspective=full&conceptId1=749001000000101))   |                                                                                                                                                                                        |
@@ -263,7 +263,7 @@ info:
 
     Once you have done this, you will need to ask for the 'internet' (if accessing it over the internet for your ASID) Catbag and 'Document Content Read' interaction permissions to be added to your ASID. You can request these permissions by emailing [ITOC](mailto:itoc.supportdesk@nhs.net)
 
-    If you are a GP system supplier looking to onboard to retrieve 'Lloyd George Record Folder' pointers, then SSP will not be used. Instead, you will need to onboard to the National Data Repository (NDR) retrieval proxy.
+    If you are a GP system supplier looking to onboard to retrieve 'Lloyd George Record Folder' pointers, then SSP will not be used. Instead, you will need to onboard to the Large Document Retrieval (LDR) retrieval proxy.
 
     ## Change log
 
@@ -355,7 +355,7 @@ paths:
                             - attachment:
                                 contentType: application/pdf
                                 language: en-UK
-                                url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/MentalHealthCrisisPlan.pdf
+                                url: ssp://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/MentalHealthCrisisPlan.pdf
                                 title: Example Mental Health Crisis Plan electronic document
                                 creation: "2022-12-20T09:45:41+00:00"
                               format:
@@ -369,6 +369,12 @@ paths:
                                         code: static
                                         display: Static
                                   url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability
+                                - valueCodeableConcept:
+                                    coding:
+                                      - system: https://fhir.nhs.uk/England/CodeSystem/England-RetrievalMechanism
+                                        code: SSP
+                                        display: Spine Secure Proxy
+                                  url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England
                           context:
                             event:
                               - coding:
@@ -507,7 +513,7 @@ paths:
                             - attachment:
                                 contentType: application/pdf
                                 language: en-UK
-                                url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/MentalHealthCrisisPlan.pdf
+                                url: ssp://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/MentalHealthCrisisPlan.pdf
                                 title: Example Mental Health Crisis Plan electronic document
                                 creation: "2022-12-20T09:45:41+00:00"
                               format:
@@ -521,6 +527,12 @@ paths:
                                         code: static
                                         display: Static
                                   url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability
+                                - valueCodeableConcept:
+                                    coding:
+                                      - system: https://fhir.nhs.uk/England/CodeSystem/England-RetrievalMechanism
+                                        code: SSP
+                                        display: Spine Secure Proxy
+                                  url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England
                           context:
                             event:
                               - coding:
@@ -657,12 +669,25 @@ paths:
                   - attachment:
                       contentType: application/pdf
                       language: en-US
-                      url: https://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EmergencyHealthPlan.pdf
+                      url: ssp://spine-proxy.national.ncrs.nhs.uk/p1.nhs.uk/EPAACS/EmergencyHealthPlan.pdf
                       creation: "2022-12-22T09:45:41+11:00"
                     format:
                       system: urn:oid:1.3.6.1.4.1.19376.1.2.3
                       code: urn:ihe:pcc:handp:2008
                       display: History and Physical Specification
+                    extension:
+                      - valueCodeableConcept:
+                          coding:
+                            - system: https://fhir.nhs.uk/England/CodeSystem/England-NRLContentStability,
+                              code: static
+                              display: Static
+                        url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England-ContentStability
+                      - valueCodeableConcept:
+                          coding:
+                            - system: https://fhir.nhs.uk/England/CodeSystem/England-RetrievalMechanism
+                              code: SSP
+                              display: Spine Secure Proxy
+                        url: https://fhir.nhs.uk/England/StructureDefinition/Extension-England
                 context:
                   event:
                     - coding:
@@ -949,10 +974,12 @@ components:
         extension:
           type: array
           items:
-            $ref: "#/components/schemas/ContentStabilityExtension"
-            description: Additional extension for content stability.
+            oneOf:
+              - $ref: "#/components/schemas/ContentStabilityExtension"
+              - $ref: "#/components/schemas/RetrievalMechanismExtension"
+              - $ref: "#/components/schemas/Extension"
+            description: Additional extensions which include Content Stability and Retrieval Mechanism.
           minItems: 1
-          maxItems: 1
       required:
         - attachment
         - format
@@ -1232,6 +1259,53 @@ components:
             - system
             - code
             - display
+    RetrievalMechanismExtension:
+      allOf:
+        - $ref: "#/components/schemas/Extension"
+        - type: object
+          properties:
+            url:
+              type: string
+              enum:
+                - "https://fhir.nhs.uk/England/StructureDefinition/Extension-England-RetrievalMechanism"
+            valueCodeableConcept:
+              $ref: "#/components/schemas/RetrievalMechanismExtensionValueCodeableConcept"
+          required:
+            - url
+            - valueCodeableConcept
+    RetrievalMechanismExtensionValueCodeableConcept:
+      allOf:
+        - $ref: "#/components/schemas/CodeableConcept"
+        - type: object
+          properties:
+            coding:
+              type: array
+              items:
+                $ref: "#/components/schemas/RetrievalMechanismExtensionCoding"
+              minItems: 1
+              maxItems: 1
+          required:
+            - coding
+    RetrievalMechanismExtensionCoding:
+      allOf:
+        - $ref: "#/components/schemas/Coding"
+        - type: object
+          properties:
+            system:
+              type: string
+              enum:
+                - "https://fhir.nhs.uk/England/CodeSystem/England-RetrievalMechanism"
+            code:
+              type: string
+              enum: ["SSP", "Direct", "LDR"]
+            display:
+              type: string
+              enum:
+                ["Spine Secure Proxy", "Direct", "Large Document Retrieval"]
+          required:
+            - system
+            - code
+            - display
     NRLFormatCode:
       allOf:
         - $ref: "#/components/schemas/Coding"