Signature constructor

const Signature({ @JsonKey(name: 'id') String? fhirId, @JsonKey(name: 'extension') List<FhirExtension>? extension_, required List<Coding> type, FhirInstant? when, @JsonKey(name: '_when') Element? whenElement, required Reference who, Reference? onBehalfOf, FhirCode? targetFormat, @JsonKey(name: '_targetFormat') Element? targetFormatElement, FhirCode? sigFormat, @JsonKey(name: '_sigFormat') Element? sigFormatElement, FhirBase64Binary? data, @JsonKey(name: '_data') Element? dataElement, })

Signature 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.

id Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extension 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.

type 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.

when When the digital signature was signed.

whenElement Extensions for when

who A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

onBehalfOf A reference to an application-usable description of the identity that is represented by the signature.

targetFormat A mime type that indicates the technical format of the target resources signed by the signature.

targetFormatElement Extensions for targetFormat

sigFormat 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.

sigFormatElement Extensions for sigFormat

data The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.

dataElement Extensions for data

Implementation

const factory Signature({
  /// [id] Unique id for the element within a resource (for internal
  ///  references). This may be any string value that does not contain spaces.
  @JsonKey(name: 'id') String? fhirId,

  /// [extension] 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.
  @JsonKey(name: 'extension') List<FhirExtension>? extension_,

  /// [type] 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.
  required List<Coding> type,

  /// [when] When the digital signature was signed.
  FhirInstant? when,

  /// [whenElement] Extensions for when
  @JsonKey(name: '_when') Element? whenElement,

  /// [who] A reference to an application-usable description of the identity
  ///  that signed  (e.g. the signature used their private key).
  required Reference who,

  /// [onBehalfOf] A reference to an application-usable description of the
  ///  identity that is represented by the signature.
  Reference? onBehalfOf,

  /// [targetFormat] A mime type that indicates the technical format of the
  ///  target resources signed by the signature.
  FhirCode? targetFormat,

  /// [targetFormatElement] Extensions for targetFormat
  @JsonKey(name: '_targetFormat') Element? targetFormatElement,

  /// [sigFormat] 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.
  FhirCode? sigFormat,

  /// [sigFormatElement] Extensions for sigFormat
  @JsonKey(name: '_sigFormat') Element? sigFormatElement,

  /// [data] The base64 encoding of the Signature content. When signature is
  ///  not recorded electronically this element would be empty.
  FhirBase64Binary? data,

  /// [dataElement] Extensions for data
  @JsonKey(name: '_data') Element? dataElement,
}) = _Signature;