HL7 FHIR Profile: Occupational Data for Health (ODH), Release 1 (Standard for Trial Use)

This page is part of the Occupational Data for Health (ODH) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.2.0. For a full list of available versions, see the Directory of published versions

SignatureProfile

Definitions for cimi-element-Signature.

Signature
Definition

A digital Signature - XML DigSig, JWT, Graphical image of signature, etc.

Control0..* This element is affected by the following invariants: ele-1
Comments

The elements of the Signature Resource are for ease of access of these elements. Foro digital signatures (Xml DigSig, JWT), 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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
Signature.id
Definition

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

Control0..1
Typestring
Signature.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Signature.type
Definition

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.

Control1..*
BindingAn indication of the reason that an entity signed the object
The codes SHALL be taken from Signature Type Codes; other codes may be used where these codes are not suitable
TypeCoding
Comments

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

Signature.when
Definition

When the digital signature was signed.

Control1..1
Typeinstant
Comments

This should agree with the information in the signature.

Signature.whoUri
Definition

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

Control1..1
Typeuri
Comments

This should agree with the information in the signature.

Signature.onBehalfOf[x]
Definition

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

Control0..1
TypeChoice of: uri, Reference(OrganizationProfile)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

used when the signature is on behalf of a non-signer.

Comments

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

Signature.contentType
Definition

A mime type that indicates the technical format of the signature. Important mime types are application/signature+xml for X ML DigSig, application/jwt for JWT, and image/* for a graphical image of a signature, etc.

Control0..1
BindingThe mime type of an attachment. Any valid mime type is allowed.
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/mimetypes
Typecode
Signature.blob
Definition

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

Control0..1
Typebase64Binary
Comments

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.