HL7 BE Laboratory Result WG Implementation Guide (work in progress)
0.0.7 - CI Build

HL7 BE Laboratory Result WG Implementation Guide (work in progress), published by HL7 Belgium. This is not an authorized publication; it is the continuous build for version 0.0.7). This version is based on the current content of https://github.com/hl7-be/hl7-be-fhir-laboratory-report/ and changes regularly. See the Directory of published versions

Data Type Profile: BeCodedAnnotation - Detailed Descriptions

Active as of 2022-04-19

Definitions for the coded-annotation data type profile.

1. Annotation
Definition

A text note which also contains information about who made the statement and when.

Control0..* This element is affected by the following invariants: ele-1
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Annotation.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
3. Annotation.extension
Definition

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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Annotation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Annotation.extension:code
SliceNamecode
Definition

Codifies the content of an Annotation

Control0..1
TypeExtension(BeExtAnnotationCode) (Extension Type: CodeableConcept)
InvariantsDefined on this element
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())
5. Annotation.author[x]
Definition

The individual responsible for making the annotation.

Control0..1
TypeChoice of: Reference(Practitioner | Patient | RelatedPerson | Organization), string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Organization is used when there's no need for specific attribution as to who made the comment.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. Annotation.time
Definition

Indicates when this particular annotation was made.

Control0..1
TypedateTime
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. Annotation.text
Definition

The text of the annotation in markdown format.

Control1..1
Typemarkdown
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))