This page is part of the U.S. Physical Activity IG (v1.0.0-ballot: STU 1.0 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

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

Resource Profile: PA Related Person

A profile on RelatedPerson that mirrors the requirements of future US Core versions

Usage:

• Refer to this Resource Profile: PA Care Plan, PA-Related Goal and PA Service Request

Formal Views of Profile Content

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

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

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
implicitRules		0..0
modifierExtension		0..0
active	S	0..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(US Core Patient Profile)	The patient this person is related to
relationship	SC	0..*	CodeableConcept	The nature of the relationship
text	S	1..1	string	Plain text representation of the concept
name	SC	0..*	HumanName	A name associated with the person pa-relatedperson-1: At least one of given and family must exist
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
telecom	S	0..*	ContactPoint	A contact detail for the person
address	S	0..*	Address	Address where the related person can be contacted or visited
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
pa-relatedperson-1	error	RelatedPerson.name	At least one of given and family must exist : given.exists() or family.exists()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
active	?!SΣ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(US Core Patient Profile)	The patient this person is related to
relationship	SΣC	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
text	SΣ	1..1	string	Plain text representation of the concept
name	SΣC	0..*	HumanName	A name associated with the person pa-relatedperson-1: At least one of given and family must exist
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	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	SΣ	0..*	ContactPoint	A contact detail for the person
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.relationship	preferred	PatientRelationshipType
RelatedPerson.name.use	required	NameUse

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())
pa-relatedperson-1	error	RelatedPerson.name	At least one of given and family must exist : given.exists() or family.exists()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
identifier	Σ	0..*	Identifier	A human identifier for this person
active	?!SΣ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(US Core Patient Profile)	The patient this person is related to
relationship	SΣC	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	1..1	string	Plain text representation of the concept
name	SΣC	0..*	HumanName	A name associated with the person pa-relatedperson-1: At least one of given and family must exist
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	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	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	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
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
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	Conformance	ValueSet
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType
RelatedPerson.name.use	required	NameUse
RelatedPerson.gender	required	AdministrativeGender
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
pa-relatedperson-1	error	RelatedPerson.name	At least one of given and family must exist : given.exists() or family.exists()

This structure is derived from RelatedPerson

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 9 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)

Differential View

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
implicitRules		0..0
modifierExtension		0..0
active	S	0..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(US Core Patient Profile)	The patient this person is related to
relationship	SC	0..*	CodeableConcept	The nature of the relationship
text	S	1..1	string	Plain text representation of the concept
name	SC	0..*	HumanName	A name associated with the person pa-relatedperson-1: At least one of given and family must exist
family	S	0..1	string	Family name (often called 'Surname')
given	S	0..*	string	Given names (not always 'first'). Includes middle names
telecom	S	0..*	ContactPoint	A contact detail for the person
address	S	0..*	Address	Address where the related person can be contacted or visited
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
pa-relatedperson-1	error	RelatedPerson.name	At least one of given and family must exist : given.exists() or family.exists()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
active	?!SΣ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(US Core Patient Profile)	The patient this person is related to
relationship	SΣC	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
text	SΣ	1..1	string	Plain text representation of the concept
name	SΣC	0..*	HumanName	A name associated with the person pa-relatedperson-1: At least one of given and family must exist
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	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	SΣ	0..*	ContactPoint	A contact detail for the person
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.relationship	preferred	PatientRelationshipType
RelatedPerson.name.use	required	NameUse

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())
pa-relatedperson-1	error	RelatedPerson.name	At least one of given and family must exist : given.exists() or family.exists()
us-core-14	error	RelatedPerson	Either a name or a relationship SHALL be provided (or both) : name.exists() or relationship.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	RelatedPerson	A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both)
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
identifier	Σ	0..*	Identifier	A human identifier for this person
active	?!SΣ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(US Core Patient Profile)	The patient this person is related to
relationship	SΣC	0..*	CodeableConcept	The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
text	SΣ	1..1	string	Plain text representation of the concept
name	SΣC	0..*	HumanName	A name associated with the person pa-relatedperson-1: At least one of given and family must exist
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name.
text	Σ	0..1	string	Text representation of the full name
family	SΣ	0..1	string	Family name (often called 'Surname')
given	SΣ	0..*	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	Σ	0..*	string	Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name
suffix	Σ	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
gender	Σ	0..1	code	male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
birthDate	Σ	0..1	date	The date on which the related person was born
address	SΣ	0..*	Address	Address where the related person can be contacted or visited
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	Conformance	ValueSet
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType
RelatedPerson.name.use	required	NameUse
RelatedPerson.gender	required	AdministrativeGender
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

Constraints

Id	Grade	Path(s)	Details	Requirements
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()
pa-relatedperson-1	error	RelatedPerson.name	At least one of given and family must exist : given.exists() or family.exists()

This structure is derived from RelatedPerson

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 9 elements
Prohibited: 2 elements

Structures

This structure refers to these other structures:

• US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)

Other representations of profile: CSV, Excel, Schematron