Status: DRAFT: For Review

Definition Information about a person that has a relationship with a patient.

Introduction

NB: Whilst the term "Patient" is used by FHIR, the profile is equally relevant to a "citizen", "service user" or "client" in other contexts such as Social Care.

This profile sets minimum expectations for the RelatedPerson resource to record Information about a person who has a relationship with a patient. We use the relatedPerson structure definition as a base to this profile.

This Resource will give the consumer the ability to see information about a person who has a relationship with a patient. The related person will always defined from the position of the patient e.g. This related person is the patient’s mother, spouse, brother etc. In Social Care, a related person may also play one or more roles in the service user’s support.

The RelatedPerson resource provides information about a person who is involved in the care of a patient but has no formal responsibility. RelatedPersons typically have a personal relationship with the patient such as a spouse, relative, friend, guardian, or attorney. RelatedPersons are commonly a source of information about a patient.

The distinction between Practitioner and RelatedPerson is a practitioner cares for multiple patients on behalf of a healthcare facility where a RelatedPerson performs care tasks for a specific patient and may not be associated with any healthcare facility.

Coverage and references

• A Data Provider MUST offer RelatedPerson FHIR resources to represent its own patients' relationships (those that are relevant for regional sharing).

• The related person resource does not negate the use of the patient.contact field. This should still be used to specify the person who should be contacted in an emergency, and the related person should be used to model all other relationships.

• When referencing a RelatedPerson the "reference" (URL of FHIR Resource) and "display" (related person's name) MUST be populated.

Mandatory fields

The following fields are mandatory:

1. name - "usual" name, what they liked to be known as, including given and family names. Its only relevant to capture the person's current name, no history is required.

2. active - A mandatory flag to indicate whether the relatedPerson record is active.

3. patient - To whom this person has a relationship with.

4. relationship - How this person is related to the patient e.g. mother, spouse, brother etc.

Must Support fields

In addition, the following fields are "Must Support" - i.e. they must be populated if relevant and known:

1. telecom - how the related person can be contacted e.g. phone and/or email details. It's only relevant to capture the person's current contact details, no telecom history is appropriate.

2. socialCareSupportRole (Extension) - This extension has been developed for use by the Social Care sector, who have a requirement to model the role(s) which a related person plays in a service user's support. We have specified a preferred interweave valueset for populating this field, which was developed with the Social Care Data Standards working group. Please note, that if ‘Other’ is entered here, then it is essential to provide additional detail of the role within the text field.

Background to extension: Initially we looked at whether we should relationship field, given role is a different concept, it was agreed that this should be represented by a separate field.

1. period - The period during which the relationship existed.

2. address - Can be provided if known and relevant. Only the person's current address should be captured.

Optional fields

Other fields are optional and may be populated if known - on the understanding that not all data consumers will necessarily make use of them. Optional fields to note include:

• contactPreference (Extension) - The preferred method of contact, contact times and written communication format given by a Patient or Related Person.

• copyCorrespondenceIndicator (Extension) - Extension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence.

• gender and birthDate - These can be provided if known, but it is felt that these do not add much value to the related person record.

• identifier:localIdentifier - An optional local identifier which may be helpful to identify the record at a local level.

• communication - A language which may be used to communicate with about the patient's health. If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. If no language is specified, this implies that the default local language (English) is spoken.

Discouraged or Removed fields

• photo - removed - not relevant here and adds size and complexity to the content.

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

This structure is derived from UKCoreRelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson			UKCoreRelatedPerson
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension				Content/Rules for all slices
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportRole
Slices for identifier		0..*	Identifier	A human identifier for this person Slice: Unordered, Open by value:system
identifier:localIdentifier		0..1	Identifier	A human identifier for this person
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-RelatedPerson-identifier
value	S	1..1	string	The Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
active		1..1	boolean	Whether this related person's record is in active use.
patient		1..1	Reference(InterweavePatient)	The patient this person is related to.
id		0..0
extension		0..0
reference		1..1	string	Reference to a resource (could be Contained)
type		0..0
identifier		0..1	Identifier	If relevant could include an id
display		1..1	string	Description of the referenced resource
relationship		1..1	CodeableConcept	The nature of the relationship. Binding: UK Core Person Relationship Type (required)
id		0..0
extension		0..0
coding
id		0..0
extension		0..0
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name		1..*	HumanName	A name associated with the person.
id		0..0
extension		0..0
use	S	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..*	string	Parts that come before the name
suffix	S	0..*	string	Parts that come after the name
telecom
id		0..0
extension		0..0
system	S	1..1	code	phone | fax | email | pager | url | sms | other
id		0..0
value	S	1..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
photo		0..0
period	S	0..1	Period	Period of time that this relationship is considered valid
communication
id		0..0
extension		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	required	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	UKCoreRelatedPerson	A person that is related to a patient, but who is not a direct target of care
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension				Content/Rules for all slices
contactPreference		0..1	(Complex)	The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
copyCorrespondenceIndicator		0..1	boolean	Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportRole
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	A human identifier for this person Slice: Unordered, Open by value:system
identifier:localIdentifier	Σ	0..1	Identifier	A human identifier for this person
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.interweavedigital.nhs.uk/Id/local-RelatedPerson-identifier
value	SΣ	1..1	string	The Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use.
patient	SΣ	1..1	Reference(InterweavePatient)	The patient this person is related to.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
relationship	SΣ	1..1	CodeableConcept	The nature of the relationship. Binding: UK Core Person Relationship Type (required)
extension		0..0
name	SΣ	1..*	HumanName	A name associated with the person.
extension		0..0
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	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	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the person.
extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Slices for extension				Content/Rules for all slices
otherContactSystem		0..1	CodeableConcept	Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address	SΣ	0..*	Address	Address where the related person can be contacted or visited.
period	S	0..1	Period	Period of time that this relationship is considered valid
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
RelatedPerson.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
RelatedPerson.relationship	required	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
RelatedPerson.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
RelatedPerson.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	UKCoreRelatedPerson	A person that is related to a patient, but who is not a direct target of care
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
contactPreference		0..1	(Complex)	The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
copyCorrespondenceIndicator		0..1	boolean	Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportRole
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	A human identifier for this person Slice: Unordered, Open by value:system
identifier:localIdentifier	Σ	0..1	Identifier	A human identifier for this person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-RelatedPerson-identifier
value	SΣ	1..1	string	The Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use.
patient	SΣ	1..1	Reference(InterweavePatient)	The patient this person is related to.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
relationship	SΣ	1..1	CodeableConcept	The nature of the relationship. Binding: UK Core Person Relationship Type (required)
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name	SΣ	1..*	HumanName	A name associated with the person.
extension		0..0
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	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	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the person.
extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
otherContactSystem		0..1	CodeableConcept	Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	string	Primitive value for code
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited.
period	S	0..1	Period	Period of time that this relationship is considered valid
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): A language which may be used to communicate with the related person about the patient's health.
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
RelatedPerson.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
RelatedPerson.identifier:localIdentifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
RelatedPerson.relationship	required	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
RelatedPerson.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
RelatedPerson.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.communication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Differential View

This structure is derived from UKCoreRelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson			UKCoreRelatedPerson
id	S	0..1	id	Logical id of this artifact
meta
id		0..0
versionId	S	0..1	id	Version specific identifier
lastUpdated	S	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	S	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security		0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers
Slices for tag		0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system
tag:Source	S	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
version		0..0
code	S	1..1	code	The Data Provider Id of the system supplying the data
display	S	1..1	string	Name of the system supplying the data
tag:Provenance	S	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data
id		0..0
system		1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
version		0..0
code	S	1..1	code	The ODS Code of the organisation responsible for the data
display	S	1..1	string	Name of the organisation supplying the data
implicitRules		0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation)
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension				Content/Rules for all slices
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportRole
Slices for identifier		0..*	Identifier	A human identifier for this person Slice: Unordered, Open by value:system
identifier:localIdentifier		0..1	Identifier	A human identifier for this person
system	S	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-RelatedPerson-identifier
value	S	1..1	string	The Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique
period		0..0
assigner		0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
active		1..1	boolean	Whether this related person's record is in active use.
patient		1..1	Reference(InterweavePatient)	The patient this person is related to.
id		0..0
extension		0..0
reference		1..1	string	Reference to a resource (could be Contained)
type		0..0
identifier		0..1	Identifier	If relevant could include an id
display		1..1	string	Description of the referenced resource
relationship		1..1	CodeableConcept	The nature of the relationship. Binding: UK Core Person Relationship Type (required)
id		0..0
extension		0..0
coding
id		0..0
extension		0..0
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name		1..*	HumanName	A name associated with the person.
id		0..0
extension		0..0
use	S	0..1	code	usual | official | temp | nickname | anonymous | old | maiden
text		0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	S	1..1	string	Family name (often called 'Surname')
given	S	1..*	string	Given names (not always 'first'). Includes middle names
prefix	S	0..*	string	Parts that come before the name
suffix	S	0..*	string	Parts that come after the name
telecom
id		0..0
extension		0..0
system	S	1..1	code	phone | fax | email | pager | url | sms | other
id		0..0
value	S	1..1	string	The actual contact point details
use	S	0..1	code	home | work | temp | old | mobile - purpose of this contact point
photo		0..0
period	S	0..1	Period	Period of time that this relationship is considered valid
communication
id		0..0
extension		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	required	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	UKCoreRelatedPerson	A person that is related to a patient, but who is not a direct target of care
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
Slices for extension				Content/Rules for all slices
contactPreference		0..1	(Complex)	The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
copyCorrespondenceIndicator		0..1	boolean	Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportRole
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	A human identifier for this person Slice: Unordered, Open by value:system
identifier:localIdentifier	Σ	0..1	Identifier	A human identifier for this person
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.interweavedigital.nhs.uk/Id/local-RelatedPerson-identifier
value	SΣ	1..1	string	The Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use.
patient	SΣ	1..1	Reference(InterweavePatient)	The patient this person is related to.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
relationship	SΣ	1..1	CodeableConcept	The nature of the relationship. Binding: UK Core Person Relationship Type (required)
extension		0..0
name	SΣ	1..*	HumanName	A name associated with the person.
extension		0..0
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	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	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
telecom	SΣ	0..*	ContactPoint	A contact detail for the person.
extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Slices for extension				Content/Rules for all slices
otherContactSystem		0..1	CodeableConcept	Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
address	SΣ	0..*	Address	Address where the related person can be contacted or visited.
period	S	0..1	Period	Period of time that this relationship is considered valid
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
RelatedPerson.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
RelatedPerson.relationship	required	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
RelatedPerson.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
RelatedPerson.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	UKCoreRelatedPerson	A person that is related to a patient, but who is not a direct target of care
id	SΣ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	SΣ	0..1	id	Version specific identifier
lastUpdated	SΣ	0..1	instant	MANDATORY except in Contained Resources. When the resource version last changed.
source	Σ	0..1	uri	Identifies where the resource comes from
profile	SΣ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to. Should list (i) this profile (ii) base profile for this resource.
security	Σ	0..*	Coding	DISCOURAGED - may not be honoured by Data Consumers Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Slices for tag	Σ	0..*	Coding	Tags applied to this resource Slice: Unordered, Open by value:system Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
tag:Source	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The Data Provider Id (and display text) of the system supplying the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Source
code	SΣ	1..1	code	The Data Provider Id of the system supplying the data
display	SΣ	1..1	string	Name of the system supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
tag:Provenance	SΣ	0..1	Coding	MANDATORY except in Contained Resources. The ODS Code (and display text) of the organisation responsible for the data Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.interweavedigital.nhs.uk/Provenance
code	SΣ	1..1	code	The ODS Code of the organisation responsible for the data
display	SΣ	1..1	string	Name of the organisation supplying the data
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	DISCOURAGED - may not be honoured by Data Consumers
language		0..1	code	English is assumed (not currently a multi-lingual implementation) Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	DISCOURAGED - the preferred approach is to offer structured data fields which a Data Consumer can then render and present in a manner most suited to its users
contained		0..*	Resource	Contained, inline Resources
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
contactPreference		0..1	(Complex)	The preferred method of contact, contact times and written communication format given by a Patient or Related Person. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreference
copyCorrespondenceIndicator		0..1	boolean	Indicates that a Patient contact or RelatedPerson must be copied in to Patient correspondence. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicator
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportRole
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	Σ	0..*	Identifier	A human identifier for this person Slice: Unordered, Open by value:system
identifier:localIdentifier	Σ	0..1	Identifier	A human identifier for this person
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	1..1	uri	The namespace for the identifier value Fixed Value: https://fhir.interweavedigital.nhs.uk/Id/local-RelatedPerson-identifier
value	SΣ	1..1	string	The Local RelatedPerson Identifier. Please prefix with ODS code plus period (XXX.) to ensure unique Example General: 123456
assigner	Σ	0..1	Reference(InterweaveOrganization)	Organization that issued id (may be just text)
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use.
patient	SΣ	1..1	Reference(InterweavePatient)	The patient this person is related to.
extension		0..0
reference	ΣC	1..1	string	Reference to a resource (could be Contained)
identifier	Σ	0..1	Identifier	If relevant could include an id
display	Σ	1..1	string	Description of the referenced resource
relationship	SΣ	1..1	CodeableConcept	The nature of the relationship. Binding: UK Core Person Relationship Type (required)
extension		0..0
coding	Σ	0..*	Coding	Code defined by a terminology system
extension		0..0
system	Σ	1..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	1..1	code	Symbol in syntax defined by the system
display	Σ	1..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
text	Σ	0..1	string	Plain text representation of the concept
name	SΣ	1..*	HumanName	A name associated with the person.
extension		0..0
use	?!SΣ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	DISCOURAGED: Please do not rely on this. Providers might not populate and Consumers might not use. Instead display the name based on the detailed elements.
family	SΣ	1..1	string	Family name (often called 'Surname')
given	SΣ	1..*	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	SΣ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	SΣ	0..*	string	Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name
period	Σ	0..1	Period	Time period when name was/is in use
telecom	SΣ	0..*	ContactPoint	A contact detail for the person.
extension		0..0
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point.
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
otherContactSystem		0..1	CodeableConcept	Information about other contact methods which could be used in addition to those listed in `ContactPoint.system`. URL: https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystem Binding: UK Core Other Contact System (extensible)
value		0..1	string	Primitive value for code
value	SΣ	1..1	string	The actual contact point details
use	?!SΣ	0..1	code	home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point.
rank	Σ	0..1	positiveInt	Specify preferred order of use (1 = highest)
period	Σ	0..1	Period	Time period when the contact point was/is in use
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited.
period	S	0..1	Period	Period of time that this relationship is considered valid
communication		0..*	BackboneElement	A language which may be used to communicate with about the patient's health
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
language		1..1	CodeableConcept	The language which can be used to communicate with the patient about his or her health Binding: AllLanguages (required): A language which may be used to communicate with the related person about the patient's health.
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
RelatedPerson.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.meta.tag:Source	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.meta.tag:Provenance	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
RelatedPerson.identifier:localIdentifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard
RelatedPerson.identifier:localIdentifier.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard
RelatedPerson.relationship	required	UKCorePersonRelationshipType https://fhir.hl7.org.uk/ValueSet/UKCore-PersonRelationshipType from this IG
RelatedPerson.name.use	required	NameUse http://hl7.org/fhir/ValueSet/name-use|4.0.1 from the FHIR Standard
RelatedPerson.telecom.system	required	ContactPointSystem http://hl7.org/fhir/ValueSet/contact-point-system|4.0.1 from the FHIR Standard
RelatedPerson.telecom.use	required	ContactPointUse http://hl7.org/fhir/ValueSet/contact-point-use|4.0.1 from the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.communication.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	RelatedPerson	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	RelatedPerson	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	RelatedPerson	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	RelatedPerson	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()

This structure is derived from UKCoreRelatedPerson

Summary

Mandatory: 7 elements(13 nested mandatory elements)
Must-Support: 22 elements
Fixed: 3 elements
Prohibited: 21 elements

Structures

This structure refers to these other structures:

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

Extensions

This structure refers to these extensions:

• https://fhir.interweavedigital.nhs.uk/R4/StructureDefinition/Extension-Interweave-SocialCareSupportRole

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of RelatedPerson.meta.tag
• The element 1 is sliced based on the value of RelatedPerson.identifier