Skip to main content

Signature

Base StructureDefinition for 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.

Elements

NameRequiredTypeDescription
idstring

Unique id for inter-element referencing

Details

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

extensionExtension[]

Additional content defined by implementations

Details

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.

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.

typeCoding[]

Indication of the reason the entity signed the object(s)

Details

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.

Examples include attesting to: authorship, correct transcription, and witness of specific event. Also known as a "Commitment Type Indication".

wheninstant

When the signature was created

Details

When the digital signature was signed.

This should agree with the information in the signature.

whoReference< Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization >

Who signed

Details

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

This should agree with the information in the signature.

onBehalfOfReference< Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization >

The party represented

Details

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

The party that can't sign. For example a child.

targetFormatcode

The technical format of the signed resources

Details

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

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

sigFormatcode

The technical format of the signature

Details

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.

database64Binary

The actual signature content (XML DigSig. JWS, picture, etc.)

Details

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

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.