Status: Active: Approved (STU)

Definition Information about a person that has a relationship with a patient. The person may be involved in the care or support of a patient, but is not the target of the care/support.

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. The related person is 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.

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:

• 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.

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

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

• 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:

• 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.

• 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 adopt the R4 relationship field, which allows for multiple relationships to be specified, to support this requirement. however, as this breaks compliance with STU3 and given role is a different concept, it was agreed that this should be represented by a separate field.

• period - The period during which the relationship existed.

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:

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

• 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.

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 CareConnect-RelatedPerson-1

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	CareConnect-RelatedPerson-1	An 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
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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)
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.yhcr.nhs.uk/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.yhcr.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
active	S	1..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(CareConnectPatient1)	The patient this person is related to
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
display	S	1..1	string	Text alternative for the resource
relationship	S	1..1	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (required)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name	S	1..*	HumanName	A name associated with the person
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	S	0..*	ContactPoint	A contact detail for the person
system	S	1..1	code	phone | fax | email | pager | url | sms | other
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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
RelatedPerson.relationship	required	PatientRelationshipType

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	CareConnect-RelatedPerson-1	An 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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (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://yhcr.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: Common Tags (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://yhcr.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: Common Languages (extensible): 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		0..*	Extension	Extension Slice: Unordered, Open by value:url
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.yhcr.nhs.uk/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:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
identifier:localIdentifier	Σ	0..1	Identifier	A human identifier for this person
use	?!Σ	0..1	code	usual | official | temp | secondary (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.yhcr.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
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(CareConnectPatient1)	The patient this person is related to
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
display	SΣ	1..1	string	Text alternative for the resource
relationship	SΣ	1..1	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (required)
name	SΣ	1..*	HumanName	A name associated with the person
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
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point
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
period	S	0..1	Period	Period of time that this relationship is considered valid
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.meta.security	extensible	All Security Labels
RelatedPerson.meta.tag	example	Common Tags
RelatedPerson.meta.tag:Source	example	Common Tags
RelatedPerson.meta.tag:Provenance	example	Common Tags
RelatedPerson.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.identifier.use	required	IdentifierUse
RelatedPerson.identifier:localIdentifier.use	required	IdentifierUse
RelatedPerson.relationship	required	PatientRelationshipType
RelatedPerson.name.use	required	NameUse
RelatedPerson.telecom.system	required	ContactPointSystem
RelatedPerson.telecom.use	required	ContactPointUse

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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..*	CareConnect-RelatedPerson-1	An 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
id		0..1	string	xml:id (or equivalent in JSON)
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.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
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: Common Languages (extensible): 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
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.yhcr.nhs.uk/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:All Slices				Content/Rules for all slices
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
identifier:localIdentifier	Σ	0..1	Identifier	A human identifier for this person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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.yhcr.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(CareConnect-Organization-1)	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(CareConnectPatient1)	The patient this person is related to
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	1..1	string	Text alternative for the resource
relationship	SΣ	1..1	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
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
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!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
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point
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	Σ	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
RelatedPerson.meta.security	extensible	All Security Labels
RelatedPerson.meta.tag	example	Common Tags
RelatedPerson.meta.tag:Source	example	Common Tags
RelatedPerson.meta.tag:Provenance	example	Common Tags
RelatedPerson.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.identifier.use	required	IdentifierUse
RelatedPerson.identifier.type	extensible	Identifier Type Codes
RelatedPerson.identifier:localIdentifier.use	required	IdentifierUse
RelatedPerson.identifier:localIdentifier.type	extensible	Identifier Type Codes
RelatedPerson.relationship	required	PatientRelationshipType
RelatedPerson.name.use	required	NameUse
RelatedPerson.telecom.system	required	ContactPointSystem
RelatedPerson.telecom.use	required	ContactPointUse
RelatedPerson.gender	required	AdministrativeGender

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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 CareConnect-RelatedPerson-1

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	CareConnect-RelatedPerson-1	An 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
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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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
system		1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.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)
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		0..*	Extension	Extension Slice: Unordered, Open by value:url
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.yhcr.nhs.uk/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.yhcr.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
active	S	1..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(CareConnectPatient1)	The patient this person is related to
reference	S	1..1	string	Literal reference, Relative, internal or absolute URL
display	S	1..1	string	Text alternative for the resource
relationship	S	1..1	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (required)
coding
system		1..1	uri	Identity of the terminology system
code		1..1	code	Symbol in syntax defined by the system
display		1..1	string	Representation defined by the system
name	S	1..*	HumanName	A name associated with the person
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	S	0..*	ContactPoint	A contact detail for the person
system	S	1..1	code	phone | fax | email | pager | url | sms | other
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
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet
RelatedPerson.relationship	required	PatientRelationshipType

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	CareConnect-RelatedPerson-1	An 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..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (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://yhcr.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: Common Tags (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://yhcr.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: Common Languages (extensible): 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		0..*	Extension	Extension Slice: Unordered, Open by value:url
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.yhcr.nhs.uk/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:All Slices				Content/Rules for all slices
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
identifier:localIdentifier	Σ	0..1	Identifier	A human identifier for this person
use	?!Σ	0..1	code	usual | official | temp | secondary (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.yhcr.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
active	?!SΣ	1..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(CareConnectPatient1)	The patient this person is related to
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
display	SΣ	1..1	string	Text alternative for the resource
relationship	SΣ	1..1	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (required)
name	SΣ	1..*	HumanName	A name associated with the person
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
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point
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
period	S	0..1	Period	Period of time that this relationship is considered valid
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.meta.security	extensible	All Security Labels
RelatedPerson.meta.tag	example	Common Tags
RelatedPerson.meta.tag:Source	example	Common Tags
RelatedPerson.meta.tag:Provenance	example	Common Tags
RelatedPerson.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.identifier.use	required	IdentifierUse
RelatedPerson.identifier:localIdentifier.use	required	IdentifierUse
RelatedPerson.relationship	required	PatientRelationshipType
RelatedPerson.name.use	required	NameUse
RelatedPerson.telecom.system	required	ContactPointSystem
RelatedPerson.telecom.use	required	ContactPointUse

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-1	error	RelatedPerson	If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty()
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 : contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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..*	CareConnect-RelatedPerson-1	An 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
id		0..1	string	xml:id (or equivalent in JSON)
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.
profile	SΣ	0..*	uri	Profiles this resource claims to conform to. Should list (i) this profile (ii) underlying CareConnect profile
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: Common Tags (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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Source
version	Σ	0..1	string	Version of the system - if relevant
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: Common Tags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system Fixed Value: https://yhcr.nhs.uk/Provenance
version	Σ	0..1	string	Version of the system - if relevant
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: Common Languages (extensible): 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
socialCareSupportRole	S	0..*	(Complex)	Social Care Support Role: The role which a person plays in this service user's support URL: https://fhir.yhcr.nhs.uk/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:All Slices				Content/Rules for all slices
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	0..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	0..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(CareConnect-Organization-1)	Organization that issued id (may be just text)
identifier:localIdentifier	Σ	0..1	Identifier	A human identifier for this person
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary (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.yhcr.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(CareConnect-Organization-1)	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(CareConnectPatient1)	The patient this person is related to
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
reference	SΣC	1..1	string	Literal reference, Relative, internal or absolute URL
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	SΣ	1..1	string	Text alternative for the resource
relationship	SΣ	1..1	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (required)
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	Σ	1..1	uri	Identity of the terminology system
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
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
use	?!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
id		0..1	string	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations Slice: Unordered, Open by value:url
system	SΣC	1..1	code	phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point
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	Σ	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
RelatedPerson.meta.security	extensible	All Security Labels
RelatedPerson.meta.tag	example	Common Tags
RelatedPerson.meta.tag:Source	example	Common Tags
RelatedPerson.meta.tag:Provenance	example	Common Tags
RelatedPerson.language	extensible	Common Languages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.identifier.use	required	IdentifierUse
RelatedPerson.identifier.type	extensible	Identifier Type Codes
RelatedPerson.identifier:localIdentifier.use	required	IdentifierUse
RelatedPerson.identifier:localIdentifier.type	extensible	Identifier Type Codes
RelatedPerson.relationship	required	PatientRelationshipType
RelatedPerson.name.use	required	NameUse
RelatedPerson.telecom.system	required	ContactPointSystem
RelatedPerson.telecom.use	required	ContactPointUse
RelatedPerson.gender	required	AdministrativeGender

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() | (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 CareConnect-RelatedPerson-1

Summary

Mandatory: 7 elements (13 nested mandatory elements)
Must-Support: 29 elements
Fixed Value: 3 elements
Prohibited: 2 elements

Extensions

This structure refers to these extensions:

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

Slices

This structure defines the following Slices:

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