|
object
|
|
|
resourceType
string
|
Default: Patient
|
|
id
string
required
|
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. Pattern: ^\d{10}$
Example: 9000000009
|
|
identifier
array
|
Identifier and system of identification used for this Patient. |
|
object
|
Max items: 1
|
|
system
string
url
|
System identifier belongs to. Default: https://fhir.nhs.uk/Id/nhs-number
|
|
value
string
required
|
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. Pattern: ^\d{10}$
Example: 9000000009
|
|
extension
array
|
|
|
object
|
Status indicating if NHS number is present and verified. |
|
url
string
|
URL of the extension definition. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
|
|
valueCodeableConcept
object
|
NHS Number Verification Status Indicator. |
|
coding
array
required
|
Max items: 1
Min items: 1
|
|
object
|
|
|
system
string
|
URI of the coding system specification. Default: https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatus
|
|
version
string
|
Version of the coding system in use. Example: 1.0.0
|
|
code
string
required
|
Symbol in syntax defined by the system. Example: 01
|
|
display
string
|
Representation defined by the system. Example: Number present and verified
|
|
meta
object
|
Metadata about this resource. |
|
versionId
string
|
The NHS Digital assigned version of the patient resource. Example: 2
|
|
security
array
|
The level of security on the patients record, which affects which fields are populated on retrieval. The possible responses are:
- U - unrestricted. All available data is returned.
- R - restricted. Any sensitive data around the patient's location, so
address, generalPractitioner and telecom, are removed from the response.
- V - very restricted. All patient data is removed from the response apart from
id, identifier and meta fields. The gender field returns unknown regardless of actual gender.
- REDACTED - redacted. The patient record has been marked as invalid, so the data should not be used. This code is never returned; you receive a 404, and appropriate error response, if an invalidated patient retrieval is attempted.
Max items: 1
|
|
object
|
|
|
system
string
|
URI of the value set specification. Example: http://terminology.hl7.org/CodeSystem/v3-Confidentiality
|
|
code
string
|
Code defined by the system value set. Allowed values: U, R, V, REDACTED
|
|
display
string
|
Representation defined by the system. Allowed values: unrestricted, restricted, very restricted, redacted
|
|
name
array
|
List of names associated with the patient.
When a patient tagged as very restricted is retrieved, all names are removed from the response. Min items: 1
|
|
object
|
|
|
id
string
|
Unique object identifier for this name. Example: 123
|
|
use
string
required
|
How this name should be used.
- usual - Known as, conventional or the one patient normally uses. A patient always has a usual name.
- temp - An alias or temporary name. This may also be used for temporary names assigned at birth or in emergency situations.
- nickname - A name that the patient prefers to be addressed by, but is not part of their usual name.
- old - This name is no longer in use (or was never correct, but retained for records).
- 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.
The following use codes are included in the name-use value set, but should not be used and is not be returned as part of a retrieval.
- official - The formal name as registered in an official (government) registry, but which name might not be commonly used. May be called "legal name".
- anonymous - Anonymous assigned name, alias, or pseudonym (used to protect a person's identity for privacy reasons).
Allowed values: usual, temp, nickname, old, maiden
|
|
period
object
|
Business effective period when name was, is, or will be in use. |
|
start
string
date
required
|
Start date of time period, if known, in format yyyy-mm-dd. Can be a future date. Example: 2020-01-01
|
|
end
string
date
|
End date of time period, if known and if not ongoing, in format yyyy-mm-dd. Can be a future date. Example: 2021-12-31
|
|
given
array
|
Given names, including any middle names.
Each name(s) should be a separate item in the list. The first given name may include multiple names, separated by a space.
Subsequent names must be broken down into list items. For example, the input [Jane Marie Anne, Jo Adele] returns [Jane Marie Anne, Jo, Adele]. Max items: 5
Example: ["Jane Marie Anne","Jo","Adele"]
|
|
string
|
Max length: 35
Example: Jane
|
|
family
string
required
|
Family name (often called Surname). Max length: 35
Example: Smith
|
|
prefix
array
|
Name prefixes, titles, and prenominals. Example: ["Mrs"]
|
|
string
|
Example: Mrs
|
|
suffix
array
|
Name suffices and postnominals. Example: ["MBE","PhD"]
|
|
string
|
Example: MBE
|
|
gender
string
|
Classification of the gender of a patient. The classification is phenotypical rather than genotypical, i.e. it does not provide codes for medical or scientific purposes.
It is the administrative gender that the patient wishes to be known as. In some cases, this may not be the same as the patient’s registered birth gender, or their current clinical gender. Allowed values: male, female, other, unknown
|
|
birthDate
string
date
|
The date on which the patient was born or is officially deemed to have been born.
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.
When a patient tagged as very restricted is retrieved, birth date is removed from the response. Example: 2010-10-22
|
|
multipleBirthInteger
integer
|
The order in which the patient was born, with 1 indicating the first or only birth in the sequence, 2 indicating the second birth in the sequence, 3 indicating the third, and so on up to 7.
There are two other valid values; 8 meaning Not applicable and 9 meaning Not known. Maximum: 9
(inclusive)
Minimum: 1
(inclusive)
Example: 1
|
|
deceasedDateTime
string
date-time
|
The date and time on which a person died or is officially deemed to have died, if applicable and known.
It is a datetime in the format yyyy-mm-ddTHH:MM:SS+HH:MM or yyyy-mm-dd. Due to data quality issues on a small number of patients yyyy-mm and yyyy format may also be returned.
When a patient tagged as very restricted is retrieved, death date is removed from the response. Pattern: ^([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2})$|^([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T\d{2}:\d{2}:\d{2})$|^([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])T\d{2}:\d{2}:\d{2}\+\d{2}:\d{2})$|^([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))$
Example: 2010-10-22T00:00Z
|
|
address
array
|
List of addresses associated with the patient.
These are fully populated on a retrieval or a successful update, only the home address is returned on a search.
When a patient tagged as restricted or very restricted is retrieved, all addresses are removed from the response. |
|
object
|
An address associated with the patient. |
|
id
string
|
Unique system identifier for this address. Example: 456
|
|
period
object
|
Business effective period when name was, is, or will be in use. |
|
start
string
date
required
|
Start date of time period, if known, in format yyyy-mm-dd. Can be a future date. Example: 2020-01-01
|
|
end
string
date
|
End date of time period, if known and if not ongoing, in format yyyy-mm-dd. Can be a future date. Example: 2021-12-31
|
|
use
string
required
|
Purpose of this address:
home - the home address is the patient's normal residence. Home address is also known as usual, main, registered, current or permanent addresstemp - a temporary address is an address used for a set period of time, but where the patient's home, permanent address remains unchangedbilling - an address used for correspondence purposes onlywork - an office address. This can be returned due to legacy data but cannot be added or replaced on update
A patient should have no more than one current temp and/or billing address.
However, historically this was constrained only by the integration requirements and was not enforced so theoretically more than one can exist for a patient when retrieving.
Where multiple instances already exist for the patient it is not expected that local systems should manage those, but should choose the most appropriate one to maintain (e.g. by examining period dates).
A home address is the patient's main residential address and should normally be used for all clinical and demographic purposes, including clinical and appointment correspondence.
However additionally, temp and billing addresses may be provided by a patient when there is a requirement to record an alternative location for the purposes of unbroken care.
When sending correspondence to a patient:
- a present and valid
billing address may take precedence over home and temp addresses. A patient should have only a single current billing address. An address is considered 'valid' according to its period start and end dates.
- if no current
billing address is provided, a temp address may take precedence over the home address, again if it is valid according to its period start and end dates.
- if there is no valid, current
billing and/or temp address, the home address must be used.
Allowed values: home, work, temp, billing
|
|
text
string
|
Where a temp address is provided a descriptor text must be sent.
The list of possible values are:
Second Home - a patient's second homeStudent Accommodation - a patient's place of residence while at universityRespite Care Address - where the patient resides during respite careTemporary Residence Address - where the patient resides for a specific period of timeConvalescence Home - the address for a patient during a period of recoveryMobile Home - the address of a patient's mobile home, parked for a specific period of time, e.g. the address of a caravan parkHoliday Home - the address for a patient during a holiday
A patient can also register temporarily at a GP practice using a temporary address. Temporary GP registration information does not appear on the PDS, but the address used for it may. Allowed values: Second Home, Student Accommodation, Respite Care Address, Temporary Residence Address, Convalescence Home, Mobile Home, Holiday Home
|
|
line
array
|
All lines of the address except the postal code.
Systems must apply the following formatting convention when adding or replacing addresses lines:
- line 1 - premises ID and/or house name, e.g.
Flat 1 or The Old Schoolhouse
- line 2 - house number, dependent thoroughfare name and descriptor (if present), thoroughfare name and descriptor, e.g.
23 Mill Lane
- line 3 - dependent locality/village, locality (if present), e.g.
Boxgrove
- line 4 - post town, e.g.
Leeds
- line 5 - county (if present), e.g.
West Yorkshire
If any of the lines are blank, they are not returned due to FHIR conformance constraints. Max items: 5
Example: ["1 Trevelyan Square","Boar Lane","City Centre","Leeds","West Yorkshire"]
|
|
string
|
|
|
postalCode
string
|
Postal code of the address. Example: LS1 6AE
|
|
extension
array
|
Postal Address File (PAF) key associated with this address formatted as a FHIR extension. Empty if no PAF key for the address is known, or an object specifying the code system of the address key and the value of the address key. |
|
object
|
Unique identifier for an address. |
|
url
string
|
URL of specification of the AddressKey extension. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
|
|
extension
array
|
Specification of address key system and address key value. Contains exactly two items: one describing the code system the Address Key uses, and the other specifying the value of the Address Key. Max items: 2
Min items: 2
|
|
anyOf
|
|
|
object
|
Coding system of the address key. |
|
url
string
required
|
Default: type
|
|
valueCoding
object
required
|
URL of specification of address key format. |
|
system
string
required
|
URL of Code System that describes available Address Key formats. Default: https://fhir.hl7.org.uk/CodeSystem/UKCore-AddressKeyType
|
|
code
string
required
|
Address Key system. Always 'PAF'. Default: PAF
Example: PAF
|
|
object
|
Value of the address key. |
|
url
string
required
|
Default: value
Example: value
|
|
valueString
string
required
|
Address key in PAF format. An 8 digit number including leading zeroes, formatted as a string. Pattern: ^[0-9]{8}$
Max length: 8
Min length: 8
Example: 12345678
|
|
telecom
array
|
List of contact points for the patient; for example, phone numbers or email addresses.
When a patient tagged as restricted or very restricted is retrieved, all contact points are removed from the response. |
|
object
|
A contact point, such as a phone number or email address |
|
id
string
|
Unique object identifier for this contact point. Example: 789
|
|
period
object
|
Business effective period when name was, is, or will be in use. |
|
start
string
date
required
|
Start date of time period, if known, in format yyyy-mm-dd. Can be a future date. Example: 2020-01-01
|
|
end
string
date
|
End date of time period, if known and if not ongoing, in format yyyy-mm-dd. Can be a future date. Example: 2021-12-31
|
|
system
string
required
|
Means of communication, such as phone or email. Allowed values: phone, fax, email, other
|
|
value
string
required
|
Phone number, email address, or other identifier for use with contact system. Example: 01632960587
|
|
use
string
|
Location associated with communication system. Allowed values: home, work, temp, mobile
|
|
extension
array
|
Extension that is returned when the communication type is textphone. The only code returned is textphone, which means Minicom (Textphone).
The system is other when the extension is included. Max items: 1
|
|
object
|
Wrapped object for other contact system details. |
|
url
string
|
Definition of other contact system extension. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
|
|
valueCoding
object
|
URL of specification of other contact systems. |
|
system
string
|
URL of Code System that describes available contact relationships. Default: https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem
|
|
code
string
|
Coded value for the other contact system in place. Example: textphone
|
|
display
string
|
Display-friendly representation of the other contact system code. Example: Minicom (Textphone)
|
|
contact
array
|
A list of patient contacts. Only emergency contacts are returned and only emergency contacts should be added. Any other contacts should be added to the patients Related Person.
Patients designate here any contact number they desire to be used in case of an emergency.
Note, while a patient may also desire to record various related persons telecom details, these do not separately allow for a concept of emergency contact; only ranking. See RelatedPerson endpoint.
When a patient tagged as restricted or very restricted is retrieved, all contacts are removed from the response. |
|
object
|
Schema for a patient contact.
|
|
id
string
|
Example: C123
|
|
period
object
|
Business effective period when name was, is, or will be in use. |
|
start
string
date
required
|
Start date of time period, if known, in format yyyy-mm-dd. Can be a future date. Example: 2020-01-01
|
|
end
string
date
|
End date of time period, if known and if not ongoing, in format yyyy-mm-dd. Can be a future date. Example: 2021-12-31
|
|
relationship
array
required
|
The contact relationship wrapper object that holds the details of the relationship to the patient.
This is only returned when an Emergency Contact number has been set on telecom. The only valid code is C, which means Emergency Contact. Max items: 1
Min items: 1
|
|
object
|
|
|
coding
array
required
|
Exactly one contact relationship. Max items: 1
Min items: 1
|
|
object
|
|
|
system
string
url
|
URL of Code System that describes available contact relationships. Default: http://terminology.hl7.org/CodeSystem/v2-0131
|
|
code
string
required
|
Coded value for contact relationship. Example: C
|
|
display
string
|
Display-friendly representation of the contact relationship code. Example: Emergency Contact
|
|
telecom
array
required
|
List of Telecom objects on the contact only contains system and value. |
|
object
|
A contact point, such as a phone number or email address |
|
id
string
|
Unique object identifier for this contact point. Example: 789
|
|
period
object
|
Business effective period when name was, is, or will be in use. |
|
start
string
date
required
|
Start date of time period, if known, in format yyyy-mm-dd. Can be a future date. Example: 2020-01-01
|
|
end
string
date
|
End date of time period, if known and if not ongoing, in format yyyy-mm-dd. Can be a future date. Example: 2021-12-31
|
|
system
string
required
|
Means of communication, such as phone or email. Allowed values: phone, fax, email, other
|
|
value
string
required
|
Phone number, email address, or other identifier for use with contact system. Example: 01632960587
|
|
use
string
|
Location associated with communication system. Allowed values: home, work, temp, mobile
|
|
extension
array
|
Extension that is returned when the communication type is textphone. The only code returned is textphone, which means Minicom (Textphone).
The system is other when the extension is included. Max items: 1
|
|
object
|
Wrapped object for other contact system details. |
|
url
string
|
Definition of other contact system extension. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
|
|
valueCoding
object
|
URL of specification of other contact systems. |
|
system
string
|
URL of Code System that describes available contact relationships. Default: https://fhir.hl7.org.uk/CodeSystem/UKCore-OtherContactSystem
|
|
code
string
|
Coded value for the other contact system in place. Example: textphone
|
|
display
string
|
Display-friendly representation of the other contact system code. Example: Minicom (Textphone)
|
|
generalPractitioner
array
|
General Practice (not practitioner) with which the patient is, or was, registered. Always contains zero or one general practitioner object.
When a patient tagged as restricted or very restricted is retrieved, the General Practice is removed from the response. Max items: 1
|
|
object
|
General practice (not practitioner) with which the patient is or was registered. |
|
id
string
|
Object identifier (OID) specific to the returned details - this should be return exactly the same in any update. Example: 254406A3
|
|
type
string
|
Type of Reference being returned. Example: Organization
|
|
identifier
object
required
|
Identifier and system of identification used for this Organisation. |
|
system
string
|
URL for the Organisation Data Service - who are responsible for publishing codes that identify organisations and individuals across health and social care. Example: https://fhir.nhs.uk/Id/ods-organization-code
|
|
value
string
required
|
Pattern: ^[0-9A-Z]+$
Example: Y12345
|
|
period
object
|
Business effective period when name was, is, or will be in use. |
|
start
string
date
required
|
Start date of time period, if known, in format yyyy-mm-dd. Can be a future date. Example: 2020-01-01
|
|
end
string
date
|
End date of time period, if known and if not ongoing, in format yyyy-mm-dd. Can be a future date. Example: 2021-12-31
|
|
managingOrganization
object
|
The managing organization of a de-registered patient. |
|
type
string
|
Type of Reference being returned. Example: Organization
|
|
identifier
object
required
|
Identifier and system of identification used for this Organisation. |
|
system
string
|
URL for the Organisation Data Service - who are responsible for publishing codes that identify organisations and individuals across health and social care. Example: https://fhir.nhs.uk/Id/ods-organization-code
|
|
value
string
required
|
Pattern: ^[0-9A-Z]+$
Example: Y12345
|
|
period
object
|
Business effective period when name was, is, or will be in use. |
|
start
string
date
required
|
Start date of time period, if known, in format yyyy-mm-dd. Can be a future date. Example: 2020-01-01
|
|
end
string
date
|
End date of time period, if known and if not ongoing, in format yyyy-mm-dd. Can be a future date. Example: 2021-12-31
|
|
extension
array
|
Wrapper array for the patient's pharmacies, death notification status, communication details, contact preferences and place of birth; these are all FHIR extensions.
Always contains zero or one of each pharmacy object, zero or one death notification status object, zero or one communication details object, zero or one contact preference and zero or one place of birth object.
When a patient tagged as restricted or very restricted is retrieved, the pharmacy and birth place extensions are removed from the response. |
|
anyOf
|
|
|
object
|
Wrapper object for the patient's nominated pharmacy. This will only be populated on a retrieval and not a search. |
|
url
string
required
|
URL of specification of UKCore-NominatedPharmacy FHIR extension. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NominatedPharmacy
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NominatedPharmacy
|
|
valueReference
object
required
|
Reference to a pharmacy Organization resource. |
|
identifier
object
required
|
Wrapper object for the patient's nominated pharmacy organisation code. |
|
system
string
|
URL for the FHIR code system for the ODS organisation code. Default: https://fhir.nhs.uk/Id/ods-organization-code
|
|
value
string
required
|
Pattern: ^[A-Za-z0-9]{3,10}$
Example: Y12345
|
|
object
|
Wrapper object for the patient's dispensing doctor. This will only be populated on a retrieval and not a search. |
|
url
string
required
|
URL of specification of UKCore-DispensingDoctor FHIR extension. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PreferredDispenserOrganization
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-PreferredDispenserOrganization
|
|
valueReference
object
required
|
Reference to a GP practice pharmacy Organization resource. |
|
identifier
object
required
|
Wrapper object for the patient's dispensing doctor organisation code. |
|
system
string
|
URL for the FHIR code system for the ODS organisation code. Default: https://fhir.nhs.uk/Id/ods-organization-code
|
|
value
string
required
|
Pattern: ^[A-Za-z0-9]{3,10}$
Example: Y23456
|
|
object
|
Wrapper object for the patient's medical appliance supplier. This will only be populated on a retrieval and not a search. |
|
url
string
required
|
URL of specification of UKCore-MedicalApplianceSupplier FHIR extension. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicalApplianceSupplier
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-MedicalApplianceSupplier
|
|
valueReference
object
required
|
Reference to medical appliance supplier pharmacy Organization resource. |
|
identifier
object
required
|
Wrapper object for the patient's medical appliance supplier organisation code. |
|
system
string
|
URL for the FHIR code system for the ODS organisation code. Default: https://fhir.nhs.uk/Id/ods-organization-code
|
|
value
string
required
|
Pattern: ^[A-Za-z0-9]{3,10}$
Example: Y34567
|
|
object
|
Wrapper object for death notification details. |
|
url
string
required
|
Definition of death notification extension. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
|
|
extension
array
required
|
Array containing exactly one death notification status code object and exactly one effective date object. Max items: 2
Min items: 1
|
|
oneOf
|
|
|
object
|
Wrapper object for death notification status code. |
|
url
string
required
|
Key of this object. Always deathNotificationStatus. Allowed values: deathNotificationStatus
Default: deathNotificationStatus
|
|
valueCodeableConcept
object
required
|
Death Notification Status. |
|
coding
array
|
Max items: 1
Min items: 1
|
|
object
|
|
|
system
string
required
|
URI of the coding system specification. Example: https://fhir.hl7.org.uk/CodeSystem/UKCore-DeathNotificationStatus
|
|
version
string
|
Version of the coding system in use. Example: 1.0.0
|
|
code
string
required
|
Symbol, in syntax, defined by the system:
1 - Informal - death notice received via an update from a local NHS Organisation such as GP or Trust2 - Formal - death notice received from Registrar of Deaths. Only these endpoints are allowed to add a Formal death:
- National Back Office using the Demographic Spine Application (DSA)
- Office of National Statistics (ONS)
- Maternity sites
U - Removed. This is a possible response, but it cannot be used on an update because Spine will reject it Allowed values: 1, 2, U
|
|
display
string
|
Representation defined by the system. Allowed values: Informal - death notice received via an update from a local NHS Organisation such as GP or Trust, Formal - death notice received from Registrar of Deaths, Removed
|
|
object
|
Wrapper object for death notification effective date. |
|
url
string
required
|
Key of this object. Always systemEffectiveDate. Allowed values: systemEffectiveDate
Default: systemEffectiveDate
|
|
valueDateTime
string
date-time
required
|
Date and time at which death notification status took effect. Example: 2010-10-22T00:00Z
|
|
object
|
Wrapper object for communication details. This will only be populated on a retrieval and not a search. |
|
url
string
required
|
Definition of communication extension. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSCommunication
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSCommunication
|
|
extension
array
required
|
Definition of communication extension, The array must have two items, a valueCodeableConcept for the language and a valueBoolean for if an interpreter is required. Max items: 2
Min items: 1
|
|
anyOf
|
|
|
object
|
Wrapper object for communication language. |
|
url
string
required
|
Key of this object. Always language. Allowed values: language
Default: language
|
|
valueCodeableConcept
object
required
|
|
|
coding
array
required
|
Exactly one language code. Max items: 1
Min items: 1
|
|
object
|
|
|
system
string
|
URL of the Language Code System. Always uses the 'UKCore-HumanLanguage' Code System. Example: https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage
|
|
version
string
|
Version of the language code system. Example: 1.0.0
|
|
code
string
required
|
Language code based on ISO 639-1 standard plus extensions for braille, makaton and sign languages, which are:
q1 - Brailleq2 - American Sign Languageq3 - Australian Sign Languageq4 - British Sign Languageq5 - Makaton
All valid codes combined can be found at https://fhir.hl7.org.uk/CodeSystem/UKCore-HumanLanguage. Example: fr
|
|
display
string
|
Display-friendly representation of the language code (such as English). If there is a language code with no defined mapping, Unknown will be returned. Example: French
|
|
object
|
Wrapper object for whether an interpreter is required. |
|
url
string
required
|
Key of this object. Always interpreterRequired. Allowed values: interpreterRequired
Default: interpreterRequired
|
|
valueBoolean
boolean
required
|
Whether an interpreter is required. Example: true
|
|
object
|
Wrapper object for preferred contact details; the written communication format, preferred contact time and method. This will only be populated on a retrieval and not a search. |
|
url
string
required
|
Definition of the contact preference extension. Allowed values: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
Default: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
|
|
extension
array
required
|
Wrapper array containing zero or one preferred contact method, zero or one preferred written communication format; and zero or one preferred contact time. Max items: 3
|
|
oneOf
|
|
|
object
|
Wrapper object for preferred written communication format. |
|
url
string
required
|
Key of this object. Always PreferredWrittenCommunicationFormat. Default: PreferredWrittenCommunicationFormat
|
|
valueCodeableConcept
object
required
|
Preferred Written Communication Format. |
|
coding
array
required
|
Max items: 1
Min items: 1
|
|
object
|
|
|
system
string
url
|
Definition of the preferred written communication extension. Allowed values: https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat
Default: https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredWrittenCommunicationFormat
|
|
code
string
required
|
A code to identify the preferred written communication format of a patient, contact or related person.
- 11 - Large print
- 12 - Braille
- 13 - Audio tape
Example: 12
|
|
display
string
|
Display-friendly representation of the preferred written communication format code. Example: Braille
|
|
object
|
Wrapper object for preferred contact method. |
|
url
string
required
|
Key of this object. Always PreferredContactMethod. Allowed values: PreferredContactMethod
Default: PreferredContactMethod
|
|
valueCodeableConcept
object
required
|
Preferred Contact Method. |
|
coding
array
required
|
Max items: 1
Min items: 1
|
|
object
|
|
|
system
string
url
|
Definition of the preferred contact method extension. Allowed values: https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod
Default: https://fhir.hl7.org.uk/CodeSystem/UKCore-PreferredContactMethod
|
|
code
string
required
|
A code to identify to identify the preferred contact method of a patient, contact or related person.
- 1 - Letter
- 2 - Visit
- 3 - Telephone
- 4 - E-mail
- 5 - Minicom (Textphone)
- 6 - Telephone contact via proxy
- 7 - Sign language
- 8 - No Telephone contact
Example: 1
|
|
display
string
|
Display-friendly representation of the preferred contact method code. Example: Letter
|
|
object
|
Wrapper object for preferred contact times. |
|
url
string
required
|
Key of this object. Always PreferredContactTimes. Allowed values: PreferredContactTimes
Default: PreferredContactTimes
|
|
valueString
string
required
|
A free-text description about the preferred contact times. Maximum: 40
(inclusive)
Example: Not after 7pm
|
|
object
|
Wrapper object for place of birth details. This will not be returned on a restricted patient. |
|
url
string
required
|
Definition of place of birth extension. Allowed values: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
Default: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
|
|
valueAddress
object
required
|
|
|
city
string
|
Example: Manchester
|
|
district
string
|
County or metropolitan district of birth. Example: Greater Manchester
|
|
country
string
|
A coded value for a patient's country of birth.
From ISO 3166-1 plus codes from the UK Internal Code list which do not have entries in ISO 3166-1.
UK Internal Codes:
1 - England2 - Scotland3 - Wales4 - Northern Ireland7 - Sark9 - Alderney10 - Channel Islands Example: GBR
|
