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