CARECONNECT-BASE\Patient-1

INTEROPen CareConnect Base STU3 Implementation Guide - Local Development build (v3.0.0). See the Directory of published versions

StructureDefinition: CareConnect-Patient-1

The patient resource represents the patient involved in the provision of healthcare related services.

The official URL for this profile is:

https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1

Contents:

Identifiers
Examples

This profile defines a patient administration details structure that includes core localisation concepts for use in a UK context.

Identifiers

These definitions represent common data held in the Patient.identifier element:

NHS Number - England and Wales
CHI Number - Scotland. Not yet specified
HSNi - Northern Ireland. Not yet specified

Examples

Patient with NHS Number and NHS Trust Identifier

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from Patient

Summary

Mandatory: 3 elements (11 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element Patient.identifier is sliced based on the value of value:system (Open at End)
The element Patient.name is sliced based on the value of value:use (Open at End)

This structure is derived from Patient

Name	Card.	Type	Description & Constraints
Patient	0..*	Patient
extension	0..*	Extension	Slice: Unordered, Open by value:url
Extension-CareConnect-EthnicCategory-1	0..1	CodeableConcept	Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Extension-CareConnect-ReligiousAffiliation-1	0..1	CodeableConcept	Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1
patient-cadavericDonor	0..1	boolean	Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
Extension-CareConnect-ResidentialStatus-1	0..1	CodeableConcept	The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Extension-CareConnect-TreatmentCategory-1	0..1	CodeableConcept	The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Extension-CareConnect-NHSCommunication-1	0..*	(Complex)	NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
extension:preferred	0..1	Extension
valueBoolean:valueBoolean	1..1	boolean
extension:interpreterRequired	0..1	Extension
valueBoolean:valueBoolean	1..1	boolean
birthPlace	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/birthPlace
Extension-CareConnect-NominatedPharmacy-1	0..1	Reference()	A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
Extension-CareConnect-DeathNotificationStatus-1	0..1	(Complex)	Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
identifier	0..*	(Slice Definition)	Slice: Unordered, Open At End by value:system
identifier:nhsNumber	0..1	Identifier	The patient's NHS number
extension	0..*	Extension	Slice: Unordered, Open by value:url
Extension-CareConnect-NHSNumberVerificationStatus-1	1..1	CodeableConcept	NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
system	1..1	uri	Fixed Value: https://fhir.nhs.uk/Id/nhs-number
value	1..1	string	Example General: 1234567890
assigner	0..1	Reference(CareConnect-Organization-1)
name	0..*	(Slice Definition)	Slice: Unordered, Open At End by value:use
name:official	1..1	HumanName
use	1..1	code	Binding: NameUse (required) Fixed Value: official
family	1..1	string
telecom
system	1..1	code
value	1..1	string
gender	0..1	code	Binding: Administrative Gender (required)
birthDate
extension	0..*	Extension	Slice: Unordered, Open by value:url
patient-birthTime	0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
address
text	0..1	string	Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF
line	0..*	string	Example General: 42 Grove Street
city	0..1	string	Example General: Overtown
district	0..1	string	Example General: West Yorkshire
postalCode	0..1	string	Example General: LS21 1PF
country	0..1	string	Example General: GBR
maritalStatus	0..1	CodeableConcept	Binding: (unbound) (required)
coding	1..1	Coding
system	1..1	uri	Example General: http://hl7.org/fhir/v3/MaritalStatus
code	1..1	code
display	1..1	string
contact
name	1..1	HumanName
use	1..1	code
address
text	0..1	string	Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT
line	0..*	string	Example General: 120, Grove Street
city	0..1	string	Example General: Overtown
district	0..1	string	Example General: West Yorkshire
postalCode	0..1	string	Example General: LS21 1PT
country	0..1	string	Example General: GBR
gender	0..1	code	Binding: AdministrativeGender (required)
organization	0..1	Reference(CareConnect-Organization-1)
animal	0..0
communication	0..0
generalPractitioner	0..*	Reference(CareConnect-Organization-1 \| CareConnect-Practitioner-1)
managingOrganization	0..1	Reference(CareConnect-Organization-1)
link
other	1..1	Reference(RelatedPerson \| CareConnect-Patient-1)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Patient	I	0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Extension-CareConnect-EthnicCategory-1	I	0..1	CodeableConcept	Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Extension-CareConnect-ReligiousAffiliation-1	I	0..1	CodeableConcept	Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1
patient-cadavericDonor	I	0..1	boolean	Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
Extension-CareConnect-ResidentialStatus-1	I	0..1	CodeableConcept	The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Extension-CareConnect-TreatmentCategory-1	I	0..1	CodeableConcept	The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Extension-CareConnect-NHSCommunication-1	I	0..*	(Complex)	NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:language		1..1	Extension	Languages which may be used for communication
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"language"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Languages which may be used for communication Binding: Care Connect Human Language (required)
extension:preferred		0..1	Extension	Extension
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"preferred"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean		1..1	boolean	Indicates whether or not this language is preferred (over other languages up a certain level)
extension:modeOfCommunication		0..*	Extension	Mode of communication for the selected language
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"modeOfCommunication"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. Binding: Care Connect Language Ability Mode (required)
extension:communicationProficiency		0..1	Extension	The level of proficiency in communicating a language
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"communicationProficiency"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	A valueset to describe the level of proficiency in communicating a language Binding: Care Connect Language Ability Proficiency (required)
extension:interpreterRequired		0..1	Extension	Extension
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"interpreterRequired"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean		1..1	boolean	Indicates whether an interpreter is required for communication purposes
url		1..1	uri	"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1"
birthPlace	I	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/birthPlace
Extension-CareConnect-NominatedPharmacy-1	I	0..1	Reference()	A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
Extension-CareConnect-DeathNotificationStatus-1	I	0..1	(Complex)	Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	(Slice Definition)	An identifier for this patient Slice: Unordered, Open At End by value:system
identifier:nhsNumber	Σ	0..1	Identifier	The patient's NHS number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Extension-CareConnect-NHSNumberVerificationStatus-1		1..1	CodeableConcept	NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
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 Example General: 1234567890
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	(Slice Definition)	A name associated with the patient Slice: Unordered, Open At End by value:use
name:official	Σ	1..1	HumanName	A name associated with the patient
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required) Fixed Value: official
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..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	Σ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	ΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	Σ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
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	Σ	0..1	code	male \| female \| other \| unknown Binding: Administrative Gender (required)
birthDate	Σ	0..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
patient-birthTime	I	0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	Address	Addresses for the individual
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old - purpose of this address Binding: AddressUse (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF
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 Example General: 42 Grove Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon Example General: Overtown
district	Σ	0..1	string	District name (aka county) Example General: Madison Example General: West Yorkshire
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132 Example General: LS21 1PF
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR
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: Marital Status Codes (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Example General: http://hl7.org/fhir/v3/MaritalStatus
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
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	I	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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
relationship		0..*	CodeableConcept	The kind of relationship Binding: v2 Contact Role (extensible)
name		1..1	HumanName	A name associated with the contact person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	Σ	0..1	string	Text representation of the full name
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		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old - purpose of this address Binding: AddressUse (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT
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 Example General: 120, Grove Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon Example General: Overtown
district	Σ	0..1	string	District name (aka county) Example General: Madison Example General: West Yorkshire
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132 Example General: LS21 1PT
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR
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)
organization	I	0..1	Reference(CareConnect-Organization-1)	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
generalPractitioner		0..*	Reference(CareConnect-Organization-1 \| CareConnect-Practitioner-1)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that is the custodian of the patient record
link	?!ΣI	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
other	Σ	1..1	Reference(RelatedPerson \| CareConnect-Patient-1)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso - type of link Binding: LinkType (required)
Documentation for this format

This structure is derived from Patient

Summary

Mandatory: 3 elements (11 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

The element Patient.identifier is sliced based on the value of value:system (Open at End)
The element Patient.name is sliced based on the value of value:use (Open at End)

Differential View

This structure is derived from Patient

Name	Card.	Type	Description & Constraints
Patient	0..*	Patient
extension	0..*	Extension	Slice: Unordered, Open by value:url
Extension-CareConnect-EthnicCategory-1	0..1	CodeableConcept	Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Extension-CareConnect-ReligiousAffiliation-1	0..1	CodeableConcept	Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1
patient-cadavericDonor	0..1	boolean	Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
Extension-CareConnect-ResidentialStatus-1	0..1	CodeableConcept	The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Extension-CareConnect-TreatmentCategory-1	0..1	CodeableConcept	The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Extension-CareConnect-NHSCommunication-1	0..*	(Complex)	NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
extension:preferred	0..1	Extension
valueBoolean:valueBoolean	1..1	boolean
extension:interpreterRequired	0..1	Extension
valueBoolean:valueBoolean	1..1	boolean
birthPlace	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/birthPlace
Extension-CareConnect-NominatedPharmacy-1	0..1	Reference()	A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
Extension-CareConnect-DeathNotificationStatus-1	0..1	(Complex)	Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
identifier	0..*	(Slice Definition)	Slice: Unordered, Open At End by value:system
identifier:nhsNumber	0..1	Identifier	The patient's NHS number
extension	0..*	Extension	Slice: Unordered, Open by value:url
Extension-CareConnect-NHSNumberVerificationStatus-1	1..1	CodeableConcept	NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
system	1..1	uri	Fixed Value: https://fhir.nhs.uk/Id/nhs-number
value	1..1	string	Example General: 1234567890
assigner	0..1	Reference(CareConnect-Organization-1)
name	0..*	(Slice Definition)	Slice: Unordered, Open At End by value:use
name:official	1..1	HumanName
use	1..1	code	Binding: NameUse (required) Fixed Value: official
family	1..1	string
telecom
system	1..1	code
value	1..1	string
gender	0..1	code	Binding: Administrative Gender (required)
birthDate
extension	0..*	Extension	Slice: Unordered, Open by value:url
patient-birthTime	0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
address
text	0..1	string	Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF
line	0..*	string	Example General: 42 Grove Street
city	0..1	string	Example General: Overtown
district	0..1	string	Example General: West Yorkshire
postalCode	0..1	string	Example General: LS21 1PF
country	0..1	string	Example General: GBR
maritalStatus	0..1	CodeableConcept	Binding: (unbound) (required)
coding	1..1	Coding
system	1..1	uri	Example General: http://hl7.org/fhir/v3/MaritalStatus
code	1..1	code
display	1..1	string
contact
name	1..1	HumanName
use	1..1	code
address
text	0..1	string	Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT
line	0..*	string	Example General: 120, Grove Street
city	0..1	string	Example General: Overtown
district	0..1	string	Example General: West Yorkshire
postalCode	0..1	string	Example General: LS21 1PT
country	0..1	string	Example General: GBR
gender	0..1	code	Binding: AdministrativeGender (required)
organization	0..1	Reference(CareConnect-Organization-1)
animal	0..0
communication	0..0
generalPractitioner	0..*	Reference(CareConnect-Organization-1 \| CareConnect-Practitioner-1)
managingOrganization	0..1	Reference(CareConnect-Organization-1)
link
other	1..1	Reference(RelatedPerson \| CareConnect-Patient-1)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Patient	I	0..*	Patient	Information about an individual or animal receiving health care services
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: Common Languages (extensible) Max Binding: All Languages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Extension-CareConnect-EthnicCategory-1	I	0..1	CodeableConcept	Ethnic category URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-EthnicCategory-1
Extension-CareConnect-ReligiousAffiliation-1	I	0..1	CodeableConcept	Religious affiliation URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ReligiousAffiliation-1
patient-cadavericDonor	I	0..1	boolean	Post-mortem donor status URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
Extension-CareConnect-ResidentialStatus-1	I	0..1	CodeableConcept	The residential status of the patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ResidentialStatus-1
Extension-CareConnect-TreatmentCategory-1	I	0..1	CodeableConcept	The treatment category for this patient URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-TreatmentCategory-1
Extension-CareConnect-NHSCommunication-1	I	0..*	(Complex)	NHS communication preferences for a resource URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:language		1..1	Extension	Languages which may be used for communication
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"language"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	Languages which may be used for communication Binding: Care Connect Human Language (required)
extension:preferred		0..1	Extension	Extension
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"preferred"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean		1..1	boolean	Indicates whether or not this language is preferred (over other languages up a certain level)
extension:modeOfCommunication		0..*	Extension	Mode of communication for the selected language
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"modeOfCommunication"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	A valueset to describe the mode the patient can communicate in, representing the method of expression of the language. Binding: Care Connect Language Ability Mode (required)
extension:communicationProficiency		0..1	Extension	The level of proficiency in communicating a language
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"communicationProficiency"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueCodeableConcept		1..1	CodeableConcept	A valueset to describe the level of proficiency in communicating a language Binding: Care Connect Language Ability Proficiency (required)
extension:interpreterRequired		0..1	Extension	Extension
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]		0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueMeta			Meta
url		1..1	uri	"interpreterRequired"
value[x]		1..1	(Slice Definition)	Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueBoolean		1..1	boolean	Indicates whether an interpreter is required for communication purposes
url		1..1	uri	"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSCommunication-1"
birthPlace	I	0..1	Address	Place of Birth for patient URL: http://hl7.org/fhir/StructureDefinition/birthPlace
Extension-CareConnect-NominatedPharmacy-1	I	0..1	Reference()	A patient's nominated pharmacy URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NominatedPharmacy-1
Extension-CareConnect-DeathNotificationStatus-1	I	0..1	(Complex)	Representation of a patient’s death notification status (as held on Personal Demographics Service (PDS)) URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DeathNotificationStatus-1
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	(Slice Definition)	An identifier for this patient Slice: Unordered, Open At End by value:system
identifier:nhsNumber	Σ	0..1	Identifier	The patient's NHS number
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
Extension-CareConnect-NHSNumberVerificationStatus-1		1..1	CodeableConcept	NHS number verification status URL: https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-NHSNumberVerificationStatus-1
use	?!Σ	0..1	code	usual \| official \| temp \| secondary (If known) Binding: IdentifierUse (required)
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible)
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 Example General: 1234567890
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
active	?!Σ	0..1	boolean	Whether this patient's record is in active use
name	Σ	0..*	(Slice Definition)	A name associated with the patient Slice: Unordered, Open At End by value:use
name:official	Σ	1..1	HumanName	A name associated with the patient
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required) Fixed Value: official
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..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	Σ	0..*	ContactPoint	A contact detail for the individual
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	ΣI	1..1	code	phone \| fax \| email \| pager \| url \| sms \| other Binding: ContactPointSystem (required)
value	Σ	1..1	string	The actual contact point details
use	?!Σ	0..1	code	home \| work \| temp \| old \| mobile - purpose of this contact point Binding: ContactPointUse (required)
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	Σ	0..1	code	male \| female \| other \| unknown Binding: Administrative Gender (required)
birthDate	Σ	0..1	date	The date of birth for the individual
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
patient-birthTime	I	0..1	dateTime	Time of day of birth URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	Σ	0..*	Address	Addresses for the individual
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old - purpose of this address Binding: AddressUse (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 Example General: 42 Grove Street, Overtown, West Yorkshire, LS21 1PF
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 Example General: 42 Grove Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon Example General: Overtown
district	Σ	0..1	string	District name (aka county) Example General: Madison Example General: West Yorkshire
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132 Example General: LS21 1PF
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR
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: Marital Status Codes (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	1..1	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Example General: http://hl7.org/fhir/v3/MaritalStatus
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
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo		0..*	Attachment	Image of the patient
contact	I	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	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
relationship		0..*	CodeableConcept	The kind of relationship Binding: v2 Contact Role (extensible)
name		1..1	HumanName	A name associated with the contact person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	1..1	code	usual \| official \| temp \| nickname \| anonymous \| old \| maiden Binding: NameUse (required)
text	Σ	0..1	string	Text representation of the full name
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		0..*	ContactPoint	A contact detail for the person
address		0..1	Address	Address for the contact person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home \| work \| temp \| old - purpose of this address Binding: AddressUse (required) Example General: home
type	Σ	0..1	code	postal \| physical \| both Binding: AddressType (required) Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 Example General: 120, Grove Street, Overtown, West Yorkshire, LS21 1PT
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 Example General: 120, Grove Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon Example General: Overtown
district	Σ	0..1	string	District name (aka county) Example General: Madison Example General: West Yorkshire
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132 Example General: LS21 1PT
country	Σ	0..1	string	Country (e.g. can be ISO 3166 2 or 3 letter code) Example General: GBR
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)
organization	I	0..1	Reference(CareConnect-Organization-1)	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
generalPractitioner		0..*	Reference(CareConnect-Organization-1 \| CareConnect-Practitioner-1)	Patient's nominated primary care provider
managingOrganization	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that is the custodian of the patient record
link	?!ΣI	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
other	Σ	1..1	Reference(RelatedPerson \| CareConnect-Patient-1)	The other patient or related person resource that the link refers to
type	Σ	1..1	code	replaced-by \| replaces \| refer \| seealso - type of link Binding: LinkType (required)
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet / Code
Patient.language	extensible	Common Languages Max Binding: All Languages
Patient.extension:nhsCommunication.extension:language.value[x]:valueCodeableConcept	required	Care Connect Human Language
Patient.extension:nhsCommunication.extension:modeOfCommunication.value[x]:valueCodeableConcept	required	Care Connect Language Ability Mode
Patient.extension:nhsCommunication.extension:communicationProficiency.value[x]:valueCodeableConcept	required	Care Connect Language Ability Proficiency
Patient.identifier:nhsNumber.use	required	IdentifierUse
Patient.identifier:nhsNumber.type	extensible	Identifier Type Codes
Patient.name:official.use	required	Fixed Value: official
Patient.telecom.system	required	ContactPointSystem
Patient.telecom.use	required	ContactPointUse
Patient.gender	required	Administrative Gender
Patient.address.use	required	AddressUse
Patient.address.type	required	AddressType
Patient.maritalStatus	required	Marital Status Codes
Patient.contact.relationship	extensible	v2 Contact Role
Patient.contact.name.use	required	NameUse
Patient.contact.address.use	required	AddressUse
Patient.contact.address.type	required	AddressType
Patient.contact.gender	required	AdministrativeGender
Patient.animal.species	example	AnimalSpecies
Patient.animal.breed	example	AnimalBreeds
Patient.animal.genderStatus	example	GenderStatus
Patient.communication.language	extensible	Common Languages Max Binding: All Languages
Patient.link.type	required	LinkType

Constraints

Id	Path	Details	Requirements
dom-2	Patient	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-1	Patient	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
dom-4	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-3	Patient	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ele-1	Patient.extension:ethnicCategory	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.extension:ethnicCategory	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:religiousAffiliation	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.extension:religiousAffiliation	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:patient-cadavericDonor	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.extension:patient-cadavericDonor	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:residentialStatus	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.extension:residentialStatus	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:treatmentCategory	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.extension:treatmentCategory	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:nhsCommunication	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.extension:nhsCommunication	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:birthPlace	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.extension:birthPlace	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:nominatedPharmacy	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.extension:nominatedPharmacy	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.extension:deathNotificationStatus	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.extension:deathNotificationStatus	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.birthDate.extension:patient-birthTime	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
ext-1	Patient.birthDate.extension:patient-birthTime	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Patient.contact	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())
pat-1	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()
ele-1	Patient.link	All FHIR elements must have a @value or children : hasValue() \| (children().count() > id.count())