Social Care Interoperability Platform FHIR Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: MODS Patient

This profile defines the MODS constraints and extensions on the UKCore FHIR Resource Patient

Usages:

• Refer to this Profile: MODS About Me Observation, MODS Activity Task, MODS Care Needs Assessment Observation, MODS Care Plan... Show 10 more, MODS Condition, MODS DSCR $transfer — Input Parameters, MODS DSCR $transfer — Output Parameters, MODS Flag, MODS Instruction Task, MODS Need Observation, MODS Preference Observation, MODS Risk Assessment Observation, MODS Risk Observation and MODS Wish Observation
• Examples for this Profile: Patient/4262416e-b333-4a7e-b3f2-5d5edd7e7fd5

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	UKCorePatient	Information about an individual or animal receiving health care services Constraints: female-pregnancystatus-required, female-pregnancystatus-notpermitted
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		5..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace	N	0..1	(Complex)	The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]	N	1..1	Address	The registered place of birth of the patient.
extension:birthSex	S	1..1	CodeableConcept	An extension to support the patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required)
extension:cadavericDonor	N	0..1	(Complex)	Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
value[x]	N	1..1	boolean	Post-mortem donor status.
extension:contactPreference	N	0..1	(Complex)	The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
extension:deathNotificationStatus	N	0..1	(Complex)	The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
extension:ethnicCategory	S	1..1	CodeableConcept	Ethnic category URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (extensible): A set of codes that define the ethnicity of a person, as specified by the person.
extension:residentialStatus	N	0..1	CodeableConcept	The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible)
extension:patientInterpreterRequired	N	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	N	1..1	boolean	Indicator showing whether the patient needs an interpreter
extension:nhsNumberUnavailableReason	N	0..1	CodeableConcept	Reason why this Patient does not include an NHS Number identifier URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason Binding: UK Core NHS Number Unavailable Reason (extensible)
extension:careProvider		0..*	Reference(MODS Organization)	Extension MODS Person Care Provider URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
extension:deathDetails		0..1	(Complex)	Extension MODS Person Death Details URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonDeathDetails
extension:pregnancyStatus		0..1	Coding	Extension MODS Female Pregnancy Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-FemalePregnancyStatus Binding: MODS Female Pregnancy Status (required)
extension:genderIdentity	S	1..1	Coding	Extension MODS Person Gender Identity URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonGenderIdentity Binding: MODS Person Gender Identity Code (required)
extension:immigrationStatus		0..1	string	Extension MODS Person Immigration Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonImmigrationStatus
extension:otherNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:ordinarilyResidentIn		0..1	Reference(MODS Organization)	Extension MODS Person Ordinarily Resident In URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonOrdinarilyResidentIn
extension:primaryNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:pronouns		0..1	string	Extension MODS Person Pronoun(s) URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonPronoun
extension:religiousAffiliation	S	1..1	Coding	Extension MODS Religious Affiliation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonReligiousAffiliation Binding: MODS Person Religion Code (required)
extension:sexualOrientation	S	1..1	Coding	Extension MODS Sexual Orientation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonSexualOrientation Binding: MODS Person Sexual Orientation Code (required)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣN	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:nhsNumber	ΣN	0..1	Identifier	The patient's NHS number
Slices for extension				Content/Rules for all slices
extension:nhsNumberVerificationStatus	N	0..1	CodeableConcept	NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required)
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:nino	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/Id/nino
value	Σ	1..1	string	The value that is unique Example General: 123456
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	0..*	HumanName	A name associated with the patient
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	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
Slices for telecom	SΣC	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Constraints: cpt-2
telecom:All Slices				Content/Rules for all slices
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
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact 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	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email	SΣC	0..*	ContactPoint	A contact detail for the individual Constraints: cpt-2
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:emailAddressType	S	1..1	Coding	Extension MODS Person Email Address Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType Binding: MODS Email Address Type (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
Slices for extension				Content/Rules for all slices
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value	SΣ	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): Use of contact point.
telecom:phone	SΣC	0..*	ContactPoint	A contact detail for the individual Constraints: cpt-2
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:telephoneNumberType	S	1..1	Coding	Extension MODS Person Telephone Number Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType Binding: MODS Person Telephone Number Type Code (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
Slices for extension				Content/Rules for all slices
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value	SΣ	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): Use of contact point.
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
extension:birthTime	N	0..1	(Complex)	Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	N	1..1	dateTime	Time of day of birth.
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:addressKey	N	0..*	(Complex)	A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
extension:addressCountry	S	1..1	Coding	Extension MODS Address Country URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry Binding: MODS Country (required)
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MODS Person Marital Status Code (required)
generalPractitioner	C	0..*	Reference(MODS Organization)	Patient's nominated primary care provider Constraints: ref-1
managingOrganization	ΣC	0..1	Reference(MODS Organization)	Organization that is the custodian of the patient record Constraints: ref-1
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to Constraints: ref-1
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	Status	Usage	ValueSet	Version	Source
Patient.identifier:nhsNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nino.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	required	MODS Person Marital Status Code	📦0.1.0	This IG
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
cpt-2	error	Patient.telecom, Patient.telecom:email, Patient.telecom:phone	A system is required if a value is provided.	value.empty() or system.exists()
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()
female-pregnancystatus-notpermitted	error	Patient	Pregnancy status NOT permitted when gender (administrative sex) !== female.	$this.extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists() implies gender = 'female'
female-pregnancystatus-required	error	Patient	REQUIRED when gender (administrative sex) === female	$this.gender = 'female' implies extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists()
ref-1	error	Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other	SHALL have a contained resource if a local reference is provided	reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from UKCorePatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	UKCorePatient	Information about an individual or animal receiving health care services Constraints: female-pregnancystatus-required, female-pregnancystatus-notpermitted
extension		5..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:birthSex	S	1..1	ExtensionUKCoreBirthSex	An extension to support the patient's phenotypic sex at birth.
extension:ethnicCategory	S	1..1	ExtensionUKCoreEthnicCategory	Ethnic category
extension:careProvider		0..*	Reference(MODS Organization)	Extension MODS Person Care Provider URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
extension:deathDetails		0..1	(Complex)	Extension MODS Person Death Details URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonDeathDetails
extension:pregnancyStatus		0..1	Coding	Extension MODS Female Pregnancy Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-FemalePregnancyStatus Binding: MODS Female Pregnancy Status (required)
extension:genderIdentity	S	1..1	Coding	Extension MODS Person Gender Identity URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonGenderIdentity Binding: MODS Person Gender Identity Code (required)
extension:immigrationStatus		0..1	string	Extension MODS Person Immigration Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonImmigrationStatus
extension:otherNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:ordinarilyResidentIn		0..1	Reference(MODS Organization)	Extension MODS Person Ordinarily Resident In URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonOrdinarilyResidentIn
extension:primaryNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:pronouns		0..1	string	Extension MODS Person Pronoun(s) URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonPronoun
extension:religiousAffiliation	S	1..1	Coding	Extension MODS Religious Affiliation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonReligiousAffiliation Binding: MODS Person Religion Code (required)
extension:sexualOrientation	S	1..1	Coding	Extension MODS Sexual Orientation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonSexualOrientation Binding: MODS Person Sexual Orientation Code (required)
Slices for identifier				Content/Rules for all slices
identifier:nino	S	0..1	Identifier	An identifier for this patient
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: NI
display		0..1	string	Representation defined by the system Required Pattern: National Insurance Number
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/Id/nino
value		1..1	string	The value that is unique
Slices for telecom		0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:email		0..*	ContactPoint	A contact detail for the individual
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:emailAddressType	S	1..1	Coding	Extension MODS Person Email Address Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType Binding: MODS Email Address Type (required)
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: email
value		1..1	string	The actual contact point details
telecom:phone		0..*	ContactPoint	A contact detail for the individual
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:telephoneNumberType	S	1..1	Coding	Extension MODS Person Telephone Number Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType Binding: MODS Person Telephone Number Type Code (required)
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
value		1..1	string	The actual contact point details
address
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:addressCountry	S	1..1	Coding	Extension MODS Address Country URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry Binding: MODS Country (required)
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MODS Person Marital Status Code (required)
generalPractitioner		0..*	Reference(MODS Organization)	Patient's nominated primary care provider
managingOrganization		0..1	Reference(MODS Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.maritalStatus	Base	required	MODS Person Marital Status Code	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
female-pregnancystatus-notpermitted	error	Patient	Pregnancy status NOT permitted when gender (administrative sex) !== female.	$this.extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists() implies gender = 'female'
female-pregnancystatus-required	error	Patient	REQUIRED when gender (administrative sex) === female	$this.gender = 'female' implies extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists()

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	UKCorePatient	Information about an individual or animal receiving health care services Constraints: female-pregnancystatus-required, female-pregnancystatus-notpermitted
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		5..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace	N	0..1	(Complex)	The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]	N	1..1	Address	The registered place of birth of the patient.
extension:birthSex	S	1..1	CodeableConcept	An extension to support the patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required)
extension:cadavericDonor	N	0..1	(Complex)	Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
value[x]	N	1..1	boolean	Post-mortem donor status.
extension:contactPreference	N	0..1	(Complex)	The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
extension:deathNotificationStatus	N	0..1	(Complex)	The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
extension:ethnicCategory	S	1..1	CodeableConcept	Ethnic category URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (extensible): A set of codes that define the ethnicity of a person, as specified by the person.
extension:residentialStatus	N	0..1	CodeableConcept	The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible)
extension:patientInterpreterRequired	N	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	N	1..1	boolean	Indicator showing whether the patient needs an interpreter
extension:nhsNumberUnavailableReason	N	0..1	CodeableConcept	Reason why this Patient does not include an NHS Number identifier URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason Binding: UK Core NHS Number Unavailable Reason (extensible)
extension:careProvider		0..*	Reference(MODS Organization)	Extension MODS Person Care Provider URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
extension:deathDetails		0..1	(Complex)	Extension MODS Person Death Details URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonDeathDetails
extension:pregnancyStatus		0..1	Coding	Extension MODS Female Pregnancy Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-FemalePregnancyStatus Binding: MODS Female Pregnancy Status (required)
extension:genderIdentity	S	1..1	Coding	Extension MODS Person Gender Identity URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonGenderIdentity Binding: MODS Person Gender Identity Code (required)
extension:immigrationStatus		0..1	string	Extension MODS Person Immigration Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonImmigrationStatus
extension:otherNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:ordinarilyResidentIn		0..1	Reference(MODS Organization)	Extension MODS Person Ordinarily Resident In URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonOrdinarilyResidentIn
extension:primaryNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:pronouns		0..1	string	Extension MODS Person Pronoun(s) URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonPronoun
extension:religiousAffiliation	S	1..1	Coding	Extension MODS Religious Affiliation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonReligiousAffiliation Binding: MODS Person Religion Code (required)
extension:sexualOrientation	S	1..1	Coding	Extension MODS Sexual Orientation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonSexualOrientation Binding: MODS Person Sexual Orientation Code (required)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣN	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:nhsNumber	ΣN	0..1	Identifier	The patient's NHS number
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nhsNumberVerificationStatus	N	0..1	CodeableConcept	NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required)
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	ΣN	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	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	ΣCN	0..1	Period	Time period when id is/was valid for use Constraints: per-1
assigner	ΣCN	0..1	Reference(Organization)	Organization that issued id (may be just text) Constraints: ref-1
identifier:nino	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
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.
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: NI
display	Σ	0..1	string	Representation defined by the system Required Pattern: National Insurance Number
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/Id/nino
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	0..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	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	ΣC	0..1	Period	Time period when name was/is in use Constraints: per-1
Slices for telecom	SΣC	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Constraints: cpt-2
telecom:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	code	Primitive value for code Max Length:1048576
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use Constraints: per-1
telecom:email	SΣC	0..*	ContactPoint	A contact detail for the individual Constraints: cpt-2
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:emailAddressType	S	1..1	Coding	Extension MODS Person Email Address Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType Binding: MODS Email Address Type (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	code	Primitive value for code Max Length:1048576
value	SΣ	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): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use Constraints: per-1
telecom:phone	SΣC	0..*	ContactPoint	A contact detail for the individual Constraints: cpt-2
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:telephoneNumberType	S	1..1	Coding	Extension MODS Person Telephone Number Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType Binding: MODS Person Telephone Number Type Code (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	code	Primitive value for code Max Length:1048576
value	SΣ	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): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use Constraints: per-1
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:birthTime	N	0..1	(Complex)	Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	N	1..1	dateTime	Time of day of birth.
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:addressKey	N	0..*	(Complex)	A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
extension:addressCountry	S	1..1	Coding	Extension MODS Address Country URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry Binding: MODS Country (required)
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	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	Σ	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	ΣC	0..1	Period	Time period when address was/is in use Constraints: per-1 Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MODS Person Marital Status Code (required)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo	C	0..*	Attachment	Image of the patient Constraints: att-1
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactRank	N	0..1	positiveInt	Preferred ranking or order of contact applied to a contact on a patient's contact list URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank
extension:copyCorrespondenceIndicator	N	0..1	boolean	Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom	C	0..*	ContactPoint	A contact detail for the person Constraints: cpt-2
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	code	Primitive value for code Max Length:1048576
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use Constraints: per-1
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact Constraints: ref-1
period	C	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient Constraints: per-1
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:proficiency	N	0..1	(Complex)	Proficiency level of the communication URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:level	N	0..1	Extension	The proficiency level of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"level"
value[x]	N	1..1	Coding	The proficiency level for the communication Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication.
extension:type	N	0..*	Extension	The proficiency type of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"type"
value[x]	N	1..1	Coding	The proficiency type for the communication Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-proficiency"
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	A ValueSet that identifies the language used by a person. Binding: AllLanguages (required): A ValueSet that identifies the language used by a person. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	C	0..*	Reference(MODS Organization)	Patient's nominated primary care provider Constraints: ref-1
managingOrganization	ΣC	0..1	Reference(MODS Organization)	Organization that is the custodian of the patient record Constraints: ref-1
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to Constraints: ref-1
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	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.identifier:nhsNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nhsNumber.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.identifier:nino.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nino.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	required	MODS Person Marital Status Code	📦0.1.0	This IG
Patient.contact.relationship	Base	extensible	UK Core Person Relationship Type	📦2.1.0	fhir.r4.ukcore.stu2 v2.0
Patient.contact.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.contact.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​extension:proficiency.​extension:level.value[x]	Base	preferred	LanguageAbilityProficiency	📦3.0.0	THO v7.1
Patient.communication.​extension:proficiency.​extension:type.value[x]	Base	preferred	LanguageAbilityMode	📦3.0.0	THO v7.1
Patient.communication.​language	Base	required	All Languages	📦4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
att-1	error	Patient.photo	If the Attachment has data, it SHALL have a contentType	data.empty() or contentType.exists()
cpt-2	error	Patient.telecom, Patient.telecom:email, Patient.telecom:phone, Patient.contact.telecom	A system is required if a value is provided.	value.empty() or system.exists()
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()
female-pregnancystatus-notpermitted	error	Patient	Pregnancy status NOT permitted when gender (administrative sex) !== female.	$this.extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists() implies gender = 'female'
female-pregnancystatus-required	error	Patient	REQUIRED when gender (administrative sex) === female	$this.gender = 'female' implies extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').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()
per-1	error	Patient.identifier:nhsNumber.period, Patient.name.period, Patient.telecom.period, Patient.telecom:email.period, Patient.telecom:phone.period, Patient.address.period, Patient.contact.telecom.period, Patient.contact.period	If present, start SHALL have a lower value than end	start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Patient.identifier:nhsNumber.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other	SHALL have a contained resource if a local reference is provided	reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from UKCorePatient

Summary

Mandatory: 6 elements(12 nested mandatory elements)
Must-Support: 10 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• MODS Organization (https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization)

Extensions

This structure refers to these extensions:

• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonDeathDetails
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-FemalePregnancyStatus
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonGenderIdentity
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonImmigrationStatus
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonOrdinarilyResidentIn
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonPronoun
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonReligiousAffiliation
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonSexualOrientation
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.telecom

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	UKCorePatient	Information about an individual or animal receiving health care services Constraints: female-pregnancystatus-required, female-pregnancystatus-notpermitted
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for extension		5..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace	N	0..1	(Complex)	The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]	N	1..1	Address	The registered place of birth of the patient.
extension:birthSex	S	1..1	CodeableConcept	An extension to support the patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required)
extension:cadavericDonor	N	0..1	(Complex)	Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
value[x]	N	1..1	boolean	Post-mortem donor status.
extension:contactPreference	N	0..1	(Complex)	The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
extension:deathNotificationStatus	N	0..1	(Complex)	The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
extension:ethnicCategory	S	1..1	CodeableConcept	Ethnic category URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (extensible): A set of codes that define the ethnicity of a person, as specified by the person.
extension:residentialStatus	N	0..1	CodeableConcept	The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible)
extension:patientInterpreterRequired	N	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	N	1..1	boolean	Indicator showing whether the patient needs an interpreter
extension:nhsNumberUnavailableReason	N	0..1	CodeableConcept	Reason why this Patient does not include an NHS Number identifier URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason Binding: UK Core NHS Number Unavailable Reason (extensible)
extension:careProvider		0..*	Reference(MODS Organization)	Extension MODS Person Care Provider URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
extension:deathDetails		0..1	(Complex)	Extension MODS Person Death Details URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonDeathDetails
extension:pregnancyStatus		0..1	Coding	Extension MODS Female Pregnancy Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-FemalePregnancyStatus Binding: MODS Female Pregnancy Status (required)
extension:genderIdentity	S	1..1	Coding	Extension MODS Person Gender Identity URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonGenderIdentity Binding: MODS Person Gender Identity Code (required)
extension:immigrationStatus		0..1	string	Extension MODS Person Immigration Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonImmigrationStatus
extension:otherNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:ordinarilyResidentIn		0..1	Reference(MODS Organization)	Extension MODS Person Ordinarily Resident In URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonOrdinarilyResidentIn
extension:primaryNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:pronouns		0..1	string	Extension MODS Person Pronoun(s) URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonPronoun
extension:religiousAffiliation	S	1..1	Coding	Extension MODS Religious Affiliation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonReligiousAffiliation Binding: MODS Person Religion Code (required)
extension:sexualOrientation	S	1..1	Coding	Extension MODS Sexual Orientation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonSexualOrientation Binding: MODS Person Sexual Orientation Code (required)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣN	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:nhsNumber	ΣN	0..1	Identifier	The patient's NHS number
Slices for extension				Content/Rules for all slices
extension:nhsNumberVerificationStatus	N	0..1	CodeableConcept	NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required)
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number
value	SΣ	1..1	string	The value that is unique Example General: 123456
identifier:nino	SΣ	0..1	Identifier	An identifier for this patient
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/Id/nino
value	Σ	1..1	string	The value that is unique Example General: 123456
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	0..*	HumanName	A name associated with the patient
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	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
Slices for telecom	SΣC	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Constraints: cpt-2
telecom:All Slices				Content/Rules for all slices
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
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact 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	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
telecom:email	SΣC	0..*	ContactPoint	A contact detail for the individual Constraints: cpt-2
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:emailAddressType	S	1..1	Coding	Extension MODS Person Email Address Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType Binding: MODS Email Address Type (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
Slices for extension				Content/Rules for all slices
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value	SΣ	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): Use of contact point.
telecom:phone	SΣC	0..*	ContactPoint	A contact detail for the individual Constraints: cpt-2
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:telephoneNumberType	S	1..1	Coding	Extension MODS Person Telephone Number Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType Binding: MODS Person Telephone Number Type Code (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
Slices for extension				Content/Rules for all slices
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value	SΣ	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): Use of contact point.
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
Slices for extension				Content/Rules for all slices
extension:birthTime	N	0..1	(Complex)	Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	N	1..1	dateTime	Time of day of birth.
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:addressKey	N	0..*	(Complex)	A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
extension:addressCountry	S	1..1	Coding	Extension MODS Address Country URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry Binding: MODS Country (required)
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
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
postalCode	SΣ	0..1	string	Postal code for area Example General: 9132
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MODS Person Marital Status Code (required)
generalPractitioner	C	0..*	Reference(MODS Organization)	Patient's nominated primary care provider Constraints: ref-1
managingOrganization	ΣC	0..1	Reference(MODS Organization)	Organization that is the custodian of the patient record Constraints: ref-1
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to Constraints: ref-1
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	Status	Usage	ValueSet	Version	Source
Patient.identifier:nhsNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nino.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	required	MODS Person Marital Status Code	📦0.1.0	This IG
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
cpt-2	error	Patient.telecom, Patient.telecom:email, Patient.telecom:phone	A system is required if a value is provided.	value.empty() or system.exists()
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()
female-pregnancystatus-notpermitted	error	Patient	Pregnancy status NOT permitted when gender (administrative sex) !== female.	$this.extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists() implies gender = 'female'
female-pregnancystatus-required	error	Patient	REQUIRED when gender (administrative sex) === female	$this.gender = 'female' implies extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists()
ref-1	error	Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other	SHALL have a contained resource if a local reference is provided	reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

Differential View

This structure is derived from UKCorePatient

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	UKCorePatient	Information about an individual or animal receiving health care services Constraints: female-pregnancystatus-required, female-pregnancystatus-notpermitted
extension		5..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:birthSex	S	1..1	ExtensionUKCoreBirthSex	An extension to support the patient's phenotypic sex at birth.
extension:ethnicCategory	S	1..1	ExtensionUKCoreEthnicCategory	Ethnic category
extension:careProvider		0..*	Reference(MODS Organization)	Extension MODS Person Care Provider URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
extension:deathDetails		0..1	(Complex)	Extension MODS Person Death Details URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonDeathDetails
extension:pregnancyStatus		0..1	Coding	Extension MODS Female Pregnancy Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-FemalePregnancyStatus Binding: MODS Female Pregnancy Status (required)
extension:genderIdentity	S	1..1	Coding	Extension MODS Person Gender Identity URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonGenderIdentity Binding: MODS Person Gender Identity Code (required)
extension:immigrationStatus		0..1	string	Extension MODS Person Immigration Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonImmigrationStatus
extension:otherNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:ordinarilyResidentIn		0..1	Reference(MODS Organization)	Extension MODS Person Ordinarily Resident In URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonOrdinarilyResidentIn
extension:primaryNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:pronouns		0..1	string	Extension MODS Person Pronoun(s) URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonPronoun
extension:religiousAffiliation	S	1..1	Coding	Extension MODS Religious Affiliation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonReligiousAffiliation Binding: MODS Person Religion Code (required)
extension:sexualOrientation	S	1..1	Coding	Extension MODS Sexual Orientation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonSexualOrientation Binding: MODS Person Sexual Orientation Code (required)
Slices for identifier				Content/Rules for all slices
identifier:nino	S	0..1	Identifier	An identifier for this patient
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
type
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
code		0..1	code	Symbol in syntax defined by the system Required Pattern: NI
display		0..1	string	Representation defined by the system Required Pattern: National Insurance Number
system		1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/Id/nino
value		1..1	string	The value that is unique
Slices for telecom		0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system
telecom:email		0..*	ContactPoint	A contact detail for the individual
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:emailAddressType	S	1..1	Coding	Extension MODS Person Email Address Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType Binding: MODS Email Address Type (required)
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: email
value		1..1	string	The actual contact point details
telecom:phone		0..*	ContactPoint	A contact detail for the individual
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:telephoneNumberType	S	1..1	Coding	Extension MODS Person Telephone Number Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType Binding: MODS Person Telephone Number Type Code (required)
system		1..1	code	phone | fax | email | pager | url | sms | other Required Pattern: phone
value		1..1	string	The actual contact point details
address
extension		1..*	Extension	Extension
Slices for extension				Content/Rules for all slices
extension:addressCountry	S	1..1	Coding	Extension MODS Address Country URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry Binding: MODS Country (required)
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MODS Person Marital Status Code (required)
generalPractitioner		0..*	Reference(MODS Organization)	Patient's nominated primary care provider
managingOrganization		0..1	Reference(MODS Organization)	Organization that is the custodian of the patient record
Documentation for this format

Terminology Bindings (Differential)

Path	Status	Usage	ValueSet	Version	Source
Patient.maritalStatus	Base	required	MODS Person Marital Status Code	📦0.1.0	This IG

Constraints

Id	Grade	Path(s)	Description	Expression
female-pregnancystatus-notpermitted	error	Patient	Pregnancy status NOT permitted when gender (administrative sex) !== female.	$this.extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists() implies gender = 'female'
female-pregnancystatus-required	error	Patient	REQUIRED when gender (administrative sex) === female	$this.gender = 'female' implies extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Patient	C	0..*	UKCorePatient	Information about an individual or animal receiving health care services Constraints: female-pregnancystatus-required, female-pregnancystatus-notpermitted
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
Slices for extension		5..*	Extension	Extension Slice: Unordered, Open by value:url
extension:birthPlace	N	0..1	(Complex)	The registered place of birth of the patient. URL: http://hl7.org/fhir/StructureDefinition/patient-birthPlace
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthPlace"
value[x]	N	1..1	Address	The registered place of birth of the patient.
extension:birthSex	S	1..1	CodeableConcept	An extension to support the patient's phenotypic sex at birth. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSex Binding: UK Core Birth Sex (required)
extension:cadavericDonor	N	0..1	(Complex)	Post-mortem donor status. URL: http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-cadavericDonor"
value[x]	N	1..1	boolean	Post-mortem donor status.
extension:contactPreference	N	0..1	(Complex)	The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
extension:deathNotificationStatus	N	0..1	(Complex)	The patient's death notification status. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatus
extension:ethnicCategory	S	1..1	CodeableConcept	Ethnic category URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategory Binding: UK Core Ethnic Category (extensible): A set of codes that define the ethnicity of a person, as specified by the person.
extension:residentialStatus	N	0..1	CodeableConcept	The residential status of the patient. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatus Binding: UK Core Residential Status (extensible)
extension:patientInterpreterRequired	N	0..1	(Complex)	Whether the patient needs an interpreter URL: http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired"
value[x]	N	1..1	boolean	Indicator showing whether the patient needs an interpreter
extension:nhsNumberUnavailableReason	N	0..1	CodeableConcept	Reason why this Patient does not include an NHS Number identifier URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberUnavailableReason Binding: UK Core NHS Number Unavailable Reason (extensible)
extension:careProvider		0..*	Reference(MODS Organization)	Extension MODS Person Care Provider URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
extension:deathDetails		0..1	(Complex)	Extension MODS Person Death Details URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonDeathDetails
extension:pregnancyStatus		0..1	Coding	Extension MODS Female Pregnancy Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-FemalePregnancyStatus Binding: MODS Female Pregnancy Status (required)
extension:genderIdentity	S	1..1	Coding	Extension MODS Person Gender Identity URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonGenderIdentity Binding: MODS Person Gender Identity Code (required)
extension:immigrationStatus		0..1	string	Extension MODS Person Immigration Status URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonImmigrationStatus
extension:otherNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:ordinarilyResidentIn		0..1	Reference(MODS Organization)	Extension MODS Person Ordinarily Resident In URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonOrdinarilyResidentIn
extension:primaryNationality		0..1	Coding	Extension MODS Person Nationality URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality Binding: MODS Country (required)
extension:pronouns		0..1	string	Extension MODS Person Pronoun(s) URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonPronoun
extension:religiousAffiliation	S	1..1	Coding	Extension MODS Religious Affiliation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonReligiousAffiliation Binding: MODS Person Religion Code (required)
extension:sexualOrientation	S	1..1	Coding	Extension MODS Sexual Orientation URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonSexualOrientation Binding: MODS Person Sexual Orientation Code (required)
modifierExtension	?!N	0..*	Extension	Extensions that cannot be ignored Slice: Unordered, Open by value:url
Slices for identifier	SΣN	0..*	Identifier	An identifier for this patient Slice: Unordered, Open by value:system
identifier:nhsNumber	ΣN	0..1	Identifier	The patient's NHS number
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:nhsNumberVerificationStatus	N	0..1	CodeableConcept	NHS number verification status URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatus Binding: UK Core NHS Number Verification Status (required)
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	ΣN	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	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.nhs.uk/Id/nhs-number
value	SΣ	1..1	string	The value that is unique Example General: 123456
period	ΣCN	0..1	Period	Time period when id is/was valid for use Constraints: per-1
assigner	ΣCN	0..1	Reference(Organization)	Organization that issued id (may be just text) Constraints: ref-1
identifier:nino	SΣ	0..1	Identifier	An identifier for this 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	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
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.
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	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v2-0203
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system Required Pattern: NI
display	Σ	0..1	string	Representation defined by the system Required Pattern: National Insurance Number
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
system	Σ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.hl7.org.uk/Id/nino
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
active	?!SΣ	0..1	boolean	Whether this patient's record is in active use
name	SΣ	0..*	HumanName	A name associated with the patient
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	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	ΣC	0..1	Period	Time period when name was/is in use Constraints: per-1
Slices for telecom	SΣC	0..*	ContactPoint	A contact detail for the individual Slice: Unordered, Open by value:system Constraints: cpt-2
telecom:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	code	Primitive value for code Max Length:1048576
value	SΣ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use Constraints: per-1
telecom:email	SΣC	0..*	ContactPoint	A contact detail for the individual Constraints: cpt-2
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:emailAddressType	S	1..1	Coding	Extension MODS Person Email Address Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType Binding: MODS Email Address Type (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: email
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	code	Primitive value for code Max Length:1048576
value	SΣ	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): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use Constraints: per-1
telecom:phone	SΣC	0..*	ContactPoint	A contact detail for the individual Constraints: cpt-2
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:telephoneNumberType	S	1..1	Coding	Extension MODS Person Telephone Number Type URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType Binding: MODS Person Telephone Number Type Code (required)
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Required Pattern: phone
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	code	Primitive value for code Max Length:1048576
value	SΣ	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): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use Constraints: per-1
gender	SΣ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	SΣ	0..1	date	The date of birth for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:birthTime	N	0..1	(Complex)	Time of day of birth. URL: http://hl7.org/fhir/StructureDefinition/patient-birthTime
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-birthTime"
value[x]	N	1..1	dateTime	Time of day of birth.
value		0..1	date	Primitive value for date
deceased[x]	?!Σ	0..1		Indicates if the individual is deceased or not
deceasedBoolean			boolean
deceasedDateTime			dateTime
address	SΣ	0..*	Address	An address for the individual
id		0..1	string	Unique id for inter-element referencing
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:addressKey	N	0..*	(Complex)	A patient's address key and type URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey
extension:addressCountry	S	1..1	Coding	Extension MODS Address Country URL: https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry Binding: MODS Country (required)
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	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	Σ	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	ΣC	0..1	Period	Time period when address was/is in use Constraints: per-1 Example General: {"start":"2010-03-23","end":"2010-07-01"}
maritalStatus	S	1..1	CodeableConcept	Marital (civil) status of a patient Binding: MODS Person Marital Status Code (required)
multipleBirth[x]		0..1		Whether patient is part of a multiple birth
multipleBirthBoolean			boolean
multipleBirthInteger			integer
photo	C	0..*	Attachment	Image of the patient Constraints: att-1
contact	C	0..*	BackboneElement	A contact party (e.g. guardian, partner, friend) for the patient Constraints: pat-1
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:contactRank	N	0..1	positiveInt	Preferred ranking or order of contact applied to a contact on a patient's contact list URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank
extension:copyCorrespondenceIndicator	N	0..1	boolean	Indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
relationship		0..*	CodeableConcept	The kind of relationship Binding: UK Core Person Relationship Type (extensible): The nature of the relationship between a patient and a contact person for that patient.
name		0..1	HumanName	A name associated with the contact person
telecom	C	0..*	ContactPoint	A contact detail for the person Constraints: cpt-2
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	ΣC	0..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:otherContactSystem	N	0..1	CodeableConcept	Other contact system URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	code	Primitive value for code Max Length:1048576
value	Σ	0..1	string	The actual contact point details
use	?!Σ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	ΣC	0..1	Period	Time period when the contact point was/is in use Constraints: per-1
address		0..1	Address	Address for the contact person
gender		0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
organization	C	0..1	Reference(Organization)	Organization that is associated with the contact Constraints: ref-1
period	C	0..1	Period	The period during which this contact person or organization is valid to be contacted relating to this patient Constraints: per-1
communication		0..*	BackboneElement	A language which may be used to communicate with the patient about his or her health
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:proficiency	N	0..1	(Complex)	Proficiency level of the communication URL: http://hl7.org/fhir/StructureDefinition/patient-proficiency
id		0..1	string	Unique id for inter-element referencing
Slices for extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:level	N	0..1	Extension	The proficiency level of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"level"
value[x]	N	1..1	Coding	The proficiency level for the communication Binding: LanguageAbilityProficiency (preferred): The proficiency level for the communication.
extension:type	N	0..*	Extension	The proficiency type of the communication
id		0..1	string	Unique id for inter-element referencing
extension	N	0..0		Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	"type"
value[x]	N	1..1	Coding	The proficiency type for the communication Binding: LanguageAbilityMode (preferred): The proficiency type for the communication.
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/patient-proficiency"
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	A ValueSet that identifies the language used by a person. Binding: AllLanguages (required): A ValueSet that identifies the language used by a person. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
generalPractitioner	C	0..*	Reference(MODS Organization)	Patient's nominated primary care provider Constraints: ref-1
managingOrganization	ΣC	0..1	Reference(MODS Organization)	Organization that is the custodian of the patient record Constraints: ref-1
link	?!Σ	0..*	BackboneElement	Link to another patient resource that concerns the same actual person
id		0..1	string	Unique id for inter-element referencing
extension	N	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
other	ΣC	1..1	Reference(Patient | RelatedPerson)	The other patient or related person resource that the link refers to Constraints: ref-1
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	Status	Usage	ValueSet	Version	Source
Patient.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
Patient.identifier:nhsNumber.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nhsNumber.​type	Base	extensible	IdentifierType	📦4.0.1	FHIR Std.
Patient.identifier:nino.​use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Patient.identifier:nino.​type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Patient.name.use	Base	required	NameUse	📍4.0.1	FHIR Std.
Patient.telecom.system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom.use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:email.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:email.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.telecom:phone.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.telecom:phone.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.address.use	Base	required	AddressUse	📍4.0.1	FHIR Std.
Patient.address.type	Base	required	AddressType	📍4.0.1	FHIR Std.
Patient.maritalStatus	Base	required	MODS Person Marital Status Code	📦0.1.0	This IG
Patient.contact.relationship	Base	extensible	UK Core Person Relationship Type	📦2.1.0	fhir.r4.ukcore.stu2 v2.0
Patient.contact.telecom.​system	Base	required	ContactPointSystem	📍4.0.1	FHIR Std.
Patient.contact.telecom.​use	Base	required	ContactPointUse	📍4.0.1	FHIR Std.
Patient.contact.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
Patient.communication.​extension:proficiency.​extension:level.value[x]	Base	preferred	LanguageAbilityProficiency	📦3.0.0	THO v7.1
Patient.communication.​extension:proficiency.​extension:type.value[x]	Base	preferred	LanguageAbilityMode	📦3.0.0	THO v7.1
Patient.communication.​language	Base	required	All Languages	📦4.0.1	FHIR Std.
Patient.link.type	Base	required	LinkType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
att-1	error	Patient.photo	If the Attachment has data, it SHALL have a contentType	data.empty() or contentType.exists()
cpt-2	error	Patient.telecom, Patient.telecom:email, Patient.telecom:phone, Patient.contact.telecom	A system is required if a value is provided.	value.empty() or system.exists()
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()
female-pregnancystatus-notpermitted	error	Patient	Pregnancy status NOT permitted when gender (administrative sex) !== female.	$this.extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').exists() implies gender = 'female'
female-pregnancystatus-required	error	Patient	REQUIRED when gender (administrative sex) === female	$this.gender = 'female' implies extension.where(url='https://ig.phase2.scip.synanetics.cloud/StructureDefinition/Extension-MODS-FemalePregnancyStatus').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()
per-1	error	Patient.identifier:nhsNumber.period, Patient.name.period, Patient.telecom.period, Patient.telecom:email.period, Patient.telecom:phone.period, Patient.address.period, Patient.contact.telecom.period, Patient.contact.period	If present, start SHALL have a lower value than end	start.hasValue().not() or end.hasValue().not() or (start <= end)
ref-1	error	Patient.identifier:nhsNumber.assigner, Patient.contact.organization, Patient.generalPractitioner, Patient.managingOrganization, Patient.link.other	SHALL have a contained resource if a local reference is provided	reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))

This structure is derived from UKCorePatient

Summary

Mandatory: 6 elements(12 nested mandatory elements)
Must-Support: 10 elements
Fixed: 1 element

Structures

This structure refers to these other structures:

• MODS Organization (https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/MODS-Organization)

Extensions

This structure refers to these extensions:

• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonCareProvider
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonDeathDetails
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-FemalePregnancyStatus
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonGenderIdentity
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonImmigrationStatus
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonNationality
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonOrdinarilyResidentIn
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonPronoun
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonReligiousAffiliation
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonSexualOrientation
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonEmailAddressType
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-PersonTelephoneNumberType
• https://metadata.phase2.scip.synanetics.cloud/fhir/r4/StructureDefinition/Extension-MODS-AddressCountry

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Patient.telecom