Package com.ibm.fhir.model.type

Class Signature

  • All Implemented Interfaces:
    Visitable
    @Generated("com.ibm.fhir.tools.CodeGenerator")
public class Signature
extends Element
    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.

    • Method Detail

      • getType

        public List<Coding> getType()
        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.
        Returns:
        An unmodifiable list containing immutable objects of type Coding that is non-empty.

      • getWhen

        public Instant getWhen()
        When the digital signature was signed.
        Returns:
        An immutable object of type Instant that is non-null.

      • getWho

        public Reference getWho()
        A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).
        Returns:
        An immutable object of type Reference that is non-null.

      • getOnBehalfOf

        public Reference getOnBehalfOf()
        A reference to an application-usable description of the identity that is represented by the signature.
        Returns:
        An immutable object of type Reference that may be null.

      • getTargetFormat

        public Code getTargetFormat()
        A mime type that indicates the technical format of the target resources signed by the signature.
        Returns:
        An immutable object of type Code that may be null.

      • getSigFormat

        public Code getSigFormat()
        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.
        Returns:
        An immutable object of type Code that may be null.

      • getData

        public Base64Binary getData()
        The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
        Returns:
        An immutable object of type Base64Binary that may be null.

      • accept

        public void accept​(String elementName,
                   int elementIndex,
                   Visitor visitor)
        Description copied from interface: Visitable
        Accept a Visitor and invoke the appropriate visit methods. A typical implementation would look like this: 
         if (visitor.preVisit(this)) {
     visitor.visitStart(elementName, elementIndex, this);
     if (visitor.visit(elementName, elementIndex, this)) {
         // visit children
     }
     visitor.visitEnd(elementName, elementIndex, this);
     visitor.postVisit(this);
 }
        Specified by:
        accept in interface Visitable
        Specified by:
        accept in class AbstractVisitable
        Parameters:
        elementName - the name of the element in the context of this visit
        elementIndex - the index of the element in a list or -1 if it is not contained within a List
        visitor - the visitor to use

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object