You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification/schemas/components/Recipient.yaml
+25-3Lines changed: 25 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ properties:
8
8
minLength: 10
9
9
maxLength: 10
10
10
example: "9990548609"
11
-
description: The [NHS number](https://digital.nhs.uk/services/nhs-number) of the recipient. Only [valid NHS Numbers](https://www.datadictionary.nhs.uk/attributes/nhs_number.html) will be accepted. This will be used to lookup the recipients details with the [Personal Demographics Service](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir).
11
+
description: The [NHS number](https://digital.nhs.uk/services/nhs-number) of the recipient. Only [valid NHS Numbers](https://www.datadictionary.nhs.uk/attributes/nhs_number.html) will be accepted. This will be used to lookup the recipients details with the [Personal Demographics Service](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir). Normally a required field, unless prior agreement with the Onboarding team is in place to enable the Anonymous Patients feature.
12
12
contactDetails:
13
13
type: object
14
14
description: "Overriding contact details is a sensitive action and requires explicit approval from the onboarding team."
@@ -47,5 +47,27 @@ properties:
47
47
type: string
48
48
description: Postcode of overriding address. A required field when address is specified. Must be a valid UK postcode format.
49
49
example: "LS1 4AP"
50
-
required:
51
-
- nhsNumber
50
+
name:
51
+
type: object
52
+
description: Overriding name fields for the recipient.
53
+
properties:
54
+
prefix:
55
+
type: string
56
+
description: Prefix of overriding name.
57
+
example: Dr.
58
+
firstName:
59
+
type: string
60
+
description: First name of overriding name.
61
+
example: John
62
+
middleNames:
63
+
type: string
64
+
description: Middle names of overriding name.
65
+
example: Andrew Robert
66
+
lastName:
67
+
type: string
68
+
description: Last name of overriding name. A required field when name is specified.
0 commit comments