SignatureDt (HAPI FHIR Structures - DSTU2 (FHIR v1.0.0) 1.4 API)

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:

ICompositeDatatype, ICompositeElement, IDatatype, IElement, IIdentifiableElement, ISupportsUndeclaredExtensions, Serializable, IBase, IBaseDatatype, ICompositeType
```
public class SignatureDt
extends BaseIdentifiableElement
implements 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 and Description

SignatureDt()
Constructor

Constructors
Constructor and Description
`SignatureDt()` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CodingDt`	`addType()` Adds and returns a new value for type ()
`SignatureDt`	`addType(CodingDt theValue)` Adds a given new value for type ()
`<T extends IElement> List<T>`	`getAllPopulatedChildElementsOfType(Class<T> theType)`
`byte[]`	`getBlob()` Gets the value(s) for blob ().
`Base64BinaryDt`	`getBlobElement()` Gets the value(s) for blob ().
`String`	`getContentType()` Gets the value(s) for contentType ().
`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 ().
`InstantDt`	`getWhenElement()` Gets the value(s) for when ().
`IDatatype`	`getWho()` Gets the value(s) for who[x] ().
`boolean`	`isEmpty()`
`SignatureDt`	`setBlob(Base64BinaryDt theValue)` Sets the value(s) for blob ()
`SignatureDt`	`setBlob(byte[] theBytes)` Sets the value for blob ()
`SignatureDt`	`setContentType(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(Date theDate, TemporalPrecisionEnum thePrecision)` Sets the value for when ()
`SignatureDt`	`setWhen(InstantDt theValue)` Sets the value(s) for when ()
`SignatureDt`	`setWhenWithMillisPrecision(Date theDate)` Sets the value for when ()
`SignatureDt`	`setWho(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, getUndeclaredExtensions, getUndeclaredExtensionsByUrl, getUndeclaredModifierExtensions, isBaseEmpty

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SignatureDt
```
public SignatureDt()
```
    Constructor
- Method Detail
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface IBase
  - getAllPopulatedChildElementsOfType
```
public <T extends IElement> List<T> getAllPopulatedChildElementsOfType(Class<T> theType)
```
    Specified by:
    
    getAllPopulatedChildElementsOfType in interface 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
```
public CodingDt 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 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. Will not return null.
    Definition: When the digital signature was signed.
  - setWhen
```
public SignatureDt setWhen(InstantDt theValue)
```
    Sets the value(s) for when ()
    Definition: When the digital signature was signed.
  - setWhenWithMillisPrecision
```
public SignatureDt setWhenWithMillisPrecision(Date theDate)
```
    Sets the value for when ()
    Definition: When the digital signature was signed.
  - setWhen
```
public SignatureDt setWhen(Date theDate,
                           TemporalPrecisionEnum thePrecision)
```
    Sets the value for when ()
    Definition: When the digital signature was signed.
  - getWho
```
public 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(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 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
```
public String getContentType()
```
    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
  - setContentType
```
public SignatureDt setContentType(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 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. Will not return null.
    Definition: The base64 encoding of the Signature content
  - setBlob
```
public SignatureDt setBlob(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

Class SignatureDt

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

SignatureDt

Method Detail

isEmpty

getAllPopulatedChildElementsOfType

getType

setType

addType

addType

getTypeFirstRep

getWhenElement

getWhen

setWhen

setWhenWithMillisPrecision

setWhen

getWho

setWho

getContentTypeElement

getContentType

setContentType

setContentType

getBlobElement

getBlob

setBlob

setBlob