Clinical Document Architecture
2.0.0-sd - release

Clinical Document Architecture, published by Health Level 7. This guide is not an authorized publication; it is the continuous build for version 2.0.0-sd built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-core-sd/ and changes regularly. See the Directory of published versions

Logical Model: RelatedEntity (CDA Class)

Official URL: http://hl7.org/cda/stds/core/StructureDefinition/RelatedEntity Version: 2.0.0-sd
Active as of 2024-10-25 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).

Usage:

Formal Views of Template Content

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

This structure is derived from InfrastructureRoot

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
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)

PathConformanceValueSetURI
RelatedEntity.classCoderequiredCDARoleClassMutualRelationship
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship
from this IG
RelatedEntity.codeexamplePersonalRelationshipRoleType
http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
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

PathConformanceValueSetURI
RelatedEntity.classCoderequiredCDARoleClassMutualRelationship
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship
from this IG
RelatedEntity.codeexamplePersonalRelationshipRoleType
http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @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

PathConformanceValueSetURI
RelatedEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RelatedEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RelatedEntity.classCoderequiredCDARoleClassMutualRelationship
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship
from this IG
RelatedEntity.codeexamplePersonalRelationshipRoleType
http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType

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 & Constraintsdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
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)

PathConformanceValueSetURI
RelatedEntity.classCoderequiredCDARoleClassMutualRelationship
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship
from this IG
RelatedEntity.codeexamplePersonalRelationshipRoleType
http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
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

PathConformanceValueSetURI
RelatedEntity.classCoderequiredCDARoleClassMutualRelationship
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship
from this IG
RelatedEntity.codeexamplePersonalRelationshipRoleType
http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedEntity 1..1 InfrastructureRoot XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @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

PathConformanceValueSetURI
RelatedEntity.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RelatedEntity.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
from this IG
RelatedEntity.classCoderequiredCDARoleClassMutualRelationship
http://hl7.org/cda/stds/core/ValueSet/CDARoleClassMutualRelationship
from this IG
RelatedEntity.codeexamplePersonalRelationshipRoleType
http://terminology.hl7.org/ValueSet/v3-PersonalRelationshipRoleType

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