This page is part of the Interoperability of Clic Santé (v1.0.0: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

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

Resource Profile: Related Person ( Experimental )

A constrained RelatedPerson resource to represent specific familial relationships, including spouse, mother, father and emergency contact.

Usage:

• Refer to this Resource Profile: Appointment

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	1..1	id	Logical id of this artifact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
relatedPersonOccupation		0..1	string	The occupation of the related person URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/related-person-occupation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patient	Σ	1..1	Reference(Patient)	The patient this person is related to ele-1: All FHIR elements must have a @value or children
relationship	Σ	1..1	CodeableConcept	FTH | MTH | SPS | C Binding: Patient Relationship Value Set (required) ele-1: All FHIR elements must have a @value or children
name	Σ	1..1	HumanName	A name associated with the person ele-1: All FHIR elements must have a @value or children
family	Σ	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	Σ	1..1	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	Σ	0..1	ContactPoint	A contact detail for the person ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	required	PatientRelationshipTypeValueSet http://documentation.clicsante.ca/fhir/base/ValueSet/patient-relationship-type from this IG
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

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 RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson			RelatedPerson
id		1..1	id	Logical id of this artifact
meta		0..0
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
relatedPersonOccupation		0..1	string	The occupation of the related person URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/related-person-occupation
modifierExtension		0..0
identifier		0..0
active		0..0
relationship		1..1	CodeableConcept	FTH | MTH | SPS | C Binding: Patient Relationship Value Set (required)
name		1..1	HumanName	A name associated with the person
id		0..0
use		0..0
family		1..1	string	Family name (often called 'Surname')
given		1..1	string	Given names (not always 'first'). Includes middle names
prefix		0..0
suffix		0..0
period		0..0
telecom		0..1	ContactPoint	A contact detail for the person
gender		0..0
birthDate		0..0
address		0..0
photo		0..0
period		0..0
communication		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	required	PatientRelationshipTypeValueSet http://documentation.clicsante.ca/fhir/base/ValueSet/patient-relationship-type from this IG

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
id	Σ	1..1	id	Logical id of this artifact
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
relatedPersonOccupation		0..1	string	The occupation of the related person URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/related-person-occupation
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	1..1	CodeableConcept	FTH | MTH | SPS | C Binding: Patient Relationship Value Set (required)
name	Σ	1..1	HumanName	A name associated with the person
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..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
telecom	Σ	0..1	ContactPoint	A contact detail for the person
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	required	PatientRelationshipTypeValueSet http://documentation.clicsante.ca/fhir/base/ValueSet/patient-relationship-type from this IG
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

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 RelatedPerson

Summary

Mandatory: 5 elements
Prohibited: 18 elements

Extensions

This structure refers to these extensions:

• http://documentation.clicsante.ca/fhir/base/StructureDefinition/related-person-occupation

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
id	Σ	1..1	id	Logical id of this artifact
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
relatedPersonOccupation		0..1	string	The occupation of the related person URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/related-person-occupation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
patient	Σ	1..1	Reference(Patient)	The patient this person is related to ele-1: All FHIR elements must have a @value or children
relationship	Σ	1..1	CodeableConcept	FTH | MTH | SPS | C Binding: Patient Relationship Value Set (required) ele-1: All FHIR elements must have a @value or children
name	Σ	1..1	HumanName	A name associated with the person ele-1: All FHIR elements must have a @value or children
family	Σ	1..1	string	Family name (often called 'Surname') ele-1: All FHIR elements must have a @value or children
given	Σ	1..1	string	Given names (not always 'first'). Includes middle names ele-1: All FHIR elements must have a @value or children This repeating element order: Given Names appear in the correct order for presenting the name
telecom	Σ	0..1	ContactPoint	A contact detail for the person ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	required	PatientRelationshipTypeValueSet http://documentation.clicsante.ca/fhir/base/ValueSet/patient-relationship-type from this IG
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

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 RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson			RelatedPerson
id		1..1	id	Logical id of this artifact
meta		0..0
implicitRules		0..0
language		0..0
contained		0..0
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
relatedPersonOccupation		0..1	string	The occupation of the related person URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/related-person-occupation
modifierExtension		0..0
identifier		0..0
active		0..0
relationship		1..1	CodeableConcept	FTH | MTH | SPS | C Binding: Patient Relationship Value Set (required)
name		1..1	HumanName	A name associated with the person
id		0..0
use		0..0
family		1..1	string	Family name (often called 'Surname')
given		1..1	string	Given names (not always 'first'). Includes middle names
prefix		0..0
suffix		0..0
period		0..0
telecom		0..1	ContactPoint	A contact detail for the person
gender		0..0
birthDate		0..0
address		0..0
photo		0..0
period		0..0
communication		0..0
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	required	PatientRelationshipTypeValueSet http://documentation.clicsante.ca/fhir/base/ValueSet/patient-relationship-type from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
id	Σ	1..1	id	Logical id of this artifact
text		0..1	Narrative	Text summary of the resource, for human interpretation
Slices for extension		0..*	Extension	Extension Slice: Unordered, Open by value:url
relatedPersonOccupation		0..1	string	The occupation of the related person URL: http://documentation.clicsante.ca/fhir/base/StructureDefinition/related-person-occupation
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	1..1	CodeableConcept	FTH | MTH | SPS | C Binding: Patient Relationship Value Set (required)
name	Σ	1..1	HumanName	A name associated with the person
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
text	Σ	0..1	string	Text representation of the full name
family	Σ	1..1	string	Family name (often called 'Surname')
given	Σ	1..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
telecom	Σ	0..1	ContactPoint	A contact detail for the person
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	required	PatientRelationshipTypeValueSet http://documentation.clicsante.ca/fhir/base/ValueSet/patient-relationship-type from this IG
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

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 RelatedPerson

Summary

Mandatory: 5 elements
Prohibited: 18 elements

Extensions

This structure refers to these extensions:

• http://documentation.clicsante.ca/fhir/base/StructureDefinition/related-person-occupation

Other representations of profile: CSV, Excel, Schematron