Annotation.xml 1 <?xml version="1.0" encoding="utf-8"?> 2 <StructureDefinition xmlns="http://hl7.org/fhir"> 3 <id value="Annotation" /> 4 <meta> 5 <lastUpdated value="2023-03-26T06:21:02.749+02:00" /> 6 </meta> 7 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 8 <valueCode value="normative" /> 9 </extension> 10 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> 11 <valueCode value="4.0.0" /> 12 </extension> 13 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics"> 14 <valueCode value="has-size" /> 15 </extension> 16 <url value="http://hl7.org/fhir/StructureDefinition/Annotation" /> 17 <version value="5.0.0" /> 18 <name value="Annotation" /> 19 <status value="active" /> 20 <experimental value="false" /> 21 <date value="2023-03-26T06:21:02.0000000+02:00" /> 22 <publisher value="HL7 FHIR Standard" /> 23 <contact> 24 <telecom> 25 <system value="url" /> 26 <value value="http://hl7.org/fhir" /> 27 </telecom> 28 </contact> 29 <description value="Annotation Type: A text note which also contains information about who made the statement and when." /> 30 <jurisdiction> 31 <coding> 32 <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" /> 33 <code value="001" /> 34 <display value="World" /> 35 </coding> 36 </jurisdiction> 37 <fhirVersion value="5.0.0" /> 38 <mapping> 39 <identity value="v2" /> 40 <uri value="http://hl7.org/v2" /> 41 <name value="HL7 V2 Mapping" /> 42 </mapping> 43 <mapping> 44 <identity value="rim" /> 45 <uri value="http://hl7.org/v3" /> 46 <name value="RIM Mapping" /> 47 </mapping> 48 <kind value="complex-type" /> 49 <abstract value="false" /> 50 <type value="Annotation" /> 51 <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType" /> 52 <derivation value="specialization" /> 53 <snapshot> 54 <element id="Annotation"> 55 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 56 <valueCode value="normative" /> 57 </extension> 58 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> 59 <valueCode value="4.0.0" /> 60 </extension> 61 <path value="Annotation" /> 62 <short value="Text node with attribution" /> 63 <definition value="A text note which also contains information about who made the statement and when." /> 64 <comment value="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)." /> 65 <min value="0" /> 66 <max value="*" /> 67 <base> 68 <path value="Annotation" /> 69 <min value="0" /> 70 <max value="*" /> 71 </base> 72 <constraint> 73 <key value="ele-1" /> 74 <severity value="error" /> 75 <human value="All FHIR elements must have a @value or children" /> 76 <expression value="hasValue() or (children().count() > id.count())" /> 77 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 78 </constraint> 79 <isModifier value="false" /> 80 <mapping> 81 <identity value="rim" /> 82 <map value="n/a,Act" /> 83 </mapping> 84 <mapping> 85 <identity value="v2" /> 86 <map value="N/A" /> 87 </mapping> 88 </element> 89 <element id="Annotation.id"> 90 <path value="Annotation.id" /> 91 <representation value="xmlAttr" /> 92 <short value="Unique id for inter-element referencing" /> 93 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 94 <min value="0" /> 95 <max value="1" /> 96 <base> 97 <path value="Element.id" /> 98 <min value="0" /> 99 <max value="1" /> 100 </base> 101 <type> 102 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 103 <valueUrl value="id" /> 104 </extension> 105 <code value="http://hl7.org/fhirpath/System.String" /> 106 </type> 107 <condition value="ele-1" /> 108 <isModifier value="false" /> 109 <isSummary value="false" /> 110 <mapping> 111 <identity value="rim" /> 112 <map value="n/a" /> 113 </mapping> 114 </element> 115 <element id="Annotation.extension"> 116 <path value="Annotation.extension" /> 117 <slicing> 118 <discriminator> 119 <type value="value" /> 120 <path value="url" /> 121 </discriminator> 122 <description value="Extensions are always sliced by (at least) url" /> 123 <rules value="open" /> 124 </slicing> 125 <short value="Additional content defined by implementations" /> 126 <definition value="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 managable, 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." /> 127 <comment value="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." /> 128 <alias value="extensions" /> 129 <alias value="user content" /> 130 <min value="0" /> 131 <max value="*" /> 132 <base> 133 <path value="Element.extension" /> 134 <min value="0" /> 135 <max value="*" /> 136 </base> 137 <type> 138 <code value="Extension" /> 139 </type> 140 <constraint> 141 <key value="ele-1" /> 142 <severity value="error" /> 143 <human value="All FHIR elements must have a @value or children" /> 144 <expression value="hasValue() or (children().count() > id.count())" /> 145 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 146 </constraint> 147 <constraint> 148 <key value="ext-1" /> 149 <severity value="error" /> 150 <human value="Must have either extensions or value[x], not both" /> 151 <expression value="extension.exists() != value.exists()" /> 152 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 153 </constraint> 154 <isModifier value="false" /> 155 <isSummary value="false" /> 156 <mapping> 157 <identity value="rim" /> 158 <map value="n/a" /> 159 </mapping> 160 </element> 161 <element id="Annotation.author[x]"> 162 <path value="Annotation.author[x]" /> 163 <short value="Individual responsible for the annotation" /> 164 <definition value="The individual responsible for making the annotation." /> 165 <comment value="Organization is used when there's no need for specific attribution as to who made the comment." /> 166 <min value="0" /> 167 <max value="1" /> 168 <base> 169 <path value="Annotation.author[x]" /> 170 <min value="0" /> 171 <max value="1" /> 172 </base> 173 <type> 174 <code value="Reference" /> 175 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> 176 <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> 177 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> 178 <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> 179 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> 180 </type> 181 <type> 182 <code value="string" /> 183 </type> 184 <constraint> 185 <key value="ele-1" /> 186 <severity value="error" /> 187 <human value="All FHIR elements must have a @value or children" /> 188 <expression value="hasValue() or (children().count() > id.count())" /> 189 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 190 </constraint> 191 <isModifier value="false" /> 192 <isSummary value="true" /> 193 <mapping> 194 <identity value="v2" /> 195 <map value="N/A" /> 196 </mapping> 197 <mapping> 198 <identity value="rim" /> 199 <map value="Act.participant[typeCode=AUT].role" /> 200 </mapping> 201 </element> 202 <element id="Annotation.time"> 203 <path value="Annotation.time" /> 204 <short value="When the annotation was made" /> 205 <definition value="Indicates when this particular annotation was made." /> 206 <min value="0" /> 207 <max value="1" /> 208 <base> 209 <path value="Annotation.time" /> 210 <min value="0" /> 211 <max value="1" /> 212 </base> 213 <type> 214 <code value="dateTime" /> 215 </type> 216 <constraint> 217 <key value="ele-1" /> 218 <severity value="error" /> 219 <human value="All FHIR elements must have a @value or children" /> 220 <expression value="hasValue() or (children().count() > id.count())" /> 221 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 222 </constraint> 223 <isModifier value="false" /> 224 <isSummary value="true" /> 225 <mapping> 226 <identity value="v2" /> 227 <map value="N/A" /> 228 </mapping> 229 <mapping> 230 <identity value="rim" /> 231 <map value="Act.effectiveTime" /> 232 </mapping> 233 </element> 234 <element id="Annotation.text"> 235 <path value="Annotation.text" /> 236 <short value="The annotation - text content (as markdown)" /> 237 <definition value="The text of the annotation in markdown format." /> 238 <min value="1" /> 239 <max value="1" /> 240 <base> 241 <path value="Annotation.text" /> 242 <min value="1" /> 243 <max value="1" /> 244 </base> 245 <type> 246 <code value="markdown" /> 247 </type> 248 <constraint> 249 <key value="ele-1" /> 250 <severity value="error" /> 251 <human value="All FHIR elements must have a @value or children" /> 252 <expression value="hasValue() or (children().count() > id.count())" /> 253 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 254 </constraint> 255 <isModifier value="false" /> 256 <isSummary value="true" /> 257 <mapping> 258 <identity value="v2" /> 259 <map value="N/A" /> 260 </mapping> 261 <mapping> 262 <identity value="rim" /> 263 <map value="Act.text" /> 264 </mapping> 265 </element> 266 </snapshot> 267 <differential> 268 <element id="Annotation"> 269 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 270 <valueCode value="normative" /> 271 </extension> 272 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version"> 273 <valueCode value="4.0.0" /> 274 </extension> 275 <path value="Annotation" /> 276 <short value="Text node with attribution" /> 277 <definition value="A text note which also contains information about who made the statement and when." /> 278 <comment value="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)." /> 279 <min value="0" /> 280 <max value="*" /> 281 <mapping> 282 <identity value="v2" /> 283 <map value="N/A" /> 284 </mapping> 285 <mapping> 286 <identity value="rim" /> 287 <map value="Act" /> 288 </mapping> 289 </element> 290 <element id="Annotation.author[x]"> 291 <path value="Annotation.author[x]" /> 292 <short value="Individual responsible for the annotation" /> 293 <definition value="The individual responsible for making the annotation." /> 294 <comment value="Organization is used when there's no need for specific attribution as to who made the comment." /> 295 <min value="0" /> 296 <max value="1" /> 297 <type> 298 <code value="Reference" /> 299 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> 300 <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> 301 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> 302 <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> 303 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> 304 </type> 305 <type> 306 <code value="string" /> 307 </type> 308 <isSummary value="true" /> 309 <mapping> 310 <identity value="v2" /> 311 <map value="N/A" /> 312 </mapping> 313 <mapping> 314 <identity value="rim" /> 315 <map value="Act.participant[typeCode=AUT].role" /> 316 </mapping> 317 </element> 318 <element id="Annotation.time"> 319 <path value="Annotation.time" /> 320 <short value="When the annotation was made" /> 321 <definition value="Indicates when this particular annotation was made." /> 322 <min value="0" /> 323 <max value="1" /> 324 <type> 325 <code value="dateTime" /> 326 </type> 327 <isSummary value="true" /> 328 <mapping> 329 <identity value="v2" /> 330 <map value="N/A" /> 331 </mapping> 332 <mapping> 333 <identity value="rim" /> 334 <map value="Act.effectiveTime" /> 335 </mapping> 336 </element> 337 <element id="Annotation.text"> 338 <path value="Annotation.text" /> 339 <short value="The annotation - text content (as markdown)" /> 340 <definition value="The text of the annotation in markdown format." /> 341 <min value="1" /> 342 <max value="1" /> 343 <type> 344 <code value="markdown" /> 345 </type> 346 <isSummary value="true" /> 347 <mapping> 348 <identity value="v2" /> 349 <map value="N/A" /> 350 </mapping> 351 <mapping> 352 <identity value="rim" /> 353 <map value="Act.text" /> 354 </mapping> 355 </element> 356 </differential> 357 </StructureDefinition>