Signature.xml 1 <?xml version="1.0" encoding="utf-8"?> 2 <StructureDefinition xmlns="http://hl7.org/fhir"> 3 <id value="Signature" /> 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="trial-use" /> 9 </extension> 10 <url value="http://hl7.org/fhir/StructureDefinition/Signature" /> 11 <version value="5.0.0" /> 12 <name value="Signature" /> 13 <status value="draft" /> 14 <experimental value="false" /> 15 <date value="2023-03-26T06:21:02.0000000+02:00" /> 16 <publisher value="HL7 FHIR Standard" /> 17 <contact> 18 <telecom> 19 <system value="url" /> 20 <value value="http://hl7.org/fhir" /> 21 </telecom> 22 </contact> 23 <description value="Signature Type: A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities." /> 24 <jurisdiction> 25 <coding> 26 <system value="http://unstats.un.org/unsd/methods/m49/m49.htm" /> 27 <code value="001" /> 28 <display value="World" /> 29 </coding> 30 </jurisdiction> 31 <purpose value="There are a number of places where content must be signed in healthcare." /> 32 <fhirVersion value="5.0.0" /> 33 <mapping> 34 <identity value="rim" /> 35 <uri value="http://hl7.org/v3" /> 36 <name value="RIM Mapping" /> 37 </mapping> 38 <kind value="complex-type" /> 39 <abstract value="false" /> 40 <type value="Signature" /> 41 <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DataType" /> 42 <derivation value="specialization" /> 43 <snapshot> 44 <element id="Signature"> 45 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 46 <valueCode value="trial-use" /> 47 </extension> 48 <path value="Signature" /> 49 <short value="A Signature - XML DigSig, JWS, Graphical image of signature, etc." /> 50 <definition value="A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities." /> 51 <comment value="The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form." /> 52 <min value="0" /> 53 <max value="*" /> 54 <base> 55 <path value="Signature" /> 56 <min value="0" /> 57 <max value="*" /> 58 </base> 59 <constraint> 60 <key value="ele-1" /> 61 <severity value="error" /> 62 <human value="All FHIR elements must have a @value or children" /> 63 <expression value="hasValue() or (children().count() > id.count())" /> 64 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 65 </constraint> 66 <isModifier value="false" /> 67 <mapping> 68 <identity value="rim" /> 69 <map value="n/a,N/A" /> 70 </mapping> 71 </element> 72 <element id="Signature.id"> 73 <path value="Signature.id" /> 74 <representation value="xmlAttr" /> 75 <short value="Unique id for inter-element referencing" /> 76 <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> 77 <min value="0" /> 78 <max value="1" /> 79 <base> 80 <path value="Element.id" /> 81 <min value="0" /> 82 <max value="1" /> 83 </base> 84 <type> 85 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> 86 <valueUrl value="id" /> 87 </extension> 88 <code value="http://hl7.org/fhirpath/System.String" /> 89 </type> 90 <condition value="ele-1" /> 91 <isModifier value="false" /> 92 <isSummary value="false" /> 93 <mapping> 94 <identity value="rim" /> 95 <map value="n/a" /> 96 </mapping> 97 </element> 98 <element id="Signature.extension"> 99 <path value="Signature.extension" /> 100 <slicing> 101 <discriminator> 102 <type value="value" /> 103 <path value="url" /> 104 </discriminator> 105 <description value="Extensions are always sliced by (at least) url" /> 106 <rules value="open" /> 107 </slicing> 108 <short value="Additional content defined by implementations" /> 109 <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." /> 110 <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." /> 111 <alias value="extensions" /> 112 <alias value="user content" /> 113 <min value="0" /> 114 <max value="*" /> 115 <base> 116 <path value="Element.extension" /> 117 <min value="0" /> 118 <max value="*" /> 119 </base> 120 <type> 121 <code value="Extension" /> 122 </type> 123 <constraint> 124 <key value="ele-1" /> 125 <severity value="error" /> 126 <human value="All FHIR elements must have a @value or children" /> 127 <expression value="hasValue() or (children().count() > id.count())" /> 128 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 129 </constraint> 130 <constraint> 131 <key value="ext-1" /> 132 <severity value="error" /> 133 <human value="Must have either extensions or value[x], not both" /> 134 <expression value="extension.exists() != value.exists()" /> 135 <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> 136 </constraint> 137 <isModifier value="false" /> 138 <isSummary value="false" /> 139 <mapping> 140 <identity value="rim" /> 141 <map value="n/a" /> 142 </mapping> 143 </element> 144 <element id="Signature.type"> 145 <path value="Signature.type" /> 146 <short value="Indication of the reason the entity signed the object(s)" /> 147 <definition value="An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document." /> 148 <comment value="Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication"." /> 149 <min value="0" /> 150 <max value="*" /> 151 <base> 152 <path value="Signature.type" /> 153 <min value="0" /> 154 <max value="*" /> 155 </base> 156 <type> 157 <code value="Coding" /> 158 </type> 159 <constraint> 160 <key value="ele-1" /> 161 <severity value="error" /> 162 <human value="All FHIR elements must have a @value or children" /> 163 <expression value="hasValue() or (children().count() > id.count())" /> 164 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 165 </constraint> 166 <isModifier value="false" /> 167 <isSummary value="true" /> 168 <binding> 169 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 170 <valueString value="An indication of the reason that an entity signed the object." /> 171 </extension> 172 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 173 <valueString value="SignatureType" /> 174 </extension> 175 <strength value="preferred" /> 176 <description value="An indication of the reason that an entity signed the object." /> 177 <valueSet value="http://hl7.org/fhir/ValueSet/signature-type" /> 178 </binding> 179 </element> 180 <element id="Signature.when"> 181 <path value="Signature.when" /> 182 <short value="When the signature was created" /> 183 <definition value="When the digital signature was signed." /> 184 <comment value="This should agree with the information in the signature." /> 185 <min value="0" /> 186 <max value="1" /> 187 <base> 188 <path value="Signature.when" /> 189 <min value="0" /> 190 <max value="1" /> 191 </base> 192 <type> 193 <code value="instant" /> 194 </type> 195 <constraint> 196 <key value="ele-1" /> 197 <severity value="error" /> 198 <human value="All FHIR elements must have a @value or children" /> 199 <expression value="hasValue() or (children().count() > id.count())" /> 200 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 201 </constraint> 202 <isModifier value="false" /> 203 <isSummary value="true" /> 204 </element> 205 <element id="Signature.who"> 206 <path value="Signature.who" /> 207 <short value="Who signed" /> 208 <definition value="A reference to an application-usable description of the identity that signed (e.g. the signature used their private key)." /> 209 <comment value="This should agree with the information in the signature." /> 210 <min value="0" /> 211 <max value="1" /> 212 <base> 213 <path value="Signature.who" /> 214 <min value="0" /> 215 <max value="1" /> 216 </base> 217 <type> 218 <code value="Reference" /> 219 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> 220 <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> 221 <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> 222 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> 223 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> 224 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> 225 </type> 226 <constraint> 227 <key value="ele-1" /> 228 <severity value="error" /> 229 <human value="All FHIR elements must have a @value or children" /> 230 <expression value="hasValue() or (children().count() > id.count())" /> 231 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 232 </constraint> 233 <isModifier value="false" /> 234 <isSummary value="true" /> 235 </element> 236 <element id="Signature.onBehalfOf"> 237 <path value="Signature.onBehalfOf" /> 238 <short value="The party represented" /> 239 <definition value="A reference to an application-usable description of the identity that is represented by the signature." /> 240 <comment value="The party that can't sign. For example a child." /> 241 <requirements value="used when the signature is on behalf of a non-signer." /> 242 <min value="0" /> 243 <max value="1" /> 244 <base> 245 <path value="Signature.onBehalfOf" /> 246 <min value="0" /> 247 <max value="1" /> 248 </base> 249 <type> 250 <code value="Reference" /> 251 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> 252 <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> 253 <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> 254 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> 255 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> 256 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> 257 </type> 258 <constraint> 259 <key value="ele-1" /> 260 <severity value="error" /> 261 <human value="All FHIR elements must have a @value or children" /> 262 <expression value="hasValue() or (children().count() > id.count())" /> 263 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 264 </constraint> 265 <isModifier value="false" /> 266 <isSummary value="true" /> 267 </element> 268 <element id="Signature.targetFormat"> 269 <path value="Signature.targetFormat" /> 270 <short value="The technical format of the signed resources" /> 271 <definition value="A mime type that indicates the technical format of the target resources signed by the signature." /> 272 <comment value=""xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here." /> 273 <min value="0" /> 274 <max value="1" /> 275 <base> 276 <path value="Signature.targetFormat" /> 277 <min value="0" /> 278 <max value="1" /> 279 </base> 280 <type> 281 <code value="code" /> 282 </type> 283 <constraint> 284 <key value="ele-1" /> 285 <severity value="error" /> 286 <human value="All FHIR elements must have a @value or children" /> 287 <expression value="hasValue() or (children().count() > id.count())" /> 288 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 289 </constraint> 290 <isModifier value="false" /> 291 <isSummary value="false" /> 292 <binding> 293 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 294 <valueString value="The mime type of an attachment. Any valid mime type is allowed." /> 295 </extension> 296 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 297 <valueString value="MimeType" /> 298 </extension> 299 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> 300 <valueBoolean value="true" /> 301 </extension> 302 <strength value="required" /> 303 <description value="BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)" /> 304 <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|5.0.0" /> 305 </binding> 306 </element> 307 <element id="Signature.sigFormat"> 308 <path value="Signature.sigFormat" /> 309 <short value="The technical format of the signature" /> 310 <definition value="A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc." /> 311 <min value="0" /> 312 <max value="1" /> 313 <base> 314 <path value="Signature.sigFormat" /> 315 <min value="0" /> 316 <max value="1" /> 317 </base> 318 <type> 319 <code value="code" /> 320 </type> 321 <constraint> 322 <key value="ele-1" /> 323 <severity value="error" /> 324 <human value="All FHIR elements must have a @value or children" /> 325 <expression value="hasValue() or (children().count() > id.count())" /> 326 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 327 </constraint> 328 <isModifier value="false" /> 329 <isSummary value="false" /> 330 <binding> 331 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 332 <valueString value="The mime type of an attachment. Any valid mime type is allowed." /> 333 </extension> 334 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 335 <valueString value="MimeType" /> 336 </extension> 337 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> 338 <valueBoolean value="true" /> 339 </extension> 340 <strength value="required" /> 341 <description value="BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)" /> 342 <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|5.0.0" /> 343 </binding> 344 </element> 345 <element id="Signature.data"> 346 <path value="Signature.data" /> 347 <short value="The actual signature content (XML DigSig. JWS, picture, etc.)" /> 348 <definition value="The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty." /> 349 <comment value="Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form." /> 350 <min value="0" /> 351 <max value="1" /> 352 <base> 353 <path value="Signature.data" /> 354 <min value="0" /> 355 <max value="1" /> 356 </base> 357 <type> 358 <code value="base64Binary" /> 359 </type> 360 <constraint> 361 <key value="ele-1" /> 362 <severity value="error" /> 363 <human value="All FHIR elements must have a @value or children" /> 364 <expression value="hasValue() or (children().count() > id.count())" /> 365 <source value="http://hl7.org/fhir/StructureDefinition/Element" /> 366 </constraint> 367 <isModifier value="false" /> 368 <isSummary value="false" /> 369 </element> 370 </snapshot> 371 <differential> 372 <element id="Signature"> 373 <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status"> 374 <valueCode value="trial-use" /> 375 </extension> 376 <path value="Signature" /> 377 <short value="A Signature - XML DigSig, JWS, Graphical image of signature, etc." /> 378 <definition value="A signature along with supporting context. The signature may be a digital signature that is cryptographic in nature, or some other signature acceptable to the domain. This other signature may be as simple as a graphical image representing a hand-written signature, or a signature ceremony Different signature approaches have different utilities." /> 379 <comment value="The elements of the Signature Resource are for ease of access of these elements. For digital signatures (Xml DigSig, JWS), the non-repudiation proof comes from the Signature validation, which includes validation of the referenced objects (e.g. Resources) (a.k.a., Content) in the XML-Signature Detached form." /> 380 <min value="0" /> 381 <max value="*" /> 382 <mapping> 383 <identity value="rim" /> 384 <map value="N/A" /> 385 </mapping> 386 </element> 387 <element id="Signature.type"> 388 <path value="Signature.type" /> 389 <short value="Indication of the reason the entity signed the object(s)" /> 390 <definition value="An indication of the reason that the entity signed this document. This may be explicitly included as part of the signature information and can be used when determining accountability for various actions concerning the document." /> 391 <comment value="Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication"." /> 392 <min value="0" /> 393 <max value="*" /> 394 <type> 395 <code value="Coding" /> 396 </type> 397 <isSummary value="true" /> 398 <binding> 399 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 400 <valueString value="An indication of the reason that an entity signed the object." /> 401 </extension> 402 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 403 <valueString value="SignatureType" /> 404 </extension> 405 <strength value="preferred" /> 406 <description value="An indication of the reason that an entity signed the object." /> 407 <valueSet value="http://hl7.org/fhir/ValueSet/signature-type" /> 408 </binding> 409 </element> 410 <element id="Signature.when"> 411 <path value="Signature.when" /> 412 <short value="When the signature was created" /> 413 <definition value="When the digital signature was signed." /> 414 <comment value="This should agree with the information in the signature." /> 415 <min value="0" /> 416 <max value="1" /> 417 <type> 418 <code value="instant" /> 419 </type> 420 <isSummary value="true" /> 421 </element> 422 <element id="Signature.who"> 423 <path value="Signature.who" /> 424 <short value="Who signed" /> 425 <definition value="A reference to an application-usable description of the identity that signed (e.g. the signature used their private key)." /> 426 <comment value="This should agree with the information in the signature." /> 427 <min value="0" /> 428 <max value="1" /> 429 <type> 430 <code value="Reference" /> 431 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> 432 <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> 433 <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> 434 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> 435 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> 436 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> 437 </type> 438 <isSummary value="true" /> 439 </element> 440 <element id="Signature.onBehalfOf"> 441 <path value="Signature.onBehalfOf" /> 442 <short value="The party represented" /> 443 <definition value="A reference to an application-usable description of the identity that is represented by the signature." /> 444 <comment value="The party that can't sign. For example a child." /> 445 <requirements value="used when the signature is on behalf of a non-signer." /> 446 <min value="0" /> 447 <max value="1" /> 448 <type> 449 <code value="Reference" /> 450 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> 451 <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> 452 <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> 453 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> 454 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" /> 455 <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> 456 </type> 457 <isSummary value="true" /> 458 </element> 459 <element id="Signature.targetFormat"> 460 <path value="Signature.targetFormat" /> 461 <short value="The technical format of the signed resources" /> 462 <definition value="A mime type that indicates the technical format of the target resources signed by the signature." /> 463 <comment value=""xml", "json" and "ttl" are allowed, which describe the simple encodings described in the specification (and imply appropriate bundle support). Otherwise, mime types are legal here." /> 464 <min value="0" /> 465 <max value="1" /> 466 <type> 467 <code value="code" /> 468 </type> 469 <binding> 470 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 471 <valueString value="The mime type of an attachment. Any valid mime type is allowed." /> 472 </extension> 473 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 474 <valueString value="MimeType" /> 475 </extension> 476 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> 477 <valueBoolean value="true" /> 478 </extension> 479 <strength value="required" /> 480 <description value="BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)" /> 481 <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|5.0.0" /> 482 </binding> 483 </element> 484 <element id="Signature.sigFormat"> 485 <path value="Signature.sigFormat" /> 486 <short value="The technical format of the signature" /> 487 <definition value="A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jose for JWS, and image/* for a graphical image of a signature, etc." /> 488 <min value="0" /> 489 <max value="1" /> 490 <type> 491 <code value="code" /> 492 </type> 493 <binding> 494 <extension url="http://hl7.org/fhir/tools/StructureDefinition/binding-definition"> 495 <valueString value="The mime type of an attachment. Any valid mime type is allowed." /> 496 </extension> 497 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> 498 <valueString value="MimeType" /> 499 </extension> 500 <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> 501 <valueBoolean value="true" /> 502 </extension> 503 <strength value="required" /> 504 <description value="BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)" /> 505 <valueSet value="http://hl7.org/fhir/ValueSet/mimetypes|5.0.0" /> 506 </binding> 507 </element> 508 <element id="Signature.data"> 509 <path value="Signature.data" /> 510 <short value="The actual signature content (XML DigSig. JWS, picture, etc.)" /> 511 <definition value="The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty." /> 512 <comment value="Where the signature type is an XML DigSig, the signed content is a FHIR Resource(s), the signature is of the XML form of the Resource(s) using XML-Signature (XMLDIG) "Detached Signature" form." /> 513 <min value="0" /> 514 <max value="1" /> 515 <type> 516 <code value="base64Binary" /> 517 </type> 518 </element> 519 </differential> 520 </StructureDefinition>