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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• History

Resource Profile: InterweavePatient

Interweave Patient resource profile - DRAFT.

Usage:

• Refer to this Resource Profile: InterweaveAllergyIntolerance, InterweaveAppointment, InterweaveCarePlan, InterweaveCondition... Show 27 more, InterweaveDiagnosticReport, InterweaveDocumentReference, InterweaveEncounter, InterweaveEncounterGrouping, InterweaveEpisodeOfCare, InterweaveFlag, InterweaveMedicationAdministration, InterweaveMedicationRequest, InterweaveObservationACVPU, InterweaveObservationVitalSignsBloodPressure, InterweaveObservationVitalSignsBodyHeight, InterweaveObservationVitalSignsBodyTemperature, InterweaveObservationVitalSignsBodyWeight, InterweaveObservationVitalSignsHeartRate, InterweaveObservationVitalSignsOxygenSaturation, InterweaveObservationVitalSignsRespirationRate, InterweaveObservationVitalSigns, InterweaveObservation, InterweavePatient, InterweaveProcedure, InterweaveQuestionnaireResponse, InterweaveRelatedPerson, InterweaveServiceRequest, InterweaveSocialCareAssessment, InterweaveSocialCareContact, InterweaveSocialCareEquipmentProvision and InterweaveSocialCareSupportReason

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
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..1	PatBirthPlace(5.1.0)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive
extension:cadavericDonor		0..1	PatCadavericDonor(5.1.0)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive
extension:deathNotificationStatus		0..1	ExtensionUKCoreDeathNotificationStatus	DISCOURAGED: this is generally managed Nationally through PDS and not needed again here
extension:ethnicCategory		0..1	ExtensionUKCoreEthnicCategory	Ethnic category
value[x]		1..1	CodeableConcept	A code classifying the person's ethnicity Binding: UK Core Ethnic Category (required)
identifier		1..*	Identifier	An identifier for this patient.
Slices for identifier				Content/Rules for all slices
identifier:nhsNumber	S	1..1	Identifier	The patient's NHS number.
Slices for extension				Content/Rules for all slices
extension:nhsNumberVerificationStatus		0..1	ExtensionUKCoreNHSNumberVerificationStatus	Verification status of the NHS Number - must be traced and verified
value[x]		1..1	CodeableConcept	Verification status of the NHS number Fixed Value: As shown
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 01
display		1..1	string	Representation defined by the system Fixed Value: Number present and verified
active		0..1	boolean	Whether this patient's record is in active use - must be both populated and understood if 'false'. See notes on usage.
Slices for name		1..*	HumanName	A name associated with the patient. Slice: Unordered, Open by value:use
name:official	S	1..1	HumanName	A name associated with the patient.
use	S	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	S	1..1	string	Family name (often called 'Surname'). NB: First 3 letters must match PDS
given	S	1..*	string	Given names (not always 'first'). Includes middle names. NB: First letter (initial) must match PDS
prefix	S	0..*	string	Parts that come before the name
suffix	S	0..*	string	Parts that come after the name
name:other		0..*	HumanName	A name associated with the patient.
use	S	1..1	code	usual | official | temp | nickname | anonymous | old | maiden
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
telecom
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
birthDate		1..1	date	The date of birth for the individual. NB: Must match PDS
id		0..0
deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not. Do not populate - populated by PDS only.
address
use	S	0..1	code	home | work | temp | old | billing - purpose of this address
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
line	S	0..*	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county)
postalCode	S	0..1	string	Postal code for area
photo		0..0
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	0..*	CodeableConcept	The kind of relationship
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name	S	0..1	HumanName	A name associated with the contact person
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
telecom	S	0..*	ContactPoint	A contact detail for the person
address
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
organization		0..1	Reference(InterweaveOrganization)	Organization that is associated with the contact
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	DISCOURAGED: PDS is the master of this information, should not normally be populated by other systems.
managingOrganization		0..1	Reference(InterweaveOrganization)	DISCOURAGED: Already covered by the provenance tags. (If populated then must match this)
link		0..*	BackboneElement	Link to another patient resource that concerns the same actual person. (For example merged record)
other		1..1	Reference(InterweaveRelatedPerson | InterweavePatient)	The other patient or related person resource that the link refers to
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.extension:ethnicCategory.value[x]	required	UKCoreEthnicCategory https://fhir.hl7.org.uk/ValueSet/UKCore-EthnicCategory from this IG

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	UKCorePatient	Information about an individual or animal receiving health care services
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension				Content/Rules for all slices
birthPlace		0..1	(Complex)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive 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)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive 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)	DISCOURAGED: this is generally managed Nationally through PDS and not needed again here URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
ethnicCategory		0..1	(Complex)	Ethnic category URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory
extension		0..0
url		1..1	uri	"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory"
value[x]		1..1	CodeableConcept	A code classifying the person's ethnicity Binding: UK Core Ethnic Category (required)
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
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient. Slice: Unordered, Open by value:system
identifier:nhsNumber	SΣ	1..1	Identifier	The patient's NHS number.
Slices for extension				Content/Rules for all slices
nhsNumberVerificationStatus		0..1	(Complex)	Verification status of the NHS Number - must be traced and verified URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
extension		0..0
url		1..1	uri	"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"
value[x]		1..1	CodeableConcept	Verification status of the NHS number Binding: UK Core NHS Number Verification Status (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 01
display		1..1	string	Representation defined by the system Fixed Value: Number present and verified
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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 - must be both populated and understood if 'false'. See notes on usage.
Slices for name	SΣ	1..*	HumanName	A name associated with the patient. Slice: Unordered, Open by value:use
name:official	SΣ	1..1	HumanName	A name associated with the patient.
use	?!SΣ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	SΣ	1..1	string	Family name (often called 'Surname'). NB: First 3 letters must match PDS
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names. NB: First letter (initial) must match PDS This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
name:other	SΣ	0..*	HumanName	A name associated with the patient.
use	?!SΣ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual.
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Slices for extension				Content/Rules for all slices
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	SΣ	0..1	string	The actual contact point details
use	?!SΣ	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Σ	1..1	date	The date of birth for the individual. NB: Must match PDS
Slices for extension				Content/Rules for all slices
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. Do not populate - populated by PDS only.
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	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	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	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
contact	SC	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
Slices for extension				Content/Rules for all slices
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	S	0..*	CodeableConcept	The kind of relationship Binding: UK Core Person Relationship Type (extensible)
name	S	0..1	HumanName	A name associated with the contact person
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
telecom	S	0..*	ContactPoint	A contact detail for the person
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
organization	C	0..1	Reference(InterweaveOrganization)	Organization that is associated with the contact
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	DISCOURAGED: PDS is the master of this information, should not normally be populated by other systems.
managingOrganization	SΣ	0..1	Reference(InterweaveOrganization)	DISCOURAGED: Already covered by the provenance tags. (If populated then must match this)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person. (For example merged record)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(InterweaveRelatedPerson | InterweavePatient)	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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.extension:ethnicCategory.value[x]	required	UKCoreEthnicCategory https://fhir.hl7.org.uk/ValueSet/UKCore-EthnicCategory from this IG
Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]	required	Fixed Value: 01("Number present and verified") https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus from this IG
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name:official.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:other.use	required	NameUse http://hl7.org/fhir/ValueSet/name-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.contact.relationship	extensible	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|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.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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 : 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-4	error	Patient	If 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-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	UKCorePatient	Information about an individual or animal receiving health care services
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace		0..1	(Complex)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive 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)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive 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)	DISCOURAGED: this is generally managed Nationally through PDS and not needed again here URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
ethnicCategory		0..1	(Complex)	Ethnic category URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory"
value[x]		1..1	CodeableConcept	A code classifying the person's ethnicity Binding: UK Core Ethnic Category (required)
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Σ	1..*	Identifier	An identifier for this patient. Slice: Unordered, Open by value:system
identifier:nhsNumber	SΣ	1..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	(Complex)	Verification status of the NHS Number - must be traced and verified URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"
value[x]		1..1	CodeableConcept	Verification status of the NHS number Binding: UK Core NHS Number Verification Status (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 01
display		1..1	string	Representation defined by the system Fixed Value: Number present and verified
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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 - must be both populated and understood if 'false'. See notes on usage.
Slices for name	SΣ	1..*	HumanName	A name associated with the patient. Slice: Unordered, Open by value:use
name:official	SΣ	1..1	HumanName	A name associated with the patient.
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	?!SΣ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	SΣ	1..1	string	Family name (often called 'Surname'). NB: First 3 letters must match PDS
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names. NB: First letter (initial) must match PDS This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
name:other	SΣ	0..*	HumanName	A name associated with the patient.
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	?!SΣ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
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	SΣ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	SΣ	0..1	string	The actual contact point details
use	?!SΣ	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Σ	1..1	date	The date of birth for the individual. NB: Must match PDS
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. Do not populate - populated by PDS only.
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	?!SΣ	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	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	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	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	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
contact	SC	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	S	0..*	CodeableConcept	The kind of relationship Binding: UK Core Person Relationship Type (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name	S	0..1	HumanName	A name associated with the contact 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
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	S	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
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	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	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. 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"}
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(InterweaveOrganization)	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)	DISCOURAGED: PDS is the master of this information, should not normally be populated by other systems.
managingOrganization	SΣ	0..1	Reference(InterweaveOrganization)	DISCOURAGED: Already covered by the provenance tags. (If populated then must match this)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person. (For example merged record)
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(InterweaveRelatedPerson | InterweavePatient)	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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.extension:ethnicCategory.value[x]	required	UKCoreEthnicCategory https://fhir.hl7.org.uk/ValueSet/UKCore-EthnicCategory from this IG
Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]	required	Fixed Value: 01("Number present and verified") https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus from this IG
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.name:official.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:other.use	required	NameUse http://hl7.org/fhir/ValueSet/name-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.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 from this IG
Patient.contact.relationship	extensible	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
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.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.contact.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|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
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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 : 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-4	error	Patient	If 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-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from UKCorePatient

Summary

Mandatory: 8 elements(10 nested mandatory elements)
Must-Support: 30 elements
Fixed: 4 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

• InterweaveOrganization (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Organization)
• InterweaveRelatedPerson (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-RelatedPerson)
• InterweavePatient (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Patient)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.meta.tag
• The element 1 is sliced based on the value of Patient.name

Differential View

This structure is derived from UKCorePatient

Name	Flags	Card.	Type	Description & Constraints
Patient			UKCorePatient
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension				Content/Rules for all slices
extension:birthPlace		0..1	PatBirthPlace(5.1.0)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive
extension:cadavericDonor		0..1	PatCadavericDonor(5.1.0)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive
extension:deathNotificationStatus		0..1	ExtensionUKCoreDeathNotificationStatus	DISCOURAGED: this is generally managed Nationally through PDS and not needed again here
extension:ethnicCategory		0..1	ExtensionUKCoreEthnicCategory	Ethnic category
value[x]		1..1	CodeableConcept	A code classifying the person's ethnicity Binding: UK Core Ethnic Category (required)
identifier		1..*	Identifier	An identifier for this patient.
Slices for identifier				Content/Rules for all slices
identifier:nhsNumber	S	1..1	Identifier	The patient's NHS number.
Slices for extension				Content/Rules for all slices
extension:nhsNumberVerificationStatus		0..1	ExtensionUKCoreNHSNumberVerificationStatus	Verification status of the NHS Number - must be traced and verified
value[x]		1..1	CodeableConcept	Verification status of the NHS number Fixed Value: As shown
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 01
display		1..1	string	Representation defined by the system Fixed Value: Number present and verified
active		0..1	boolean	Whether this patient's record is in active use - must be both populated and understood if 'false'. See notes on usage.
Slices for name		1..*	HumanName	A name associated with the patient. Slice: Unordered, Open by value:use
name:official	S	1..1	HumanName	A name associated with the patient.
use	S	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Fixed Value: official
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	S	1..1	string	Family name (often called 'Surname'). NB: First 3 letters must match PDS
given	S	1..*	string	Given names (not always 'first'). Includes middle names. NB: First letter (initial) must match PDS
prefix	S	0..*	string	Parts that come before the name
suffix	S	0..*	string	Parts that come after the name
name:other		0..*	HumanName	A name associated with the patient.
use	S	1..1	code	usual | official | temp | nickname | anonymous | old | maiden
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
telecom
system	S	0..1	code	phone | fax | email | pager | url | sms | other
value	S	0..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
birthDate		1..1	date	The date of birth for the individual. NB: Must match PDS
id		0..0
deceased[x]		0..1	boolean, dateTime	Indicates if the individual is deceased or not. Do not populate - populated by PDS only.
address
use	S	0..1	code	home | work | temp | old | billing - purpose of this address
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
line	S	0..*	string	Street name, number, direction & P.O. Box etc.
city	S	0..1	string	Name of city, town etc.
district	S	0..1	string	District name (aka county)
postalCode	S	0..1	string	Postal code for area
photo		0..0
contact	S	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient
relationship	S	0..*	CodeableConcept	The kind of relationship
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name	S	0..1	HumanName	A name associated with the contact person
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
telecom	S	0..*	ContactPoint	A contact detail for the person
address
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements.
organization		0..1	Reference(InterweaveOrganization)	Organization that is associated with the contact
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	DISCOURAGED: PDS is the master of this information, should not normally be populated by other systems.
managingOrganization		0..1	Reference(InterweaveOrganization)	DISCOURAGED: Already covered by the provenance tags. (If populated then must match this)
link		0..*	BackboneElement	Link to another patient resource that concerns the same actual person. (For example merged record)
other		1..1	Reference(InterweaveRelatedPerson | InterweavePatient)	The other patient or related person resource that the link refers to
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Patient.extension:ethnicCategory.value[x]	required	UKCoreEthnicCategory https://fhir.hl7.org.uk/ValueSet/UKCore-EthnicCategory from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	UKCorePatient	Information about an individual or animal receiving health care services
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension				Content/Rules for all slices
birthPlace		0..1	(Complex)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive 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)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive 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)	DISCOURAGED: this is generally managed Nationally through PDS and not needed again here URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
ethnicCategory		0..1	(Complex)	Ethnic category URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory
extension		0..0
url		1..1	uri	"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory"
value[x]		1..1	CodeableConcept	A code classifying the person's ethnicity Binding: UK Core Ethnic Category (required)
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
Slices for identifier	SΣ	1..*	Identifier	An identifier for this patient. Slice: Unordered, Open by value:system
identifier:nhsNumber	SΣ	1..1	Identifier	The patient's NHS number.
Slices for extension				Content/Rules for all slices
nhsNumberVerificationStatus		0..1	(Complex)	Verification status of the NHS Number - must be traced and verified URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
extension		0..0
url		1..1	uri	"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"
value[x]		1..1	CodeableConcept	Verification status of the NHS number Binding: UK Core NHS Number Verification Status (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 01
display		1..1	string	Representation defined by the system Fixed Value: Number present and verified
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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 - must be both populated and understood if 'false'. See notes on usage.
Slices for name	SΣ	1..*	HumanName	A name associated with the patient. Slice: Unordered, Open by value:use
name:official	SΣ	1..1	HumanName	A name associated with the patient.
use	?!SΣ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	SΣ	1..1	string	Family name (often called 'Surname'). NB: First 3 letters must match PDS
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names. NB: First letter (initial) must match PDS This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
name:other	SΣ	0..*	HumanName	A name associated with the patient.
use	?!SΣ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
telecom	SΣ	0..*	ContactPoint	A contact detail for the individual.
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Slices for extension				Content/Rules for all slices
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	SΣ	0..1	string	The actual contact point details
use	?!SΣ	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Σ	1..1	date	The date of birth for the individual. NB: Must match PDS
Slices for extension				Content/Rules for all slices
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. Do not populate - populated by PDS only.
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	?!SΣ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	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	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
contact	SC	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
Slices for extension				Content/Rules for all slices
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	S	0..*	CodeableConcept	The kind of relationship Binding: UK Core Person Relationship Type (extensible)
name	S	0..1	HumanName	A name associated with the contact person
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
telecom	S	0..*	ContactPoint	A contact detail for the person
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
organization	C	0..1	Reference(InterweaveOrganization)	Organization that is associated with the contact
generalPractitioner		0..*	Reference(Organization | Practitioner | PractitionerRole)	DISCOURAGED: PDS is the master of this information, should not normally be populated by other systems.
managingOrganization	SΣ	0..1	Reference(InterweaveOrganization)	DISCOURAGED: Already covered by the provenance tags. (If populated then must match this)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person. (For example merged record)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	Σ	1..1	Reference(InterweaveRelatedPerson | InterweavePatient)	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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.extension:ethnicCategory.value[x]	required	UKCoreEthnicCategory https://fhir.hl7.org.uk/ValueSet/UKCore-EthnicCategory from this IG
Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]	required	Fixed Value: 01("Number present and verified") https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus from this IG
Patient.identifier:nhsNumber.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
Patient.name:official.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:other.use	required	NameUse http://hl7.org/fhir/ValueSet/name-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.contact.relationship	extensible	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|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.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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 : 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-4	error	Patient	If 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-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient		0..*	UKCorePatient	Information about an individual or animal receiving health care services
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
birthPlace		0..1	(Complex)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive 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)	DISCOURAGED: could be useful but seems unlikely to be relevant to ongoing regional care whilst they are still alive 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)	DISCOURAGED: this is generally managed Nationally through PDS and not needed again here URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
ethnicCategory		0..1	(Complex)	Ethnic category URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory"
value[x]		1..1	CodeableConcept	A code classifying the person's ethnicity Binding: UK Core Ethnic Category (required)
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Σ	1..*	Identifier	An identifier for this patient. Slice: Unordered, Open by value:system
identifier:nhsNumber	SΣ	1..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	(Complex)	Verification status of the NHS Number - must be traced and verified URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus
id		0..1	string	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus"
value[x]		1..1	CodeableConcept	Verification status of the NHS number Binding: UK Core NHS Number Verification Status (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.hl7.org.uk/CodeSystem/UKCore-NHSNumberVerificationStatusEngland
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 01
display		1..1	string	Representation defined by the system Fixed Value: Number present and verified
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
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 - must be both populated and understood if 'false'. See notes on usage.
Slices for name	SΣ	1..*	HumanName	A name associated with the patient. Slice: Unordered, Open by value:use
name:official	SΣ	1..1	HumanName	A name associated with the patient.
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	?!SΣ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. Fixed Value: official
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	SΣ	1..1	string	Family name (often called 'Surname'). NB: First 3 letters must match PDS
given	SΣ	1..*	string	Given names (not always 'first'). Includes middle names. NB: First letter (initial) must match PDS This repeating element order: Given Names appear in the correct order for presenting the name
prefix	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
name:other	SΣ	0..*	HumanName	A name associated with the patient.
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	?!SΣ	1..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
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	SΣ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	SΣ	0..1	string	The actual contact point details
use	?!SΣ	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Σ	1..1	date	The date of birth for the individual. NB: Must match PDS
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. Do not populate - populated by PDS only.
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	?!SΣ	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	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. Example General: 137 Nowhere Street, Erewhon 9132
line	SΣ	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	SΣ	0..1	string	Name of city, town etc. Example General: Erewhon
district	SΣ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	SΣ	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
contact	SC	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	S	0..*	CodeableConcept	The kind of relationship Binding: UK Core Person Relationship Type (extensible)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
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	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name	S	0..1	HumanName	A name associated with the contact 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
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	Σ	0..1	string	Family name (often called 'Surname')
given	Σ	0..*	string	Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name
prefix	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	S	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
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	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	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the address based on the detailed elements. 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"}
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(InterweaveOrganization)	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)	DISCOURAGED: PDS is the master of this information, should not normally be populated by other systems.
managingOrganization	SΣ	0..1	Reference(InterweaveOrganization)	DISCOURAGED: Already covered by the provenance tags. (If populated then must match this)
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person. (For example merged record)
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(InterweaveRelatedPerson | InterweavePatient)	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.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Patient.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Patient.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
Patient.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
Patient.extension:ethnicCategory.value[x]	required	UKCoreEthnicCategory https://fhir.hl7.org.uk/ValueSet/UKCore-EthnicCategory from this IG
Patient.identifier:nhsNumber.extension:nhsNumberVerificationStatus.value[x]	required	Fixed Value: 01("Number present and verified") https://fhir.hl7.org.uk/ValueSet/UKCore-NHSNumberVerificationStatus from this IG
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.name:official.use	required	Fixed Value: official http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
Patient.name:other.use	required	NameUse http://hl7.org/fhir/ValueSet/name-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.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 from this IG
Patient.contact.relationship	extensible	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG
Patient.contact.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
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.address.use	required	AddressUse http://hl7.org/fhir/ValueSet/address-use|4.0.1 from the FHIR Standard
Patient.contact.address.type	required	AddressType http://hl7.org/fhir/ValueSet/address-type|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
Patient.link.type	required	LinkType http://hl7.org/fhir/ValueSet/link-type|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Patient	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 : 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-4	error	Patient	If 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-5	error	Patient	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Patient	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
pat-1	error	Patient.contact	SHALL at least contain a contact's details or a reference to an organization : name.exists() or telecom.exists() or address.exists() or organization.exists()

This structure is derived from UKCorePatient

Summary

Mandatory: 8 elements(10 nested mandatory elements)
Must-Support: 30 elements
Fixed: 4 elements
Prohibited: 7 elements

Structures

This structure refers to these other structures:

• InterweaveOrganization (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Organization)
• InterweaveRelatedPerson (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-RelatedPerson)
• InterweavePatient (https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Interweave-Patient)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.meta.tag
• The element 1 is sliced based on the value of Patient.name