Skip to content

Commit 5224ab3

Browse files
authored
NPA-6129: Updated the description for patient identifiers in OAS (#278)
# Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-6129 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - Updated description of patient identifiers in consent resource within OAS --- ## 🧪 Developer Testing Carried Out <!-- Describe what tests (automated/unit/manual etc.) have been done for the ticket. Include: --> <!-- - Any tests added/updated --> <!-- - Evidence that each acceptance criterion from the Jira ticket is met --> - N/A --- ## 🧪 Reviewer Testing Required <!-- Describe how to test the changes that have been made in the ticket. Include: --> <!-- - Testing environment details (e.g. sandbox/local setup) --> <!-- - Steps to verify the changes --> - [] Review PR --- ## ✅ Developer Checklist <!-- Complete before submitting the PR --> - [x] PR title follows the format: `NPA-XXXX: <short-description>` - [x] Branch name follows the convention: `<type>/NPA-XXXX/<short-description>` - [x] Commit messages follow the template: `NPA-XXXX: <short-description>` - [x] All acceptance criteria from the Jira ticket are addressed - [x] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [x] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- ## 👀 Reviewer Checklist <!-- To be completed by the reviewer --> - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) --- ## 🚀 Post-merge <!-- Actions to complete after merging --> After merging and deploying changes to the sandbox, Postman collection or spec examples please run the Run Postman collection workflow. This will run the tests within the collection to check that the sandbox is working as expected once deployed.
1 parent abef3a9 commit 5224ab3

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

specification/validated-relationships-service-api.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2213,21 +2213,21 @@ components:
22132213
$ref: "#/components/schemas/Meta"
22142214
identifier:
22152215
type: array
2216-
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).
2216+
description: The primary identifier of a patient. Possible identifiers include the NHS number or local GP patient identifier. If it is an NHS number, it will always 10 digits and must be a [valid NHS number](https://www.datadictionary.nhs.uk/attributes/nhs_number.html).
22172217
items:
22182218
type: object
22192219
properties:
22202220
system:
22212221
type: string
2222-
description: Codesystem URL for the NHS number.
2222+
description: Codesystem URL for the identifier.
22232223
enum:
22242224
[
22252225
"https://fhir.nhs.uk/Id/nhs-number",
22262226
"https://placeholder.fhir.nhs.uk/Id/local-gp-patient-identifier",
22272227
]
22282228
value:
22292229
type: string
2230-
description: The NHS number.
2230+
description: The identifier value (e.g. NHS number).
22312231
name:
22322232
$ref: "#/components/schemas/PDSName"
22332233
birthDate:

0 commit comments

Comments
 (0)