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.Entity - Detailed Descriptions

Active as of 2023-10-03

Definitions for the Entity logical model.

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

0. Entity
Control1..1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Entity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default ValueENT
4. Entity.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
6. Entity.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/cda/stds/core/StructureDefinition/II
8. Entity.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Entity.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from EntityCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
12. Entity.desc
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED

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

0. Entity
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..1*
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Entity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default ValueENT
4. Entity.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
6. Entity.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/cda/stds/core/StructureDefinition/II
8. Entity.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Entity.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from EntityCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
12. Entity.desc
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED

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

0. Entity
Definition

Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control1..1
Is Modifierfalse
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. Entity.classCode
Control1..1
BindingThe codes SHALL be taken from EntityClassRoot
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Default ValueENT
4. Entity.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode(cs: Coded Simple Value)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
XML FormatIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
6. Entity.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/cda/stds/core/StructureDefinition/II
8. Entity.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Entity.code
Control0..1
BindingUnless not suitable, these codes SHALL be taken from EntityCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
12. Entity.desc
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED