This page is part of the HL7 Belgium FHIR Implementation Guide - Core profiles (v2.1.2: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
The annotation - plain text without markdown is strongly recommended
Guidance on how to interpret the contents of this table can be found here
0. Annotation
Definition
A text note which also contains information about who made the statement and when.
Short
Text node with attribution
Comments
For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. Annotation.text
Definition
The text of the annotation in markdown format.
Short
The annotation - plain text without markdown is strongly recommendedThe annotation - text content (as markdown)
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
Guidance on how to interpret the contents of this table can be found here
0. Annotation
Definition
A text note which also contains information about who made the statement and when.
Short
Text node with attribution
Comments
For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Short
Additional content defined by implementations
Comments
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
This element introduces a set of slices on Annotation.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. Annotation.author[x]
Definition
The individual responsible for making the annotation.
Short
Individual responsible for the annotation
Comments
Organization is used when there's no need for specific attribution as to who made the comment.
