| Datatypes UML Documentation |
Summary:AttributesProperties | Detail:Attributes |
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 |
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 |
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 |
The date and time the comment was entered."Indicates when this particular annotation was made." - HL7 FHIR, Annotation.time |
Properties:
Alias | |
Classifier Behavior | |
Is Abstract | false |
Is Active | false |
Is Leaf | false |
Keywords | |
Name | Annotation |
Name Expression | |
Namespace | Datatypes |
Owned Template Signature | |
Owner | Datatypes |
Owning Template Parameter | |
Package | Datatypes |
Qualified Name | FHIM::Datatypes::Annotation |
Representation | |
Stereotype | |
Template Parameter | |
Visibility | Public |
Attribute Details |
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]
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Annotation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | author |
Name Expression | |
Namespace | Annotation |
Opposite | |
Owner | Annotation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::Annotation::author |
Stereotype | |
Template Parameter | |
Type | Participation |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
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
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Annotation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 1 |
Lower Value | (1) |
Multiplicity | 1 |
Name | comment |
Name Expression | |
Namespace | Annotation |
Opposite | |
Owner | Annotation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::Annotation::comment |
Stereotype | |
Template Parameter | |
Type | String |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
Public «TS» PointInTime dateTime
The date and time the comment was entered."Indicates when this particular annotation was made." - HL7 FHIR, Annotation.time
Aggregation | None |
Alias | |
Association | |
Association End | |
Class | Annotation |
Datatype | |
Default | |
Default Value | |
Is Composite | false |
Is Derived | false |
Is Derived Union | false |
Is Leaf | false |
Is Ordered | false |
Is Read Only | false |
Is Static | false |
Is Unique | true |
Keywords | |
Lower | 0 |
Lower Value | (0) |
Multiplicity | 0..1 |
Name | dateTime |
Name Expression | |
Namespace | Annotation |
Opposite | |
Owner | Annotation |
Owning Association | |
Owning Template Parameter | |
Qualified Name | FHIM::Datatypes::Annotation::dateTime |
Stereotype | |
Template Parameter | |
Type | «TS» PointInTime |
Upper | 1 |
Upper Value | (1) |
Visibility | Public |
| Datatypes UML Documentation |
Summary:AttributesProperties | Detail:Attributes |