DRAFT Implementation Guide

This is for collaboration and discussion purposes and is subject to change.

North West Genomics Testing Workflow (GTW) - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• XML
• JSON

Resource Profile: Patient

DRAFT Extension of UKCore-Patient which includes constraints from:

• NHS England Genomics Patient use text descriptions only, not the rendered profile.
• HL7 PID segment definitions from NHS England HL7 v2 ADT Message Specification

Usage:

• Refer to this Resource Profile: Diagnostic Report, DocumentReference, Encounter, Observation... Show 3 more, RequestGroup, ServiceRequest and Specimen
• CapabilityStatements using this Resource Profile: CapabilityStatement for MFT Regional Integration Engine for Genomics

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from UKCorePatient

Name	Flags	Card.	Type	Description & Constraints
Patient			UKCorePatient
identifier		1..*	Identifier	An identifier for this patient.
assigner	S	1..1	Reference(Organization)	Assigning Facility
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
system		0..1	uri	The namespace for the identifier value Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
value	S	1..1	string	The value that is unique
Slices for identifier				Content/Rules for all slices
identifier:nhsNumber		0..1	NHSNumber	UK National Health Identifiers
Slices for extension				Content/Rules for all slices
extension:nhsNumberVerificationStatus		0..1	ExtensionUKCoreNHSNumberVerificationStatus	NOT REQUIRED. As all NHS Numbers **MUST** be *01 Number present and verified*, this status will be assumed.
assigner	S	1..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:MedicalRecordNumber		0..*	MedicalRecordNumber	Medical Record Number
name		1..*	HumanName	A name associated with the patient.
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	UKCorePatient	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
birthPlace	N	0..1	(Complex)	The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]	N	1..1	Address	The registered place of birth of the patient. ele-1: All FHIR elements must have a @value or children
birthSex	N	0..1	CodeableConcept	The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
cadavericDonor	N	0..1	(Complex)	Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
value[x]	N	1..1	boolean	Post-mortem donor status. ele-1: All FHIR elements must have a @value or children
contactPreference	N	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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deathNotificationStatus	N	0..1	(Complex)	The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
ethnicCategory	N	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. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
fetalStatus	N	0..1	code	An indicator on the fetal status of a baby. URL: http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus Binding: FetalStatus (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
residentialStatus	N	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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patientInterpreterRequired	N	0..1	(Complex)	Indicator showing whether the patient needs an interpreter. URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	N	1..1	boolean	Indicator showing whether the patient needs an interpreter ele-1: All FHIR elements must have a @value or children
nhsNumberUnavailableReason	N	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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient. Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
assigner	SΣ	1..1	Reference(Organization)	Assigning Facility ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:nhsNumber	Σ	0..1	NHSNumber	UK National Health Identifiers ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
nhsNumberVerificationStatus		0..1	CodeableConcept	NOT REQUIRED. As all NHS Numbers **MUST** be *01 Number present and verified*, this status will be assumed. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://fhir.nhs.uk/Id/nhs-number
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	SΣC	1..1	Reference(Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
identifier:MedicalRecordNumber	SΣ	0..*	MedicalRecordNumber	Medical Record Number ele-1: All FHIR elements must have a @value or children
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use. ele-1: All FHIR elements must have a @value or children
name	SΣ	1..*	HumanName	A name associated with the patient. ele-1: All FHIR elements must have a @value or children
telecom	SΣC	0..*	ContactPoint	A contact detail for the individual. ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided.
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
otherContactSystem	N	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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	0..1	date	The date of birth for the individual. ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
birthTime	N	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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	N	1..1	dateTime	Time of day of birth. ele-1: All FHIR elements must have a @value or children
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
addressKey	N	0..*	(Complex)	A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
managingOrganization	SΣC	0..1	Reference(Organization)	Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.assigner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	UKCorePatient	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
birthPlace	N	0..1	(Complex)	The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]	N	1..1	Address	The registered place of birth of the patient.
birthSex	N	0..1	CodeableConcept	The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required)
cadavericDonor	N	0..1	(Complex)	Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
value[x]	N	1..1	boolean	Post-mortem donor status.
contactPreference	N	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	N	0..1	(Complex)	The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
ethnicCategory	N	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.
fetalStatus	N	0..1	code	An indicator on the fetal status of a baby. URL: http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus Binding: FetalStatus (required)
residentialStatus	N	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	N	0..1	(Complex)	Indicator showing whether the patient needs an interpreter. URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	N	1..1	boolean	Indicator showing whether the patient needs an interpreter
nhsNumberUnavailableReason	N	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	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient. Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	1..1	Reference(Organization)	Assigning Facility
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	Σ	0..1	uri	The namespace for the identifier value Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
value	SΣ	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)
display	Σ	0..1	string	Text alternative for the resource
identifier:nhsNumber	Σ	0..1	NHSNumber	UK National Health Identifiers
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
nhsNumberVerificationStatus		0..1	CodeableConcept	NOT REQUIRED. As all NHS Numbers **MUST** be *01 Number present and verified*, this status will be assumed. 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	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	SΣC	1..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:MedicalRecordNumber	SΣ	0..*	MedicalRecordNumber	Medical Record Number
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use.
name	SΣ	1..*	HumanName	A name associated with the patient.
telecom	SΣC	0..*	ContactPoint	A contact detail for the individual. cpt-2: A system is required if a value is provided.
id		0..1	string	Unique id for inter-element referencing
extension	N	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	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
otherContactSystem	N	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	code	Primitive value for code Max Length:1048576
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	ΣC	0..1	Period	Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end
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	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
birthTime	N	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	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	N	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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
addressKey	N	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	ΣC	0..1	Period	Time period when address was/is in use per-1: If present, start SHALL have a lower value than end 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	C	0..*	Attachment	Image of the patient att-1: If the Attachment has data, it SHALL have a contentType
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactRank	N	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	N	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): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom	C	0..*	ContactPoint	A contact detail for the person cpt-2: A system is required if a value is provided.
id		0..1	string	Unique id for inter-element referencing
extension	N	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	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
otherContactSystem	N	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	code	Primitive value for code Max Length:1048576
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	ΣC	0..1	Period	Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end
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 ref-1: SHALL have a contained resource if a local reference is provided
period	C	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
proficiency	N	0..1	(Complex)	The patient's proficiency level of the communication method. URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:level	N	0..1	Extension	The proficiency level of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"level"
value[x]	N	1..1	Coding	The proficiency level for the communication Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication.
extension:type	N	0..*	Extension	The proficiency type of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"type"
value[x]	N	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. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	C	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided
managingOrganization	SΣC	0..1	Reference(Organization)	Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.identifier.assigner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.assigner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:nhsNumber.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	UKCorePersonMaritalStatusCode https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode
Patient.contact.relationship	extensible	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.extension:proficiency.extension:level.value[x]	preferred	LanguageAbilityProficiency http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
Patient.communication.extension:proficiency.extension:type.value[x]	preferred	LanguageAbilityMode http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
Patient.communication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

This structure is derived from UKCorePatient

Summary

Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• NHS Number (https://hl7.mft.nhs.uk/StructureDefinition/NHSNumber)
• Medical Record Number (https://hl7.mft.nhs.uk/StructureDefinition/MedicalRecordNumber)

Differential View

This structure is derived from UKCorePatient

Name	Flags	Card.	Type	Description & Constraints
Patient			UKCorePatient
identifier		1..*	Identifier	An identifier for this patient.
assigner	S	1..1	Reference(Organization)	Assigning Facility
identifier	S	1..1	Identifier	Logical reference, when literal reference is not known
system		0..1	uri	The namespace for the identifier value Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
value	S	1..1	string	The value that is unique
Slices for identifier				Content/Rules for all slices
identifier:nhsNumber		0..1	NHSNumber	UK National Health Identifiers
Slices for extension				Content/Rules for all slices
extension:nhsNumberVerificationStatus		0..1	ExtensionUKCoreNHSNumberVerificationStatus	NOT REQUIRED. As all NHS Numbers **MUST** be *01 Number present and verified*, this status will be assumed.
assigner	S	1..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:MedicalRecordNumber		0..*	MedicalRecordNumber	Medical Record Number
name		1..*	HumanName	A name associated with the patient.
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	UKCorePatient	Information about an individual or animal receiving health care services dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
birthPlace	N	0..1	(Complex)	The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]	N	1..1	Address	The registered place of birth of the patient. ele-1: All FHIR elements must have a @value or children
birthSex	N	0..1	CodeableConcept	The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
cadavericDonor	N	0..1	(Complex)	Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
value[x]	N	1..1	boolean	Post-mortem donor status. ele-1: All FHIR elements must have a @value or children
contactPreference	N	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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
deathNotificationStatus	N	0..1	(Complex)	The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
ethnicCategory	N	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. ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
fetalStatus	N	0..1	code	An indicator on the fetal status of a baby. URL: http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus Binding: FetalStatus (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
residentialStatus	N	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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patientInterpreterRequired	N	0..1	(Complex)	Indicator showing whether the patient needs an interpreter. URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	N	1..1	boolean	Indicator showing whether the patient needs an interpreter ele-1: All FHIR elements must have a @value or children
nhsNumberUnavailableReason	N	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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient. Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children
identifier:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
assigner	SΣ	1..1	Reference(Organization)	Assigning Facility ele-1: All FHIR elements must have a @value or children
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	0..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
value	SΣ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
identifier:nhsNumber	Σ	0..1	NHSNumber	UK National Health Identifiers ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
nhsNumberVerificationStatus		0..1	CodeableConcept	NOT REQUIRED. As all NHS Numbers **MUST** be *01 Number present and verified*, this status will be assumed. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children
system	Σ	1..1	uri	The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Fixed Value: https://fhir.nhs.uk/Id/nhs-number
value	Σ	1..1	string	The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456
assigner	SΣC	1..1	Reference(Organization)	Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
identifier:MedicalRecordNumber	SΣ	0..*	MedicalRecordNumber	Medical Record Number ele-1: All FHIR elements must have a @value or children
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use. ele-1: All FHIR elements must have a @value or children
name	SΣ	1..*	HumanName	A name associated with the patient. ele-1: All FHIR elements must have a @value or children
telecom	SΣC	0..*	ContactPoint	A contact detail for the individual. ele-1: All FHIR elements must have a @value or children cpt-2: A system is required if a value is provided.
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
otherContactSystem	N	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) ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. ele-1: All FHIR elements must have a @value or children
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. ele-1: All FHIR elements must have a @value or children
birthDate	SΣ	0..1	date	The date of birth for the individual. ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
birthTime	N	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 ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	N	1..1	dateTime	Time of day of birth. ele-1: All FHIR elements must have a @value or children
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not ele-1: All FHIR elements must have a @value or children
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual ele-1: All FHIR elements must have a @value or children
Slices for extension				Content/Rules for all slices
addressKey	N	0..*	(Complex)	A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. ele-1: All FHIR elements must have a @value or children Example General: home
managingOrganization	SΣC	0..1	Reference(Organization)	Organization that is the custodian of the patient record ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.assigner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	UKCorePatient	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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
birthPlace	N	0..1	(Complex)	The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]	N	1..1	Address	The registered place of birth of the patient.
birthSex	N	0..1	CodeableConcept	The patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required)
cadavericDonor	N	0..1	(Complex)	Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
value[x]	N	1..1	boolean	Post-mortem donor status.
contactPreference	N	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	N	0..1	(Complex)	The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
ethnicCategory	N	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.
fetalStatus	N	0..1	code	An indicator on the fetal status of a baby. URL: http://hl7.org/fhir/6.0/StructureDefinition/extension-Patient.fetalStatus Binding: FetalStatus (required)
residentialStatus	N	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	N	0..1	(Complex)	Indicator showing whether the patient needs an interpreter. URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	N	1..1	boolean	Indicator showing whether the patient needs an interpreter
nhsNumberUnavailableReason	N	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	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient. Slice: Unordered, Open by value:system
identifier:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	SΣ	1..1	Reference(Organization)	Assigning Facility
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	SΣ	1..1	Identifier	Logical reference, when literal reference is not known
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
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	Σ	0..1	uri	The namespace for the identifier value Required Pattern: https://fhir.nhs.uk/Id/ods-organization-code
value	SΣ	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)
display	Σ	0..1	string	Text alternative for the resource
identifier:nhsNumber	Σ	0..1	NHSNumber	UK National Health Identifiers
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
nhsNumberVerificationStatus		0..1	CodeableConcept	NOT REQUIRED. As all NHS Numbers **MUST** be *01 Number present and verified*, this status will be assumed. 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	ΣC	0..1	Period	Time period when id is/was valid for use per-1: If present, start SHALL have a lower value than end
assigner	SΣC	1..1	Reference(Organization)	Organization that issued id (may be just text) ref-1: SHALL have a contained resource if a local reference is provided
identifier:MedicalRecordNumber	SΣ	0..*	MedicalRecordNumber	Medical Record Number
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use.
name	SΣ	1..*	HumanName	A name associated with the patient.
telecom	SΣC	0..*	ContactPoint	A contact detail for the individual. cpt-2: A system is required if a value is provided.
id		0..1	string	Unique id for inter-element referencing
extension	N	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	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
otherContactSystem	N	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	code	Primitive value for code Max Length:1048576
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	ΣC	0..1	Period	Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end
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	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
birthTime	N	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	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	N	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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
addressKey	N	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	ΣC	0..1	Period	Time period when address was/is in use per-1: If present, start SHALL have a lower value than end 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	C	0..*	Attachment	Image of the patient att-1: If the Attachment has data, it SHALL have a contentType
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contactRank	N	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	N	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): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom	C	0..*	ContactPoint	A contact detail for the person cpt-2: A system is required if a value is provided.
id		0..1	string	Unique id for inter-element referencing
extension	N	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	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
otherContactSystem	N	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	code	Primitive value for code Max Length:1048576
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	ΣC	0..1	Period	Time period when the contact point was/is in use per-1: If present, start SHALL have a lower value than end
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 ref-1: SHALL have a contained resource if a local reference is provided
period	C	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient per-1: If present, start SHALL have a lower value than end
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
proficiency	N	0..1	(Complex)	The patient's proficiency level of the communication method. URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:level	N	0..1	Extension	The proficiency level of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"level"
value[x]	N	1..1	Coding	The proficiency level for the communication Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication.
extension:type	N	0..*	Extension	The proficiency type of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0
url		1..1	uri	"type"
value[x]	N	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. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	C	0..*	Reference(Organization | Practitioner | PractitionerRole)	Patient's nominated primary care provider ref-1: SHALL have a contained resource if a local reference is provided
managingOrganization	SΣC	0..1	Reference(Organization)	Organization that is the custodian of the patient record ref-1: SHALL have a contained resource if a local reference is provided
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	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to ref-1: SHALL have a contained resource if a local reference is provided
type	Σ	1..1	code	replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
Patient.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier.assigner.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard
Patient.identifier.assigner.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier.assigner.identifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.identifier:nhsNumber.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
Patient.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|4.0.1 from the FHIR Standard
Patient.maritalStatus	extensible	UKCorePersonMaritalStatusCode https://fhir.hl7.org.uk/ValueSet/UKCore-PersonMaritalStatusCode
Patient.contact.relationship	extensible	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType
Patient.contact.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
Patient.contact.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
Patient.contact.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
Patient.communication.extension:proficiency.extension:level.value[x]	preferred	LanguageAbilityProficiency http://terminology.hl7.org/ValueSet/v3-LanguageAbilityProficiency
Patient.communication.extension:proficiency.extension:type.value[x]	preferred	LanguageAbilityMode http://terminology.hl7.org/ValueSet/v3-LanguageAbilityMode
Patient.communication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

This structure is derived from UKCorePatient

Summary

Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• NHS Number (https://hl7.mft.nhs.uk/StructureDefinition/NHSNumber)
• Medical Record Number (https://hl7.mft.nhs.uk/StructureDefinition/MedicalRecordNumber)