Clinical Practice Guidelines
3.0.0-ballot - STU 3 Ballot International flag

Clinical Practice Guidelines, published by HL7 International / Clinical Decision Support. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/cqf-recommendations/ and changes regularly. See the Directory of published versions

Resource Profile: CPG Related Person

Official URL: http://hl7.org/fhir/uv/cpg/StructureDefinition/cpg-relatedperson Version: 3.0.0-ballot
Standards status: Trial-use Maturity Level: 4 * Computable Name: CPGRelatedPerson
Other Identifiers: OID:2.16.840.1.113883.4.642.40.48.42.111

CPG related person defines the minimum expectations for a person related to a patient in a CPG case, such as a care partner, spouse, or other related person

CPGRelatedPerson identifies an actual person related to a patient, such as a caregiver or spouse, within guideline-supported care. Use it for that person's relationship and identity in the patient context. It is an instance-level resource, not a reusable persona definition and not a practitioner-role assignment.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.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
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.identifier This element must be supported. This element is included in summaries. 0..* Identifier A human identifier for this person
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(CPG Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
RelatedPerson.name This element must be supported. This element is included in summaries. 0..* HumanName A name associated with the person

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.

The nature of the relationship between a patient and the related person.

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.identifier This element must be supported. 0..* Identifier A human identifier for this person
RelatedPerson.active This element must be supported. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. 1..1 Reference(CPG Patient) The patient this person is related to
RelatedPerson.name This element must be supported. 0..* HumanName A name associated with the person

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.id This element is included in summaries. 0..1 id Logical id of this artifact
RelatedPerson.meta This element is included in summaries. 0..1 Meta Metadata about the resource
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
RelatedPerson.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
RelatedPerson.contained 0..* Resource Contained, inline Resources
RelatedPerson.extension 0..* Extension Additional content defined by implementations
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.identifier This element must be supported. This element is included in summaries. 0..* Identifier A human identifier for this person
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(CPG Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
RelatedPerson.name This element must be supported. This element is included in summaries. 0..* HumanName A name associated with the person
RelatedPerson.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
RelatedPerson.birthDate This element is included in summaries. 0..1 date The date on which the related person was born
RelatedPerson.address This element is included in summaries. 0..* Address Address where the related person can be contacted or visited
RelatedPerson.photo 0..* Attachment Image of the person
RelatedPerson.period 0..1 Period Period of time that this relationship is considered valid
RelatedPerson.communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
RelatedPerson.communication.id 0..1 string Unique id for inter-element referencing
RelatedPerson.communication.extension 0..* Extension Additional content defined by implementations
RelatedPerson.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
RelatedPerson.communication.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 BindingsPurpose
AllLanguages Max Binding
RelatedPerson.communication.preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.

A human language.

RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.

The nature of the relationship between a patient and the related person.

RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

The gender of a person used for administrative purposes.

RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

A human language.

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

Must-Support: 5 elements

Structures

This structure refers to these other structures:

Maturity: 4

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.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
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.identifier This element must be supported. This element is included in summaries. 0..* Identifier A human identifier for this person
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(CPG Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
RelatedPerson.name This element must be supported. This element is included in summaries. 0..* HumanName A name associated with the person

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.

The nature of the relationship between a patient and the related person.

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

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.identifier This element must be supported. 0..* Identifier A human identifier for this person
RelatedPerson.active This element must be supported. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. 1..1 Reference(CPG Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. 0..* CodeableConcept The nature of the relationship
RelatedPerson.name This element must be supported. 0..* HumanName A name associated with the person

doco Documentation for this format

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
RelatedPerson 0..* RelatedPerson A person that is related to a patient, but who is not a direct target of care
RelatedPerson.id This element is included in summaries. 0..1 id Logical id of this artifact
RelatedPerson.meta This element is included in summaries. 0..1 Meta Metadata about the resource
RelatedPerson.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
RelatedPerson.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
RelatedPerson.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
RelatedPerson.contained 0..* Resource Contained, inline Resources
RelatedPerson.extension 0..* Extension Additional content defined by implementations
RelatedPerson.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
RelatedPerson.identifier This element must be supported. This element is included in summaries. 0..* Identifier A human identifier for this person
RelatedPerson.active This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 boolean Whether this related person's record is in active use
RelatedPerson.patient This element must be supported. This element is included in summaries. 1..1 Reference(CPG Patient) The patient this person is related to
RelatedPerson.relationship This element must be supported. This element is included in summaries. 0..* CodeableConcept The nature of the relationship
Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person.
RelatedPerson.name This element must be supported. This element is included in summaries. 0..* HumanName A name associated with the person
RelatedPerson.telecom This element is included in summaries. 0..* ContactPoint A contact detail for the person
RelatedPerson.gender This element is included in summaries. 0..1 code male | female | other | unknown
Binding: AdministrativeGender (required): The gender of a person used for administrative purposes.
RelatedPerson.birthDate This element is included in summaries. 0..1 date The date on which the related person was born
RelatedPerson.address This element is included in summaries. 0..* Address Address where the related person can be contacted or visited
RelatedPerson.photo 0..* Attachment Image of the person
RelatedPerson.period 0..1 Period Period of time that this relationship is considered valid
RelatedPerson.communication 0..* BackboneElement A language which may be used to communicate with about the patient's health
RelatedPerson.communication.id 0..1 string Unique id for inter-element referencing
RelatedPerson.communication.extension 0..* Extension Additional content defined by implementations
RelatedPerson.communication.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
RelatedPerson.communication.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 BindingsPurpose
AllLanguages Max Binding
RelatedPerson.communication.preferred 0..1 boolean Language preference indicator

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source Documentation
RelatedPerson.language Base preferred Common Languages 📍4.0.1 FHIR Std.

A human language.

RelatedPerson.relationship Base preferred Patient relationship type 📍4.0.1 FHIR Std.

The nature of the relationship between a patient and the related person.

RelatedPerson.gender Base required AdministrativeGender 📍4.0.1 FHIR Std.

The gender of a person used for administrative purposes.

RelatedPerson.communication.​language Base preferred Common Languages 📍4.0.1 FHIR Std.

A human language.

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

Must-Support: 5 elements

Structures

This structure refers to these other structures:

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron

Notes:

  • Active status, a patient reference to CPGPatient, and at least one name are required. The active value is not fixed to true.
  • Identifier and relationship are must-support. The represented relationship supplies context; it does not by itself determine consent, access, or clinical-action authority.

Related guidance: CPGPatient; CPGCareTeam; personas.