RelatedArtifact.xml 1 <?xml version="1.0" encoding="utf-8"?> 2 <StructureDefinition xmlns="http://hl7.org/fhir"> 3 <id value="RelatedArtifact" /> 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="trial-use" /> 9 </extension> 10 <url value="http://hl7.org/fhir/StructureDefinition/RelatedArtifact" /> 11 <version value="4.0.1" /> 12 <name value="RelatedArtifact" /> 13 <status value="draft" /> 14 <date value="2019-10-31T23:29:23.0000000+01:00" /> 15 <publisher value="HL7 FHIR Standard" /> 16 <contact> 17 <telecom> 18 <system value="url" /> 19 <value value="http://hl7.org/fhir" /> 20 </telecom> 21 </contact> 22 <description value="Base StructureDefinition for RelatedArtifact Type: Related artifacts such as additional documentation, justification, or bibliographic references." /> 23 <purpose value="Knowledge resources must be able to provide enough information for consumers of the content (and/or interventions or results produced by the content) to be able to determine and understand the justification for and evidence in support of the content." /> 24 <fhirVersion value="4.0.1" /> 25 <mapping> 26 <identity value="rim" /> 27 <uri value="http://hl7.org/v3" /> 28 <name value="RIM Mapping" /> 29 </mapping> 30 <kind value="complex-type" /> 31 <abstract value="false" /> 32 <type value="RelatedArtifact" /> 33 <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Element" /> 34 <derivation value="specialization" /> 35 <snapshot> 36 <element id="RelatedArtifact"> 37 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 38 <valueCode value="trial-use" /> 39 </extension> 40 <path value="RelatedArtifact" /> 41 <short value="Related artifacts for a knowledge resource" /> 42 <definition value="Related artifacts such as additional documentation, justification, or bibliographic references." /> 43 <comment value="Each related artifact is either an attachment, or a reference to another knowledge resource, but not both." /> 44 <min value="0" /> 45 <max value="*" /> 46 <base> 47 <path value="RelatedArtifact" /> 48 <min value="0" /> 49 <max value="*" /> 50 </base> 51 <condition value="ele-1" /> 52 <constraint> 53 <key value="ele-1" /> 54 <severity value="error" /> 55 <human value="All FHIR elements must have a @value or children" /> 56 <expression value="hasValue() or (children().count() > id.count())" /> 57 <xpath value="@value|f:*|h:div" /> 58 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 59 </constraint> 60 <isModifier value="false" /> 61 <mapping> 62 <identity value="rim" /> 63 <map value="n/a" /> 64 </mapping> 65 </element> 66 <element id="RelatedArtifact.id"> 67 <path value="RelatedArtifact.id" /> 68 <representation value="xmlAttr" /> 69 <short value="Unique id for inter-element referencing" /> 70 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 71 <min value="0" /> 72 <max value="1" /> 73 <base> 74 <path value="Element.id" /> 75 <min value="0" /> 76 <max value="1" /> 77 </base> 78 <type> 79 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 80 <valueUrl value="string" /> 81 </extension> 82 <code value="http://hl7.org/fhirpath/System.String" /> 83 </type> 84 <isModifier value="false" /> 85 <isSummary value="false" /> 86 <mapping> 87 <identity value="rim" /> 88 <map value="n/a" /> 89 </mapping> 90 </element> 91 <element id="RelatedArtifact.extension"> 92 <path value="RelatedArtifact.extension" /> 93 <slicing> 94 <discriminator> 95 <type value="value" /> 96 <path value="url" /> 97 </discriminator> 98 <description value="Extensions are always sliced by (at least) url" /> 99 <rules value="open" /> 100 </slicing> 101 <short value="Additional content defined by implementations" /> 102 <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." /> 103 <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." /> 104 <alias value="extensions" /> 105 <alias value="user content" /> 106 <min value="0" /> 107 <max value="*" /> 108 <base> 109 <path value="Element.extension" /> 110 <min value="0" /> 111 <max value="*" /> 112 </base> 113 <type> 114 <code value="Extension" /> 115 </type> 116 <constraint> 117 <key value="ele-1" /> 118 <severity value="error" /> 119 <human value="All FHIR elements must have a @value or children" /> 120 <expression value="hasValue() or (children().count() > id.count())" /> 121 <xpath value="@value|f:*|h:div" /> 122 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 123 </constraint> 124 <constraint> 125 <key value="ext-1" /> 126 <severity value="error" /> 127 <human value="Must have either extensions or value[x], not both" /> 128 <expression value="extension.exists() != value.exists()" /> 129 <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> 130 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 131 </constraint> 132 <isModifier value="false" /> 133 <isSummary value="false" /> 134 <mapping> 135 <identity value="rim" /> 136 <map value="n/a" /> 137 </mapping> 138 </element> 139 <element id="RelatedArtifact.type"> 140 <path value="RelatedArtifact.type" /> 141 <short value="documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of" /> 142 <definition value="The type of relationship to the related artifact." /> 143 <min value="1" /> 144 <max value="1" /> 145 <base> 146 <path value="RelatedArtifact.type" /> 147 <min value="1" /> 148 <max value="1" /> 149 </base> 150 <type> 151 <code value="code" /> 152 </type> 153 <constraint> 154 <key value="ele-1" /> 155 <severity value="error" /> 156 <human value="All FHIR elements must have a @value or children" /> 157 <expression value="hasValue() or (children().count() > id.count())" /> 158 <xpath value="@value|f:*|h:div" /> 159 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 160 </constraint> 161 <isModifier value="false" /> 162 <isSummary value="true" /> 163 <binding> 164 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 165 <valueString value="RelatedArtifactType" /> 166 </extension> 167 <strength value="required" /> 168 <description value="The type of relationship to the related artifact." /> 169 <valueSet value="http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1" /> 170 </binding> 171 </element> 172 <element id="RelatedArtifact.label"> 173 <path value="RelatedArtifact.label" /> 174 <short value="Short label" /> 175 <definition value="A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index." /> 176 <min value="0" /> 177 <max value="1" /> 178 <base> 179 <path value="RelatedArtifact.label" /> 180 <min value="0" /> 181 <max value="1" /> 182 </base> 183 <type> 184 <code value="string" /> 185 </type> 186 <constraint> 187 <key value="ele-1" /> 188 <severity value="error" /> 189 <human value="All FHIR elements must have a @value or children" /> 190 <expression value="hasValue() or (children().count() > id.count())" /> 191 <xpath value="@value|f:*|h:div" /> 192 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 193 </constraint> 194 <isModifier value="false" /> 195 <isSummary value="true" /> 196 </element> 197 <element id="RelatedArtifact.display"> 198 <path value="RelatedArtifact.display" /> 199 <short value="Brief description of the related artifact" /> 200 <definition value="A brief description of the document or knowledge resource being referenced, suitable for display to a consumer." /> 201 <min value="0" /> 202 <max value="1" /> 203 <base> 204 <path value="RelatedArtifact.display" /> 205 <min value="0" /> 206 <max value="1" /> 207 </base> 208 <type> 209 <code value="string" /> 210 </type> 211 <constraint> 212 <key value="ele-1" /> 213 <severity value="error" /> 214 <human value="All FHIR elements must have a @value or children" /> 215 <expression value="hasValue() or (children().count() > id.count())" /> 216 <xpath value="@value|f:*|h:div" /> 217 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 218 </constraint> 219 <isModifier value="false" /> 220 <isSummary value="true" /> 221 </element> 222 <element id="RelatedArtifact.citation"> 223 <path value="RelatedArtifact.citation" /> 224 <short value="Bibliographic citation for the artifact" /> 225 <definition value="A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format." /> 226 <comment value="Additional structured information about citations should be captured as extensions." /> 227 <min value="0" /> 228 <max value="1" /> 229 <base> 230 <path value="RelatedArtifact.citation" /> 231 <min value="0" /> 232 <max value="1" /> 233 </base> 234 <type> 235 <code value="markdown" /> 236 </type> 237 <constraint> 238 <key value="ele-1" /> 239 <severity value="error" /> 240 <human value="All FHIR elements must have a @value or children" /> 241 <expression value="hasValue() or (children().count() > id.count())" /> 242 <xpath value="@value|f:*|h:div" /> 243 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 244 </constraint> 245 <isModifier value="false" /> 246 <isSummary value="true" /> 247 </element> 248 <element id="RelatedArtifact.url"> 249 <path value="RelatedArtifact.url" /> 250 <short value="Where the artifact can be accessed" /> 251 <definition value="A url for the artifact that can be followed to access the actual content." /> 252 <comment value="If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference)." /> 253 <min value="0" /> 254 <max value="1" /> 255 <base> 256 <path value="RelatedArtifact.url" /> 257 <min value="0" /> 258 <max value="1" /> 259 </base> 260 <type> 261 <code value="url" /> 262 </type> 263 <constraint> 264 <key value="ele-1" /> 265 <severity value="error" /> 266 <human value="All FHIR elements must have a @value or children" /> 267 <expression value="hasValue() or (children().count() > id.count())" /> 268 <xpath value="@value|f:*|h:div" /> 269 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 270 </constraint> 271 <isModifier value="false" /> 272 <isSummary value="true" /> 273 </element> 274 <element id="RelatedArtifact.document"> 275 <path value="RelatedArtifact.document" /> 276 <short value="What document is being referenced" /> 277 <definition value="The document being referenced, represented as an attachment. This is exclusive with the resource element." /> 278 <min value="0" /> 279 <max value="1" /> 280 <base> 281 <path value="RelatedArtifact.document" /> 282 <min value="0" /> 283 <max value="1" /> 284 </base> 285 <type> 286 <code value="Attachment" /> 287 </type> 288 <constraint> 289 <key value="ele-1" /> 290 <severity value="error" /> 291 <human value="All FHIR elements must have a @value or children" /> 292 <expression value="hasValue() or (children().count() > id.count())" /> 293 <xpath value="@value|f:*|h:div" /> 294 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 295 </constraint> 296 <isModifier value="false" /> 297 <isSummary value="true" /> 298 </element> 299 <element id="RelatedArtifact.resource"> 300 <path value="RelatedArtifact.resource" /> 301 <short value="What resource is being referenced" /> 302 <definition value="The related resource, such as a library, value set, profile, or other knowledge resource." /> 303 <comment value="If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource." /> 304 <min value="0" /> 305 <max value="1" /> 306 <base> 307 <path value="RelatedArtifact.resource" /> 308 <min value="0" /> 309 <max value="1" /> 310 </base> 311 <type> 312 <code value="canonical" /> 313 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource" /> 314 </type> 315 <constraint> 316 <key value="ele-1" /> 317 <severity value="error" /> 318 <human value="All FHIR elements must have a @value or children" /> 319 <expression value="hasValue() or (children().count() > id.count())" /> 320 <xpath value="@value|f:*|h:div" /> 321 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 322 </constraint> 323 <isModifier value="false" /> 324 <isSummary value="true" /> 325 </element> 326 </snapshot> 327 <differential> 328 <element id="RelatedArtifact"> 329 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 330 <valueCode value="trial-use" /> 331 </extension> 332 <path value="RelatedArtifact" /> 333 <short value="Related artifacts for a knowledge resource" /> 334 <definition value="Related artifacts such as additional documentation, justification, or bibliographic references." /> 335 <comment value="Each related artifact is either an attachment, or a reference to another knowledge resource, but not both." /> 336 <min value="0" /> 337 <max value="*" /> 338 </element> 339 <element id="RelatedArtifact.type"> 340 <path value="RelatedArtifact.type" /> 341 <short value="documentation | justification | citation | predecessor | successor | derived-from | depends-on | composed-of" /> 342 <definition value="The type of relationship to the related artifact." /> 343 <min value="1" /> 344 <max value="1" /> 345 <type> 346 <code value="code" /> 347 </type> 348 <isSummary value="true" /> 349 <binding> 350 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 351 <valueString value="RelatedArtifactType" /> 352 </extension> 353 <strength value="required" /> 354 <description value="The type of relationship to the related artifact." /> 355 <valueSet value="http://hl7.org/fhir/ValueSet/related-artifact-type|4.0.1" /> 356 </binding> 357 </element> 358 <element id="RelatedArtifact.label"> 359 <path value="RelatedArtifact.label" /> 360 <short value="Short label" /> 361 <definition value="A short label that can be used to reference the citation from elsewhere in the containing artifact, such as a footnote index." /> 362 <min value="0" /> 363 <max value="1" /> 364 <type> 365 <code value="string" /> 366 </type> 367 <isSummary value="true" /> 368 </element> 369 <element id="RelatedArtifact.display"> 370 <path value="RelatedArtifact.display" /> 371 <short value="Brief description of the related artifact" /> 372 <definition value="A brief description of the document or knowledge resource being referenced, suitable for display to a consumer." /> 373 <min value="0" /> 374 <max value="1" /> 375 <type> 376 <code value="string" /> 377 </type> 378 <isSummary value="true" /> 379 </element> 380 <element id="RelatedArtifact.citation"> 381 <path value="RelatedArtifact.citation" /> 382 <short value="Bibliographic citation for the artifact" /> 383 <definition value="A bibliographic citation for the related artifact. This text SHOULD be formatted according to an accepted citation format." /> 384 <comment value="Additional structured information about citations should be captured as extensions." /> 385 <min value="0" /> 386 <max value="1" /> 387 <type> 388 <code value="markdown" /> 389 </type> 390 <isSummary value="true" /> 391 </element> 392 <element id="RelatedArtifact.url"> 393 <path value="RelatedArtifact.url" /> 394 <short value="Where the artifact can be accessed" /> 395 <definition value="A url for the artifact that can be followed to access the actual content." /> 396 <comment value="If a document or resource element is present, this element SHALL NOT be provided (use the url or reference in the Attachment or resource reference)." /> 397 <min value="0" /> 398 <max value="1" /> 399 <type> 400 <code value="url" /> 401 </type> 402 <isSummary value="true" /> 403 </element> 404 <element id="RelatedArtifact.document"> 405 <path value="RelatedArtifact.document" /> 406 <short value="What document is being referenced" /> 407 <definition value="The document being referenced, represented as an attachment. This is exclusive with the resource element." /> 408 <min value="0" /> 409 <max value="1" /> 410 <type> 411 <code value="Attachment" /> 412 </type> 413 <isSummary value="true" /> 414 </element> 415 <element id="RelatedArtifact.resource"> 416 <path value="RelatedArtifact.resource" /> 417 <short value="What resource is being referenced" /> 418 <definition value="The related resource, such as a library, value set, profile, or other knowledge resource." /> 419 <comment value="If the type is predecessor, this is a reference to the succeeding knowledge resource. If the type is successor, this is a reference to the prior knowledge resource." /> 420 <min value="0" /> 421 <max value="1" /> 422 <type> 423 <code value="canonical" /> 424 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Resource" /> 425 </type> 426 <isSummary value="true" /> 427 </element> 428 </differential> 429 </StructureDefinition>