CARIN Consumer Directed Payer Data Exchange (CARIN IG for Blue Button®), published by HL7 International / Financial Management. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/carin-bb/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Examples
• 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: C4BB Explanation Of Benefit
• Examples for this Resource Profile: RelatedPerson/RelatedPerson1

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 USCoreRelatedPersonProfile

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson			USCoreRelatedPersonProfile
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
patient		1..1	Reference(C4BB Patient)	(USCDI) The patient this person is related to
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	USCoreRelatedPersonProfile	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 us-core-14: Either a name or a relationship SHALL be provided (or both)
meta	SΣ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	SΣ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(C4BB Patient)	(USCDI) The patient this person is related to ele-1: All FHIR elements must have a @value or children
relationship	SΣC	0..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children
name	SΣC	0..*	HumanName	(USCDI) A name associated with the person ele-1: All FHIR elements must have a @value or children
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person ele-1: All FHIR elements must have a @value or children
address	SΣ	0..*	Address	(USCDI) Address where the related person can be contacted or visited ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	USCoreRelatedPersonProfile	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	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	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(C4BB Patient)	(USCDI) The patient this person is related to
relationship	SΣC	0..*	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	0..*	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	Conformance	ValueSet	URI
RelatedPerson.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
RelatedPerson.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

This structure is derived from USCoreRelatedPersonProfile

Summary

Mandatory: 3 elements
Must-Support: 2 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 USCoreRelatedPersonProfile

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson			USCoreRelatedPersonProfile
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
patient		1..1	Reference(C4BB Patient)	(USCDI) The patient this person is related to
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	USCoreRelatedPersonProfile	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 us-core-14: Either a name or a relationship SHALL be provided (or both)
meta	SΣ	1..1	Meta	Metadata about the resource ele-1: All FHIR elements must have a @value or children
lastUpdated	SΣ	1..1	instant	When the resource version last changed ele-1: All FHIR elements must have a @value or children
profile	Σ	1..*	canonical(StructureDefinition)	Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
active	?!SΣ	1..1	boolean	(USCDI) Whether this related person's record is in active use ele-1: All FHIR elements must have a @value or children
patient	SΣ	1..1	Reference(C4BB Patient)	(USCDI) The patient this person is related to ele-1: All FHIR elements must have a @value or children
relationship	SΣC	0..*	CodeableConcept	(USCDI) The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. ele-1: All FHIR elements must have a @value or children
name	SΣC	0..*	HumanName	(USCDI) A name associated with the person ele-1: All FHIR elements must have a @value or children
telecom	SΣ	0..*	ContactPoint	(USCDI) A contact detail for the person ele-1: All FHIR elements must have a @value or children
address	SΣ	0..*	Address	(USCDI) Address where the related person can be contacted or visited ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson	C	0..*	USCoreRelatedPersonProfile	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	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	(USCDI) Whether this related person's record is in active use
patient	SΣ	1..1	Reference(C4BB Patient)	(USCDI) The patient this person is related to
relationship	SΣC	0..*	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	0..*	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	Conformance	ValueSet	URI
RelatedPerson.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
RelatedPerson.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard
RelatedPerson.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
RelatedPerson.relationship	preferred	PatientRelationshipType http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard
RelatedPerson.gender	required	AdministrativeGender http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard
RelatedPerson.communication.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding

This structure is derived from USCoreRelatedPersonProfile

Summary

Mandatory: 3 elements
Must-Support: 2 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