Package org.hl7.fhir.r5.model

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 DataType
implements org.hl7.fhir.instance.model.api.ICompositeType
    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.
    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 Reference who
        A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).

      • onBehalfOf

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

      • targetFormat

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

      • sigFormat

        protected CodeType 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.

      • data

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

    • Method Detail

      • getType

        public List<Coding> getType()
        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 {3}

      • 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 Reference getWho()
        Returns:
        who (A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).)

      • hasWho

        public boolean hasWho()

      • setWho

        public Signature setWho​(Reference value)
        Parameters:
        value - who (A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).)

      • getOnBehalfOf

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

      • setOnBehalfOf

        public Signature setOnBehalfOf​(Reference value)
        Parameters:
        value - onBehalfOf (A reference to an application-usable description of the identity that is represented by the signature.)

      • getTargetFormatElement

        public CodeType getTargetFormatElement()
        Returns:
        targetFormat (A mime type that indicates the technical format of the target resources signed by the signature.). This is the underlying object with id, value and extensions. The accessor "getTargetFormat" gives direct access to the value

      • setTargetFormatElement

        public Signature setTargetFormatElement​(CodeType value)
        Parameters:
        value - targetFormat (A mime type that indicates the technical format of the target resources signed by the signature.). This is the underlying object with id, value and extensions. The accessor "getTargetFormat" gives direct access to the value

      • getTargetFormat

        public String getTargetFormat()
        Returns:
        A mime type that indicates the technical format of the target resources signed by the signature.

      • setTargetFormat

        public Signature setTargetFormat​(String value)
        Parameters:
        value - A mime type that indicates the technical format of the target resources signed by the signature.

      • getSigFormatElement

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

      • setSigFormatElement

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

      • getSigFormat

        public String getSigFormat()
        Returns:
        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.

      • setSigFormat

        public Signature setSigFormat​(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/jose for JWS, and image/* for a graphical image of a signature, etc.

      • getDataElement

        public Base64BinaryType getDataElement()
        Returns:
        data (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 "getData" gives direct access to the value

      • hasData

        public boolean hasData()

      • setDataElement

        public Signature setDataElement​(Base64BinaryType value)
        Parameters:
        value - data (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 "getData" gives direct access to the value

      • getData

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

      • setData

        public Signature setData​(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 DataType

      • isEmpty

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