Introduction

This profile is used to represent a subscriber to a plan due to which a member gets their Coverage as a dependent.

Implementation Requirements

Implementers are advised to read Data Model Requirements to implement the RelatedPerson profile.

APIs : Retrieval of RelatedPerson Resource Instance:

The RelatedPerson instance is retrieved as part of the Bulk API request on the Group resource representing the Member Attribution List.

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

This structure is derived from RelatedPerson

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	Davinci ATR RelatedPerson
identifier	S	0..*	Identifier	A human identifier for this person
patient	S	1..1	Reference(Davinci ATR 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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	Davinci ATR RelatedPerson
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(Davinci ATR 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.relationship	preferred	PatientRelationshipType

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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	Davinci ATR RelatedPerson
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(Davinci ATR 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	Σ	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	Σ	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.gender	required	AdministrativeGender
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

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())
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
RelatedPerson		0..*	RelatedPerson	Davinci ATR RelatedPerson
identifier	S	0..*	Identifier	A human identifier for this person
patient	S	1..1	Reference(Davinci ATR 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
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	Davinci ATR RelatedPerson
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(Davinci ATR 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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
RelatedPerson.relationship	preferred	PatientRelationshipType

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())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
RelatedPerson		0..*	RelatedPerson	Davinci ATR RelatedPerson
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	SΣ	0..*	Identifier	A human identifier for this person
active	?!Σ	0..1	boolean	Whether this related person's record is in active use
patient	SΣ	1..1	Reference(Davinci ATR 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	Σ	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	Σ	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.gender	required	AdministrativeGender
RelatedPerson.communication.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding

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())
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

Mandatory: 1 element
Must-Support: 4 elements

Structures

This structure refers to these other structures:

• Davinci ATR Patient (http://hl7.org/fhir/us/davinci-atr/StructureDefinition/atr-patient)