Skip to content

Commit b089732

Browse files
committed
NPA-5064 Remove Duplicate Patient Spec Component
1 parent 3c7b2e5 commit b089732

File tree

1 file changed

+2
-73
lines changed

1 file changed

+2
-73
lines changed

specification/validated-relationships-service-api.yaml

Lines changed: 2 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -2010,80 +2010,9 @@ components:
20102010
type: string
20112011
description: The NHS number.
20122012
name:
2013-
type: array
2014-
description: List of names associated with the patient.
2015-
items:
2016-
type: object
2017-
required:
2018-
- use
2019-
- family
2020-
additionalProperties: false
2021-
properties:
2022-
id:
2023-
type: string
2024-
description: Unique object identifier for this name.
2025-
use:
2026-
type: string
2027-
description: |
2028-
How this name should be used.
2029-
* usual - Known as, conventional or the one patient normally uses. A patient always has a usual name.
2030-
* temp - An alias or temporary name. This may also be used for temporary names assigned at birth or in emergency situations.
2031-
* nickname - A name that the patient prefers to be addressed by, but is not part of their usual name.
2032-
* old - This name is no longer in use (or was never correct, but retained for records).
2033-
* maiden - Name changed for Marriage. A name used prior to changing name because of marriage. This term is not gender specific. The use of this term does not imply any particular history for a person's name.
2034-
2035-
The following use codes are included in the [name-use](https://www.hl7.org/fhir/valueset-name-use.html) value set, but should not be used and is not be returned as part of a retrieval.
2036-
* official - The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
2037-
* anonymous - Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
2038-
enum: [usual, temp, nickname, old, maiden]
2039-
period:
2040-
type: object
2041-
description: |
2042-
Business effective period when the name was, is, or will be in use.
2043-
required:
2044-
- start
2045-
properties:
2046-
start:
2047-
type: string
2048-
format: date
2049-
description: Start date of time period, if known, in format `yyyy-mm-dd`. Can be a future date.
2050-
end:
2051-
type: string
2052-
format: date
2053-
description: End date of time period, if known and if not ongoing, in format `yyyy-mm-dd`. Can be a future date.
2054-
given:
2055-
type: array
2056-
maxItems: 5
2057-
description: |
2058-
Given names, including any middle names.
2059-
2060-
Each name(s) should be a separate item in the list. The first given name may include multiple names, separated by a space.
2061-
Subsequent names must be broken down into list items. For example, the input `[Jane Marie Anne, Jo Adele]` returns `[Jane Marie Anne, Jo, Adele]`.
2062-
2063-
items:
2064-
type: string
2065-
maxLength: 35
2066-
family:
2067-
type: string
2068-
maxLength: 35
2069-
description: Family name (often called Surname).
2070-
prefix:
2071-
type: array
2072-
description: Name prefixes, titles, and prenominals.
2073-
items:
2074-
type: string
2075-
suffix:
2076-
type: array
2077-
description: Name suffices and postnominals.
2078-
items:
2079-
type: string
2013+
$ref: "#/components/schemas/PDSName"
20802014
birthDate:
2081-
description: |
2082-
The date on which the patient was born or is officially deemed to have been born.
2083-
2084-
It is a date in the format `yyyy-mm-dd`. Due to data quality issues on a small number of patients `yyyy-mm` and `yyyy` format may also be returned.
2085-
type: string
2086-
format: date
2015+
$ref: "#/components/schemas/PDSBirthDate"
20872016
generalPractitioner:
20882017
type: array
20892018
description: Patient's nominated primary care provider, each a Reference(Organization | Practitioner | PractitionerRole).

0 commit comments

Comments
 (0)