Clinical Document Architecture
2.0.2-sd - release

This page is part of the CDA: Clinical Document Architecture (v2.0.2-sd: CDA 2.0 - Informative) generated with FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: RelatedEntity (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity Version: 2.0.2-sd
Active as of 2025-12-12 Computable Name: RelatedEntity

The RelatedEntity role is used to represent an informant without a role.id (e.g. a parent or guy on the street).

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 1..1 cs Binding: CDARoleClassMutualRelationship (required)
... code 0..1 CE Binding: PersonalRelationshipRoleType (example)
... addr 0..* AD
... effectiveTime 0..1 IVL_TS
... relatedPerson 0..1 Person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedEntity.classCode Base required CDARoleClassMutualRelationship 📦2.0.2-sd This IG
RelatedEntity.code Base example PersonalRelationshipRoleType 📦2.0.0 THO v5.2
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 1..1 cs Binding: CDARoleClassMutualRelationship (required)
... code 0..1 CE Binding: PersonalRelationshipRoleType (example)
... addr 0..* AD
... telecom 0..* TEL
... effectiveTime 0..1 IVL_TS
... relatedPerson 0..1 Person

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedEntity.nullFlavor Base required CDANullFlavor 📦2.0.2-sd This IG
RelatedEntity.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd This IG
RelatedEntity.classCode Base required CDARoleClassMutualRelationship 📦2.0.2-sd This IG
RelatedEntity.code Base example PersonalRelationshipRoleType 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error RelatedEntity.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 1..1 cs Binding: CDARoleClassMutualRelationship (required)
... code 0..1 CE Binding: PersonalRelationshipRoleType (example)
... addr 0..* AD
... telecom 0..* TEL
... effectiveTime 0..1 IVL_TS
... relatedPerson 0..1 Person

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedEntity.nullFlavor Base required CDANullFlavor 📦2.0.2-sd This IG
RelatedEntity.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd This IG
RelatedEntity.classCode Base required CDARoleClassMutualRelationship 📦2.0.2-sd This IG
RelatedEntity.code Base example PersonalRelationshipRoleType 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error RelatedEntity.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

Differential View

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @classCode 1..1 cs Binding: CDARoleClassMutualRelationship (required)
... code 0..1 CE Binding: PersonalRelationshipRoleType (example)
... addr 0..* AD
... effectiveTime 0..1 IVL_TS
... relatedPerson 0..1 Person

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
RelatedEntity.classCode Base required CDARoleClassMutualRelationship 📦2.0.2-sd This IG
RelatedEntity.code Base example PersonalRelationshipRoleType 📦2.0.0 THO v5.2

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 1..1 cs Binding: CDARoleClassMutualRelationship (required)
... code 0..1 CE Binding: PersonalRelationshipRoleType (example)
... addr 0..* AD
... telecom 0..* TEL
... effectiveTime 0..1 IVL_TS
... relatedPerson 0..1 Person

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedEntity.nullFlavor Base required CDANullFlavor 📦2.0.2-sd This IG
RelatedEntity.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd This IG
RelatedEntity.classCode Base required CDARoleClassMutualRelationship 📦2.0.2-sd This IG
RelatedEntity.code Base example PersonalRelationshipRoleType 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error RelatedEntity.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Base for all types and resources

Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId C 0..1 II Constraints: II-1
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
... @classCode 1..1 cs Binding: CDARoleClassMutualRelationship (required)
... code 0..1 CE Binding: PersonalRelationshipRoleType (example)
... addr 0..* AD
... telecom 0..* TEL
... effectiveTime 0..1 IVL_TS
... relatedPerson 0..1 Person

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
RelatedEntity.nullFlavor Base required CDANullFlavor 📦2.0.2-sd This IG
RelatedEntity.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.2-sd This IG
RelatedEntity.classCode Base required CDARoleClassMutualRelationship 📦2.0.2-sd This IG
RelatedEntity.code Base example PersonalRelationshipRoleType 📦2.0.0 THO v5.2

Constraints

Id Grade Path(s) Description Expression
II-1 error RelatedEntity.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()

This structure is derived from InfrastructureRoot

Summary

Mandatory: 0 element(1 nested mandatory element)

Structures

This structure refers to these other structures:

 

Other representations of profile: CSV, Excel