This page is part of the Csiro Stars (v0.5.1: Release) based on FHIR (HL7® FHIR® Standard) v5.0.0. 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: CSIRO STARS RelatedPerson Profile

A person that is related to a patient in some way.

Usages:

• Refer to this Profile: CSIRO STARS Patient Profile
• Examples for this Profile: RelatedPerson/relatedperson-example

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		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
name	SΣ	0..*	HumanName	A name associated with the person
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
country	Σ	0..1	string	Country preferred as 2 or 3 letter code from [ISO3166](http://hl7.org/fhir/ValueSet/iso3166-1-2)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.address.​use	Base	required	AddressUse	📍5.0.0	FHIR Std.
RelatedPerson.communication.​language	Base	required	All Languages	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
active		0..0
name	S	0..*	HumanName	A name associated with the person
gender		0..0
birthDate		0..0
address	S	0..*	Address	Address where the related person can be contacted or visited
country		0..1	string	Country preferred as 2 or 3 letter code from [ISO3166](http://hl7.org/fhir/ValueSet/iso3166-1-2)
photo		0..0
period		0..0
communication		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	0..*	CodeableConcept	The relationship of the related person to the patient Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	0..*	HumanName	A name associated with the person
telecom	Σ	0..*	ContactPoint	A contact detail for the person
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country preferred as 2 or 3 letter code from [ISO3166](http://hl7.org/fhir/ValueSet/iso3166-1-2)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	required	All Languages	📍5.0.0	FHIR Std.
RelatedPerson.relationship	Base	preferred	Patient Relationship Type	📍5.0.0	FHIR Std.
RelatedPerson.address.​use	Base	required	AddressUse	📍5.0.0	FHIR Std.
RelatedPerson.address.​type	Base	required	AddressType	📍5.0.0	FHIR Std.
RelatedPerson.communication.​language	Base	required	All Languages	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

Must-Support: 2 elements
Prohibited: 6 elements

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
name	SΣ	0..*	HumanName	A name associated with the person
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
country	Σ	0..1	string	Country preferred as 2 or 3 letter code from [ISO3166](http://hl7.org/fhir/ValueSet/iso3166-1-2)
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.address.​use	Base	required	AddressUse	📍5.0.0	FHIR Std.
RelatedPerson.communication.​language	Base	required	All Languages	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
active		0..0
name	S	0..*	HumanName	A name associated with the person
gender		0..0
birthDate		0..0
address	S	0..*	Address	Address where the related person can be contacted or visited
country		0..1	string	Country preferred as 2 or 3 letter code from [ISO3166](http://hl7.org/fhir/ValueSet/iso3166-1-2)
photo		0..0
period		0..0
communication		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
RelatedPerson		0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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
patient	Σ	1..1	Reference(Patient)	The patient this person is related to
relationship	Σ	0..*	CodeableConcept	The relationship of the related person to the patient Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
name	SΣ	0..*	HumanName	A name associated with the person
telecom	Σ	0..*	ContactPoint	A contact detail for the person
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address (home / work / etc.). Example General: home
type	Σ	0..1	code	postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both
text	Σ	0..1	string	Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132
line	Σ	0..*	string	Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street
city	Σ	0..1	string	Name of city, town etc. Example General: Erewhon
district	Σ	0..1	string	District name (aka county) Example General: Madison
state	Σ	0..1	string	Sub-unit of country (abbreviations ok)
postalCode	Σ	0..1	string	Postal code for area Example General: 9132
country	Σ	0..1	string	Country preferred as 2 or 3 letter code from [ISO3166](http://hl7.org/fhir/ValueSet/iso3166-1-2)
period	Σ	0..1	Period	Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"}
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
RelatedPerson.language	Base	required	All Languages	📍5.0.0	FHIR Std.
RelatedPerson.relationship	Base	preferred	Patient Relationship Type	📍5.0.0	FHIR Std.
RelatedPerson.address.​use	Base	required	AddressUse	📍5.0.0	FHIR Std.
RelatedPerson.address.​type	Base	required	AddressType	📍5.0.0	FHIR Std.
RelatedPerson.communication.​language	Base	required	All Languages	📍5.0.0	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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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

Must-Support: 2 elements
Prohibited: 6 elements

Other representations of profile: CSV, Excel, Schematron