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: Entry - Detailed Descriptions

Active as of 2023-10-03

Definitions for the Entry logical model.

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

0. Entry
Control1..*
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
Invariantsentry-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. ((act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1)
2. Entry.typeCode
Control0..1
BindingThe codes SHALL be taken from x_ActRelationshipEntry
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 ValueCOMP
4. Entry.contextConductionInd
Control0..1
Typeboolean(bl: Boolean)
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 Valuetrue
6. Entry.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
8. Entry.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
10. Entry.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
12. Entry.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
14. Entry.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
16. Entry.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
18. Entry.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
20. Entry.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
22. Entry.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply

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

0. Entry
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.


Base definition for all types defined in FHIR type system.

ShortBase for all types and resources
Control10..*
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()))
entry-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. ((act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1)
2. Entry.typeCode
Control0..1
BindingThe codes SHALL be taken from x_ActRelationshipEntry
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 ValueCOMP
4. Entry.contextConductionInd
Control0..1
Typeboolean(bl: Boolean)
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 Valuetrue
6. Entry.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
8. Entry.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
10. Entry.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
12. Entry.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
14. Entry.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
16. Entry.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
18. Entry.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
20. Entry.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
22. Entry.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply

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

0. Entry
Definition

Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.

ShortBase for all types and resources
Control1..*
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()))
entry-only-one: SHALL have no more than one of act, encounter, observation, observationMedia, organizer, procedure, regionOfInterest, substanceAdministration, or supply. ((act | encounter | observation | observationMedia | organizer | procedure | regionOfInterest | substanceAdministration | supply).count() = 1)
2. Entry.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
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.
LabelExceptional Value Detail
4. Entry.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
6. Entry.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
8. Entry.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
10. Entry.typeCode
Control0..1
BindingThe codes SHALL be taken from x_ActRelationshipEntry
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 ValueCOMP
12. Entry.contextConductionInd
Control0..1
Typeboolean(bl: Boolean)
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 Valuetrue
14. Entry.act
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Act
16. Entry.encounter
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Encounter
18. Entry.observation
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Observation
20. Entry.observationMedia
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia
22. Entry.organizer
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Organizer
24. Entry.procedure
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Procedure
26. Entry.regionOfInterest
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest
28. Entry.substanceAdministration
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration
30. Entry.supply
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Supply