Datatypes
Class Annotation

This class is used to capture remarks about an Activity which might be made by various Practitioners or Persons during the course of that Activity.

Note that this class used to be called CommentEvent. It was renamed to Annotation in May 2017, as the FHIR Annotation datatype is identical in structure and in use.
Note that this class used to contain an optional property called commentCategory, which was intended to provide an categorization of the comment for grouping purposes or to identify the situation in which the comment occured. The FHIM terminology team decided to remove this property in January 2013 as no universally standardized values could be identified for the comment category. This property may be reinstated in the future should a desired set of categories be identified.

"A text note which also contains information about who made the statement and when." - HL7 FHIR, Annotation

Attributes
Participation author author

Indicates the Person who created the comment. Note that the Person may be a Practitioner, the Patient, or a Patient's representative, which is why the datatype for this property is Participation, not PractitionerParticipation.
"The individual responsible for making the annotation." - HL7 FHIR, Annotation.author[x]

String comment comment

This property contains the comment text.
"Contains the comment contained in the segment." - HL7 Version 2.8, NTE-3.
"The text of the annotation." - HL7 FHIR, Annotation.text
"May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result." - HL7 FHIR, Observation.comment

«TS» PointInTime dateTime dateTime

The date and time the comment was entered.
"Indicates when this particular annotation was made." - HL7 FHIR, Annotation.time


Properties:

Alias
Classifier Behavior
Is Abstractfalse
Is Activefalse
Is Leaffalse
Keywords
NameAnnotation
Name Expression
NamespaceDatatypes
Owned Template Signature
OwnerDatatypes
Owning Template Parameter
PackageDatatypes
Qualified NameFHIM::Datatypes::Annotation
Representation
Stereotype
Template Parameter
VisibilityPublic

Attribute Details

 author
Public Participation author

Indicates the Person who created the comment. Note that the Person may be a Practitioner, the Patient, or a Patient's representative, which is why the datatype for this property is Participation, not PractitionerParticipation.
"The individual responsible for making the annotation." - HL7 FHIR, Annotation.author[x]

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAnnotation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Nameauthor
Name Expression
NamespaceAnnotation
Opposite
OwnerAnnotation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Annotation::author
Stereotype
Template Parameter
TypeParticipation
Upper1
Upper Value(1)
VisibilityPublic


 comment
Public String comment

This property contains the comment text.
"Contains the comment contained in the segment." - HL7 Version 2.8, NTE-3.
"The text of the annotation." - HL7 FHIR, Annotation.text
"May include statements about significant, unexpected or unreliable values, or information about the source of the value where this may be relevant to the interpretation of the result." - HL7 FHIR, Observation.comment

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAnnotation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower1
Lower Value(1)
Multiplicity1
Namecomment
Name Expression
NamespaceAnnotation
Opposite
OwnerAnnotation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Annotation::comment
Stereotype
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 dateTime
Public «TS» PointInTime dateTime

The date and time the comment was entered.
"Indicates when this particular annotation was made." - HL7 FHIR, Annotation.time

Constraints:
Properties:

AggregationNone
Alias
Association
Association End
ClassAnnotation
Datatype
Default
Default Value
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
Keywords
Lower0
Lower Value(0)
Multiplicity0..1
NamedateTime
Name Expression
NamespaceAnnotation
Opposite
OwnerAnnotation
Owning Association
Owning Template Parameter
Qualified NameFHIM::Datatypes::Annotation::dateTime
Stereotype
Template Parameter
Type«TS» PointInTime
Upper1
Upper Value(1)
VisibilityPublic