NPA-5003: Update RelatedPerson for RPN

Author: JackPlowman

specification/validated-relationships-service-api.yaml

@@ -2018,7 +2018,9 @@ components:
           type: string
           description: The canonical URL of the resource in the entry
         resource:
-          $ref: "#/components/schemas/RelatedPerson"
+          oneOf:
+            - $ref: "#/components/schemas/PDSRelatedPerson"
+            - $ref: "#/components/schemas/RPNRelatedPerson"
         search:
           type: object
           properties:
@@ -2067,9 +2069,9 @@ components:
                 - include
               example: match
 
-    RelatedPerson:
+    PDSRelatedPerson:
       type: object
-      description: The proxy's details. This includes their relationship to the referenced patient.
+      description: The proxy's details. This includes their relationship to the referenced patient from PDS.
       properties:
         resourceType:
           type: string
@@ -2153,6 +2155,92 @@ components:
                         - "Personal relationship with the patient"
                         - "child"
 
+  RPNRelatedPerson:
+      type: object
+      description: The proxy's details. This includes their relationship to the referenced patient from RPN.
+      properties:
+        resourceType:
+          type: string
+          description: FHIR resource type.
+          enum: [RelatedPerson]
+          default: RelatedPerson
+        id:
+          type: string
+          description: Unique identifier of the RelatedPerson resource.
+        identifier:
+          type: array
+          description: The patient's NHS number. The primary identifier of a patient, unique within NHS England and Wales. Always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).
+          items:
+            type: object
+            properties:
+              system:
+                type: string
+                description: Codesystem URL for the patient's NHS number.
+                enum:
+                  [
+                    "https://fhir.nhs.uk/Id/nhs-number",
+                    "https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier",
+                  ]
+              value:
+                type: string
+                description: The patient's NHS number.
+        patient:
+          type: object
+          description: A reference to the proxy.
+          properties:
+            type:
+              type: string
+              description: FHIR resource type.
+              enum: ["Patient"]
+            identifier:
+              type: object
+              description: The proxy's NHS number. The primary identifier of a proxy, unique within NHS England and Wales. Always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).
+              properties:
+                system:
+                  type: string
+                  description: Codesystem URL for the proxy's NHS number.
+                  enum: ["https://fhir.nhs.uk/Id/nhs-number"]
+                value:
+                  type: string
+                  description: The proxy's NHS number.
+        relationship:
+          type: array
+          description: How the proxy is related to the patient.
+          items:
+            type: object
+            properties:
+              coding:
+                type: array
+                description: FHIR coding array.
+                items:
+                  type: object
+                  properties:
+                    system:
+                      type: string
+                      description: FHIR codesystem.
+                      default: "http://terminology.hl7.org/CodeSystem/v3-RoleCode"
+                      enum:
+                        [
+                          "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
+                          "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole",
+                        ]
+                    code:
+                      type: string
+                      description: FHIR relationship type code.
+                      enum:
+                        - "MTH"
+                        - "PRN"
+                        - "Personal"
+                        - "CHILD"
+                    display:
+                      type: string
+                      description: FHIR relationship type.
+                      enum:
+                        - "mother"
+                        - "parent"
+                        - "Personal relationship with the patient"
+                        - "child"
+
     Patient:
       type: object
       description: The patient's details.