Skip to content

Commit fcdaba3

Browse files
committed
CCM-8392: [API Docs] Add name override fields to send single and batch endpoints
1 parent adfd187 commit fcdaba3

1 file changed

Lines changed: 25 additions & 3 deletions

File tree

specification/schemas/components/Recipient.yaml

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ properties:
88
minLength: 10
99
maxLength: 10
1010
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.
1212
contactDetails:
1313
type: object
1414
description: "Overriding contact details is a sensitive action and requires explicit approval from the onboarding team."
@@ -47,5 +47,27 @@ properties:
4747
type: string
4848
description: Postcode of overriding address. A required field when address is specified. Must be a valid UK postcode format.
4949
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.
69+
example: Smith
70+
suffix:
71+
type: string
72+
description: Suffix of overriding name.
73+
example: Jr.

0 commit comments

Comments
 (0)