Class SignatureDt

java.lang.Object
ca.uhn.fhir.model.api.BaseElement
ca.uhn.fhir.model.api.BaseIdentifiableElement
ca.uhn.fhir.model.dstu2.composite.SignatureDt
All Implemented Interfaces:
ca.uhn.fhir.model.api.ICompositeDatatype, ca.uhn.fhir.model.api.ICompositeElement, ca.uhn.fhir.model.api.IDatatype, ca.uhn.fhir.model.api.IElement, ca.uhn.fhir.model.api.IIdentifiableElement, ca.uhn.fhir.model.api.ISupportsUndeclaredExtensions, Serializable, org.hl7.fhir.instance.model.api.IBase, org.hl7.fhir.instance.model.api.IBaseDatatype, org.hl7.fhir.instance.model.api.ICompositeType

public class SignatureDt
extends ca.uhn.fhir.model.api.BaseIdentifiableElement
implements ca.uhn.fhir.model.api.ICompositeDatatype
HAPI/FHIR SignatureDt Datatype ()

Definition: 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

Requirements: There are a number of places where content must be signed in healthcare

See Also:
Serialized Form
  • Constructor Summary

    Constructors 
    Constructor Description
    SignatureDt()
    Constructor
  • Method Summary

    Modifier and Type Method Description
    CodingDt addType()
    Adds and returns a new value for type ()
    SignatureDt addType​(CodingDt theValue)
    Adds a given new value for type ()
    <T extends ca.uhn.fhir.model.api.IElement>
    List<T>
    getAllPopulatedChildElementsOfType​(Class<T> theType)  
    byte[] getBlob()
    Gets the value(s) for blob ().
    ca.uhn.fhir.model.primitive.Base64BinaryDt getBlobElement()
    Gets the value(s) for blob ().
    String getContentType()
    Gets the value(s) for contentType ().
    ca.uhn.fhir.model.primitive.CodeDt getContentTypeElement()
    Gets the value(s) for contentType ().
    List<CodingDt> getType()
    Gets the value(s) for type ().
    CodingDt getTypeFirstRep()
    Gets the first repetition for type (), creating it if it does not already exist.
    Date getWhen()
    Gets the value(s) for when ().
    ca.uhn.fhir.model.primitive.InstantDt getWhenElement()
    Gets the value(s) for when ().
    ca.uhn.fhir.model.api.IDatatype getWho()
    Gets the value(s) for who[x] ().
    boolean isEmpty()  
    SignatureDt setBlob​(byte[] theBytes)
    Sets the value for blob ()
    SignatureDt setBlob​(ca.uhn.fhir.model.primitive.Base64BinaryDt theValue)
    Sets the value(s) for blob ()
    SignatureDt setContentType​(ca.uhn.fhir.model.primitive.CodeDt theValue)
    Sets the value(s) for contentType ()
    SignatureDt setContentType​(String theCode)
    Sets the value for contentType ()
    SignatureDt setType​(List<CodingDt> theValue)
    Sets the value(s) for type ()
    SignatureDt setWhen​(ca.uhn.fhir.model.primitive.InstantDt theValue)
    Sets the value(s) for when ()
    SignatureDt setWhen​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
    Sets the value for when ()
    SignatureDt setWhenWithMillisPrecision​(Date theDate)
    Sets the value for when ()
    SignatureDt setWho​(ca.uhn.fhir.model.api.IDatatype theValue)
    Sets the value(s) for who[x] ()

    Methods inherited from class ca.uhn.fhir.model.api.BaseIdentifiableElement

    getElementSpecificId, getId, setElementSpecificId, setId, setId

    Methods inherited from class ca.uhn.fhir.model.api.BaseElement

    addUndeclaredExtension, addUndeclaredExtension, addUndeclaredExtension, getAllUndeclaredExtensions, getFormatCommentsPost, getFormatCommentsPre, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, getUserData, hasFormatComment, isBaseEmpty, setUserData

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.hl7.fhir.instance.model.api.IBase

    fhirType, getFormatCommentsPost, getFormatCommentsPre, getUserData, hasFormatComment, setUserData
  • Constructor Details

  • Method Details

    • isEmpty

      public boolean isEmpty()
      Specified by:
      isEmpty in interface org.hl7.fhir.instance.model.api.IBase
    • getAllPopulatedChildElementsOfType

      public <T extends ca.uhn.fhir.model.api.IElement> List<T> getAllPopulatedChildElementsOfType​(Class<T> theType)
      Specified by:
      getAllPopulatedChildElementsOfType in interface ca.uhn.fhir.model.api.ICompositeElement
    • getType

      public List<CodingDt> getType()
      Gets the value(s) for type (). creating it if it does not exist. Will not return null.

      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.

    • setType

      public SignatureDt setType​(List<CodingDt> theValue)
      Sets the value(s) for 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.

    • addType

      public CodingDt addType()
      Adds and returns a new value for 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.

    • addType

      public SignatureDt addType​(CodingDt theValue)
      Adds a given new value for 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.

      Parameters:
      theValue - The type to add (must not be null)
    • getTypeFirstRep

      Gets the first repetition for type (), creating it if it does not already exist.

      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.

    • getWhenElement

      public ca.uhn.fhir.model.primitive.InstantDt getWhenElement()
      Gets the value(s) for when (). creating it if it does not exist. Will not return null.

      Definition: When the digital signature was signed.

    • getWhen

      public Date getWhen()
      Gets the value(s) for when (). creating it if it does not exist. This method may return null.

      Definition: When the digital signature was signed.

    • setWhen

      public SignatureDt setWhen​(ca.uhn.fhir.model.primitive.InstantDt theValue)
      Sets the value(s) for when ()

      Definition: When the digital signature was signed.

    • setWhenWithMillisPrecision

      Sets the value for when ()

      Definition: When the digital signature was signed.

    • setWhen

      public SignatureDt setWhen​(Date theDate, ca.uhn.fhir.model.api.TemporalPrecisionEnum thePrecision)
      Sets the value for when ()

      Definition: When the digital signature was signed.

    • getWho

      public ca.uhn.fhir.model.api.IDatatype getWho()
      Gets the value(s) for who[x] (). creating it if it does not exist. Will not return null.

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

    • setWho

      public SignatureDt setWho​(ca.uhn.fhir.model.api.IDatatype theValue)
      Sets the value(s) for who[x] ()

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

    • getContentTypeElement

      public ca.uhn.fhir.model.primitive.CodeDt getContentTypeElement()
      Gets the value(s) for contentType (). creating it if it does not exist. Will not return null.

      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

    • getContentType

      Gets the value(s) for contentType (). creating it if it does not exist. This method may return null.

      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

    • setContentType

      public SignatureDt setContentType​(ca.uhn.fhir.model.primitive.CodeDt theValue)
      Sets the value(s) for 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

    • setContentType

      public SignatureDt setContentType​(String theCode)
      Sets the value for 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

    • getBlobElement

      public ca.uhn.fhir.model.primitive.Base64BinaryDt getBlobElement()
      Gets the value(s) for blob (). creating it if it does not exist. Will not return null.

      Definition: The base64 encoding of the Signature content

    • getBlob

      public byte[] getBlob()
      Gets the value(s) for blob (). creating it if it does not exist. This method may return null.

      Definition: The base64 encoding of the Signature content

    • setBlob

      public SignatureDt setBlob​(ca.uhn.fhir.model.primitive.Base64BinaryDt theValue)
      Sets the value(s) for blob ()

      Definition: The base64 encoding of the Signature content

    • setBlob

      public SignatureDt setBlob​(byte[] theBytes)
      Sets the value for blob ()

      Definition: The base64 encoding of the Signature content