Class Signature

  • All Implemented Interfaces:
    ca.uhn.fhir.model.api.IElement, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.IBaseElement, org.hl7.fhir.instance.model.api.IBaseHasExtensions, org.hl7.fhir.instance.model.api.ICompositeType

    public class Signature
    extends Type
    implements org.hl7.fhir.instance.model.api.ICompositeType
    A digital signature along with supporting context. The signature may be electronic/cryptographic in nature, or a graphical image representing a hand-written signature, or a signature process. Different signature approaches have different utilities.
    See Also:
    Serialized Form
    • Field Detail

      • type

        protected List<Coding> 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.
      • who

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

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

        protected CodeType contentType
        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.
      • blob

        protected Base64BinaryType blob
        The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
    • Method Detail

      • getType

        public List<CodinggetType()
        Returns:
        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.)
      • hasType

        public boolean hasType()
      • getTypeFirstRep

        public Coding getTypeFirstRep()
        Returns:
        The first repetition of repeating field type, creating it if it does not already exist
      • getWhenElement

        public InstantType getWhenElement()
        Returns:
        when (When the digital signature was signed.). This is the underlying object with id, value and extensions. The accessor "getWhen" gives direct access to the value
      • hasWhen

        public boolean hasWhen()
      • setWhenElement

        public Signature setWhenElement​(InstantType value)
        Parameters:
        value - when (When the digital signature was signed.). This is the underlying object with id, value and extensions. The accessor "getWhen" gives direct access to the value
      • getWhen

        public Date getWhen()
        Returns:
        When the digital signature was signed.
      • setWhen

        public Signature setWhen​(Date value)
        Parameters:
        value - When the digital signature was signed.
      • getWho

        public Type getWho()
        Returns:
        who (A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).)
      • getWhoUriType

        public UriType getWhoUriType()
                              throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        who (A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getWhoReference

        public Reference getWhoReference()
                                  throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        who (A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • hasWho

        public boolean hasWho()
      • setWho

        public Signature setWho​(Type value)
                         throws org.hl7.fhir.exceptions.FHIRFormatError
        Parameters:
        value - who (A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).)
        Throws:
        org.hl7.fhir.exceptions.FHIRFormatError
      • getOnBehalfOf

        public Type getOnBehalfOf()
        Returns:
        onBehalfOf (A reference to an application-usable description of the identity that is represented by the signature.)
      • getOnBehalfOfUriType

        public UriType getOnBehalfOfUriType()
                                     throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        onBehalfOf (A reference to an application-usable description of the identity that is represented by the signature.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • getOnBehalfOfReference

        public Reference getOnBehalfOfReference()
                                         throws org.hl7.fhir.exceptions.FHIRException
        Returns:
        onBehalfOf (A reference to an application-usable description of the identity that is represented by the signature.)
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • setOnBehalfOf

        public Signature setOnBehalfOf​(Type value)
                                throws org.hl7.fhir.exceptions.FHIRFormatError
        Parameters:
        value - onBehalfOf (A reference to an application-usable description of the identity that is represented by the signature.)
        Throws:
        org.hl7.fhir.exceptions.FHIRFormatError
      • getContentTypeElement

        public CodeType getContentTypeElement()
        Returns:
        contentType (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.). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value
      • setContentTypeElement

        public Signature setContentTypeElement​(CodeType value)
        Parameters:
        value - contentType (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.). This is the underlying object with id, value and extensions. The accessor "getContentType" gives direct access to the value
      • getContentType

        public String getContentType()
        Returns:
        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.
      • setContentType

        public Signature setContentType​(String value)
        Parameters:
        value - 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.
      • getBlobElement

        public Base64BinaryType getBlobElement()
        Returns:
        blob (The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.). This is the underlying object with id, value and extensions. The accessor "getBlob" gives direct access to the value
      • hasBlob

        public boolean hasBlob()
      • setBlobElement

        public Signature setBlobElement​(Base64BinaryType value)
        Parameters:
        value - blob (The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.). This is the underlying object with id, value and extensions. The accessor "getBlob" gives direct access to the value
      • getBlob

        public byte[] getBlob()
        Returns:
        The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
      • setBlob

        public Signature setBlob​(byte[] value)
        Parameters:
        value - The base64 encoding of the Signature content. When signature is not recorded electronically this element would be empty.
      • getProperty

        public Base[] getProperty​(int hash,
                                  String name,
                                  boolean checkValid)
                           throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        getProperty in class Element
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • addChild

        public Base addChild​(String name)
                      throws org.hl7.fhir.exceptions.FHIRException
        Overrides:
        addChild in class Element
        Throws:
        org.hl7.fhir.exceptions.FHIRException
      • fhirType

        public String fhirType()
        Specified by:
        fhirType in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        fhirType in class Element
      • isEmpty

        public boolean isEmpty()
        Specified by:
        isEmpty in interface org.hl7.fhir.instance.model.api.IBase
        Overrides:
        isEmpty in class Element