Clinical Document Architecture
2.0.0-sd-ballot - ballot

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-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/ahdis/cda-core-2.0/ and changes regularly. See the Directory of published versions

Logical Model: Act - Detailed Descriptions

Active as of 2024-03-04

Definitions for the Act logical model.

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

0. Act
Control1..1
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Act.classCode
Control1..1
BindingThe codes SHALL be taken from XActClassDocumentEntryAct (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
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.
4. Act.moodCode
Control1..1
BindingThe codes SHALL be taken from XDocumentActMood (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
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.
6. Act.negationInd
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.
8. Act.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Act.code
Control1..1
BindingFor example codes, see v3 Code System ActCode
(example to http://terminology.hl7.org/ValueSet/v3-ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
12. Act.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
14. Act.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
16. Act.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
18. Act.priorityCode
Control0..1
BindingFor example codes, see ActPriority
(example to http://terminology.hl7.org/ValueSet/v3-ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
20. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
22. Act.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
24. Act.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
26. Act.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
28. Act.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
30. Act.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
32. Act.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
34. Act.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
36. Act.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
38. Act.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
40. Act.sdtcPrecondition2
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition2
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2.
42. Act.sdtcInFulfillmentOf1
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.

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

0. Act
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..1*
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Act.classCode
Control1..1
BindingThe codes SHALL be taken from XActClassDocumentEntryAct (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
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.
4. Act.moodCode
Control1..1
BindingThe codes SHALL be taken from XDocumentActMood (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
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.
6. Act.negationInd
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.
8. Act.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
10. Act.code
Control1..1
BindingFor example codes, see v3 Code System ActCode
(example to http://terminology.hl7.org/ValueSet/v3-ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
12. Act.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
14. Act.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
16. Act.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
18. Act.priorityCode
Control0..1
BindingFor example codes, see ActPriority
(example to http://terminology.hl7.org/ValueSet/v3-ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
20. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
22. Act.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
24. Act.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
26. Act.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
28. Act.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
30. Act.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
32. Act.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
34. Act.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
36. Act.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
38. Act.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
40. Act.sdtcPrecondition2
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition2
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2.
42. Act.sdtcInFulfillmentOf1
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.

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

0. Act
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..1
Is Modifierfalse
Logical ContainerClinicalDocument (CDA Class)
ValidationInstances of this type are validated by templateId
XML FormatIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Act.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 CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
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. Act.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. Act.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. Act.typeId.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 CDANullFlavor
(required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
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
10. Act.typeId.assigningAuthorityName
Definition

A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.

Control0..1
Typestring(st: Character String)
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.
LabelAssigning Authority Name
12. Act.typeId.displayable
Definition

Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).

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.
LabelDisplayable
14. Act.typeId.root
Definition

Identifies the type as an HL7 Registered model

Control1..1
Typestring(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme)
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.
LabelRoot
Fixed Value2.16.840.1.113883.1.3
16. Act.typeId.extension
Definition

A character string as a unique identifier within the scope of the identifier root.

Control1..1
Typestring(st: Character String)
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.
LabelExtension
18. Act.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
20. Act.classCode
Control1..1
BindingThe codes SHALL be taken from XActClassDocumentEntryAct (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0
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.
22. Act.moodCode
Control1..1
BindingThe codes SHALL be taken from XDocumentActMood (2.0.0)
(required to http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0
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.
24. Act.negationInd
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.
26. Act.id
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/II
28. Act.code
Control1..1
BindingFor example codes, see v3 Code System ActCode
(example to http://terminology.hl7.org/ValueSet/v3-ActCode
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CD
30. Act.text
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/ED
32. Act.statusCode
Control0..1
BindingThe codes SHALL be taken from ActStatus
(required to http://terminology.hl7.org/ValueSet/v3-ActStatus
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
34. Act.effectiveTime
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/IVL-TS
36. Act.priorityCode
Control0..1
BindingFor example codes, see ActPriority
(example to http://terminology.hl7.org/ValueSet/v3-ActPriority
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CE
38. Act.languageCode
Control0..1
BindingThe codes SHALL be taken from AllLanguages
(required to http://hl7.org/fhir/ValueSet/all-languages
Typehttp://hl7.org/cda/stds/core/StructureDefinition/CS
40. Act.subject
Control0..1
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Subject
42. Act.specimen
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Specimen
44. Act.performer
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Performer2
46. Act.author
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Author
48. Act.informant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Informant
50. Act.participant
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Participant2
52. Act.entryRelationship
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship
54. Act.reference
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Reference
56. Act.precondition
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition
58. Act.sdtcPrecondition2
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/Precondition2
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameprecondition2.
60. Act.sdtcInFulfillmentOf1
Control0..*
Typehttp://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1
XML FormatIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual nameinFulfillmentOf1.