haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

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

Resource Profile: haau3 RelatedPerson

Individuals related to the patient like caregivers, family members, or guardians.

Usages:

• This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	USCoreRelatedPersonProfile(6.1.0)	A person that is related to a patient, but who is not a direct target of care Constraints: us-core-14
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(haau3 Patient)	(USCDI) The patient this person is related to
relationship	SΣC	1..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣC	1..*	HumanName	(USCDI) A name associated with the person
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person
address	SΣ	0..*	Address	(USCDI) Address where the related person can be contacted or visited
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	preferred	Patient relationship type	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both)	name.exists() or relationship.exists()

This structure is derived from USCoreRelatedPersonProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	USCoreRelatedPersonProfile(6.1.0)	A person that is related to a patient, but who is not a direct target of care
patient		1..1	Reference(haau3 Patient)	(USCDI) The patient this person is related to
relationship		1..*	CodeableConcept	(USCDI) The nature of the relationship
name		1..*	HumanName	(USCDI) A name associated with the person
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	USCoreRelatedPersonProfile(6.1.0)	A person that is related to a patient, but who is not a direct target of care Constraints: us-core-14
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	A human identifier for this person
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(haau3 Patient)	(USCDI) The patient this person is related to
relationship	SΣC	1..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣC	1..*	HumanName	(USCDI) A name associated with the person
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person
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	(USCDI) Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period		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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
RelatedPerson.relationship	Base	preferred	Patient relationship type	📦4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both)	name.exists() or relationship.exists()

This structure is derived from USCoreRelatedPersonProfile

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

• haau3 Patient (https://haau3.com/fhir/StructureDefinition/haau3-patient)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	USCoreRelatedPersonProfile(6.1.0)	A person that is related to a patient, but who is not a direct target of care Constraints: us-core-14
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(haau3 Patient)	(USCDI) The patient this person is related to
relationship	SΣC	1..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣC	1..*	HumanName	(USCDI) A name associated with the person
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person
address	SΣ	0..*	Address	(USCDI) Address where the related person can be contacted or visited
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.relationship	Base	preferred	Patient relationship type	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both)	name.exists() or relationship.exists()

Differential View

This structure is derived from USCoreRelatedPersonProfile

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	USCoreRelatedPersonProfile(6.1.0)	A person that is related to a patient, but who is not a direct target of care
patient		1..1	Reference(haau3 Patient)	(USCDI) The patient this person is related to
relationship		1..*	CodeableConcept	(USCDI) The nature of the relationship
name		1..*	HumanName	(USCDI) A name associated with the person
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson	C	0..*	USCoreRelatedPersonProfile(6.1.0)	A person that is related to a patient, but who is not a direct target of care Constraints: us-core-14
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	A human identifier for this person
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(haau3 Patient)	(USCDI) The patient this person is related to
relationship	SΣC	1..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣC	1..*	HumanName	(USCDI) A name associated with the person
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person
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	(USCDI) Address where the related person can be contacted or visited
photo		0..*	Attachment	Image of the person
period		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
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
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: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
preferred		0..1	boolean	Language preference indicator
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.
RelatedPerson.relationship	Base	preferred	Patient relationship type	📦4.0.1	FHIR Std.
RelatedPerson.gender	Base	required	AdministrativeGender	📍4.0.1	FHIR Std.
RelatedPerson.communication.​language	Base	preferred	Common Languages	📦4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both)	name.exists() or relationship.exists()

This structure is derived from USCoreRelatedPersonProfile

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

• haau3 Patient (https://haau3.com/fhir/StructureDefinition/haau3-patient)

Other representations of profile: CSV, Excel, Schematron