{ "resourceType" : "StructureDefinition", "id" : "coded-annotation", "text" : { "status" : "extensions", "div" : "

Generated Narrative: StructureDefinition coded-annotation

\r\n\r\n\r\n\r\n
NameFlagsCard.TypeDescription & Constraints\"doco\"
\".\"\".\" Annotation Annotation
\".\"\".\"\".\" Slices for extension Content/Rules for all slices
\".\"\".\"\".\"\".\" extension:code 0..1CodeableConceptAnnotation Code
URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/annotation-code
Binding: Coded Annotation Types (example)
\".\"\".\"\".\" text 1..1markdownThe annotation - plain text without markdown is strongly recommended

\"doco\" Documentation for this format
" }, "url" : "https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/coded-annotation", "version" : "1.0.1", "name" : "BeCodedAnnotation", "title" : "Coded Annotation", "status" : "draft", "date" : "2026-03-25T14:20:28+00:00", "publisher" : "eHealth Platform", "contact" : [{ "name" : "eHealth Platform", "telecom" : [{ "system" : "url", "value" : "https://www.ehealth.fgov.be" }] }, { "name" : "eHealth Platform", "telecom" : [{ "system" : "email", "value" : "support@be-ehealth-standards.atlassian.net", "use" : "work" }] }], "description" : "Annotation DataType with added CodeableConcept extension element", "jurisdiction" : [{ "coding" : [{ "system" : "urn:iso:std:iso:3166", "code" : "BE", "display" : "Belgium" }] }], "fhirVersion" : "4.0.1", "mapping" : [{ "identity" : "v2", "uri" : "http://hl7.org/v2", "name" : "HL7 v2 Mapping" }, { "identity" : "rim", "uri" : "http://hl7.org/v3", "name" : "RIM Mapping" }], "kind" : "complex-type", "abstract" : false, "type" : "Annotation", "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Annotation", "derivation" : "constraint", "snapshot" : { "extension" : [{ "url" : "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString" : "4.0.1" }], "element" : [{ "id" : "Annotation", "path" : "Annotation", "short" : "Text node with attribution", "definition" : "A text note which also contains information about who made the statement and when.", "comment" : "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).", "min" : 0, "max" : "*", "base" : { "path" : "Annotation", "min" : 0, "max" : "*" }, "condition" : ["ele-1"], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }, { "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act" }] }, { "id" : "Annotation.id", "path" : "Annotation.id", "representation" : ["xmlAttr"], "short" : "Unique id for inter-element referencing", "definition" : "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min" : 0, "max" : "1", "base" : { "path" : "Element.id", "min" : 0, "max" : "1" }, "type" : [{ "extension" : [{ "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl" : "string" }], "code" : "http://hl7.org/fhirpath/System.String" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Annotation.extension", "path" : "Annotation.extension", "slicing" : { "discriminator" : [{ "type" : "value", "path" : "url" }], "description" : "Extensions are always sliced by (at least) url", "rules" : "open" }, "short" : "Additional content defined by implementations", "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.", "comment" : "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.", "alias" : ["extensions", "user content"], "min" : 0, "max" : "*", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false, "mapping" : [{ "identity" : "rim", "map" : "n/a" }] }, { "id" : "Annotation.extension:code", "path" : "Annotation.extension", "sliceName" : "code", "short" : "Annotation Code", "definition" : "Codifies the content of an Annotation", "min" : 0, "max" : "1", "base" : { "path" : "Element.extension", "min" : 0, "max" : "*" }, "type" : [{ "code" : "Extension", "profile" : ["https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/annotation-code"] }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }, { "key" : "ext-1", "severity" : "error", "human" : "Must have either extensions or value[x], not both", "expression" : "extension.exists() != value.exists()", "xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source" : "http://hl7.org/fhir/StructureDefinition/Extension" }], "isModifier" : false, "isSummary" : false }, { "id" : "Annotation.author[x]", "path" : "Annotation.author[x]", "short" : "Individual responsible for the annotation", "definition" : "The individual responsible for making the annotation.", "comment" : "Organization is used when there's no need for specific attribution as to who made the comment.", "min" : 0, "max" : "1", "base" : { "path" : "Annotation.author[x]", "min" : 0, "max" : "1" }, "type" : [{ "code" : "Reference", "targetProfile" : ["http://hl7.org/fhir/StructureDefinition/Practitioner|4.0.1", "http://hl7.org/fhir/StructureDefinition/Patient|4.0.1", "http://hl7.org/fhir/StructureDefinition/RelatedPerson|4.0.1", "http://hl7.org/fhir/StructureDefinition/Organization|4.0.1"] }, { "code" : "string" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.participant[typeCode=AUT].role" }] }, { "id" : "Annotation.time", "path" : "Annotation.time", "short" : "When the annotation was made", "definition" : "Indicates when this particular annotation was made.", "min" : 0, "max" : "1", "base" : { "path" : "Annotation.time", "min" : 0, "max" : "1" }, "type" : [{ "code" : "dateTime" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.effectiveTime" }] }, { "id" : "Annotation.text", "path" : "Annotation.text", "short" : "The annotation - plain text without markdown is strongly recommended", "definition" : "The text of the annotation in markdown format.", "min" : 1, "max" : "1", "base" : { "path" : "Annotation.text", "min" : 1, "max" : "1" }, "type" : [{ "code" : "markdown" }], "constraint" : [{ "key" : "ele-1", "severity" : "error", "human" : "All FHIR elements must have a @value or children", "expression" : "hasValue() or (children().count() > id.count())", "xpath" : "@value|f:*|h:div", "source" : "http://hl7.org/fhir/StructureDefinition/Element" }], "isModifier" : false, "isSummary" : true, "mapping" : [{ "identity" : "v2", "map" : "N/A" }, { "identity" : "rim", "map" : "Act.text" }] }] }, "differential" : { "element" : [{ "id" : "Annotation.extension:code", "path" : "Annotation.extension", "sliceName" : "code", "min" : 0, "max" : "1", "type" : [{ "code" : "Extension", "profile" : ["https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/annotation-code"] }] }, { "id" : "Annotation.text", "path" : "Annotation.text", "short" : "The annotation - plain text without markdown is strongly recommended" }] } }