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/validated-relationships-service-api.yaml
+2-73Lines changed: 2 additions & 73 deletions
Original file line number
Diff line number
Diff line change
@@ -2018,80 +2018,9 @@ components:
2018
2018
type: string
2019
2019
description: The NHS number.
2020
2020
name:
2021
-
type: array
2022
-
description: List of names associated with the patient.
2023
-
items:
2024
-
type: object
2025
-
required:
2026
-
- use
2027
-
- family
2028
-
additionalProperties: false
2029
-
properties:
2030
-
id:
2031
-
type: string
2032
-
description: Unique object identifier for this name.
2033
-
use:
2034
-
type: string
2035
-
description: |
2036
-
How this name should be used.
2037
-
* usual - Known as, conventional or the one patient normally uses. A patient always has a usual name.
2038
-
* temp - An alias or temporary name. This may also be used for temporary names assigned at birth or in emergency situations.
2039
-
* nickname - A name that the patient prefers to be addressed by, but is not part of their usual name.
2040
-
* old - This name is no longer in use (or was never correct, but retained for records).
2041
-
* 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.
2042
-
2043
-
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.
2044
-
* official - The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
2045
-
* anonymous - Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
2046
-
enum: [usual, temp, nickname, old, maiden]
2047
-
period:
2048
-
type: object
2049
-
description: |
2050
-
Business effective period when the name was, is, or will be in use.
2051
-
required:
2052
-
- start
2053
-
properties:
2054
-
start:
2055
-
type: string
2056
-
format: date
2057
-
description: Start date of time period, if known, in format `yyyy-mm-dd`. Can be a future date.
2058
-
end:
2059
-
type: string
2060
-
format: date
2061
-
description: End date of time period, if known and if not ongoing, in format `yyyy-mm-dd`. Can be a future date.
2062
-
given:
2063
-
type: array
2064
-
maxItems: 5
2065
-
description: |
2066
-
Given names, including any middle names.
2067
-
2068
-
Each name(s) should be a separate item in the list. The first given name may include multiple names, separated by a space.
2069
-
Subsequent names must be broken down into list items. For example, the input `[Jane Marie Anne, Jo Adele]` returns `[Jane Marie Anne, Jo, Adele]`.
2070
-
2071
-
items:
2072
-
type: string
2073
-
maxLength: 35
2074
-
family:
2075
-
type: string
2076
-
maxLength: 35
2077
-
description: Family name (often called Surname).
2078
-
prefix:
2079
-
type: array
2080
-
description: Name prefixes, titles, and prenominals.
2081
-
items:
2082
-
type: string
2083
-
suffix:
2084
-
type: array
2085
-
description: Name suffices and postnominals.
2086
-
items:
2087
-
type: string
2021
+
$ref: "#/components/schemas/PDSName"
2088
2022
birthDate:
2089
-
description: |
2090
-
The date on which the patient was born or is officially deemed to have been born.
2091
-
2092
-
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.
2093
-
type: string
2094
-
format: date
2023
+
$ref: "#/components/schemas/PDSBirthDate"
2095
2024
generalPractitioner:
2096
2025
type: array
2097
2026
description: Patient's nominated primary care provider, each a Reference(Organization | Practitioner | PractitionerRole).
0 commit comments