Source | fhir.r4.ukcore.stu1#1.0.4:null (v4.0.1) |
resourceType | StructureDefinition |
id | UKCore-Patient |
canonical | https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient |
version | 2.2.0 |
status | active |
publisher | HL7 UK |
name | UKCorePatient |
title | UK Core Patient |
date | 2022-08-26 |
description | Defines the UK Core constraints and extensions on the Patient resource for the minimal set of data to query and retrieve an individual’s demographic information. |
copyright | Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html. |
fhirVersion | 4.0.1 |
kind | resource |
abstract | false |
sdTtype | Patient |
derivation | constraint |
base | http://hl7.org/fhir/StructureDefinition/Patient |
Usages |
|
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Patient | Patient | |||
Slices for extension | 0.. | Slice: Unordered, Open by value:url | ||
birthPlace | 0..1 | Address |
The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace |
|
value[x] | The registered place of birth of the patient. | |||
birthSex | 0..1 | code |
The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex ( required ) |
|
cadavericDonor | 0..1 | boolean |
Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor |
|
value[x] | Post-mortem donor status. | |||
contactPreference | 0..1 | (Complex) |
The preferred method of contact, contact times and written communication format given by a Patient or Related Person.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference |
|
deathNotificationStatus | 0..1 | (Complex) |
The patient's death notification status.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus |
|
ethnicCategory | 0..1 | CodeableConcept |
The ethnicity of the subject URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category ( preferred ): A set of codes that define the ethnicity of a person, as specified by the person. |
|
residentialStatus | 0..1 | CodeableConcept |
The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status ( extensible ) |
|
patientInterpreterRequired | 0..1 | boolean |
Whether the patient needs an interpreter
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired |
|
value[x] | Indicator showing whether the patient needs an interpreter | |||
Slices for identifier | Slice: Unordered, Open by value:system | |||
identifier:nhsNumber | ..1 | The patient's NHS number | ||
Slices for extension | 0.. | Slice: Unordered, Open by value:url | ||
nhsNumberVerificationStatus | 0..1 | CodeableConcept |
NHS number verification status
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status ( required ) |
|
system | N | 1.. | Fixed Value: https://fhir.nhs.uk/Id/nhs-number | |
value | N | 1.. | ||
assigner | Reference (UK Core Organization) | |||
telecom | ||||
system | ||||
Slices for extension | 0.. | Slice: Unordered, Open by value:url | ||
otherContactSystem | 0..1 | Coding |
Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System ( extensible ) |
|
birthDate | ||||
Slices for extension | 0.. | Slice: Unordered, Open by value:url | ||
birthTime | 0..1 | dateTime |
Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime |
|
value[x] | Time of day of birth. | |||
address | ||||
Slices for extension | 0.. | Slice: Unordered, Open by value:url | ||
addressKey | 0..* | (Complex) |
A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey |
|
maritalStatus |
Binding:
UK Core Person Marital Status Code
( extensible
): An indicator to identify the legal marital status of a person |
|||
contact | ||||
Slices for extension | 0.. | Slice: Unordered, Open by value:url | ||
contactRank | 0..1 | positiveInt |
Preferred ranking or order of contact applied to a contact on a patient's contact list
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank |
|
copyCorrespondenceIndicator | 0..1 | boolean |
Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator |
|
relationship | Binding: UK Core Person Relationship Type ( extensible ) | |||
telecom | ||||
system | ||||
Slices for extension | 0.. | Slice: Unordered, Open by value:url | ||
otherContactSystem | 0..1 | Coding |
Other contact system
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System ( extensible ) |
|
organization | Reference (UK Core Organization) | |||
identifier | ||||
assigner | Reference (UK Core Organization) | |||
communication | ||||
Slices for extension | 0.. | Slice: Unordered, Open by value:url | ||
proficiency | 0..1 | (Complex) |
Proficiency level of the communication
URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency |
|
Slices for extension | 0.. | Slice: Unordered, Open by value:url | ||
extension:level | 0.. | |||
value[x] | The proficiency level for the communication | |||
extension:type | 0.. | |||
value[x] | The proficiency type for the communication | |||
language |
A ValueSet that identifies the language used by a person. Binding: UK Core Human Language ( extensible ): A ValueSet that identifies the language used by a person. |
|||
generalPractitioner | Reference (UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | |||
identifier | ||||
assigner | Reference (UK Core Organization) | |||
managingOrganization | Reference (UK Core Organization) | |||
identifier | ||||
assigner | Reference (UK Core Organization) | |||
link | ||||
other | Reference (UK Core Patient | RelatedPerson ) | |||
identifier | ||||
assigner | Reference (UK Core Organization) | |||
Documentation for this format |
Produced 08 Sep 2023