---
type: "datatype"
title: "Annotation"
datatype: "Annotation"
---
# Annotation

- [Datatypes](/datatypes)
- [Definitions](/datatypes-definitions#Annotation)
- [Examples](/datatypes-examples#Annotation)
- [Mappings](/datatypes-mappings#Annotation)
- [Profiles](/datatypes-profiles#Annotation)

## Overview

See also [Examples](datatypes-examples#Annotation), [Detailed Descriptions](datatypes-definitions#Annotation), [Mappings](datatypes-mappings#Annotation), [Profiles](datatypes-profiles#Annotation) and [Extensions]([%extensions-location%]extensions-datatypes#Annotation)

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.display` instead of the the anti-pattern `Annotation.authorString` (`authorString` cannot 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]](/datatypes-definitions#Annotation.author%5Bx%5D)** [0..1]: Reference(Practitioner|PractitionerRole|Patient|RelatedPerson|Organization)|string The individual responsible for making the annotation.
- **[Annotation.time](/datatypes-definitions#Annotation.time)** [0..1]: [dateTime](/dateTime) Indicates when this particular annotation was made
- **[Annotation.text](/datatypes-definitions#Annotation.text)** [1..1]: [markdown](/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