This page is part of the CARIN Blue Button Implementation Guide (v2.0.0: STU 2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• XML
• JSON

Resource Profile: C4BB RelatedPerson

This profile is used to convey basic demographic information about a person related to the claim.

Usage:

• Refer to this Resource Profile:

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 relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both) relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
meta	S	1..1	Meta	Metadata about the resource
lastUpdated	S	1..1	instant	When the resource version last changed
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
active	S	1..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(C4BB Patient)	The patient this person is related to
relationship	S	0..*	CodeableConcept	The nature of the relationship
name	S	0..*	HumanName	A name associated with the person
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
relatedperson-meta-profile-version	error	RelatedPerson	RelatedPerson: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson|2.0.'))
relatedperson-name-or-relationship	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 relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both) relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
meta	SΣ	1..1	Meta	Metadata about the resource
lastUpdated	SΣ	1..1	instant	When the resource version last changed
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
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	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(C4BB Patient)	The patient this person is related to
relationship	SΣ	0..*	CodeableConcept	The nature of the relationship 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	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

Constraints

Id	Grade	Path(s)	Details	Requirements
relatedperson-meta-profile-version	error	RelatedPerson	RelatedPerson: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson|2.0.'))
relatedperson-name-or-relationship	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 relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both) relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
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	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(C4BB Patient)	The patient this person is related to
relationship	SΣ	0..*	CodeableConcept	The nature of the relationship 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	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.meta.security	extensible	All Security Labels
RelatedPerson.meta.tag	example	CommonTags
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType
RelatedPerson.gender	required	AdministrativeGender
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

This structure is derived from RelatedPerson

Summary

Mandatory: 4 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• C4BB Patient (http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-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 relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both) relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
meta	S	1..1	Meta	Metadata about the resource
lastUpdated	S	1..1	instant	When the resource version last changed
profile		1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
active	S	1..1	boolean	Whether this related person's record is in active use
patient	S	1..1	Reference(C4BB Patient)	The patient this person is related to
relationship	S	0..*	CodeableConcept	The nature of the relationship
name	S	0..*	HumanName	A name associated with the person
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
relatedperson-meta-profile-version	error	RelatedPerson	RelatedPerson: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson|2.0.'))
relatedperson-name-or-relationship	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 relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both) relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
meta	SΣ	1..1	Meta	Metadata about the resource
lastUpdated	SΣ	1..1	instant	When the resource version last changed
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
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	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(C4BB Patient)	The patient this person is related to
relationship	SΣ	0..*	CodeableConcept	The nature of the relationship 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	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

Constraints

Id	Grade	Path(s)	Details	Requirements
relatedperson-meta-profile-version	error	RelatedPerson	RelatedPerson: meta.profile with canonical and major.minor. version required. : meta.profile.exists($this.startsWith('http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-RelatedPerson|2.0.'))
relatedperson-name-or-relationship	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 relatedperson-name-or-relationship: Either a name or a relationship SHALL be provided (or both) relatedperson-meta-profile-version: RelatedPerson: meta.profile with canonical and major.minor. version required.
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	SΣ	1..1	instant	When the resource version last changed
source	Σ	0..1	uri	Identifies where the resource comes from
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
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
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	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(C4BB Patient)	The patient this person is related to
relationship	SΣ	0..*	CodeableConcept	The nature of the relationship 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	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.meta.security	extensible	All Security Labels
RelatedPerson.meta.tag	example	CommonTags
RelatedPerson.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType
RelatedPerson.gender	required	AdministrativeGender
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

This structure is derived from RelatedPerson

Summary

Mandatory: 4 elements
Must-Support: 8 elements

Structures

This structure refers to these other structures:

• C4BB Patient (http://hl7.org/fhir/us/carin-bb/StructureDefinition/C4BB-Patient)

Other representations of profile: CSV, Excel, Schematron