type: datatypedatatype: Annotation
Annotation
Overview
See also Examples, Detailed Descriptions, Mappings, Profiles and Extensions
A text note which also contains information about who made the statement and when.
[%dt Annotation 16%]
Notes:
- Systems that do not have structured annotations communicate a single annotation with no author or time.
- Annotations SHOULD NOT be used to communicate "modifying" information that could be computable (this is a SHOULD because enforcing user behavior is nearly impossible).
- For communicating the author as a string value, implementers SHOULD use use
Annotation.authorReference.displayinstead of the the anti-patternAnnotation.authorString(authorStringcannot be removed because this datatype is Normative). - This element may need to be included in the Resource human-readable narrative because of the potential for modifying information.
Annotation is used in the following places: [%dtusage Annotation%]
Elements
- Annotation.author[x] [0..1]: Reference(Practitioner|PractitionerRole|Patient|RelatedPerson|Organization)|string The individual responsible for making the annotation.
- Annotation.time [0..1]: dateTime Indicates when this particular annotation was made
- Annotation.text [1..1]: markdown The text of the annotation in markdown format
Summary Elements
- Annotation.author[x]: In _summary view
- Annotation.time: In _summary view
- Annotation.text: In _summary view
Comments
- Annotation.author[x]: Organization is used when there's no need for specific attribution as to who made the comment.
Mappings
- Annotation.author[x]: RIM Mapping: Act.participant[typeCode=AUT].role
- Annotation.author[x]: v2 Mapping: N/A
- Annotation.time: RIM Mapping: Act.effectiveTime
- Annotation.time: v2 Mapping: N/A
- Annotation.text: RIM Mapping: Act.text
- Annotation.text: v2 Mapping: N/A