RelatedEntity (CDA Class) - Definitions - Clinical Document Architecture v2.0.1

Clinical Document Architecture
2.0.1 - active

Clinical Document Architecture, published by Health Level 7. This is not an authorized publication; it is the continuous build for version 2.0.1). This version is based on the current content of https://github.com/HL7/CDA-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: CDAR2.RelatedEntity - Detailed Descriptions

Active as of 2023-10-03

Definitions for the RelatedEntity logical model.

Differential Elements Table
Key Elements Table
Snapshot Elements Table

Guidance on how to interpret the contents of this table can be found here

0. RelatedEntity
Control	1..1
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
2. RelatedEntity.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassMutualRelationship
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
4. RelatedEntity.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
6. RelatedEntity.code
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from PersonalRelationshipRoleType
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
8. RelatedEntity.addr
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD
10. RelatedEntity.telecom
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
12. RelatedEntity.effectiveTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
14. RelatedEntity.relatedPerson
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Person

Guidance on how to interpret the contents of this table can be found here

0. RelatedEntity
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	10..1*
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. RelatedEntity.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassMutualRelationship
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
4. RelatedEntity.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
6. RelatedEntity.code
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from PersonalRelationshipRoleType
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
8. RelatedEntity.addr
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD
10. RelatedEntity.telecom
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
12. RelatedEntity.effectiveTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
14. RelatedEntity.relatedPerson
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Person

Guidance on how to interpret the contents of this table can be found here

0. RelatedEntity
Definition	Base definition for all types defined in FHIR type system.
Short	Base for all types and resources
Control	1..1
Is Modifier	false
XML Format	In the XML format, this property has the namespace `urn:hl7-org:v3`.
Invariants	ele-1: All FHIR elements must have a @value or children (`hasValue() or (children().count() > id.count())`)
2. RelatedEntity.classCode
Control	1..1
Binding	The codes SHALL be taken from RoleClassMutualRelationship
Type	code(cs: Coded Simple Value)
Primitive Value	This primitive element may be present, or absent, or replaced by an extension
XML Format	In the XML format, this property is represented as an attribute.
4. RelatedEntity.templateId
Definition	When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/II
6. RelatedEntity.code
Control	0..1
Binding	Unless not suitable, these codes SHALL be taken from PersonalRelationshipRoleType
Type	http://hl7.org/cda/stds/core/StructureDefinition/CE
8. RelatedEntity.addr
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/AD
10. RelatedEntity.telecom
Control	0..*
Type	http://hl7.org/cda/stds/core/StructureDefinition/TEL
12. RelatedEntity.effectiveTime
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
14. RelatedEntity.relatedPerson
Control	0..1
Type	http://hl7.org/cda/stds/core/StructureDefinition/Person

IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.1 based on FHIR 5.0.0. Generated 2023-10-03
Links: Table of Contents | QA Report | Version History external | | Propose a change