Merge pull request #855 from NHSDigital/feature/NRL-1144-retrieval-mechanism-fhirs

NRL-1144 draft FHIR valueSet and codeSystem for retrieval

Author: katebobyn-nhs

resources/fhir/NRLF-Retrieval-CodeSystem.json

@@ -0,0 +1,63 @@
+{
+  "resourceType": "CodeSystem",
+  "id": "England-RetrievalMechanismNRL",
+  "url": "https://fhir.nhs.uk/England/CodeSystem/England-RetrievalMechanismNRL",
+  "version": "1.0.0",
+  "name": "EnglandRetrievalMechanismNRL",
+  "title": "England Retrieval MechanismNRL",
+  "status": "draft",
+  "experimental": false,
+  "date": "2025-02-28",
+  "publisher": "NHS England",
+  "contact": [
+    {
+      "name": "NHS England",
+      "telecom": [
+        {
+          "system": "email",
+          "value": "[email protected]",
+          "use": "work",
+          "rank": 1
+        }
+      ]
+    },
+    {
+      "name": "NRL Team at NHS Digital",
+      "telecom": [
+        {
+          "system": "email",
+          "value": "[email protected]",
+          "use": "work"
+        }
+      ]
+    }
+  ],
+  "description": "A CodeSystem to identify the means by which an NRL DocumentReference can be retrieved via its content.attachment url.",
+  "copyright": "Copyright © 2025+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at  https://www.hl7.org/fhir/license.html.",
+  "content": "complete",
+  "hierarchyMeaning": "is-a",
+  "concept": [
+    {
+      "code": "Direct",
+      "display": "Direct",
+      "definition": "This document can be directly retrieved via HTTP(s) at its public URL."
+    },
+    {
+      "code": "Proxy",
+      "display": "Proxy",
+      "definition": "This document must be retrieved via a proxy.",
+      "concept": [
+        {
+          "code": "SSP",
+          "display": "Spine Secure Proxy",
+          "definition": "This document can be retrieved via Spine Secure Proxy by authorised organisations. The custodian's ASID will be needed and can be found in the context.related field."
+        },
+        {
+          "code": "NDR",
+          "display": "National Document Repository",
+          "definition": "This document can be retrieved via the National Document Repository proxy service."
+        }
+      ]
+    }
+  ]
+}

resources/fhir/NRLF-RetrievalMechanism-ValueSet.json

@@ -0,0 +1,41 @@
+{
+  "resourceType": "ValueSet",
+  "id": "England-RetrievalMechanism",
+  "url": "https://fhir.nhs.uk/England/ValueSet/England-RetrievalMechanism",
+  "version": "1.0.0",
+  "name": "EnglandRetrievalMechanism",
+  "status": "draft",
+  "date": "2025-02-28",
+  "publisher": "NHS Digital",
+  "contact": {
+    "name": "NRL Team at NHS Digital",
+    "telecom": {
+      "system": "email",
+      "value": "[email protected]",
+      "use": "work"
+    }
+  },
+  "description": "A code to represent the means by which the document being referenced can be accessed (via the url in the content.attachment).",
+  "copyright": "Copyright 2025 NHS Digital.",
+  "compose": {
+    "include": [
+      {
+        "system": "https://fhir.nhs.uk/England/CodeSystem/England-RetrievalMechanismNRL",
+        "concept": [
+          {
+            "code": "Direct",
+            "display": "Direct"
+          },
+          {
+            "code": "SSP",
+            "display": "Spine Secure Proxy"
+          },
+          {
+            "code": "NDR",
+            "display": "National Document Repository"
+          }
+        ]
+      }
+    ]
+  }
+}