Interweave Implementation Guide
0.1.0 - ci-build United Kingdom flag

Interweave Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the STU3 profiles here.

Resource Profile: UK Core Patient

Official URL: https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient Version: 2.6.0
Active as of 2024-03-28 Computable Name: UKCorePatient

Copyright/Legal: 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.

This profile defines the UK constraints and extensions on the International FHIR resource Patient.

This profile allows exchange of demographics and other administrative information about an individual receiving care or other health-related services.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 (Complex) The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... value[x] 1..1 Address The registered place of birth of the patient.
.... birthSex 0..1 CodeableConcept The patient's phenotypic sex at birth.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex
Binding: https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex (required)
.... cadavericDonor 0..1 (Complex) Post-mortem donor status.
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
..... value[x] 1..1 boolean 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 (extensible): 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 (Complex) Indicator showing whether the patient needs an interpreter.
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
..... value[x] 1..1 boolean Indicator showing whether the patient needs an interpreter
.... nhsNumberUnavailableReason 0..1 CodeableConcept Reason why this Patient does not include an NHS Number identifier.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason
Binding: UK Core NHS Number Unavailable Reason (extensible)
... Slices for identifier S 0..* Identifier An identifier for this patient.
Slice: Unordered, Open by value:system
.... identifier:nhsNumber 0..1 Identifier The patient's NHS number.
..... Slices for extension Content/Rules for all slices
...... 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 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value 1..1 string The value that is unique
... active S 0..1 boolean Whether this patient's record is in active use.
... telecom S 0..* ContactPoint A contact detail for the individual.
.... system
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
... gender S 0..1 code The gender that the patient is considered to have for administration and record keeping purposes.
... birthDate S 0..1 date The date of birth for the individual.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... birthTime 0..1 (Complex) The time of day that the patient was born. This SHOULD be included when the birth time is relevant.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... value[x] 1..1 dateTime Time of day of birth.
... address S 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... addressKey 0..* (Complex) A patient's address key and type
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person

... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... contactRank 0..1 positiveInt The 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 Indicates that a must be copied in to all related correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
.... relationship 0..* CodeableConcept The kind of relationship
Binding: UK Core Person Relationship Type (extensible)
.... telecom
..... system
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
... communication
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... proficiency 0..1 (Complex) The patient's proficiency level of the communication method.
URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
...... Slices for extension Content/Rules for all slices
....... extension:level 0..1 Extension Extension
........ value[x] 1..1 Coding The proficiency level for the communication
....... extension:type 0..* Extension Extension
........ value[x] 1..1 Coding The proficiency type for the communication
.... language 1..1 CodeableConcept A ValueSet that identifies the language used by a person.
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.

... managingOrganization S 0..1 Reference(Organization) Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.maritalStatusextensibleUKCorePersonMaritalStatusCode
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode
from this IG
Patient.contact.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 (Complex) The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 Address The registered place of birth of the patient.
.... birthSex 0..1 CodeableConcept The patient's phenotypic sex at birth.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex
Binding: https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex (required)
.... cadavericDonor 0..1 (Complex) Post-mortem donor status.
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
..... value[x] 1..1 boolean 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 (extensible): 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 (Complex) Indicator showing whether the patient needs an interpreter.
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
..... value[x] 1..1 boolean Indicator showing whether the patient needs an interpreter
.... nhsNumberUnavailableReason 0..1 CodeableConcept Reason why this Patient does not include an NHS Number identifier.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason
Binding: UK Core NHS Number Unavailable Reason (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:nhsNumber Σ 0..1 Identifier The patient's NHS number.
..... Slices for extension Content/Rules for all slices
...... 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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use.
... name SΣ 0..* HumanName A name associated with the patient.
... telecom SΣ 0..* ContactPoint A contact detail for the individual.
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... gender SΣ 0..1 code The gender that the patient is considered to have for administration and record keeping purposes.
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date of birth for the individual.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... birthTime 0..1 (Complex) The time of day that the patient was born. This SHOULD be included when the birth time is relevant.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
...... value[x] 1..1 dateTime Time of day of birth.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... addressKey 0..* (Complex) A patient's address key and type
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person

... managingOrganization SΣ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:nhsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleUKCorePersonMaritalStatusCode
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode
from this IG
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 (Complex) The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 Address The registered place of birth of the patient.
.... birthSex 0..1 CodeableConcept The patient's phenotypic sex at birth.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex
Binding: https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex (required)
.... cadavericDonor 0..1 (Complex) Post-mortem donor status.
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
..... value[x] 1..1 boolean 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 (extensible): 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 (Complex) Indicator showing whether the patient needs an interpreter.
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
..... value[x] 1..1 boolean Indicator showing whether the patient needs an interpreter
.... nhsNumberUnavailableReason 0..1 CodeableConcept Reason why this Patient does not include an NHS Number identifier.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason
Binding: UK Core NHS Number Unavailable Reason (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier An identifier for this patient.
Slice: Unordered, Open by value:system
.... identifier:nhsNumber Σ 0..1 Identifier The patient's NHS number.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use.
... name SΣ 0..* HumanName A name associated with the patient.
... telecom SΣ 0..* ContactPoint A contact detail for the individual.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value 0..1 string Primitive value for code
.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code The gender that the patient is considered to have for administration and record keeping purposes.
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date of birth for the individual.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... birthTime 0..1 (Complex) The time of day that the patient was born. This SHOULD be included when the birth time is relevant.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
...... value[x] 1..1 dateTime Time of day of birth.
.... value 0..1 date Primitive value for date
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
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
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... contactRank 0..1 positiveInt The 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 Indicates that a must be copied in to all related correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: UK Core Person Relationship Type (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
...... value 0..1 string Primitive value for code
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... proficiency 0..1 (Complex) The patient's proficiency level of the communication method.
URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:level 0..1 Extension Extension
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "level"
........ value[x] 1..1 Coding The proficiency level for the communication
Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication.

....... extension:type 0..* Extension Extension
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "type"
........ value[x] 1..1 Coding The proficiency type for the communication
Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.

...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-proficiency"
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept A ValueSet that identifies the language used by a person.
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.

.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization SΣ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier:nhsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:nhsNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleUKCorePersonMaritalStatusCode
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode
from this IG
Patient.contact.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.extension:proficiency.extension:level.value[x]preferredLanguageAbilityProficiency
http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
Patient.communication.extension:proficiency.extension:type.value[x]preferredLanguageAbilityMode
http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

Differential View

This structure is derived from Patient

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient Patient
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 (Complex) The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... value[x] 1..1 Address The registered place of birth of the patient.
.... birthSex 0..1 CodeableConcept The patient's phenotypic sex at birth.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex
Binding: https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex (required)
.... cadavericDonor 0..1 (Complex) Post-mortem donor status.
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
..... value[x] 1..1 boolean 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 (extensible): 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 (Complex) Indicator showing whether the patient needs an interpreter.
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
..... value[x] 1..1 boolean Indicator showing whether the patient needs an interpreter
.... nhsNumberUnavailableReason 0..1 CodeableConcept Reason why this Patient does not include an NHS Number identifier.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason
Binding: UK Core NHS Number Unavailable Reason (extensible)
... Slices for identifier S 0..* Identifier An identifier for this patient.
Slice: Unordered, Open by value:system
.... identifier:nhsNumber 0..1 Identifier The patient's NHS number.
..... Slices for extension Content/Rules for all slices
...... 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 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value 1..1 string The value that is unique
... active S 0..1 boolean Whether this patient's record is in active use.
... telecom S 0..* ContactPoint A contact detail for the individual.
.... system
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
... gender S 0..1 code The gender that the patient is considered to have for administration and record keeping purposes.
... birthDate S 0..1 date The date of birth for the individual.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... birthTime 0..1 (Complex) The time of day that the patient was born. This SHOULD be included when the birth time is relevant.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... value[x] 1..1 dateTime Time of day of birth.
... address S 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... addressKey 0..* (Complex) A patient's address key and type
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person

... contact
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... contactRank 0..1 positiveInt The 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 Indicates that a must be copied in to all related correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
.... relationship 0..* CodeableConcept The kind of relationship
Binding: UK Core Person Relationship Type (extensible)
.... telecom
..... system
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
... communication
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... proficiency 0..1 (Complex) The patient's proficiency level of the communication method.
URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
...... Slices for extension Content/Rules for all slices
....... extension:level 0..1 Extension Extension
........ value[x] 1..1 Coding The proficiency level for the communication
....... extension:type 0..* Extension Extension
........ value[x] 1..1 Coding The proficiency type for the communication
.... language 1..1 CodeableConcept A ValueSet that identifies the language used by a person.
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.

... managingOrganization S 0..1 Reference(Organization) Organization that is the custodian of the patient record

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Patient.maritalStatusextensibleUKCorePersonMaritalStatusCode
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode
from this IG
Patient.contact.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 (Complex) The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 Address The registered place of birth of the patient.
.... birthSex 0..1 CodeableConcept The patient's phenotypic sex at birth.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex
Binding: https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex (required)
.... cadavericDonor 0..1 (Complex) Post-mortem donor status.
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
..... value[x] 1..1 boolean 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 (extensible): 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 (Complex) Indicator showing whether the patient needs an interpreter.
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
..... value[x] 1..1 boolean Indicator showing whether the patient needs an interpreter
.... nhsNumberUnavailableReason 0..1 CodeableConcept Reason why this Patient does not include an NHS Number identifier.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason
Binding: UK Core NHS Number Unavailable Reason (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... identifier:nhsNumber Σ 0..1 Identifier The patient's NHS number.
..... Slices for extension Content/Rules for all slices
...... 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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value Σ 1..1 string The value that is unique
Example General: 123456
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use.
... name SΣ 0..* HumanName A name associated with the patient.
... telecom SΣ 0..* ContactPoint A contact detail for the individual.
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

... gender SΣ 0..1 code The gender that the patient is considered to have for administration and record keeping purposes.
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date of birth for the individual.
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... birthTime 0..1 (Complex) The time of day that the patient was born. This SHOULD be included when the birth time is relevant.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
...... value[x] 1..1 dateTime Time of day of birth.
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... Slices for extension Content/Rules for all slices
..... addressKey 0..* (Complex) A patient's address key and type
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person

... managingOrganization SΣ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.identifier:nhsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleUKCorePersonMaritalStatusCode
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode
from this IG
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Patient 0..* Patient Information about an individual or animal receiving health care services
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... birthPlace 0..1 (Complex) The registered place of birth of the patient.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
..... value[x] 1..1 Address The registered place of birth of the patient.
.... birthSex 0..1 CodeableConcept The patient's phenotypic sex at birth.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex
Binding: https://fhir.hl7.org.uk/ValueSet/UKCore-BirthSex (required)
.... cadavericDonor 0..1 (Complex) Post-mortem donor status.
URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
..... value[x] 1..1 boolean 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 (extensible): 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 (Complex) Indicator showing whether the patient needs an interpreter.
URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
..... id 0..1 id Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
..... value[x] 1..1 boolean Indicator showing whether the patient needs an interpreter
.... nhsNumberUnavailableReason 0..1 CodeableConcept Reason why this Patient does not include an NHS Number identifier.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason
Binding: UK Core NHS Number Unavailable Reason (extensible)
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier SΣ 0..* Identifier An identifier for this patient.
Slice: Unordered, Open by value:system
.... identifier:nhsNumber Σ 0..1 Identifier The patient's NHS number.
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 0..* Extension Additional content defined by implementations
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)
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

..... system Σ 1..1 uri The namespace for the identifier value
Fixed Value: https://fhir.nhs.uk/Id/nhs-number
..... value Σ 1..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... active ?!SΣ 0..1 boolean Whether this patient's record is in active use.
... name SΣ 0..* HumanName A name associated with the patient.
... telecom SΣ 0..* ContactPoint A contact detail for the individual.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

..... id 0..1 string xml:id (or equivalent in JSON)
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
..... value 0..1 string Primitive value for code
.... value Σ 0..1 string The actual contact point details
.... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

.... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
.... period Σ 0..1 Period Time period when the contact point was/is in use
... gender SΣ 0..1 code The gender that the patient is considered to have for administration and record keeping purposes.
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

... birthDate SΣ 0..1 date The date of birth for the individual.
.... id 0..1 string xml:id (or equivalent in JSON)
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... birthTime 0..1 (Complex) The time of day that the patient was born. This SHOULD be included when the birth time is relevant.
URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
...... id 0..1 id Unique id for inter-element referencing
...... extension 0..0
...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-birthTime"
...... value[x] 1..1 dateTime Time of day of birth.
.... value 0..1 date Primitive value for date
... deceased[x] ?!Σ 0..1 Indicates if the individual is deceased or not
.... deceasedBoolean boolean
.... deceasedDateTime dateTime
... address SΣ 0..* Address An address for the individual
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Additional content defined by implementations
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
.... use ?!Σ 0..1 code home | work | temp | old | billing - purpose of this address
Binding: AddressUse (required): The use of an address.


Example General: home
.... type Σ 0..1 code postal | physical | both
Binding: AddressType (required): The type of an address (physical / postal).


Example General: both
.... text Σ 0..1 string Text representation of the address
Example General: 137 Nowhere Street, Erewhon 9132
.... line Σ 0..* string Street name, number, direction & P.O. Box etc.
This repeating element order: The order in which lines should appear in an address label
Example General: 137 Nowhere Street
.... city Σ 0..1 string Name of city, town etc.
Example General: Erewhon
.... district Σ 0..1 string District name (aka county)
Example General: Madison
.... state Σ 0..1 string Sub-unit of country (abbreviations ok)
.... postalCode Σ 0..1 string Postal code for area
Example General: 9132
.... country Σ 0..1 string Country (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ 0..1 Period Time period when address was/is in use
Example General: {"start":"2010-03-23","end":"2010-07-01"}
... maritalStatus 0..1 CodeableConcept Marital (civil) status of a patient
Binding: UK Core Person Marital Status Code (extensible): An indicator to identify the legal marital status of a person

... multipleBirth[x] 0..1 Whether patient is part of a multiple birth
.... multipleBirthBoolean boolean
.... multipleBirthInteger integer
... photo 0..* Attachment Image of the patient
... contact C 0..* BackboneElement A contact party (e.g. guardian, partner, friend) for the patient
pat-1: SHALL at least contain a contact's details or a reference to an organization
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... contactRank 0..1 positiveInt The 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 Indicates that a must be copied in to all related correspondence.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... relationship 0..* CodeableConcept The kind of relationship
Binding: UK Core Person Relationship Type (extensible)
.... name 0..1 HumanName A name associated with the contact person
.... telecom 0..* ContactPoint A contact detail for the person
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system ΣC 0..1 code phone | fax | email | pager | url | sms | other
Binding: ContactPointSystem (required): Telecommunications form for contact point.

...... id 0..1 string xml:id (or equivalent in JSON)
...... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
....... otherContactSystem 0..1 CodeableConcept Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`.
URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem
Binding: UK Core Other Contact System (extensible)
...... value 0..1 string Primitive value for code
..... value Σ 0..1 string The actual contact point details
..... use ?!Σ 0..1 code home | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required): Use of contact point.

..... rank Σ 0..1 positiveInt Specify preferred order of use (1 = highest)
..... period Σ 0..1 Period Time period when the contact point was/is in use
.... address 0..1 Address Address for the contact person
.... gender 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.

.... organization C 0..1 Reference(Organization) Organization that is associated with the contact
.... period 0..1 Period The period during which this contact person or organization is valid to be contacted relating to this patient
... communication 0..* BackboneElement A language which may be used to communicate with the patient about his or her health
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... proficiency 0..1 (Complex) The patient's proficiency level of the communication method.
URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
...... id 0..1 id Unique id for inter-element referencing
...... Slices for extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
....... extension:level 0..1 Extension Extension
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "level"
........ value[x] 1..1 Coding The proficiency level for the communication
Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication.

....... extension:type 0..* Extension Extension
........ id 0..1 id Unique id for inter-element referencing
........ extension 0..0
........ url 1..1 uri "type"
........ value[x] 1..1 Coding The proficiency type for the communication
Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.

...... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/patient-proficiency"
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... language 1..1 CodeableConcept A ValueSet that identifies the language used by a person.
Binding: AllLanguages (required): A ValueSet that identifies the language used by a person.

.... preferred 0..1 boolean Language preference indicator
... generalPractitioner 0..* Reference(Organization | Practitioner | PractitionerRole) Patient's nominated primary care provider
... managingOrganization SΣ 0..1 Reference(Organization) Organization that is the custodian of the patient record
... link ?!Σ 0..* BackboneElement Link to another patient resource that concerns the same actual person
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... other Σ 1..1 Reference(Patient | RelatedPerson) The other patient or related person resource that the link refers to
.... type Σ 1..1 code replaced-by | replaces | refer | seealso
Binding: LinkType (required): The type of link between this patient resource and another patient resource.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Patient.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Patient.identifier:nhsNumber.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Patient.identifier:nhsNumber.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Patient.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.address.userequiredAddressUse
http://hl7.org/fhir/ValueSet/address-use|4.0.1
from the FHIR Standard
Patient.address.typerequiredAddressType
http://hl7.org/fhir/ValueSet/address-type|4.0.1
from the FHIR Standard
Patient.maritalStatusextensibleUKCorePersonMaritalStatusCode
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode
from this IG
Patient.contact.relationshipextensibleUKCorePersonRelationshipType
https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
from this IG
Patient.contact.telecom.systemrequiredContactPointSystem
http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1
from the FHIR Standard
Patient.contact.telecom.userequiredContactPointUse
http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1
from the FHIR Standard
Patient.contact.genderrequiredAdministrativeGender
http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1
from the FHIR Standard
Patient.communication.extension:proficiency.extension:level.value[x]preferredLanguageAbilityProficiency
http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
Patient.communication.extension:proficiency.extension:type.value[x]preferredLanguageAbilityMode
http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
Patient.communication.languagerequiredAllLanguages
http://hl7.org/fhir/ValueSet/all-languages
Patient.link.typerequiredLinkType
http://hl7.org/fhir/ValueSet/link-type|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorPatientIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorPatientIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorPatientIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorPatientIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practicePatientA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
pat-1errorPatient.contactSHALL at least contain a contact's details or a reference to an organization
: name.exists() or telecom.exists() or address.exists() or organization.exists()

 

Other representations of profile: CSV, Excel, Schematron