Clinical Document Architecture V2.0.1
2.1.0-draft1 - 1st Draft

This page is part of the CDA: Clinical Document Architecture (v2.1.0-draft1: CDA 2.1 Draft) based on FHIR v5.0.0. . For a full list of available versions, see the Directory of published versions

Logical Model: CDAR2.RelatedEntity - Detailed Descriptions

Active as of 2023-01-16

Definitions for the RelatedEntity logical model.

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

1. RelatedEntity
Control1..1
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. RelatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassMutualRelationship
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
4. RelatedEntity.code
Control0..1
BindingThe codes SHALL be taken from PersonalRelationshipRoleType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
5. RelatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
6. RelatedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
7. RelatedEntity.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
8. RelatedEntity.relatedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person

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

1. RelatedEntity
Definition

Base definition for all types defined in FHIR type system.

Control10..1*
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. RelatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassMutualRelationship
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
4. RelatedEntity.code
Control0..1
BindingThe codes SHALL be taken from PersonalRelationshipRoleType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
5. RelatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
6. RelatedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
7. RelatedEntity.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
8. RelatedEntity.relatedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person

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

1. RelatedEntity
Definition

Base definition for all types defined in FHIR type system.

Control1..1
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. RelatedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassMutualRelationship
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. 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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
4. RelatedEntity.code
Control0..1
BindingThe codes SHALL be taken from PersonalRelationshipRoleType; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
5. RelatedEntity.addr
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
6. RelatedEntity.telecom
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
7. RelatedEntity.effectiveTime
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
8. RelatedEntity.relatedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person