Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build United States of America flag

Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions

Logical Model: Comment Activity

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/CommentActivity Version: 2.1
Draft as of 2023-09-29 Computable Name: CommentActivity
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.20.22.4.64

Comments are free text data that cannot otherwise be recorded using data elements already defined by this specification. They are not to be used to record information that can be recorded elsewhere. For example, a free text description of the severity of an allergic reaction would not be recorded in a comment.

Usage:

  • This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
81-9429: Data elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
... classCode 1..1csFixed Value: ACT
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.64
..... extension 0..0
.... code 1..1csRequired Pattern: 48767-8
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 1..1ED
.... reference 1..1TEL
..... value C1..1url81-15969: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
... author 0..1AuthorParticipationBase for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
81-9429warningActData elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
:
81-15969errorAct.text.reference.valueThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
:
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
81-9429: Data elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.64
.... @code 1..1csRequired Pattern: 48767-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 1..1ED
.... reference 1..1TEL
..... @value C1..1url81-15969: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
... author 0..1AuthorParticipationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Act.codeextensibleActCode

Constraints

IdGradePath(s)DetailsRequirements
81-9429warningActData elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
:
81-15969errorAct.text.reference.valueThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
81-9429: Data elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.64
... id 0..*II
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: 48767-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... @negationInd 0..1bl
... text 1..1ED
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @charset 0..1cs
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (required)
.... @language 0..1cs
.... @mediaType 0..1cs
.... @representation 0..1cs
.... data[x] 0..1
..... dataStringstring(st)
..... dataBase64Binarybase64Binary(bin)
.... reference 1..1TEL
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @value C1..1url81-15969: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
..... useablePeriod 0..*
...... useablePeriodIVL_TS
...... useablePeriodEIVL_TS
...... useablePeriodPIVL_TS
...... useablePeriodSXPR_TS
..... @use 0..*csBinding: AddressUse (required)
.... thumbnail 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..1AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Act.nullFlavorrequiredNullFlavor
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.text.nullFlavorrequiredNullFlavor
Act.text.compressionrequiredCompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.reference.nullFlavorrequiredNullFlavor
Act.text.reference.userequiredAddressUse
Act.statusCoderequiredActStatus
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)

Constraints

IdGradePath(s)DetailsRequirements
81-9429warningActData elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
:
81-15969errorAct.text.reference.valueThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Act

Summary

Mandatory: 8 elements
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root

Differential View

This structure is derived from CDAR2.Act

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
81-9429: Data elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
... classCode 1..1csFixed Value: ACT
... moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.64
..... extension 0..0
.... code 1..1csRequired Pattern: 48767-8
.... codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 1..1ED
.... reference 1..1TEL
..... value C1..1url81-15969: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
... author 0..1AuthorParticipationBase for all types and resources

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
81-9429warningActData elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
:
81-15969errorAct.text.reference.valueThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
:

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
81-9429: Data elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.64
.... @code 1..1csRequired Pattern: 48767-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
... text 1..1ED
.... reference 1..1TEL
..... @value C1..1url81-15969: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
... author 0..1AuthorParticipationBase for all types and resources

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Act.codeextensibleActCode

Constraints

IdGradePath(s)DetailsRequirements
81-9429warningActData elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
:
81-15969errorAct.text.reference.valueThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Act C1..1CDAR2.ActXML Namespace: urn:hl7-org:v3
Elements defined in Ancestors: @nullFlavor, @classCode, @moodCode, realmCode, typeId, templateId, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition
Base for all types and resources
81-9429: Data elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
... @nullFlavor 0..1csBinding: NullFlavor (required)
... @classCode 1..1csFixed Value: ACT
... @moodCode 1..1csFixed Value: EVN
... typeId 0..1II
... Slices for templateId 1..*IISlice: Unordered, Open by value:root
.... templateId:primary 1..1II
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @assigningAuthorityName 0..1st
..... @displayable 0..1bl
..... @root 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.10.20.22.4.64
... id 0..*II
... code 1..1CDBinding: v3 Code System ActCode (extensible)
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @code 1..1csRequired Pattern: 48767-8
.... @codeSystem 1..1oid, uuid, ruidRequired Pattern: 2.16.840.1.113883.6.1
.... @codeSystemName 0..1st
.... @codeSystemVersion 0..1st
.... @displayName 0..1st
.... @sdtcValueSet 0..1oidXML Namespace: urn:hl7-org:sdtc
XML: valueSet (urn:hl7-org:sdtc)
.... @sdtcValueSetVersion 0..1stXML Namespace: urn:hl7-org:sdtc
XML: valueSetVersion (urn:hl7-org:sdtc)
.... originalText 0..1ED
.... qualifier 0..*CR
.... translation 0..*CD
... @negationInd 0..1bl
... text 1..1ED
.... @nullFlavor 0..1csBinding: NullFlavor (required)
.... @charset 0..1cs
.... @compression 0..1csBinding: CompressionAlgorithm (required)
.... @integrityCheck 0..1bin
.... @integrityCheckAlgorithm 0..1csBinding: IntegrityCheckAlgorithm (required)
.... @language 0..1cs
.... @mediaType 0..1cs
.... @representation 0..1cs
.... data[x] 0..1
..... dataStringstring(st)
..... dataBase64Binarybase64Binary(bin)
.... reference 1..1TEL
..... @nullFlavor 0..1csBinding: NullFlavor (required)
..... @value C1..1url81-15969: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
..... useablePeriod 0..*
...... useablePeriodIVL_TS
...... useablePeriodEIVL_TS
...... useablePeriodPIVL_TS
...... useablePeriodSXPR_TS
..... @use 0..*csBinding: AddressUse (required)
.... thumbnail 0..1ED
... statusCode 0..1CSBinding: ActStatus (required)
... effectiveTime 0..1IVL_TS
... priorityCode 0..1CEBinding: ActPriority (extensible)
... languageCode 0..1CSBinding: HumanLanguage (required)
... subject 0..1Subject
... specimen 0..*Specimen
... performer 0..*Performer2
... author 0..1AuthorParticipationBase for all types and resources
... informant 0..*Informant
... participant 0..*Participant2
... entryRelationship 0..*EntryRelationship
... reference 0..*Reference
... precondition 0..*Precondition

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Act.nullFlavorrequiredNullFlavor
Act.templateId:primary.nullFlavorrequiredNullFlavor
Act.codeextensibleActCode
Act.code.nullFlavorrequiredNullFlavor
Act.text.nullFlavorrequiredNullFlavor
Act.text.compressionrequiredCompressionAlgorithm
Act.text.integrityCheckAlgorithmrequiredIntegrityCheckAlgorithm
Act.text.reference.nullFlavorrequiredNullFlavor
Act.text.reference.userequiredAddressUse
Act.statusCoderequiredActStatus
Act.priorityCodeextensibleActPriority
Act.languageCoderequiredHumanLanguage (a valid code from http://terminology.hl7.org/CodeSystem/ietf3066)

Constraints

IdGradePath(s)DetailsRequirements
81-9429warningActData elements defined elsewhere in the specification SHALL NOT be recorded using the Comment Activity (CONF:81-9429).
:
81-15969errorAct.text.reference.valueThis reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) (CONF:81-15969).
:
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())

This structure is derived from CDAR2.Act

Summary

Mandatory: 8 elements
Fixed Value: 2 elements
Prohibited: 1 element

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Act.templateId is sliced based on the value of value:root

 

Other representations of profile: CSV, Excel