Package org.hl7.fhir.r4.model

Class Signature

java.lang.Object
org.hl7.fhir.r4.model.Base
org.hl7.fhir.r4.model.Element
org.hl7.fhir.r4.model.Type
org.hl7.fhir.r4.model.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 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:

  • Field Details

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

    • when

      protected InstantType when
      When the digital signature was signed.

    • who

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

    • whoTarget

      protected Resource whoTarget
      The actual object that is the target of the reference (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.

    • onBehalfOfTarget

      protected Resource onBehalfOfTarget
      The actual object that is the target of the reference (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.

  • Constructor Details

  • Method Details

    • 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.)

    • setType

      public Signature setType(List<Coding> theType)
      Returns:
      Returns a reference to this for easy method chaining

    • hasType

      public boolean hasType()

    • addType

      public Coding addType()

    • addType

      public Signature addType(Coding t)

    • 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

    • hasWhenElement

      public boolean hasWhenElement()

    • 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).)

    • getWhoTarget

      public Resource getWhoTarget()
      Returns:
      who The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A reference to an application-usable description of the identity that signed (e.g. the signature used their private key).)

    • setWhoTarget

      public Signature setWhoTarget(Resource value)
      Parameters:
      value - who The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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.)

    • hasOnBehalfOf

      public boolean hasOnBehalfOf()

    • 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.)

    • getOnBehalfOfTarget

      public Resource getOnBehalfOfTarget()
      Returns:
      onBehalfOf The actual object that is the target of the reference. The reference library doesn't populate this, but you can use it to hold the resource if you resolve it. (A reference to an application-usable description of the identity that is represented by the signature.)

    • setOnBehalfOfTarget

      public Signature setOnBehalfOfTarget(Resource value)
      Parameters:
      value - onBehalfOf The actual object that is the target of the reference. The reference library doesn't use these, but you can use it to hold the resource if you resolve it. (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

    • hasTargetFormatElement

      public boolean hasTargetFormatElement()

    • hasTargetFormat

      public boolean hasTargetFormat()

    • 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

    • hasSigFormatElement

      public boolean hasSigFormatElement()

    • hasSigFormat

      public boolean hasSigFormat()

    • 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

    • hasDataElement

      public boolean hasDataElement()

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

    • listChildren

      protected void listChildren(List<Property> children)
      Overrides:
      listChildren in class Element

    • getNamedProperty

      public Property getNamedProperty(int _hash, String _name, boolean _checkValid) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getNamedProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • 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

    • setProperty

      public Base setProperty(int hash, String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • setProperty

      public Base setProperty(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      setProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • removeChild

      public void removeChild(String name, Base value) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      removeChild in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • makeProperty

      public Base makeProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      makeProperty in class Element
      Throws:
      org.hl7.fhir.exceptions.FHIRException

    • getTypesForProperty

      public String[] getTypesForProperty(int hash, String name) throws org.hl7.fhir.exceptions.FHIRException
      Overrides:
      getTypesForProperty 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

    • copy

      public Signature copy()
      Overrides:
      copy in class Type

    • copyValues

      public void copyValues(Signature dst)

    • typedCopy

      protected Signature typedCopy()
      Specified by:
      typedCopy in class Type

    • equalsDeep

      public boolean equalsDeep(Base other_)
      Overrides:
      equalsDeep in class Element

    • equalsShallow

      public boolean equalsShallow(Base other_)
      Overrides:
      equalsShallow in class Element

    • isEmpty

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